httplib.h 842 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374
  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.65.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x004100"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. // How much of an unread request body the server skips to reuse the connection,
  113. // 0 for no limit
  114. #ifndef CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH
  115. #define CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH (256 * 1024) // 256KB
  116. #endif
  117. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  118. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  119. #endif
  120. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  121. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  124. // 1400 rather than a round number: a body that already fits in one 1500-byte
  125. // MTU gains nothing from being made smaller.
  126. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  127. #endif
  128. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  129. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  130. #endif
  131. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  132. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  133. #endif
  134. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  135. // recurses roughly once per matched character for quantified patterns such
  136. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  137. // a default ~8MB thread stack that has been observed to take on the order of
  138. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  139. // margin below that (well under the 8192-byte request URI limit) while still
  140. // fitting any realistic route segment; raise it if a route legitimately needs
  141. // longer paths. Regex routes are never applied to paths longer than this.
  142. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  143. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  144. #endif
  145. #ifndef CPPHTTPLIB_TCP_NODELAY
  146. #define CPPHTTPLIB_TCP_NODELAY false
  147. #endif
  148. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  149. #define CPPHTTPLIB_IPV6_V6ONLY false
  150. #endif
  151. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  152. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  153. #endif
  154. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  155. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  156. #endif
  157. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  158. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  159. #endif
  160. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  161. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  162. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  163. ? std::thread::hardware_concurrency() - 1 \
  164. : 0))
  165. #endif
  166. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  167. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  168. #endif
  169. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  170. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  171. #endif
  172. #ifndef CPPHTTPLIB_RECV_FLAGS
  173. #define CPPHTTPLIB_RECV_FLAGS 0
  174. #endif
  175. #ifndef CPPHTTPLIB_SEND_FLAGS
  176. #define CPPHTTPLIB_SEND_FLAGS 0
  177. #endif
  178. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  179. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  180. #endif
  181. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  182. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  183. #endif
  184. // These bound the parsing of every request, so 0 cannot lift them.
  185. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  186. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  187. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  188. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  189. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  190. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  191. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  192. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  193. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  194. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  195. #endif
  196. // One macro used to set the read timeout for both sides. They want different
  197. // defaults: a client's read timeout is the caller's own tool (it waits forever
  198. // until asked not to), while a server keeps a ceiling that reclaims a worker
  199. // from a peer that has gone quiet. The old name still works and sets both.
  200. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  201. #pragma message( \
  202. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  203. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  204. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  207. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  208. #endif
  209. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  210. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  211. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  212. #endif
  213. #endif
  214. // 0 waits forever. A read timeout is how a caller gets control back to send on
  215. // the same connection; it is not a liveness check (that is ping/pong). Only a
  216. // timeout set at runtime through set_read_timeout() is reported as
  217. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  218. // ws::Fail and closes the connection.
  219. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  220. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  221. #endif
  222. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  223. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  224. #endif
  225. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  226. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  227. #endif
  228. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  229. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  230. #endif
  231. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  232. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  233. #endif
  234. /*
  235. * Headers
  236. */
  237. #ifdef _WIN32
  238. #ifndef _CRT_SECURE_NO_WARNINGS
  239. #define _CRT_SECURE_NO_WARNINGS
  240. #endif //_CRT_SECURE_NO_WARNINGS
  241. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  242. #define _CRT_NONSTDC_NO_DEPRECATE
  243. #endif //_CRT_NONSTDC_NO_DEPRECATE
  244. #if defined(_MSC_VER)
  245. #if _MSC_VER < 1900
  246. #error Sorry, Visual Studio versions prior to 2015 are not supported
  247. #endif
  248. #pragma comment(lib, "ws2_32.lib")
  249. #ifndef _SSIZE_T_DEFINED
  250. using ssize_t = __int64;
  251. #define _SSIZE_T_DEFINED
  252. #endif
  253. #endif // _MSC_VER
  254. #ifndef S_ISREG
  255. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  256. #endif // S_ISREG
  257. #ifndef S_ISDIR
  258. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  259. #endif // S_ISDIR
  260. #ifndef NOMINMAX
  261. #define NOMINMAX
  262. #endif // NOMINMAX
  263. #include <io.h>
  264. #include <winsock2.h>
  265. #include <ws2tcpip.h>
  266. #if defined(__has_include)
  267. #if __has_include(<afunix.h>)
  268. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  269. #include <afunix.h>
  270. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  271. #endif
  272. #endif
  273. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  274. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  275. #endif
  276. using nfds_t = unsigned long;
  277. using socket_t = SOCKET;
  278. using socklen_t = int;
  279. #else // not _WIN32
  280. #include <arpa/inet.h>
  281. #if !defined(_AIX) && !defined(__MVS__)
  282. #include <ifaddrs.h>
  283. #endif
  284. #ifdef __MVS__
  285. #include <strings.h>
  286. #ifndef NI_MAXHOST
  287. #define NI_MAXHOST 1025
  288. #endif
  289. #endif
  290. #include <net/if.h>
  291. #include <netdb.h>
  292. #include <netinet/in.h>
  293. #ifdef __linux__
  294. #include <resolv.h>
  295. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  296. #endif
  297. #include <csignal>
  298. #include <netinet/tcp.h>
  299. #include <poll.h>
  300. #include <pthread.h>
  301. #include <sys/socket.h>
  302. #include <sys/un.h>
  303. #include <unistd.h>
  304. using socket_t = int;
  305. #ifndef INVALID_SOCKET
  306. #define INVALID_SOCKET (-1)
  307. #endif
  308. #endif //_WIN32
  309. #if defined(__APPLE__)
  310. #include <TargetConditionals.h>
  311. #endif
  312. #include <algorithm>
  313. #include <array>
  314. #include <atomic>
  315. #include <cassert>
  316. #include <chrono>
  317. #include <climits>
  318. #include <condition_variable>
  319. #include <cstdlib>
  320. #include <cstring>
  321. #include <errno.h>
  322. #include <exception>
  323. #include <fcntl.h>
  324. #include <fstream>
  325. #include <functional>
  326. #include <iomanip>
  327. #include <iostream>
  328. #include <iterator>
  329. #include <list>
  330. #include <map>
  331. #include <memory>
  332. #include <mutex>
  333. #include <random>
  334. #include <regex>
  335. #include <set>
  336. #include <sstream>
  337. #include <string>
  338. #include <sys/stat.h>
  339. #include <system_error>
  340. #include <thread>
  341. #include <type_traits>
  342. #include <unordered_map>
  343. #include <unordered_set>
  344. #include <utility>
  345. #include <vector>
  346. // On macOS with a TLS backend, enable Keychain root certificates by default
  347. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  348. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  349. // only; on those platforms the user must provide a CA bundle explicitly.
  350. #if defined(__APPLE__) && defined(__clang__) && \
  351. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  352. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  353. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  354. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  355. #if TARGET_OS_OSX
  356. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  357. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  358. #endif
  359. #endif
  360. #endif
  361. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  362. defined(__APPLE__) && !TARGET_OS_OSX
  363. #error \
  364. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  365. #endif
  366. // On Windows, enable Schannel certificate verification by default
  367. // unless the user explicitly opts out.
  368. #if defined(_WIN32) && \
  369. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  370. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  371. #endif
  372. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  373. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  374. #if TARGET_OS_MAC && defined(__clang__)
  375. #include <CFNetwork/CFHost.h>
  376. #include <CoreFoundation/CoreFoundation.h>
  377. #endif
  378. #endif
  379. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  380. #ifdef _WIN32
  381. #include <wincrypt.h>
  382. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  383. // used
  384. #undef X509_NAME
  385. #undef X509_CERT_PAIR
  386. #undef X509_EXTENSIONS
  387. #undef PKCS7_SIGNER_INFO
  388. #ifdef _MSC_VER
  389. #pragma comment(lib, "crypt32.lib")
  390. #endif
  391. #endif // _WIN32
  392. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  393. #if TARGET_OS_OSX
  394. #include <Security/Security.h>
  395. #endif
  396. #endif
  397. #include <openssl/err.h>
  398. #include <openssl/evp.h>
  399. #include <openssl/rand.h>
  400. #include <openssl/ssl.h>
  401. #include <openssl/x509v3.h>
  402. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  403. #include <openssl/applink.c>
  404. #endif
  405. #include <iostream>
  406. #include <sstream>
  407. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  408. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  409. #error Please use OpenSSL or a current version of BoringSSL
  410. #endif
  411. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  412. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  413. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  414. #endif
  415. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  416. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  417. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  418. // in with this first include group so the version gating below can use it.
  419. #include <mbedtls/error.h>
  420. #include <mbedtls/net_sockets.h>
  421. #include <mbedtls/oid.h>
  422. #include <mbedtls/pk.h>
  423. #include <mbedtls/ssl.h>
  424. #include <mbedtls/version.h>
  425. #include <mbedtls/x509_crt.h>
  426. #if MBEDTLS_VERSION_MAJOR >= 4
  427. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  428. #include <psa/crypto.h>
  429. #else
  430. #include <mbedtls/ctr_drbg.h>
  431. #include <mbedtls/entropy.h>
  432. #include <mbedtls/md5.h>
  433. #include <mbedtls/sha1.h>
  434. #include <mbedtls/sha256.h>
  435. #include <mbedtls/sha512.h>
  436. #endif
  437. #ifdef _WIN32
  438. #include <wincrypt.h>
  439. #ifdef _MSC_VER
  440. #pragma comment(lib, "crypt32.lib")
  441. #endif
  442. #endif // _WIN32
  443. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  444. #if TARGET_OS_OSX
  445. #include <Security/Security.h>
  446. #endif
  447. #endif
  448. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  449. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  450. #if MBEDTLS_VERSION_MAJOR >= 4
  451. #define CPPHTTPLIB_MBEDTLS_V4
  452. #endif
  453. #if MBEDTLS_VERSION_MAJOR >= 3
  454. #define CPPHTTPLIB_MBEDTLS_V3
  455. #endif
  456. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  457. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  458. #include <wolfssl/options.h>
  459. #include <wolfssl/openssl/x509v3.h>
  460. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  461. #ifndef WOLFSSL_GEN_EMAIL
  462. #define WOLFSSL_GEN_EMAIL 1
  463. #endif
  464. #ifndef WOLFSSL_GEN_DNS
  465. #define WOLFSSL_GEN_DNS 2
  466. #endif
  467. #ifndef WOLFSSL_GEN_URI
  468. #define WOLFSSL_GEN_URI 6
  469. #endif
  470. #ifndef WOLFSSL_GEN_IPADD
  471. #define WOLFSSL_GEN_IPADD 7
  472. #endif
  473. #include <wolfssl/ssl.h>
  474. #include <wolfssl/wolfcrypt/hash.h>
  475. #include <wolfssl/wolfcrypt/md5.h>
  476. #include <wolfssl/wolfcrypt/sha256.h>
  477. #include <wolfssl/wolfcrypt/sha512.h>
  478. #ifdef _WIN32
  479. #include <wincrypt.h>
  480. #ifdef _MSC_VER
  481. #pragma comment(lib, "crypt32.lib")
  482. #endif
  483. #endif // _WIN32
  484. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  485. #if TARGET_OS_OSX
  486. #include <Security/Security.h>
  487. #endif
  488. #endif
  489. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  490. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  491. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  492. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  493. #define CPPHTTPLIB_SSL_ENABLED
  494. #endif
  495. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  496. #include <zlib.h>
  497. #endif
  498. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  499. #include <brotli/decode.h>
  500. #include <brotli/encode.h>
  501. #endif
  502. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  503. #include <zstd.h>
  504. #endif
  505. /*
  506. * Declaration
  507. */
  508. namespace httplib {
  509. namespace ws {
  510. class WebSocket;
  511. } // namespace ws
  512. namespace sse {
  513. class SSEClient;
  514. } // namespace sse
  515. namespace detail {
  516. /*
  517. * Backport std::make_unique from C++14.
  518. *
  519. * NOTE: This code came up with the following stackoverflow post:
  520. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  521. *
  522. */
  523. template <class T, class... Args>
  524. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(Args &&...args) {
  526. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  527. }
  528. template <class T>
  529. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  530. make_unique(std::size_t n) {
  531. typedef typename std::remove_extent<T>::type RT;
  532. return std::unique_ptr<T>(new RT[n]);
  533. }
  534. // Locale-independent ASCII character classification. The <cctype>
  535. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  536. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  537. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  538. // classified without regard to the locale.
  539. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  540. inline bool is_ascii_alpha(char c) {
  541. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  542. }
  543. inline bool is_ascii_alnum(char c) {
  544. return is_ascii_digit(c) || is_ascii_alpha(c);
  545. }
  546. namespace case_ignore {
  547. inline unsigned char to_lower(int c) {
  548. const static unsigned char table[256] = {
  549. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  550. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  551. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  552. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  553. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  554. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  555. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  556. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  557. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  558. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  559. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  560. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  561. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  562. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  563. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  564. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  565. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  566. 255,
  567. };
  568. return table[(unsigned char)(char)c];
  569. }
  570. inline std::string to_lower(const std::string &s) {
  571. std::string result = s;
  572. std::transform(
  573. result.begin(), result.end(), result.begin(),
  574. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  575. return result;
  576. }
  577. inline bool equal(const std::string &a, const std::string &b) {
  578. return a.size() == b.size() &&
  579. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  580. return to_lower(ca) == to_lower(cb);
  581. });
  582. }
  583. // For a literal, without building a std::string from it.
  584. template <size_t N>
  585. inline bool equal(const std::string &a, const char (&b)[N]) {
  586. return a.size() == N - 1 &&
  587. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  588. return to_lower(ca) == to_lower(cb);
  589. });
  590. }
  591. struct equal_to {
  592. bool operator()(const std::string &a, const std::string &b) const {
  593. return equal(a, b);
  594. }
  595. };
  596. struct hash {
  597. size_t operator()(const std::string &key) const {
  598. size_t h = 0;
  599. for (auto c : key) {
  600. // Unsets the 6 high bits of h, therefore no overflow happens
  601. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  602. static_cast<unsigned char>(to_lower(c));
  603. }
  604. return h;
  605. }
  606. };
  607. template <typename T>
  608. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  609. detail::case_ignore::equal_to>;
  610. } // namespace case_ignore
  611. // This is based on
  612. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  613. struct scope_exit {
  614. explicit scope_exit(std::function<void(void)> &&f)
  615. : exit_function(std::move(f)), execute_on_destruction{true} {}
  616. scope_exit(scope_exit &&rhs) noexcept
  617. : exit_function(std::move(rhs.exit_function)),
  618. execute_on_destruction{rhs.execute_on_destruction} {
  619. rhs.release();
  620. }
  621. ~scope_exit() {
  622. if (execute_on_destruction) { this->exit_function(); }
  623. }
  624. void release() { this->execute_on_destruction = false; }
  625. private:
  626. scope_exit(const scope_exit &) = delete;
  627. void operator=(const scope_exit &) = delete;
  628. scope_exit &operator=(scope_exit &&) = delete;
  629. std::function<void(void)> exit_function;
  630. bool execute_on_destruction;
  631. };
  632. // Simple from_chars implementation for integer and double types (C++17
  633. // substitute)
  634. template <typename T> struct from_chars_result {
  635. const char *ptr;
  636. std::errc ec;
  637. };
  638. template <typename T>
  639. inline from_chars_result<T> from_chars(const char *first, const char *last,
  640. T &value, int base = 10) {
  641. value = 0;
  642. const char *p = first;
  643. bool negative = false;
  644. if (p != last && *p == '-') {
  645. negative = true;
  646. ++p;
  647. }
  648. if (p == last) { return {first, std::errc::invalid_argument}; }
  649. auto radix = static_cast<T>(base);
  650. T result = 0;
  651. for (; p != last; ++p) {
  652. char c = *p;
  653. int digit = -1;
  654. if (is_ascii_digit(c)) {
  655. digit = c - '0';
  656. } else if ('a' <= c && c <= 'z') {
  657. digit = c - 'a' + 10;
  658. } else if ('A' <= c && c <= 'Z') {
  659. digit = c - 'A' + 10;
  660. } else {
  661. break;
  662. }
  663. if (digit < 0 || digit >= base) { break; }
  664. auto d = static_cast<T>(digit);
  665. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  666. return {p, std::errc::result_out_of_range};
  667. }
  668. result = result * radix + d;
  669. }
  670. if (p == first || (negative && p == first + 1)) {
  671. return {first, std::errc::invalid_argument};
  672. }
  673. value = negative ? T(0) - result : result;
  674. return {p, std::errc{}};
  675. }
  676. // from_chars for double (hand-written, locale-independent)
  677. //
  678. // The only double consumed by this library is the HTTP quality value, whose
  679. // grammar is (RFC 9110 12.4.2):
  680. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  681. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  682. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  683. // '.' always the decimal separator (std::strtod would instead read it from the
  684. // global C locale, mis-parsing q-values once an embedder calls
  685. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  686. // the result to [0, 1], so inputs outside that range need not be distinguished
  687. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  688. // cases that exponent and wide-range handling would introduce.
  689. inline from_chars_result<double> from_chars(const char *first, const char *last,
  690. double &value) {
  691. value = 0.0;
  692. const char *p = first;
  693. // Each 1eN is exactly representable, so a single final division by the
  694. // matching entry yields a correctly-rounded result.
  695. static const double powers_of_ten[] = {
  696. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  697. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  698. const int max_frac_digits =
  699. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  700. // Accumulate digits into a 64-bit integer and remember how many were
  701. // fractional. Two independent caps keep this bounded and safe:
  702. // * accumulation saturates before mantissa could overflow uint64_t, and
  703. // * frac_digits is capped at max_frac_digits so it is always a valid index
  704. // into powers_of_ten (without this an input like "0.000...0" would never
  705. // grow mantissa, so the saturation cap alone would not bound it).
  706. // Both caps only drop digits far beyond the precision a q-value needs; any
  707. // value they would change is well outside [0, 1] and rejected by the caller.
  708. uint64_t mantissa = 0;
  709. int frac_digits = 0;
  710. bool seen_digit = false;
  711. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  712. auto accumulate = [&](char c) {
  713. if (mantissa <= limit) {
  714. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  715. return true;
  716. }
  717. return false;
  718. };
  719. for (; p != last && is_ascii_digit(*p); ++p) {
  720. seen_digit = true;
  721. accumulate(*p);
  722. }
  723. if (p != last && *p == '.') {
  724. ++p;
  725. for (; p != last && is_ascii_digit(*p); ++p) {
  726. seen_digit = true;
  727. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  728. }
  729. }
  730. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  731. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  732. return {p, std::errc{}};
  733. }
  734. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  735. int &out) {
  736. int val = 0;
  737. auto r = from_chars(s, s + len, val);
  738. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  739. return false;
  740. }
  741. out = val;
  742. return true;
  743. }
  744. inline bool parse_port(const char *s, size_t len, int &port) {
  745. return parse_int_in_range(s, len, 1, 65535, port);
  746. }
  747. inline bool parse_port(const std::string &s, int &port) {
  748. return parse_port(s.data(), s.size(), port);
  749. }
  750. struct UrlComponents {
  751. std::string scheme;
  752. std::string host;
  753. std::string port;
  754. std::string path;
  755. std::string query;
  756. };
  757. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  758. uc = {};
  759. size_t pos = 0;
  760. auto sep = url.find("://");
  761. if (sep != std::string::npos) {
  762. uc.scheme = url.substr(0, sep);
  763. // Scheme must be [a-z]+ only
  764. if (uc.scheme.empty()) { return false; }
  765. for (auto c : uc.scheme) {
  766. if (c < 'a' || c > 'z') { return false; }
  767. }
  768. pos = sep + 3;
  769. } else if (url.compare(0, 2, "//") == 0) {
  770. pos = 2;
  771. }
  772. auto has_authority_prefix = pos > 0;
  773. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  774. url[0] != '?' && url[0] != '#');
  775. if (has_authority) {
  776. // userinfo is not supported, and a backslash that some parsers take for
  777. // '/' would leave them seeing another host than this one.
  778. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  779. return false;
  780. }
  781. if (pos < url.size() && url[pos] == '[') {
  782. auto close = url.find(']', pos);
  783. if (close == std::string::npos) { return false; }
  784. uc.host = url.substr(pos + 1, close - pos - 1);
  785. // IPv6 host must be [a-fA-F0-9:]+ only
  786. if (uc.host.empty()) { return false; }
  787. for (auto c : uc.host) {
  788. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  789. (c >= 'A' && c <= 'F') || c == ':')) {
  790. return false;
  791. }
  792. }
  793. pos = close + 1;
  794. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  795. // path, query or fragment delimiter (or the end of input). Otherwise the
  796. // trailing bytes would be folded into the path while the connection
  797. // still targets the bracketed address.
  798. if (pos < url.size()) {
  799. auto c = url[pos];
  800. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  801. }
  802. } else {
  803. auto end = url.find_first_of(":/?#", pos);
  804. if (end == std::string::npos) { end = url.size(); }
  805. uc.host = url.substr(pos, end - pos);
  806. pos = end;
  807. }
  808. if (pos < url.size() && url[pos] == ':') {
  809. ++pos;
  810. auto end = url.find_first_of("/?#", pos);
  811. if (end == std::string::npos) { end = url.size(); }
  812. uc.port = url.substr(pos, end - pos);
  813. pos = end;
  814. }
  815. // Without :// or //, the entire input must be consumed as host[:port].
  816. // If there is leftover (path, query, etc.), this is not a valid
  817. // host[:port] string — clear and reparse as a plain path.
  818. if (!has_authority_prefix && pos < url.size()) {
  819. uc.host.clear();
  820. uc.port.clear();
  821. pos = 0;
  822. }
  823. }
  824. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  825. auto end = url.find_first_of("?#", pos);
  826. if (end == std::string::npos) { end = url.size(); }
  827. uc.path = url.substr(pos, end - pos);
  828. pos = end;
  829. }
  830. if (pos < url.size() && url[pos] == '?') {
  831. auto end = url.find('#', pos);
  832. if (end == std::string::npos) { end = url.size(); }
  833. uc.query = url.substr(pos, end - pos);
  834. }
  835. return true;
  836. }
  837. // Removes "." and ".." segments from a path that starts with '/' (RFC 3986
  838. // section 5.2.4).
  839. inline std::string remove_dot_segments(const std::string &path) {
  840. std::string out;
  841. size_t i = 0;
  842. while (i < path.size()) {
  843. auto next = (std::min)(path.find('/', i + 1), path.size());
  844. auto segment = path.substr(i + 1, next - i - 1);
  845. auto is_last = next == path.size();
  846. if (segment == "." || segment == "..") {
  847. if (segment == "..") {
  848. out.erase((std::min)(out.rfind('/'), out.size()));
  849. }
  850. if (is_last) { out += '/'; }
  851. } else {
  852. out += '/';
  853. out += segment;
  854. }
  855. i = next;
  856. }
  857. if (out.empty()) { out = "/"; }
  858. return out;
  859. }
  860. // Resolves a relative-path or query-only Location value against the path of
  861. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  862. // references starting with '/' are returned unchanged.
  863. inline std::string resolve_relative_location(const std::string &location,
  864. const std::string &base) {
  865. if (location.empty() || location[0] == '/') { return location; }
  866. // A ':' in the first segment means the value has a scheme.
  867. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  868. // A path starting with "//" would be re-parsed as an authority. Prefix "/."
  869. // (as the URL Standard does); remove_dot_segments strips it later.
  870. auto on_this_host = [](std::string path) -> std::string {
  871. if (path.compare(0, 2, "//") == 0) { path.insert(0, "/."); }
  872. return path;
  873. };
  874. if (location[0] == '#') {
  875. return on_this_host(base.substr(0, base.find('#')) + location);
  876. }
  877. auto base_path = base.substr(0, base.find_first_of("?#"));
  878. if (location[0] == '?') { return on_this_host(base_path + location); }
  879. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  880. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  881. // Remove "." and ".." segments from the merged path.
  882. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  883. return on_this_host(remove_dot_segments(merged.substr(0, path_end)) +
  884. merged.substr(path_end));
  885. }
  886. } // namespace detail
  887. enum class SSLVerifierResponse {
  888. // no decision has been made, use the built-in certificate verifier
  889. NoDecisionMade,
  890. // connection certificate is verified and accepted
  891. CertificateAccepted,
  892. // connection certificate was processed but is rejected
  893. CertificateRejected
  894. };
  895. // System CA loading policy for SSL clients. Auto (the default) loads system
  896. // CA certs only when no custom CA is configured; enable_system_ca() switches
  897. // to an explicit policy.
  898. enum class SystemCAMode { Auto, Enabled, Disabled };
  899. enum StatusCode {
  900. // Information responses
  901. Continue_100 = 100,
  902. SwitchingProtocol_101 = 101,
  903. Processing_102 = 102,
  904. EarlyHints_103 = 103,
  905. // Successful responses
  906. OK_200 = 200,
  907. Created_201 = 201,
  908. Accepted_202 = 202,
  909. NonAuthoritativeInformation_203 = 203,
  910. NoContent_204 = 204,
  911. ResetContent_205 = 205,
  912. PartialContent_206 = 206,
  913. MultiStatus_207 = 207,
  914. AlreadyReported_208 = 208,
  915. IMUsed_226 = 226,
  916. // Redirection messages
  917. MultipleChoices_300 = 300,
  918. MovedPermanently_301 = 301,
  919. Found_302 = 302,
  920. SeeOther_303 = 303,
  921. NotModified_304 = 304,
  922. UseProxy_305 = 305,
  923. unused_306 = 306,
  924. TemporaryRedirect_307 = 307,
  925. PermanentRedirect_308 = 308,
  926. // Client error responses
  927. BadRequest_400 = 400,
  928. Unauthorized_401 = 401,
  929. PaymentRequired_402 = 402,
  930. Forbidden_403 = 403,
  931. NotFound_404 = 404,
  932. MethodNotAllowed_405 = 405,
  933. NotAcceptable_406 = 406,
  934. ProxyAuthenticationRequired_407 = 407,
  935. RequestTimeout_408 = 408,
  936. Conflict_409 = 409,
  937. Gone_410 = 410,
  938. LengthRequired_411 = 411,
  939. PreconditionFailed_412 = 412,
  940. PayloadTooLarge_413 = 413,
  941. UriTooLong_414 = 414,
  942. UnsupportedMediaType_415 = 415,
  943. RangeNotSatisfiable_416 = 416,
  944. ExpectationFailed_417 = 417,
  945. ImATeapot_418 = 418,
  946. MisdirectedRequest_421 = 421,
  947. UnprocessableContent_422 = 422,
  948. Locked_423 = 423,
  949. FailedDependency_424 = 424,
  950. TooEarly_425 = 425,
  951. UpgradeRequired_426 = 426,
  952. PreconditionRequired_428 = 428,
  953. TooManyRequests_429 = 429,
  954. RequestHeaderFieldsTooLarge_431 = 431,
  955. UnavailableForLegalReasons_451 = 451,
  956. // Server error responses
  957. InternalServerError_500 = 500,
  958. NotImplemented_501 = 501,
  959. BadGateway_502 = 502,
  960. ServiceUnavailable_503 = 503,
  961. GatewayTimeout_504 = 504,
  962. HttpVersionNotSupported_505 = 505,
  963. VariantAlsoNegotiates_506 = 506,
  964. InsufficientStorage_507 = 507,
  965. LoopDetected_508 = 508,
  966. NotExtended_510 = 510,
  967. NetworkAuthenticationRequired_511 = 511,
  968. };
  969. namespace detail {
  970. // A multimap that keeps its entries in the order they were inserted.
  971. //
  972. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  973. // fields sharing a field name significant and forbids a proxy from reordering
  974. // them, and a query string's parameters are meaningful in the order the caller
  975. // wrote them. Neither standard container expresses it: std::unordered_multimap
  976. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  977. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  978. // key, which would drop control data such as Host behind whatever else the
  979. // message carries and alphabetise a query string.
  980. //
  981. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  982. // scan, which beats hashing for the handful of entries a message carries
  983. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  984. //
  985. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  986. // Params, whose parameter names are case-sensitive, not.
  987. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  988. public:
  989. using key_type = std::string;
  990. using mapped_type = Mapped;
  991. using value_type = std::pair<std::string, Mapped>;
  992. using size_type = std::size_t;
  993. using difference_type = std::ptrdiff_t;
  994. using reference = value_type &;
  995. using const_reference = const value_type &;
  996. private:
  997. static size_type npos() { return static_cast<size_type>(-1); }
  998. static bool keys_equal(const std::string &a, const std::string &b) {
  999. return KeyEqual()(a, b);
  1000. }
  1001. // Iterating yields every entry in insertion order, but equal_range() and
  1002. // find() have to walk only the entries sharing one key, which are not
  1003. // adjacent. Both are the same iterator type: key_idx_ selects between the
  1004. // two traversals, and since equality compares only the position, an iterator
  1005. // restricted to one key still compares equal to end().
  1006. template <typename V> class iterator_t {
  1007. public:
  1008. using iterator_category = std::bidirectional_iterator_tag;
  1009. using value_type = insertion_ordered_multimap::value_type;
  1010. using difference_type = insertion_ordered_multimap::difference_type;
  1011. using pointer = V *;
  1012. using reference = V &;
  1013. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1014. template <typename U,
  1015. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1016. int>::type = 0>
  1017. iterator_t(const iterator_t<U> &rhs)
  1018. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1019. key_idx_(rhs.key_idx_) {}
  1020. reference operator*() const { return data_[idx_]; }
  1021. pointer operator->() const { return data_ + idx_; }
  1022. iterator_t &operator++() {
  1023. // Saturating, so that advancing past the last entry of a key stays at
  1024. // end() instead of running off the container.
  1025. if (idx_ >= size_) { return *this; }
  1026. ++idx_;
  1027. if (key_idx_ != npos()) {
  1028. while (idx_ < size_ && !matches(idx_)) {
  1029. ++idx_;
  1030. }
  1031. }
  1032. return *this;
  1033. }
  1034. iterator_t operator++(int) {
  1035. auto tmp = *this;
  1036. ++*this;
  1037. return tmp;
  1038. }
  1039. iterator_t &operator--() {
  1040. if (idx_ == 0) { return *this; }
  1041. --idx_;
  1042. if (key_idx_ != npos()) {
  1043. while (idx_ > 0 && !matches(idx_)) {
  1044. --idx_;
  1045. }
  1046. }
  1047. return *this;
  1048. }
  1049. iterator_t operator--(int) {
  1050. auto tmp = *this;
  1051. --*this;
  1052. return tmp;
  1053. }
  1054. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1055. return idx_ == rhs.idx_;
  1056. }
  1057. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1058. return idx_ != rhs.idx_;
  1059. }
  1060. private:
  1061. friend class insertion_ordered_multimap;
  1062. template <typename> friend class iterator_t;
  1063. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1064. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1065. bool matches(size_type i) const {
  1066. return keys_equal(data_[i].first, data_[key_idx_].first);
  1067. }
  1068. V *data_;
  1069. size_type idx_;
  1070. size_type size_;
  1071. size_type key_idx_;
  1072. };
  1073. public:
  1074. using iterator = iterator_t<value_type>;
  1075. using const_iterator = iterator_t<const value_type>;
  1076. insertion_ordered_multimap() = default;
  1077. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1078. : entries_(il) {}
  1079. template <typename InputIt>
  1080. insertion_ordered_multimap(InputIt first, InputIt last)
  1081. : entries_(first, last) {}
  1082. iterator begin() { return make_iter(0, npos()); }
  1083. iterator end() { return make_iter(entries_.size(), npos()); }
  1084. const_iterator begin() const { return make_citer(0, npos()); }
  1085. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1086. const_iterator cbegin() const { return begin(); }
  1087. const_iterator cend() const { return end(); }
  1088. bool empty() const { return entries_.empty(); }
  1089. size_type size() const { return entries_.size(); }
  1090. void clear() { entries_.clear(); }
  1091. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1092. iterator insert(const value_type &val) {
  1093. entries_.push_back(val);
  1094. return make_iter(entries_.size() - 1, npos());
  1095. }
  1096. iterator insert(value_type &&val) {
  1097. entries_.push_back(std::move(val));
  1098. return make_iter(entries_.size() - 1, npos());
  1099. }
  1100. template <typename... Args> iterator emplace(Args &&...args) {
  1101. entries_.emplace_back(std::forward<Args>(args)...);
  1102. return make_iter(entries_.size() - 1, npos());
  1103. }
  1104. // For entries that have to lead the message, such as the Host header field
  1105. // (RFC 9110 5.3 recommends sending control data first).
  1106. template <typename... Args> iterator emplace_front(Args &&...args) {
  1107. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1108. return make_iter(0, npos());
  1109. }
  1110. iterator find(const std::string &key) {
  1111. auto i = index_of(key);
  1112. return i == npos() ? end() : make_iter(i, i);
  1113. }
  1114. const_iterator find(const std::string &key) const {
  1115. auto i = index_of(key);
  1116. return i == npos() ? end() : make_citer(i, i);
  1117. }
  1118. size_type count(const std::string &key) const {
  1119. size_type n = 0;
  1120. for (const auto &entry : entries_) {
  1121. if (keys_equal(entry.first, key)) { n++; }
  1122. }
  1123. return n;
  1124. }
  1125. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1126. auto i = index_of(key);
  1127. return i == npos() ? std::make_pair(end(), end())
  1128. : std::make_pair(make_iter(i, i), end());
  1129. }
  1130. std::pair<const_iterator, const_iterator>
  1131. equal_range(const std::string &key) const {
  1132. auto i = index_of(key);
  1133. return i == npos() ? std::make_pair(end(), end())
  1134. : std::make_pair(make_citer(i, i), end());
  1135. }
  1136. size_type erase(const std::string &key) {
  1137. auto before = entries_.size();
  1138. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1139. [&](const value_type &entry) {
  1140. return keys_equal(entry.first, key);
  1141. }),
  1142. entries_.end());
  1143. return before - entries_.size();
  1144. }
  1145. iterator erase(const_iterator pos) {
  1146. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1147. return make_iter(pos.idx_, npos());
  1148. }
  1149. // Erases what iterating [first, last) would actually visit, so erasing an
  1150. // equal_range() removes only the entries with that key, not everything
  1151. // positioned between them.
  1152. iterator erase(const_iterator first, const_iterator last) {
  1153. auto from = first.idx_;
  1154. auto to = last.idx_;
  1155. if (from >= to) { return make_iter(from, npos()); }
  1156. auto begin_it = entries_.begin();
  1157. auto from_it = begin_it + static_cast<difference_type>(from);
  1158. auto to_it = begin_it + static_cast<difference_type>(to);
  1159. if (first.key_idx_ == npos()) {
  1160. entries_.erase(from_it, to_it);
  1161. } else {
  1162. auto key = entries_[first.key_idx_].first;
  1163. auto keep = from_it;
  1164. for (auto it = from_it; it != to_it; ++it) {
  1165. if (!keys_equal(it->first, key)) {
  1166. if (keep != it) { *keep = std::move(*it); }
  1167. ++keep;
  1168. }
  1169. }
  1170. if (keep != to_it) {
  1171. keep = std::move(to_it, entries_.end(), keep);
  1172. } else {
  1173. keep = entries_.end();
  1174. }
  1175. entries_.erase(keep, entries_.end());
  1176. }
  1177. return make_iter(from, npos());
  1178. }
  1179. friend bool operator==(const insertion_ordered_multimap &lhs,
  1180. const insertion_ordered_multimap &rhs) {
  1181. return lhs.entries_ == rhs.entries_;
  1182. }
  1183. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1184. const insertion_ordered_multimap &rhs) {
  1185. return !(lhs == rhs);
  1186. }
  1187. private:
  1188. size_type index_of(const std::string &key) const {
  1189. for (size_type i = 0; i < entries_.size(); i++) {
  1190. if (keys_equal(entries_[i].first, key)) { return i; }
  1191. }
  1192. return npos();
  1193. }
  1194. iterator make_iter(size_type idx, size_type key_idx) {
  1195. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1196. }
  1197. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1198. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1199. }
  1200. std::vector<value_type> entries_;
  1201. };
  1202. } // namespace detail
  1203. using Headers =
  1204. detail::insertion_ordered_multimap<std::string,
  1205. detail::case_ignore::equal_to>;
  1206. // Query parameter names are case-sensitive, unlike header field names.
  1207. using Params =
  1208. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1209. using Match = std::smatch;
  1210. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1211. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1212. /*
  1213. * detail: type-erased storage used by UserData.
  1214. * ABI-stable regardless of C++ standard — always uses this custom
  1215. * implementation instead of std::any.
  1216. */
  1217. namespace detail {
  1218. using any_type_id = const void *;
  1219. template <typename T> any_type_id any_typeid() noexcept {
  1220. static const char id = 0;
  1221. return &id;
  1222. }
  1223. struct any_storage {
  1224. virtual ~any_storage() = default;
  1225. virtual std::unique_ptr<any_storage> clone() const = 0;
  1226. virtual any_type_id type_id() const noexcept = 0;
  1227. };
  1228. template <typename T> struct any_value final : any_storage {
  1229. T value;
  1230. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1231. std::unique_ptr<any_storage> clone() const override {
  1232. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1233. }
  1234. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1235. };
  1236. } // namespace detail
  1237. class UserData {
  1238. public:
  1239. UserData() = default;
  1240. UserData(UserData &&) noexcept = default;
  1241. UserData &operator=(UserData &&) noexcept = default;
  1242. UserData(const UserData &o) {
  1243. for (const auto &e : o.entries_) {
  1244. if (e.second) { entries_[e.first] = e.second->clone(); }
  1245. }
  1246. }
  1247. UserData &operator=(const UserData &o) {
  1248. if (this != &o) {
  1249. entries_.clear();
  1250. for (const auto &e : o.entries_) {
  1251. if (e.second) { entries_[e.first] = e.second->clone(); }
  1252. }
  1253. }
  1254. return *this;
  1255. }
  1256. template <typename T> void set(const std::string &key, T &&value) {
  1257. using D = typename std::decay<T>::type;
  1258. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1259. }
  1260. template <typename T> T *get(const std::string &key) noexcept {
  1261. auto it = entries_.find(key);
  1262. if (it == entries_.end() || !it->second) { return nullptr; }
  1263. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1264. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1265. }
  1266. template <typename T> const T *get(const std::string &key) const noexcept {
  1267. auto it = entries_.find(key);
  1268. if (it == entries_.end() || !it->second) { return nullptr; }
  1269. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1270. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1271. }
  1272. bool has(const std::string &key) const noexcept {
  1273. return entries_.find(key) != entries_.end();
  1274. }
  1275. void erase(const std::string &key) { entries_.erase(key); }
  1276. void clear() noexcept { entries_.clear(); }
  1277. private:
  1278. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1279. entries_;
  1280. };
  1281. struct Response;
  1282. using ResponseHandler = std::function<bool(const Response &response)>;
  1283. struct FormData {
  1284. std::string name;
  1285. std::string content;
  1286. std::string filename;
  1287. std::string content_type;
  1288. Headers headers;
  1289. };
  1290. struct FormField {
  1291. std::string name;
  1292. std::string content;
  1293. Headers headers;
  1294. };
  1295. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1296. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1297. // should see the parts as they were sent. A std::multimap sorts by field name
  1298. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1299. // than the case-insensitive predicate Headers uses.
  1300. using FormFields =
  1301. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1302. using FormFiles =
  1303. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1304. struct MultipartFormData {
  1305. FormFields fields; // Text fields from multipart
  1306. FormFiles files; // Files from multipart
  1307. // Text field access
  1308. std::string get_field(const std::string &key, size_t id = 0) const;
  1309. std::vector<std::string> get_fields(const std::string &key) const;
  1310. bool has_field(const std::string &key) const;
  1311. size_t get_field_count(const std::string &key) const;
  1312. // File access
  1313. FormData get_file(const std::string &key, size_t id = 0) const;
  1314. std::vector<FormData> get_files(const std::string &key) const;
  1315. bool has_file(const std::string &key) const;
  1316. size_t get_file_count(const std::string &key) const;
  1317. };
  1318. struct UploadFormData {
  1319. std::string name;
  1320. std::string content;
  1321. std::string filename;
  1322. std::string content_type;
  1323. };
  1324. using UploadFormDataItems = std::vector<UploadFormData>;
  1325. class DataSink {
  1326. public:
  1327. DataSink() : os(&sb_), sb_(*this) {}
  1328. DataSink(const DataSink &) = delete;
  1329. DataSink &operator=(const DataSink &) = delete;
  1330. DataSink(DataSink &&) = delete;
  1331. DataSink &operator=(DataSink &&) = delete;
  1332. std::function<bool(const char *data, size_t data_len)> write;
  1333. // Only `write` is mandatory. The rest are defaulted so that a provider
  1334. // calling one on a writer that does not set it gets sensible behaviour
  1335. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1336. // `this` is safe: DataSink is neither copyable nor movable.
  1337. std::function<bool()> is_writable = []() { return true; };
  1338. std::function<void()> done = []() {};
  1339. std::function<void(const Headers &trailer)> done_with_trailer =
  1340. [this](const Headers & /*trailer*/) { done(); };
  1341. std::ostream os;
  1342. private:
  1343. class data_sink_streambuf final : public std::streambuf {
  1344. public:
  1345. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1346. protected:
  1347. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1348. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1349. return 0;
  1350. }
  1351. private:
  1352. DataSink &sink_;
  1353. };
  1354. data_sink_streambuf sb_;
  1355. };
  1356. using ContentProvider =
  1357. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1358. using ContentProviderWithoutLength =
  1359. std::function<bool(size_t offset, DataSink &sink)>;
  1360. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1361. struct FormDataProvider {
  1362. std::string name;
  1363. ContentProviderWithoutLength provider;
  1364. std::string filename;
  1365. std::string content_type;
  1366. };
  1367. using FormDataProviderItems = std::vector<FormDataProvider>;
  1368. inline FormDataProvider
  1369. make_file_provider(const std::string &name, const std::string &filepath,
  1370. const std::string &filename = std::string(),
  1371. const std::string &content_type = std::string()) {
  1372. FormDataProvider fdp;
  1373. fdp.name = name;
  1374. fdp.filename = filename.empty() ? filepath : filename;
  1375. fdp.content_type = content_type;
  1376. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1377. std::ifstream f(filepath, std::ios::binary);
  1378. if (!f) { return false; }
  1379. if (offset > 0) {
  1380. f.seekg(static_cast<std::streamoff>(offset));
  1381. if (!f.good()) {
  1382. sink.done();
  1383. return true;
  1384. }
  1385. }
  1386. char buf[8192];
  1387. f.read(buf, sizeof(buf));
  1388. auto n = static_cast<size_t>(f.gcount());
  1389. if (n > 0) { return sink.write(buf, n); }
  1390. sink.done(); // EOF
  1391. return true;
  1392. };
  1393. return fdp;
  1394. }
  1395. inline std::pair<size_t, ContentProvider>
  1396. make_file_body(const std::string &filepath) {
  1397. size_t size = 0;
  1398. {
  1399. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1400. if (!f) { return {0, ContentProvider{}}; }
  1401. size = static_cast<size_t>(f.tellg());
  1402. }
  1403. ContentProvider provider = [filepath](size_t offset, size_t length,
  1404. DataSink &sink) -> bool {
  1405. std::ifstream f(filepath, std::ios::binary);
  1406. if (!f) { return false; }
  1407. f.seekg(static_cast<std::streamoff>(offset));
  1408. if (!f.good()) { return false; }
  1409. char buf[8192];
  1410. while (length > 0) {
  1411. auto to_read = (std::min)(sizeof(buf), length);
  1412. f.read(buf, static_cast<std::streamsize>(to_read));
  1413. auto n = static_cast<size_t>(f.gcount());
  1414. // The file is shorter than the size make_file_body() measured, which the
  1415. // caller has already committed to as Content-Length. The body cannot be
  1416. // completed, so fail as every other error here does.
  1417. if (n == 0) { return false; }
  1418. if (!sink.write(buf, n)) { return false; }
  1419. length -= n;
  1420. }
  1421. return true;
  1422. };
  1423. return {size, std::move(provider)};
  1424. }
  1425. using ContentReceiverWithProgress = std::function<bool(
  1426. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1427. using ContentReceiver =
  1428. std::function<bool(const char *data, size_t data_length)>;
  1429. using FormDataHeader = std::function<bool(const FormData &file)>;
  1430. class ContentReader {
  1431. public:
  1432. using Reader = std::function<bool(ContentReceiver receiver)>;
  1433. using FormDataReader =
  1434. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1435. ContentReader(Reader reader, FormDataReader multipart_reader)
  1436. : reader_(std::move(reader)),
  1437. formdata_reader_(std::move(multipart_reader)) {}
  1438. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1439. return formdata_reader_(std::move(header), std::move(receiver));
  1440. }
  1441. bool operator()(ContentReceiver receiver) const {
  1442. return reader_(std::move(receiver));
  1443. }
  1444. Reader reader_;
  1445. FormDataReader formdata_reader_;
  1446. };
  1447. using Range = std::pair<ssize_t, ssize_t>;
  1448. using Ranges = std::vector<Range>;
  1449. #ifdef CPPHTTPLIB_SSL_ENABLED
  1450. // TLS abstraction layer - public type definitions and API
  1451. namespace tls {
  1452. // Opaque handles (defined as void* for abstraction)
  1453. using ctx_t = void *;
  1454. using session_t = void *;
  1455. using const_session_t = const void *; // For read-only session access
  1456. using cert_t = void *;
  1457. using ca_store_t = void *;
  1458. // TLS versions
  1459. enum class Version {
  1460. TLS1_2 = 0x0303,
  1461. TLS1_3 = 0x0304,
  1462. };
  1463. // Subject Alternative Names (SAN) entry types
  1464. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1465. // SAN entry structure
  1466. struct SanEntry {
  1467. SanType type;
  1468. std::string value;
  1469. };
  1470. // Verification context for certificate verification callback
  1471. struct VerifyContext {
  1472. session_t session; // TLS session handle
  1473. cert_t cert; // Current certificate being verified
  1474. int depth; // Certificate chain depth (0 = leaf)
  1475. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1476. long error_code; // Backend-specific error code (0 = no error)
  1477. const char *error_string; // Human-readable error description
  1478. // Certificate introspection methods
  1479. std::string subject_cn() const;
  1480. std::string issuer_name() const;
  1481. bool check_hostname(const char *hostname) const;
  1482. std::vector<SanEntry> sans() const;
  1483. bool validity(time_t &not_before, time_t &not_after) const;
  1484. std::string serial() const;
  1485. };
  1486. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1487. // TlsError codes for TLS operations (backend-independent)
  1488. enum class ErrorCode : int {
  1489. Success = 0,
  1490. WantRead, // Non-blocking: need to wait for read
  1491. WantWrite, // Non-blocking: need to wait for write
  1492. PeerClosed, // Peer closed the connection
  1493. Fatal, // Unrecoverable error
  1494. SyscallError, // System call error (check sys_errno)
  1495. CertVerifyFailed, // Certificate verification failed
  1496. HostnameMismatch, // Hostname verification failed
  1497. };
  1498. // TLS error information
  1499. struct TlsError {
  1500. ErrorCode code = ErrorCode::Fatal;
  1501. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1502. int sys_errno = 0; // errno when SyscallError
  1503. // Convert verification error code to human-readable string
  1504. static std::string verify_error_to_string(long error_code);
  1505. };
  1506. // RAII wrapper for peer certificate
  1507. class PeerCert {
  1508. public:
  1509. PeerCert();
  1510. PeerCert(PeerCert &&other) noexcept;
  1511. PeerCert &operator=(PeerCert &&other) noexcept;
  1512. ~PeerCert();
  1513. PeerCert(const PeerCert &) = delete;
  1514. PeerCert &operator=(const PeerCert &) = delete;
  1515. explicit operator bool() const;
  1516. std::string subject_cn() const;
  1517. std::string issuer_name() const;
  1518. bool check_hostname(const char *hostname) const;
  1519. std::vector<SanEntry> sans() const;
  1520. bool validity(time_t &not_before, time_t &not_after) const;
  1521. std::string serial() const;
  1522. private:
  1523. explicit PeerCert(cert_t cert);
  1524. cert_t cert_ = nullptr;
  1525. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1526. };
  1527. // Callback for TLS context setup (used by SSLServer constructor)
  1528. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1529. } // namespace tls
  1530. #endif
  1531. struct Request {
  1532. std::string method;
  1533. std::string path;
  1534. std::string matched_route;
  1535. Params params;
  1536. Headers headers;
  1537. Headers trailers;
  1538. std::string body;
  1539. std::string remote_addr;
  1540. int remote_port = -1;
  1541. std::string local_addr;
  1542. int local_port = -1;
  1543. // for server
  1544. std::string version;
  1545. std::string target;
  1546. MultipartFormData form;
  1547. Ranges ranges;
  1548. Match matches;
  1549. std::unordered_map<std::string, std::string> path_params;
  1550. std::function<bool()> is_connection_closed = []() { return true; };
  1551. // for client
  1552. std::vector<std::string> accept_content_types;
  1553. ResponseHandler response_handler;
  1554. ContentReceiverWithProgress content_receiver;
  1555. DownloadProgress download_progress;
  1556. UploadProgress upload_progress;
  1557. bool has_header(const std::string &key) const;
  1558. std::string get_header_value(const std::string &key, const char *def = "",
  1559. size_t id = 0) const;
  1560. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1561. size_t id = 0) const;
  1562. size_t get_header_value_count(const std::string &key) const;
  1563. void set_header(const std::string &key, const std::string &val);
  1564. bool has_trailer(const std::string &key) const;
  1565. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1566. size_t get_trailer_value_count(const std::string &key) const;
  1567. bool has_param(const std::string &key) const;
  1568. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1569. std::vector<std::string> get_param_values(const std::string &key) const;
  1570. size_t get_param_value_count(const std::string &key) const;
  1571. bool is_multipart_form_data() const;
  1572. // private members...
  1573. bool body_read_started_ = false;
  1574. bool body_consumed_ = false;
  1575. bool expect_100_continue_pending_ = false;
  1576. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1577. size_t content_length_ = 0;
  1578. ContentProvider content_provider_;
  1579. bool is_chunked_content_provider_ = false;
  1580. size_t authorization_count_ = 0;
  1581. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1582. (std::chrono::steady_clock::time_point::min)();
  1583. #ifdef CPPHTTPLIB_SSL_ENABLED
  1584. tls::const_session_t ssl = nullptr;
  1585. tls::PeerCert peer_cert() const;
  1586. std::string sni() const;
  1587. #endif
  1588. };
  1589. namespace detail {
  1590. // Declared up here, away from the rest of the compression helpers, because
  1591. // `Response` stores one.
  1592. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1593. } // namespace detail
  1594. struct Response {
  1595. std::string version;
  1596. int status = -1;
  1597. std::string reason;
  1598. Headers headers;
  1599. Headers trailers;
  1600. std::string body;
  1601. std::string location; // Redirect location
  1602. // User-defined context — set by pre-routing/pre-request handlers and read
  1603. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1604. UserData user_data;
  1605. bool has_header(const std::string &key) const;
  1606. std::string get_header_value(const std::string &key, const char *def = "",
  1607. size_t id = 0) const;
  1608. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1609. size_t id = 0) const;
  1610. size_t get_header_value_count(const std::string &key) const;
  1611. void set_header(const std::string &key, const std::string &val);
  1612. bool has_trailer(const std::string &key) const;
  1613. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1614. size_t get_trailer_value_count(const std::string &key) const;
  1615. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1616. void set_content(const char *s, size_t n, const std::string &content_type);
  1617. void set_content(const std::string &s, const std::string &content_type);
  1618. void set_content(std::string &&s, const std::string &content_type);
  1619. void set_content_provider(
  1620. size_t length, const std::string &content_type, ContentProvider provider,
  1621. ContentProviderResourceReleaser resource_releaser = nullptr);
  1622. void set_content_provider(
  1623. const std::string &content_type, ContentProviderWithoutLength provider,
  1624. ContentProviderResourceReleaser resource_releaser = nullptr);
  1625. void set_chunked_content_provider(
  1626. const std::string &content_type, ContentProviderWithoutLength provider,
  1627. ContentProviderResourceReleaser resource_releaser = nullptr);
  1628. void set_file_content(const std::string &path,
  1629. const std::string &content_type);
  1630. void set_file_content(const std::string &path);
  1631. Response() = default;
  1632. Response(const Response &) = default;
  1633. Response &operator=(const Response &) = default;
  1634. Response(Response &&) = default;
  1635. Response &operator=(Response &&) = default;
  1636. ~Response() {
  1637. if (content_provider_resource_releaser_) {
  1638. content_provider_resource_releaser_(content_provider_success_);
  1639. }
  1640. }
  1641. // private members...
  1642. size_t content_length_ = 0;
  1643. ContentProvider content_provider_;
  1644. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1645. bool is_chunked_content_provider_ = false;
  1646. bool is_file_content_provider_ = false;
  1647. bool content_provider_success_ = false;
  1648. std::string file_content_path_;
  1649. std::string file_content_content_type_;
  1650. // Content coding chosen for the response body, decided once so that the
  1651. // headers and the body cannot disagree: where the file is opened for a
  1652. // file-backed content provider (keeping the ETag honest), and in
  1653. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1654. // for every other kind of response.
  1655. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1656. };
  1657. enum class Error {
  1658. Success = 0,
  1659. Unknown,
  1660. Connection,
  1661. BindIPAddress,
  1662. Read,
  1663. Write,
  1664. ExceedRedirectCount,
  1665. Canceled,
  1666. SSLConnection,
  1667. SSLLoadingCerts,
  1668. SSLServerVerification,
  1669. SSLServerHostnameVerification,
  1670. UnsupportedMultipartBoundaryChars,
  1671. Compression,
  1672. ConnectionTimeout,
  1673. ProxyConnection,
  1674. ConnectionClosed,
  1675. Timeout,
  1676. ResourceExhaustion,
  1677. TooManyFormDataFiles,
  1678. ExceedMaxPayloadSize,
  1679. ExceedUriMaxLength,
  1680. ExceedMaxSocketDescriptorCount,
  1681. InvalidRequestLine,
  1682. InvalidHTTPMethod,
  1683. InvalidHTTPVersion,
  1684. InvalidHeaders,
  1685. MultipartParsing,
  1686. OpenFile,
  1687. Listen,
  1688. GetSockName,
  1689. UnsupportedAddressFamily,
  1690. HTTPParsing,
  1691. InvalidRangeHeader,
  1692. UnsupportedContentEncoding,
  1693. WebSocketHandshake,
  1694. UserCallbackException,
  1695. // For internal use only
  1696. SSLPeerCouldBeClosed_,
  1697. };
  1698. std::string to_string(Error error);
  1699. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1700. class Stream {
  1701. public:
  1702. virtual ~Stream() = default;
  1703. virtual bool is_readable() const = 0;
  1704. virtual bool wait_readable() const = 0;
  1705. virtual bool wait_writable() const = 0;
  1706. virtual bool is_peer_alive() const { return wait_writable(); }
  1707. virtual ssize_t read(char *ptr, size_t size) = 0;
  1708. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1709. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1710. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1711. virtual socket_t socket() const = 0;
  1712. virtual time_t duration() const = 0;
  1713. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1714. (void)sec;
  1715. (void)usec;
  1716. }
  1717. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1718. // each one. 0 lifts the bound.
  1719. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1720. // Lets a wait for data end early once `interrupted` returns true, so that
  1721. // another thread can stop a blocked read on every platform.
  1722. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1723. (void)interrupted;
  1724. }
  1725. // Bytes already pulled off the socket and sitting in this stream's own
  1726. // buffer. Exposing them lets a line reader scan for a terminator in one
  1727. // pass instead of asking for a byte at a time. A stream that does no
  1728. // buffering of its own reports none, and readers fall back to read().
  1729. virtual const char *buffered_data(size_t &size) const {
  1730. size = 0;
  1731. return nullptr;
  1732. }
  1733. // Discards `size` bytes previously returned by buffered_data().
  1734. virtual void consume_buffered(size_t size) { (void)size; }
  1735. ssize_t write(const char *ptr);
  1736. ssize_t write(const std::string &s);
  1737. Error get_error() const { return error_; }
  1738. protected:
  1739. Error error_ = Error::Success;
  1740. };
  1741. class TaskQueue {
  1742. public:
  1743. TaskQueue() = default;
  1744. virtual ~TaskQueue() = default;
  1745. virtual bool enqueue(std::function<void()> fn) = 0;
  1746. virtual void shutdown() = 0;
  1747. virtual void on_idle() {}
  1748. };
  1749. class ThreadPool final : public TaskQueue {
  1750. public:
  1751. explicit ThreadPool(
  1752. size_t n, size_t max_n = 0, size_t mqr = 0,
  1753. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1754. ThreadPool(const ThreadPool &) = delete;
  1755. ~ThreadPool() override = default;
  1756. bool enqueue(std::function<void()> fn) override;
  1757. void shutdown() override;
  1758. private:
  1759. void worker(bool is_dynamic);
  1760. void move_to_finished(std::thread::id id);
  1761. void cleanup_finished_threads();
  1762. size_t base_thread_count_;
  1763. size_t max_thread_count_;
  1764. size_t max_queued_requests_;
  1765. time_t idle_timeout_sec_;
  1766. size_t idle_thread_count_;
  1767. bool shutdown_;
  1768. std::list<std::function<void()>> jobs_;
  1769. std::vector<std::thread> threads_; // base threads
  1770. std::list<std::thread> dynamic_threads_; // dynamic threads
  1771. std::vector<std::thread>
  1772. finished_threads_; // exited dynamic threads awaiting join
  1773. std::condition_variable cond_;
  1774. std::mutex mutex_;
  1775. };
  1776. using Logger = std::function<void(const Request &, const Response &)>;
  1777. // Forward declaration for Error type
  1778. enum class Error;
  1779. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1780. using SocketOptions = std::function<void(socket_t sock)>;
  1781. void default_socket_options(socket_t sock);
  1782. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1783. const char *status_message(int status);
  1784. std::string to_string(Error error);
  1785. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1786. std::string get_bearer_token_auth(const Request &req);
  1787. namespace detail {
  1788. class MatcherBase {
  1789. public:
  1790. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1791. virtual ~MatcherBase() = default;
  1792. const std::string &pattern() const { return pattern_; }
  1793. // Match request path and populate its matches and
  1794. virtual bool match(Request &request) const = 0;
  1795. private:
  1796. std::string pattern_;
  1797. };
  1798. /**
  1799. * Captures parameters in request path and stores them in Request::path_params
  1800. *
  1801. * Capture name is a substring of a pattern from : to /.
  1802. * The rest of the pattern is matched against the request path directly
  1803. * Parameters are captured starting from the next character after
  1804. * the end of the last matched static pattern fragment until the next /.
  1805. *
  1806. * Example pattern:
  1807. * "/path/fragments/:capture/more/fragments/:second_capture"
  1808. * Static fragments:
  1809. * "/path/fragments/", "more/fragments/"
  1810. *
  1811. * Given the following request path:
  1812. * "/path/fragments/:1/more/fragments/:2"
  1813. * the resulting capture will be
  1814. * {{"capture", "1"}, {"second_capture", "2"}}
  1815. */
  1816. class PathParamsMatcher final : public MatcherBase {
  1817. public:
  1818. PathParamsMatcher(const std::string &pattern);
  1819. bool match(Request &request) const override;
  1820. private:
  1821. // Treat segment separators as the end of path parameter capture
  1822. // Does not need to handle query parameters as they are parsed before path
  1823. // matching
  1824. static constexpr char separator = '/';
  1825. // Contains static path fragments to match against, excluding the '/' after
  1826. // path params
  1827. // Fragments are separated by path params
  1828. std::vector<std::string> static_fragments_;
  1829. // Stores the names of the path parameters to be used as keys in the
  1830. // Request::path_params map
  1831. std::vector<std::string> param_names_;
  1832. };
  1833. /**
  1834. * Performs std::regex_match on request path
  1835. * and stores the result in Request::matches
  1836. *
  1837. * Note that regex match is performed directly on the whole request.
  1838. * This means that wildcard patterns may match multiple path segments with /:
  1839. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1840. */
  1841. class RegexMatcher final : public MatcherBase {
  1842. public:
  1843. RegexMatcher(const std::string &pattern)
  1844. : MatcherBase(pattern), regex_(pattern) {}
  1845. bool match(Request &request) const override;
  1846. private:
  1847. std::regex regex_;
  1848. };
  1849. int close_socket(socket_t sock) noexcept;
  1850. bool is_accept_resource_error();
  1851. bool is_accept_transient_error();
  1852. ssize_t write_headers(Stream &strm, const Headers &headers);
  1853. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1854. time_t usec);
  1855. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1856. const std::string &boundary);
  1857. ContentProvider
  1858. make_multipart_content_provider(const UploadFormDataItems &items,
  1859. const std::string &boundary);
  1860. } // namespace detail
  1861. bool is_valid_multipart_boundary(const std::string &boundary);
  1862. // Serializer for multipart/form-data request bodies. The boundary is owned
  1863. // by the writer so that per-part framing and the final terminator always
  1864. // agree. Field names and filenames are escaped following the WHATWG HTML
  1865. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1866. // in content types.
  1867. class MultipartFormDataWriter {
  1868. public:
  1869. MultipartFormDataWriter();
  1870. // precondition: is_valid_multipart_boundary(boundary)
  1871. explicit MultipartFormDataWriter(std::string boundary);
  1872. const std::string &boundary() const;
  1873. std::string content_type() const;
  1874. // In-memory items -> whole body (known length)
  1875. std::string serialize(const UploadFormDataItems &items) const;
  1876. size_t content_length(const UploadFormDataItems &items) const;
  1877. // Per-part framing for streaming via a content provider
  1878. std::string item_begin(const UploadFormData &item) const;
  1879. static std::string item_end();
  1880. std::string finish() const;
  1881. private:
  1882. std::string boundary_;
  1883. };
  1884. class Server {
  1885. public:
  1886. using Handler = std::function<void(const Request &, Response &)>;
  1887. using ExceptionHandler =
  1888. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1889. enum class HandlerResponse {
  1890. Handled,
  1891. Unhandled,
  1892. };
  1893. using HandlerWithResponse =
  1894. std::function<HandlerResponse(const Request &, Response &)>;
  1895. using HandlerWithContentReader = std::function<void(
  1896. const Request &, Response &, const ContentReader &content_reader)>;
  1897. using Expect100ContinueHandler =
  1898. std::function<int(const Request &, Response &)>;
  1899. using StartHandler = std::function<void()>;
  1900. using WebSocketHandler =
  1901. std::function<void(const Request &, ws::WebSocket &)>;
  1902. using SubProtocolSelector =
  1903. std::function<std::string(const std::vector<std::string> &protocols)>;
  1904. Server();
  1905. virtual ~Server();
  1906. virtual bool is_valid() const;
  1907. Server &Get(const std::string &pattern, Handler handler);
  1908. Server &Post(const std::string &pattern, Handler handler);
  1909. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1910. Server &Put(const std::string &pattern, Handler handler);
  1911. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1912. Server &Patch(const std::string &pattern, Handler handler);
  1913. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1914. Server &Delete(const std::string &pattern, Handler handler);
  1915. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1916. Server &Options(const std::string &pattern, Handler handler);
  1917. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1918. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1919. // server accept it; an unregistered method is still rejected with 400.
  1920. // `method` must be a valid HTTP method token and must not be one of the
  1921. // built-in methods, which have their own registration functions above. A
  1922. // rejected registration makes is_valid() return false, so listen() fails.
  1923. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1924. Handler handler);
  1925. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1926. HandlerWithContentReader handler);
  1927. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1928. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1929. SubProtocolSelector sub_protocol_selector);
  1930. bool set_base_dir(const std::string &dir,
  1931. const std::string &mount_point = std::string());
  1932. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1933. Headers headers = Headers());
  1934. bool remove_mount_point(const std::string &mount_point);
  1935. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1936. const std::string &mime);
  1937. Server &set_default_file_mimetype(const std::string &mime);
  1938. Server &set_file_request_handler(Handler handler);
  1939. template <class ErrorHandlerFunc>
  1940. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1941. return set_error_handler_core(
  1942. std::forward<ErrorHandlerFunc>(handler),
  1943. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1944. }
  1945. Server &set_exception_handler(ExceptionHandler handler);
  1946. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1947. Server &set_post_routing_handler(Handler handler);
  1948. Server &set_pre_request_handler(HandlerWithResponse handler);
  1949. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1950. Server &set_start_handler(StartHandler handler);
  1951. Server &set_logger(Logger logger);
  1952. Server &set_pre_compression_logger(Logger logger);
  1953. Server &set_error_logger(ErrorLogger error_logger);
  1954. Server &set_address_family(int family);
  1955. Server &set_tcp_nodelay(bool on);
  1956. Server &set_ipv6_v6only(bool on);
  1957. Server &set_socket_options(SocketOptions socket_options);
  1958. Server &set_default_headers(Headers headers);
  1959. Server &
  1960. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1961. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1962. Server &set_keep_alive_max_count(size_t count);
  1963. Server &set_keep_alive_timeout(time_t sec);
  1964. template <class Rep, class Period>
  1965. Server &
  1966. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1967. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1968. template <class Rep, class Period>
  1969. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1970. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1971. template <class Rep, class Period>
  1972. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1973. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1974. template <class Rep, class Period>
  1975. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1976. Server &set_payload_max_length(size_t length);
  1977. Server &set_compress(bool on);
  1978. Server &set_static_file_compression(bool on);
  1979. Server &set_static_file_compression_min_length(size_t length);
  1980. Server &set_static_file_compression_max_length(size_t length);
  1981. Server &set_websocket_ping_interval(time_t sec);
  1982. template <class Rep, class Period>
  1983. Server &set_websocket_ping_interval(
  1984. const std::chrono::duration<Rep, Period> &duration);
  1985. Server &set_websocket_max_missed_pongs(int count);
  1986. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1987. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1988. bool listen_after_bind();
  1989. bool listen(const std::string &host, int port, int socket_flags = 0);
  1990. bool is_running() const;
  1991. void wait_until_ready() const;
  1992. void stop() noexcept;
  1993. void decommission();
  1994. std::function<TaskQueue *(void)> new_task_queue;
  1995. protected:
  1996. bool process_request(Stream &strm, const std::string &remote_addr,
  1997. int remote_port, const std::string &local_addr,
  1998. int local_port, bool close_connection,
  1999. bool &connection_closed,
  2000. const std::function<void(Request &)> &setup_request,
  2001. bool *websocket_upgraded = nullptr);
  2002. // Runs the per-connection serving loop and stops an exception thrown by a
  2003. // user callback from escaping the worker thread.
  2004. //
  2005. // process_request() wraps only routing() and the hooks before a WebSocket
  2006. // upgrade in a try/catch. Content providers, the post-routing, error,
  2007. // logging and expect-100 handlers and WebSocket handlers all run outside
  2008. // it, and the task queue calls the job without a catch, so an exception
  2009. // from any of those would terminate the process.
  2010. //
  2011. // No 500 is possible here: by the time a content provider runs, the status
  2012. // line and headers are already on the wire. Report it through the error
  2013. // logger and drop the connection, which is what the peer observes either
  2014. // way. Other connections are unaffected.
  2015. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2016. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2017. return serve();
  2018. #else
  2019. try {
  2020. return serve();
  2021. } catch (...) {
  2022. // The error logger is a user callback too, so it must not be able to
  2023. // throw the guard back open.
  2024. try {
  2025. output_error_log(Error::UserCallbackException, nullptr);
  2026. } catch (...) {}
  2027. return false;
  2028. }
  2029. #endif
  2030. }
  2031. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2032. std::vector<std::string> trusted_proxies_;
  2033. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2034. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2035. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2036. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2037. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2038. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2039. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2040. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2041. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2042. bool compress_ = true;
  2043. bool static_file_compression_ = false;
  2044. size_t static_file_compression_min_length_ =
  2045. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2046. size_t static_file_compression_max_length_ =
  2047. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2048. time_t websocket_ping_interval_sec_ =
  2049. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2050. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2051. private:
  2052. using Handlers =
  2053. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2054. using HandlersForContentReader =
  2055. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2056. HandlerWithContentReader>>;
  2057. // Both handler tables for one custom method live in a single entry, so that
  2058. // routing() needs only one map lookup per request to reach either of them.
  2059. struct CustomHandlerEntry {
  2060. Handlers handlers;
  2061. HandlersForContentReader handlers_for_content_reader;
  2062. };
  2063. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2064. static std::unique_ptr<detail::MatcherBase>
  2065. make_matcher(const std::string &pattern);
  2066. static const std::set<std::string> &builtin_methods();
  2067. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2068. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2069. template <typename H>
  2070. Server &add_handler(
  2071. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2072. const std::string &pattern, H handler) {
  2073. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2074. return *this;
  2075. }
  2076. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2077. Server &set_error_handler_core(Handler handler, std::false_type);
  2078. socket_t create_server_socket(const std::string &host, int port,
  2079. int socket_flags,
  2080. SocketOptions socket_options) const;
  2081. int bind_internal(const std::string &host, int port, int socket_flags);
  2082. bool listen_internal();
  2083. bool routing(Request &req, Response &res, Stream &strm,
  2084. bool skip_pre_routing);
  2085. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2086. bool handle_exception(Request &req, Response &res);
  2087. #endif
  2088. bool handle_file_request(Request &req, Response &res);
  2089. bool check_if_not_modified(const Request &req, Response &res,
  2090. const std::string &etag, time_t mtime) const;
  2091. bool check_if_range(Request &req, const std::string &etag,
  2092. time_t mtime) const;
  2093. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2094. Stream &strm);
  2095. bool dispatch_request_for_content_reader(
  2096. Request &req, Response &res, ContentReader content_reader,
  2097. const HandlersForContentReader &handlers) const;
  2098. bool parse_request_line(const char *s, Request &req) const;
  2099. detail::EncodingType static_file_encoding(const Request &req,
  2100. const Response &res,
  2101. const std::string &content_type,
  2102. size_t length) const;
  2103. bool apply_static_file_compression(const Request &req, Response &res) const;
  2104. void apply_ranges(const Request &req, Response &res,
  2105. std::string &content_type, std::string &boundary) const;
  2106. bool write_response(Stream &strm, bool close_connection, Request &req,
  2107. Response &res);
  2108. bool write_response_with_content(Stream &strm, bool close_connection,
  2109. const Request &req, Response &res);
  2110. bool write_response_core(Stream &strm, bool close_connection,
  2111. const Request &req, Response &res,
  2112. bool need_apply_ranges);
  2113. bool write_content_with_provider(Stream &strm, const Request &req,
  2114. Response &res, const std::string &boundary,
  2115. const std::string &content_type);
  2116. bool read_content(Stream &strm, Request &req, Response &res);
  2117. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2118. Response &res,
  2119. ContentReceiver receiver,
  2120. FormDataHeader multipart_header,
  2121. ContentReceiver multipart_receiver);
  2122. bool read_content_core(Stream &strm, Request &req, Response &res,
  2123. ContentReceiver receiver,
  2124. FormDataHeader multipart_header,
  2125. ContentReceiver multipart_receiver) const;
  2126. virtual bool process_and_close_socket(socket_t sock);
  2127. void output_log(const Request &req, const Response &res) const;
  2128. void output_pre_compression_log(const Request &req,
  2129. const Response &res) const;
  2130. void output_error_log(const Error &err, const Request *req) const;
  2131. std::atomic<bool> is_running_{false};
  2132. std::atomic<bool> is_decommissioned{false};
  2133. // Set when CustomRoute() refuses a registration. Written before listen(),
  2134. // read by is_valid() on the same thread, so it needs no synchronization.
  2135. bool has_invalid_registration_ = false;
  2136. struct MountPointEntry {
  2137. std::string mount_point;
  2138. std::string base_dir;
  2139. std::string resolved_base_dir;
  2140. Headers headers;
  2141. };
  2142. std::vector<MountPointEntry> base_dirs_;
  2143. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2144. std::string default_file_mimetype_ = "application/octet-stream";
  2145. Handler file_request_handler_;
  2146. Handlers get_handlers_;
  2147. Handlers post_handlers_;
  2148. HandlersForContentReader post_handlers_for_content_reader_;
  2149. Handlers put_handlers_;
  2150. HandlersForContentReader put_handlers_for_content_reader_;
  2151. Handlers patch_handlers_;
  2152. HandlersForContentReader patch_handlers_for_content_reader_;
  2153. Handlers delete_handlers_;
  2154. HandlersForContentReader delete_handlers_for_content_reader_;
  2155. Handlers options_handlers_;
  2156. CustomHandlers custom_handlers_;
  2157. struct WebSocketHandlerEntry {
  2158. std::unique_ptr<detail::MatcherBase> matcher;
  2159. WebSocketHandler handler;
  2160. SubProtocolSelector sub_protocol_selector;
  2161. };
  2162. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2163. WebSocketHandlers websocket_handlers_;
  2164. HandlerWithResponse error_handler_;
  2165. ExceptionHandler exception_handler_;
  2166. HandlerWithResponse pre_routing_handler_;
  2167. Handler post_routing_handler_;
  2168. HandlerWithResponse pre_request_handler_;
  2169. Expect100ContinueHandler expect_100_continue_handler_;
  2170. StartHandler start_handler_;
  2171. mutable std::mutex logger_mutex_;
  2172. Logger logger_;
  2173. Logger pre_compression_logger_;
  2174. ErrorLogger error_logger_;
  2175. int address_family_ = AF_UNSPEC;
  2176. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2177. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2178. SocketOptions socket_options_ = default_socket_options;
  2179. Headers default_headers_;
  2180. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2181. detail::write_headers;
  2182. };
  2183. class Result {
  2184. public:
  2185. Result() = default;
  2186. Result(std::unique_ptr<Response> &&res, Error err,
  2187. Headers &&request_headers = Headers{})
  2188. : res_(std::move(res)), err_(err),
  2189. request_headers_(std::move(request_headers)) {}
  2190. // Response
  2191. operator bool() const { return res_ != nullptr; }
  2192. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2193. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2194. const Response &value() const { return *res_; }
  2195. Response &value() { return *res_; }
  2196. const Response &operator*() const { return *res_; }
  2197. Response &operator*() { return *res_; }
  2198. const Response *operator->() const { return res_.get(); }
  2199. Response *operator->() { return res_.get(); }
  2200. // Error
  2201. Error error() const { return err_; }
  2202. // Request Headers
  2203. bool has_request_header(const std::string &key) const;
  2204. std::string get_request_header_value(const std::string &key,
  2205. const char *def = "",
  2206. size_t id = 0) const;
  2207. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2208. size_t id = 0) const;
  2209. size_t get_request_header_value_count(const std::string &key) const;
  2210. private:
  2211. std::unique_ptr<Response> res_;
  2212. Error err_ = Error::Unknown;
  2213. Headers request_headers_;
  2214. #ifdef CPPHTTPLIB_SSL_ENABLED
  2215. public:
  2216. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2217. int ssl_error)
  2218. : res_(std::move(res)), err_(err),
  2219. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2220. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2221. int ssl_error, uint64_t ssl_backend_error)
  2222. : res_(std::move(res)), err_(err),
  2223. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2224. ssl_backend_error_(ssl_backend_error) {}
  2225. int ssl_error() const { return ssl_error_; }
  2226. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2227. private:
  2228. int ssl_error_ = 0;
  2229. uint64_t ssl_backend_error_ = 0;
  2230. #endif
  2231. };
  2232. struct ClientConnection {
  2233. socket_t sock = INVALID_SOCKET;
  2234. bool is_open() const { return sock != INVALID_SOCKET; }
  2235. ClientConnection() = default;
  2236. ~ClientConnection();
  2237. ClientConnection(const ClientConnection &) = delete;
  2238. ClientConnection &operator=(const ClientConnection &) = delete;
  2239. ClientConnection(ClientConnection &&other) noexcept
  2240. : sock(other.sock)
  2241. #ifdef CPPHTTPLIB_SSL_ENABLED
  2242. ,
  2243. session(other.session)
  2244. #endif
  2245. {
  2246. other.sock = INVALID_SOCKET;
  2247. #ifdef CPPHTTPLIB_SSL_ENABLED
  2248. other.session = nullptr;
  2249. #endif
  2250. }
  2251. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2252. if (this != &other) {
  2253. sock = other.sock;
  2254. other.sock = INVALID_SOCKET;
  2255. #ifdef CPPHTTPLIB_SSL_ENABLED
  2256. session = other.session;
  2257. other.session = nullptr;
  2258. #endif
  2259. }
  2260. return *this;
  2261. }
  2262. #ifdef CPPHTTPLIB_SSL_ENABLED
  2263. tls::session_t session = nullptr;
  2264. #endif
  2265. };
  2266. namespace detail {
  2267. struct ChunkedDecoder;
  2268. struct BodyReader {
  2269. Stream *stream = nullptr;
  2270. bool has_content_length = false;
  2271. size_t content_length = 0;
  2272. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2273. size_t bytes_read = 0;
  2274. bool chunked = false;
  2275. bool eof = false;
  2276. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2277. Error last_error = Error::Success;
  2278. ssize_t read(char *buf, size_t len);
  2279. bool has_error() const { return last_error != Error::Success; }
  2280. };
  2281. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2282. size_t len) {
  2283. (void)stream;
  2284. return br.read(buf, len);
  2285. }
  2286. class decompressor;
  2287. enum class NoProxyKind {
  2288. Wildcard, // "*"
  2289. HostnameSuffix, // "example.com" or ".example.com"
  2290. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2291. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2292. };
  2293. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2294. // Lets one CIDR matcher cover both families.
  2295. using IPBytes = std::array<uint8_t, 16>;
  2296. struct NoProxyEntry {
  2297. NoProxyKind kind = NoProxyKind::Wildcard;
  2298. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2299. IPBytes net{};
  2300. int prefix_bits = 0;
  2301. };
  2302. struct NormalizedTarget {
  2303. std::string hostname; // lowercase; brackets and trailing dot removed
  2304. bool is_ipv4 = false;
  2305. bool is_ipv6 = false;
  2306. IPBytes ip{};
  2307. };
  2308. } // namespace detail
  2309. class ClientImpl {
  2310. public:
  2311. explicit ClientImpl(const std::string &host);
  2312. explicit ClientImpl(const std::string &host, int port);
  2313. explicit ClientImpl(const std::string &host, int port,
  2314. const std::string &client_cert_path,
  2315. const std::string &client_key_path);
  2316. virtual ~ClientImpl();
  2317. virtual bool is_valid() const;
  2318. struct StreamHandle {
  2319. std::unique_ptr<Response> response;
  2320. Error error = Error::Success;
  2321. StreamHandle() = default;
  2322. StreamHandle(const StreamHandle &) = delete;
  2323. StreamHandle &operator=(const StreamHandle &) = delete;
  2324. StreamHandle(StreamHandle &&) = default;
  2325. StreamHandle &operator=(StreamHandle &&) = default;
  2326. ~StreamHandle() = default;
  2327. bool is_valid() const {
  2328. return response != nullptr && error == Error::Success;
  2329. }
  2330. ssize_t read(char *buf, size_t len);
  2331. void parse_trailers_if_needed();
  2332. Error get_read_error() const { return body_reader_.last_error; }
  2333. bool has_read_error() const { return body_reader_.has_error(); }
  2334. bool trailers_parsed_ = false;
  2335. private:
  2336. friend class ClientImpl;
  2337. friend class sse::SSEClient;
  2338. ssize_t read_with_decompression(char *buf, size_t len);
  2339. std::unique_ptr<ClientConnection> connection_;
  2340. std::unique_ptr<Stream> socket_stream_;
  2341. Stream *stream_ = nullptr;
  2342. detail::BodyReader body_reader_;
  2343. std::unique_ptr<detail::decompressor> decompressor_;
  2344. std::string decompress_buffer_;
  2345. size_t decompress_offset_ = 0;
  2346. size_t decompressed_bytes_read_ = 0;
  2347. };
  2348. // clang-format off
  2349. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2350. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2351. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2352. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2353. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2354. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2355. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2356. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2357. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2358. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2359. Result Head(const std::string &path);
  2360. Result Head(const std::string &path, const Headers &headers);
  2361. Result Post(const std::string &path);
  2362. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2363. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2364. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2365. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2366. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2367. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2368. Result Post(const std::string &path, const Params &params);
  2369. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2370. Result Post(const std::string &path, const Headers &headers);
  2371. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2372. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2373. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2374. 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);
  2375. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2376. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2377. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2378. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2379. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2380. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2381. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2382. Result Put(const std::string &path);
  2383. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2385. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2386. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2387. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2388. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2389. Result Put(const std::string &path, const Params &params);
  2390. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2391. Result Put(const std::string &path, const Headers &headers);
  2392. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2393. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2394. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2395. 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);
  2396. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2397. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2398. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2399. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2400. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2401. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2402. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2403. Result Patch(const std::string &path);
  2404. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2405. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2406. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2407. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2408. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2409. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2410. Result Patch(const std::string &path, const Params &params);
  2411. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2412. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2413. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2414. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2415. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2416. 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);
  2417. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2418. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2419. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2420. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2421. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2422. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2423. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2424. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2425. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2426. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2427. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2428. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2429. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2430. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2431. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2432. Result Options(const std::string &path);
  2433. Result Options(const std::string &path, const Headers &headers);
  2434. // clang-format on
  2435. // Streaming API: Open a stream for reading response body incrementally
  2436. // Socket ownership is transferred to StreamHandle for true streaming
  2437. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2438. StreamHandle open_stream(const std::string &method, const std::string &path,
  2439. const Params &params = {},
  2440. const Headers &headers = {},
  2441. const std::string &body = {},
  2442. const std::string &content_type = {});
  2443. bool send(Request &req, Response &res, Error &error);
  2444. Result send(const Request &req);
  2445. void stop();
  2446. std::string host() const;
  2447. int port() const;
  2448. size_t is_socket_open() const;
  2449. socket_t socket() const;
  2450. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2451. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2452. void
  2453. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2454. void
  2455. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2456. void set_default_headers(Headers headers);
  2457. void
  2458. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2459. void set_address_family(int family);
  2460. void set_tcp_nodelay(bool on);
  2461. void set_ipv6_v6only(bool on);
  2462. void set_socket_options(SocketOptions socket_options);
  2463. void set_connection_timeout(time_t sec, time_t usec = 0);
  2464. template <class Rep, class Period>
  2465. void
  2466. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2467. void set_read_timeout(time_t sec, time_t usec = 0);
  2468. template <class Rep, class Period>
  2469. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2470. void set_write_timeout(time_t sec, time_t usec = 0);
  2471. template <class Rep, class Period>
  2472. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2473. void set_max_timeout(time_t msec);
  2474. template <class Rep, class Period>
  2475. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2476. void set_basic_auth(const std::string &username, const std::string &password);
  2477. void set_bearer_token_auth(const std::string &token);
  2478. void set_keep_alive(bool on);
  2479. void set_follow_location(bool on);
  2480. void set_path_encode(bool on);
  2481. void set_compress(bool on);
  2482. void set_decompress(bool on);
  2483. void set_payload_max_length(size_t length);
  2484. void set_interface(const std::string &intf);
  2485. void set_proxy(const std::string &host, int port);
  2486. void set_proxy_basic_auth(const std::string &username,
  2487. const std::string &password);
  2488. void set_proxy_bearer_token_auth(const std::string &token);
  2489. void set_no_proxy(const std::vector<std::string> &patterns);
  2490. void set_logger(Logger logger);
  2491. void set_error_logger(ErrorLogger error_logger);
  2492. protected:
  2493. struct Socket {
  2494. socket_t sock = INVALID_SOCKET;
  2495. // For Mbed TLS compatibility: start_time for request timeout tracking
  2496. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2497. bool is_open() const { return sock != INVALID_SOCKET; }
  2498. #ifdef CPPHTTPLIB_SSL_ENABLED
  2499. tls::session_t ssl = nullptr;
  2500. #endif
  2501. };
  2502. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2503. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2504. virtual bool setup_proxy_connection(
  2505. Socket &socket,
  2506. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2507. Response &res, bool &success, Error &error);
  2508. bool is_proxy_enabled_for_host(const std::string &host) const;
  2509. // All of:
  2510. // shutdown_ssl
  2511. // shutdown_socket
  2512. // close_socket
  2513. // disconnect
  2514. // should ONLY be called when socket_mutex_ is locked, and only when
  2515. // no other thread is using the socket.
  2516. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2517. void shutdown_socket(Socket &socket) const;
  2518. void close_socket(Socket &socket);
  2519. void disconnect(bool gracefully);
  2520. // Under socket_mutex_: whether the connection kept alive can take another
  2521. // request. One the peer has closed, or one set up under TLS settings changed
  2522. // since, is closed instead.
  2523. bool socket_reusable();
  2524. // TLS settings apply as a connection is set up, so a change makes the
  2525. // connection kept alive unfit for the next request.
  2526. void tls_settings_changed() { tls_settings_version_++; }
  2527. std::string make_request_target(const Request &req) const;
  2528. bool process_request(Stream &strm, Request &req, Response &res,
  2529. bool close_connection, Error &error);
  2530. bool write_content_with_provider(Stream &strm, const Request &req,
  2531. Error &error) const;
  2532. void output_log(const Request &req, const Response &res) const;
  2533. void output_error_log(const Error &err, const Request *req) const;
  2534. // Socket endpoint information
  2535. const std::string host_;
  2536. const int port_;
  2537. // Current open socket
  2538. Socket socket_;
  2539. mutable std::mutex socket_mutex_;
  2540. std::recursive_mutex request_mutex_;
  2541. // How many send() calls are running on this client, guarded by
  2542. // request_mutex_
  2543. size_t send_depth_ = 0;
  2544. // These are all protected under socket_mutex
  2545. size_t socket_requests_in_flight_ = 0;
  2546. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2547. bool socket_should_be_closed_when_request_is_done_ = false;
  2548. size_t socket_tls_settings_version_ = 0;
  2549. // Set by stop() while a request is in flight. The request's reads poll it,
  2550. // because shutting the socket down does not wake a read on Windows.
  2551. std::atomic<bool> stop_requested_{false};
  2552. std::atomic<size_t> tls_settings_version_{0};
  2553. // Hostname to connection target map. The value is an IP literal or another
  2554. // hostname; only the connection target changes, never the identity.
  2555. std::map<std::string, std::string> addr_map_;
  2556. // Hostname to CONNECT target map, used only through a proxy.
  2557. std::map<std::string, std::string> tunnel_addr_map_;
  2558. // Default headers
  2559. Headers default_headers_;
  2560. // Header writer
  2561. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2562. detail::write_headers;
  2563. // Settings
  2564. std::string client_cert_path_;
  2565. std::string client_key_path_;
  2566. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2567. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2568. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2569. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2570. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2571. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2572. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2573. std::string basic_auth_username_;
  2574. std::string basic_auth_password_;
  2575. std::string bearer_token_auth_token_;
  2576. bool keep_alive_ = false;
  2577. bool follow_location_ = false;
  2578. bool path_encode_ = true;
  2579. int address_family_ = AF_UNSPEC;
  2580. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2581. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2582. SocketOptions socket_options_ = nullptr;
  2583. bool compress_ = false;
  2584. bool decompress_ = true;
  2585. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2586. bool has_payload_max_length_ = false;
  2587. std::string interface_;
  2588. std::string proxy_host_;
  2589. int proxy_port_ = -1;
  2590. std::string proxy_basic_auth_username_;
  2591. std::string proxy_basic_auth_password_;
  2592. std::string proxy_bearer_token_auth_token_;
  2593. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2594. mutable detail::NormalizedTarget host_normalized_;
  2595. mutable bool host_normalized_valid_ = false;
  2596. mutable std::mutex logger_mutex_;
  2597. Logger logger_;
  2598. ErrorLogger error_logger_;
  2599. private:
  2600. bool send_(Request &req, Response &res, Error &error);
  2601. Result send_(Request &&req);
  2602. socket_t create_client_socket(Error &error) const;
  2603. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2604. bool skip_100_continue = true) const;
  2605. bool write_request(Stream &strm, Request &req, bool close_connection,
  2606. Error &error, bool skip_body, bool &rejected_locally);
  2607. bool write_request_body(Stream &strm, Request &req, Error &error);
  2608. void prepare_default_headers(Request &r, bool for_stream,
  2609. const std::string &ct);
  2610. bool redirect(Request &req, Response &res, Error &error);
  2611. bool create_redirect_client(const std::string &scheme,
  2612. const std::string &host, int port, Request &req,
  2613. Response &res, const std::string &path,
  2614. const std::string &location, Error &error);
  2615. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2616. bool handle_request(Stream &strm, Request &req, Response &res,
  2617. bool close_connection, Error &error);
  2618. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2619. Request &req, const char *body, size_t content_length,
  2620. ContentProvider content_provider,
  2621. ContentProviderWithoutLength content_provider_without_length,
  2622. const std::string &content_type, ContentReceiver content_receiver,
  2623. Error &error);
  2624. Result send_with_content_provider_and_receiver(
  2625. const std::string &method, const std::string &path,
  2626. const Headers &headers, const char *body, size_t content_length,
  2627. ContentProvider content_provider,
  2628. ContentProviderWithoutLength content_provider_without_length,
  2629. const std::string &content_type, ContentReceiver content_receiver,
  2630. UploadProgress progress);
  2631. ContentProviderWithoutLength get_multipart_content_provider(
  2632. const std::string &boundary, const UploadFormDataItems &items,
  2633. const FormDataProviderItems &provider_items) const;
  2634. virtual bool
  2635. process_socket(const Socket &socket,
  2636. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2637. std::function<bool(Stream &strm)> callback);
  2638. virtual bool is_ssl() const;
  2639. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2640. StreamHandle open_stream_(Request &req);
  2641. void add_credential_headers(Request &req);
  2642. std::string proxy_target_prefix() const;
  2643. #ifdef CPPHTTPLIB_SSL_ENABLED
  2644. public:
  2645. void set_digest_auth(const std::string &username,
  2646. const std::string &password);
  2647. void set_proxy_digest_auth(const std::string &username,
  2648. const std::string &password);
  2649. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2650. const std::string &ca_cert_dir_path = std::string());
  2651. void enable_server_certificate_verification(bool enabled);
  2652. void enable_server_hostname_verification(bool enabled);
  2653. void enable_system_ca(bool enabled);
  2654. protected:
  2655. std::string digest_auth_username_;
  2656. std::string digest_auth_password_;
  2657. std::string proxy_digest_auth_username_;
  2658. std::string proxy_digest_auth_password_;
  2659. std::string ca_cert_file_path_;
  2660. std::string ca_cert_dir_path_;
  2661. bool server_certificate_verification_ = true;
  2662. bool server_hostname_verification_ = true;
  2663. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2664. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2665. int last_ssl_error_ = 0;
  2666. uint64_t last_backend_error_ = 0;
  2667. #endif
  2668. };
  2669. namespace detail {
  2670. // Stands in for a client that Client could not make from its arguments, so a
  2671. // request fails rather than going through a null pointer.
  2672. class InvalidClientImpl final : public ClientImpl {
  2673. public:
  2674. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2675. bool is_valid() const override { return false; }
  2676. private:
  2677. bool create_and_connect_socket(Socket &, Error &error) override {
  2678. error = Error::Connection;
  2679. return false;
  2680. }
  2681. };
  2682. } // namespace detail
  2683. class Client {
  2684. public:
  2685. // Universal interface
  2686. explicit Client(const std::string &scheme_host_port);
  2687. explicit Client(const std::string &scheme_host_port,
  2688. const std::string &client_cert_path,
  2689. const std::string &client_key_path);
  2690. // HTTP only interface
  2691. explicit Client(const std::string &host, int port);
  2692. explicit Client(const std::string &host, int port,
  2693. const std::string &client_cert_path,
  2694. const std::string &client_key_path);
  2695. Client(Client &&) = default;
  2696. Client &operator=(Client &&) = default;
  2697. ~Client();
  2698. bool is_valid() const;
  2699. // clang-format off
  2700. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2701. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2702. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2703. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2704. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2705. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2706. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2707. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2708. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2709. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2710. Result Head(const std::string &path);
  2711. Result Head(const std::string &path, const Headers &headers);
  2712. Result Post(const std::string &path);
  2713. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2714. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2715. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2716. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2717. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2718. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2719. Result Post(const std::string &path, const Params &params);
  2720. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2721. Result Post(const std::string &path, const Headers &headers);
  2722. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2723. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2724. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2725. 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);
  2726. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2727. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2728. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2729. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2730. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2731. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2732. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2733. Result Put(const std::string &path);
  2734. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2735. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2736. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2737. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2738. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2739. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2740. Result Put(const std::string &path, const Params &params);
  2741. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2742. Result Put(const std::string &path, const Headers &headers);
  2743. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2744. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2745. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2746. 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);
  2747. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2748. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2749. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2750. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2751. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2752. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2753. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2754. Result Patch(const std::string &path);
  2755. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2756. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2757. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2758. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2759. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2760. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2761. Result Patch(const std::string &path, const Params &params);
  2762. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2763. Result Patch(const std::string &path, const Headers &headers);
  2764. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2765. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2766. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2767. 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);
  2768. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2769. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2770. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2771. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2772. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2773. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2774. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2775. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2776. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2777. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2778. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2779. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2780. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2781. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2782. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2783. Result Options(const std::string &path);
  2784. Result Options(const std::string &path, const Headers &headers);
  2785. // clang-format on
  2786. // Streaming API: Open a stream for reading response body incrementally
  2787. // Socket ownership is transferred to StreamHandle for true streaming
  2788. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2789. ClientImpl::StreamHandle open_stream(const std::string &method,
  2790. const std::string &path,
  2791. const Params &params = {},
  2792. const Headers &headers = {},
  2793. const std::string &body = {},
  2794. const std::string &content_type = {});
  2795. bool send(Request &req, Response &res, Error &error);
  2796. Result send(const Request &req);
  2797. void stop();
  2798. std::string host() const;
  2799. int port() const;
  2800. size_t is_socket_open() const;
  2801. socket_t socket() const;
  2802. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2803. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2804. void
  2805. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2806. void
  2807. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2808. void set_default_headers(Headers headers);
  2809. void
  2810. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2811. void set_address_family(int family);
  2812. void set_tcp_nodelay(bool on);
  2813. void set_socket_options(SocketOptions socket_options);
  2814. void set_connection_timeout(time_t sec, time_t usec = 0);
  2815. template <class Rep, class Period>
  2816. void
  2817. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2818. void set_read_timeout(time_t sec, time_t usec = 0);
  2819. template <class Rep, class Period>
  2820. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2821. void set_write_timeout(time_t sec, time_t usec = 0);
  2822. template <class Rep, class Period>
  2823. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2824. void set_max_timeout(time_t msec);
  2825. template <class Rep, class Period>
  2826. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2827. void set_basic_auth(const std::string &username, const std::string &password);
  2828. void set_bearer_token_auth(const std::string &token);
  2829. void set_keep_alive(bool on);
  2830. void set_follow_location(bool on);
  2831. void set_path_encode(bool on);
  2832. void set_compress(bool on);
  2833. void set_decompress(bool on);
  2834. void set_payload_max_length(size_t length);
  2835. void set_interface(const std::string &intf);
  2836. void set_proxy(const std::string &host, int port);
  2837. void set_proxy_basic_auth(const std::string &username,
  2838. const std::string &password);
  2839. void set_proxy_bearer_token_auth(const std::string &token);
  2840. void set_no_proxy(const std::vector<std::string> &patterns);
  2841. void set_logger(Logger logger);
  2842. void set_error_logger(ErrorLogger error_logger);
  2843. private:
  2844. std::unique_ptr<ClientImpl> cli_;
  2845. #ifdef CPPHTTPLIB_SSL_ENABLED
  2846. public:
  2847. void set_digest_auth(const std::string &username,
  2848. const std::string &password);
  2849. void set_proxy_digest_auth(const std::string &username,
  2850. const std::string &password);
  2851. void enable_server_certificate_verification(bool enabled);
  2852. void enable_server_hostname_verification(bool enabled);
  2853. void enable_system_ca(bool enabled);
  2854. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2855. const std::string &ca_cert_dir_path = std::string());
  2856. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2857. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2858. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2859. void set_session_verifier(
  2860. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2861. tls::ctx_t tls_context() const;
  2862. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2863. void enable_windows_certificate_verification(bool enabled);
  2864. #endif
  2865. private:
  2866. bool is_ssl_ = false;
  2867. #endif
  2868. };
  2869. #ifdef CPPHTTPLIB_SSL_ENABLED
  2870. class SSLServer : public Server {
  2871. public:
  2872. SSLServer(const char *cert_path, const char *private_key_path,
  2873. const char *client_ca_cert_file_path = nullptr,
  2874. const char *client_ca_cert_dir_path = nullptr,
  2875. const char *private_key_password = nullptr);
  2876. struct PemMemory {
  2877. const char *cert_pem;
  2878. size_t cert_pem_len;
  2879. const char *key_pem;
  2880. size_t key_pem_len;
  2881. const char *client_ca_pem;
  2882. size_t client_ca_pem_len;
  2883. const char *private_key_password;
  2884. };
  2885. explicit SSLServer(const PemMemory &pem);
  2886. // The callback receives the ctx_t handle which can be cast to the
  2887. // appropriate backend type (SSL_CTX* for OpenSSL,
  2888. // tls::impl::MbedTlsContext* for Mbed TLS)
  2889. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2890. ~SSLServer() override;
  2891. bool is_valid() const override;
  2892. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2893. const char *client_ca_pem = nullptr,
  2894. const char *password = nullptr);
  2895. tls::ctx_t tls_context() const { return ctx_; }
  2896. int ssl_last_error() const { return last_ssl_error_; }
  2897. private:
  2898. bool process_and_close_socket(socket_t sock) override;
  2899. tls::ctx_t ctx_ = nullptr;
  2900. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2901. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2902. // bounds, and new ones wait while it is pending so that they cannot keep it
  2903. // waiting.
  2904. std::mutex ctx_mutex_;
  2905. std::condition_variable ctx_cv_;
  2906. size_t handshakes_in_progress_ = 0;
  2907. size_t updates_pending_ = 0;
  2908. int last_ssl_error_ = 0;
  2909. };
  2910. class SSLClient final : public ClientImpl {
  2911. public:
  2912. explicit SSLClient(const std::string &host);
  2913. explicit SSLClient(const std::string &host, int port);
  2914. explicit SSLClient(const std::string &host, int port,
  2915. const std::string &client_cert_path,
  2916. const std::string &client_key_path,
  2917. const std::string &private_key_password = std::string());
  2918. struct PemMemory {
  2919. const char *cert_pem;
  2920. size_t cert_pem_len;
  2921. const char *key_pem;
  2922. size_t key_pem_len;
  2923. const char *private_key_password;
  2924. };
  2925. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2926. ~SSLClient() override;
  2927. bool is_valid() const override;
  2928. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2929. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2930. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2931. // Post-handshake session verifier (backend-independent)
  2932. void set_session_verifier(
  2933. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2934. tls::ctx_t tls_context() const { return ctx_; }
  2935. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2936. void enable_windows_certificate_verification(bool enabled);
  2937. #endif
  2938. private:
  2939. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2940. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2941. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2942. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2943. bool
  2944. process_socket(const Socket &socket,
  2945. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2946. std::function<bool(Stream &strm)> callback) override;
  2947. bool is_ssl() const override;
  2948. bool setup_proxy_connection(
  2949. Socket &socket,
  2950. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2951. Response &res, bool &success, Error &error) override;
  2952. bool connect_with_proxy(
  2953. Socket &sock,
  2954. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2955. Response &res, bool &success, Error &error);
  2956. bool initialize_ssl(Socket &socket, Error &error);
  2957. void init_ctx();
  2958. void reset_ctx_on_error();
  2959. bool load_certs();
  2960. tls::ctx_t ctx_ = nullptr;
  2961. std::mutex ctx_mutex_;
  2962. std::once_flag initialize_cert_;
  2963. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2964. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2965. bool ca_cert_store_set_ = false;
  2966. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2967. // no certificate, so that a CA that failed to come through fails
  2968. // verification instead of letting the system CAs in.
  2969. bool custom_ca_loaded_ = false;
  2970. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2971. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2972. // set_server_certificate_verifier() installed there.
  2973. tls::VerifyCallback server_certificate_verifier_;
  2974. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2975. bool enable_windows_cert_verification_ = true;
  2976. #endif
  2977. friend class ClientImpl;
  2978. };
  2979. #endif // CPPHTTPLIB_SSL_ENABLED
  2980. namespace detail {
  2981. template <typename T, typename U>
  2982. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2983. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2984. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2985. duration - std::chrono::seconds(sec))
  2986. .count();
  2987. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2988. }
  2989. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2990. return N - 1;
  2991. }
  2992. inline bool is_numeric(const std::string &str) {
  2993. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2994. }
  2995. // std::ranges::next(first, n, last) for C++11
  2996. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2997. for (; n > 0 && first != last; --n) {
  2998. ++first;
  2999. }
  3000. return first;
  3001. }
  3002. inline size_t get_header_value_u64(const Headers &headers,
  3003. const std::string &key, size_t def,
  3004. size_t id, bool &is_invalid_value) {
  3005. is_invalid_value = false;
  3006. auto rng = headers.equal_range(key);
  3007. auto it = bounded_next(rng.first, id, rng.second);
  3008. if (it != rng.second) {
  3009. if (is_numeric(it->second)) {
  3010. // Parse at size_t width so an out-of-range Content-Length is reported
  3011. // rather than silently saturated/truncated (a value above 2^32 would
  3012. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  3013. // and return SIZE_MAX so the existing oversized-value guards reject it.
  3014. size_t val = 0;
  3015. const auto &s = it->second;
  3016. auto r = from_chars(s.data(), s.data() + s.size(), val);
  3017. if (r.ec == std::errc::result_out_of_range) {
  3018. is_invalid_value = true;
  3019. return (std::numeric_limits<size_t>::max)();
  3020. }
  3021. return val;
  3022. } else {
  3023. is_invalid_value = true;
  3024. }
  3025. }
  3026. return def;
  3027. }
  3028. inline size_t get_header_value_u64(const Headers &headers,
  3029. const std::string &key, size_t def,
  3030. size_t id) {
  3031. auto dummy = false;
  3032. return get_header_value_u64(headers, key, def, id, dummy);
  3033. }
  3034. } // namespace detail
  3035. template <class Rep, class Period>
  3036. inline Server &
  3037. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3038. detail::duration_to_sec_and_usec(
  3039. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3040. return *this;
  3041. }
  3042. template <class Rep, class Period>
  3043. inline Server &
  3044. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3045. detail::duration_to_sec_and_usec(
  3046. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3047. return *this;
  3048. }
  3049. template <class Rep, class Period>
  3050. inline Server &
  3051. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3052. detail::duration_to_sec_and_usec(
  3053. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3054. return *this;
  3055. }
  3056. template <class Rep, class Period>
  3057. inline void ClientImpl::set_connection_timeout(
  3058. const std::chrono::duration<Rep, Period> &duration) {
  3059. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3060. set_connection_timeout(sec, usec);
  3061. });
  3062. }
  3063. template <class Rep, class Period>
  3064. inline void ClientImpl::set_read_timeout(
  3065. const std::chrono::duration<Rep, Period> &duration) {
  3066. detail::duration_to_sec_and_usec(
  3067. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3068. }
  3069. template <class Rep, class Period>
  3070. inline void ClientImpl::set_write_timeout(
  3071. const std::chrono::duration<Rep, Period> &duration) {
  3072. detail::duration_to_sec_and_usec(
  3073. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3074. }
  3075. template <class Rep, class Period>
  3076. inline void ClientImpl::set_max_timeout(
  3077. const std::chrono::duration<Rep, Period> &duration) {
  3078. auto msec =
  3079. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3080. set_max_timeout(static_cast<time_t>(msec));
  3081. }
  3082. template <class Rep, class Period>
  3083. inline void Client::set_connection_timeout(
  3084. const std::chrono::duration<Rep, Period> &duration) {
  3085. cli_->set_connection_timeout(duration);
  3086. }
  3087. template <class Rep, class Period>
  3088. inline void
  3089. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3090. cli_->set_read_timeout(duration);
  3091. }
  3092. template <class Rep, class Period>
  3093. inline void
  3094. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3095. cli_->set_write_timeout(duration);
  3096. }
  3097. inline void Client::set_max_timeout(time_t msec) {
  3098. cli_->set_max_timeout(msec);
  3099. }
  3100. template <class Rep, class Period>
  3101. inline void
  3102. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3103. cli_->set_max_timeout(duration);
  3104. }
  3105. /*
  3106. * Forward declarations and types that will be part of the .h file if split into
  3107. * .h + .cc.
  3108. */
  3109. std::string hosted_at(const std::string &hostname);
  3110. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3111. // JavaScript-style URL encoding/decoding functions
  3112. std::string encode_uri_component(const std::string &value);
  3113. std::string encode_uri(const std::string &value);
  3114. std::string decode_uri_component(const std::string &value);
  3115. std::string decode_uri(const std::string &value);
  3116. // RFC 3986 compliant URL component encoding/decoding functions
  3117. std::string encode_path_component(const std::string &component);
  3118. std::string decode_path_component(const std::string &component);
  3119. std::string encode_query_component(const std::string &component,
  3120. bool space_as_plus = true);
  3121. std::string decode_query_component(const std::string &component,
  3122. bool plus_as_space = true);
  3123. std::string sanitize_filename(const std::string &filename);
  3124. std::string append_query_params(const std::string &path, const Params &params);
  3125. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3126. std::pair<std::string, std::string>
  3127. make_basic_authentication_header(const std::string &username,
  3128. const std::string &password,
  3129. bool is_proxy = false);
  3130. namespace detail {
  3131. #if defined(_WIN32)
  3132. inline std::wstring u8string_to_wstring(const char *s) {
  3133. if (!s) { return std::wstring(); }
  3134. auto len = static_cast<int>(strlen(s));
  3135. if (!len) { return std::wstring(); }
  3136. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3137. if (!wlen) { return std::wstring(); }
  3138. std::wstring ws;
  3139. ws.resize(wlen);
  3140. wlen = ::MultiByteToWideChar(
  3141. CP_UTF8, 0, s, len,
  3142. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3143. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3144. return ws;
  3145. }
  3146. #endif
  3147. struct FileStat {
  3148. FileStat(const std::string &path);
  3149. bool is_file() const;
  3150. bool is_dir() const;
  3151. time_t mtime() const;
  3152. size_t size() const;
  3153. private:
  3154. #if defined(_WIN32)
  3155. struct _stat st_;
  3156. #else
  3157. struct stat st_;
  3158. #endif
  3159. int ret_ = -1;
  3160. };
  3161. std::string make_host_and_port_string(const std::string &host, int port,
  3162. bool is_ssl);
  3163. template <typename T>
  3164. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3165. Error &error);
  3166. bool write_data(Stream &strm, const char *d, size_t l);
  3167. std::string trim_copy(const std::string &s);
  3168. void divide(
  3169. const char *data, std::size_t size, char d,
  3170. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3171. fn);
  3172. void divide(
  3173. const std::string &str, char d,
  3174. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3175. fn);
  3176. void split(const char *b, const char *e, char d,
  3177. std::function<void(const char *, const char *)> fn);
  3178. void split(const char *b, const char *e, char d, size_t m,
  3179. std::function<void(const char *, const char *)> fn);
  3180. bool split_find(const char *b, const char *e, char d,
  3181. std::function<bool(const char *, const char *)> fn);
  3182. bool has_header_token(const Headers &headers, const std::string &key,
  3183. const std::string &token);
  3184. std::string websocket_accept_key(const std::string &client_key);
  3185. bool is_websocket_upgrade(const Request &req);
  3186. bool process_client_socket(
  3187. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3188. time_t write_timeout_sec, time_t write_timeout_usec,
  3189. time_t max_timeout_msec,
  3190. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3191. std::function<bool(Stream &)> callback);
  3192. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3193. int port, int address_family, bool tcp_nodelay,
  3194. bool ipv6_v6only, SocketOptions socket_options,
  3195. time_t connection_timeout_sec,
  3196. time_t connection_timeout_usec,
  3197. time_t read_timeout_sec, time_t read_timeout_usec,
  3198. time_t write_timeout_sec,
  3199. time_t write_timeout_usec,
  3200. const std::string &intf, Error &error);
  3201. const char *get_header_value(const Headers &headers, const std::string &key,
  3202. const char *def, size_t id);
  3203. std::string get_combined_header_value(const Headers &headers,
  3204. const std::string &key);
  3205. std::string params_to_query_str(const Params &params);
  3206. void parse_query_text(const char *data, std::size_t size, Params &params);
  3207. void parse_query_text(const std::string &s, Params &params);
  3208. bool parse_multipart_boundary(const std::string &content_type,
  3209. std::string &boundary);
  3210. bool parse_range_header(const std::string &s, Ranges &ranges);
  3211. bool parse_accept_header(const std::string &s,
  3212. std::vector<std::string> &content_types);
  3213. void parse_disposition_params(const std::string &s, Params &params);
  3214. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3215. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3216. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3217. EncodingType encoding_type(const Request &req, const Response &res,
  3218. const std::string &content_type);
  3219. EncodingType encoding_type(const Request &req, const Response &res);
  3220. class BufferStream final : public Stream {
  3221. public:
  3222. BufferStream() = default;
  3223. ~BufferStream() override = default;
  3224. bool is_readable() const override;
  3225. bool wait_readable() const override;
  3226. bool wait_writable() const override;
  3227. ssize_t read(char *ptr, size_t size) override;
  3228. ssize_t write(const char *ptr, size_t size) override;
  3229. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3230. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3231. socket_t socket() const override;
  3232. time_t duration() const override;
  3233. const std::string &get_buffer() const;
  3234. private:
  3235. std::string buffer;
  3236. size_t position = 0;
  3237. };
  3238. class compressor {
  3239. public:
  3240. virtual ~compressor() = default;
  3241. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3242. virtual bool compress(const char *data, size_t data_length, bool last,
  3243. Callback callback) = 0;
  3244. };
  3245. class decompressor {
  3246. public:
  3247. virtual ~decompressor() = default;
  3248. virtual bool is_valid() const = 0;
  3249. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3250. virtual bool decompress(const char *data, size_t data_length,
  3251. Callback callback) = 0;
  3252. };
  3253. class nocompressor final : public compressor {
  3254. public:
  3255. ~nocompressor() override = default;
  3256. bool compress(const char *data, size_t data_length, bool /*last*/,
  3257. Callback callback) override;
  3258. };
  3259. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3260. class gzip_compressor final : public compressor {
  3261. public:
  3262. gzip_compressor();
  3263. ~gzip_compressor() override;
  3264. bool compress(const char *data, size_t data_length, bool last,
  3265. Callback callback) override;
  3266. private:
  3267. bool is_valid_ = false;
  3268. z_stream strm_;
  3269. };
  3270. class gzip_decompressor final : public decompressor {
  3271. public:
  3272. gzip_decompressor();
  3273. ~gzip_decompressor() override;
  3274. bool is_valid() const override;
  3275. bool decompress(const char *data, size_t data_length,
  3276. Callback callback) override;
  3277. private:
  3278. bool is_valid_ = false;
  3279. z_stream strm_;
  3280. };
  3281. #endif
  3282. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3283. class brotli_compressor final : public compressor {
  3284. public:
  3285. brotli_compressor();
  3286. ~brotli_compressor();
  3287. bool compress(const char *data, size_t data_length, bool last,
  3288. Callback callback) override;
  3289. private:
  3290. BrotliEncoderState *state_ = nullptr;
  3291. };
  3292. class brotli_decompressor final : public decompressor {
  3293. public:
  3294. brotli_decompressor();
  3295. ~brotli_decompressor();
  3296. bool is_valid() const override;
  3297. bool decompress(const char *data, size_t data_length,
  3298. Callback callback) override;
  3299. private:
  3300. BrotliDecoderResult decoder_r;
  3301. BrotliDecoderState *decoder_s = nullptr;
  3302. };
  3303. #endif
  3304. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3305. class zstd_compressor : public compressor {
  3306. public:
  3307. zstd_compressor();
  3308. ~zstd_compressor();
  3309. bool compress(const char *data, size_t data_length, bool last,
  3310. Callback callback) override;
  3311. private:
  3312. ZSTD_CCtx *ctx_ = nullptr;
  3313. };
  3314. class zstd_decompressor : public decompressor {
  3315. public:
  3316. zstd_decompressor();
  3317. ~zstd_decompressor();
  3318. bool is_valid() const override;
  3319. bool decompress(const char *data, size_t data_length,
  3320. Callback callback) override;
  3321. private:
  3322. ZSTD_DCtx *ctx_ = nullptr;
  3323. };
  3324. #endif
  3325. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3326. // to store data. The call can set memory on stack for performance.
  3327. class stream_line_reader {
  3328. public:
  3329. stream_line_reader(Stream &strm, char *fixed_buffer,
  3330. size_t fixed_buffer_size);
  3331. const char *ptr() const;
  3332. size_t size() const;
  3333. bool end_with_crlf() const;
  3334. bool getline();
  3335. private:
  3336. void append(char c);
  3337. void append(const char *data, size_t size);
  3338. Stream &strm_;
  3339. char *fixed_buffer_;
  3340. const size_t fixed_buffer_size_;
  3341. size_t fixed_buffer_used_size_ = 0;
  3342. std::string growable_buffer_;
  3343. };
  3344. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3345. const Headers &src_headers);
  3346. struct ChunkedDecoder {
  3347. Stream &strm;
  3348. size_t chunk_remaining = 0;
  3349. bool finished = false;
  3350. char line_buf[64];
  3351. size_t last_chunk_total = 0;
  3352. size_t last_chunk_offset = 0;
  3353. size_t overhead = 0;
  3354. explicit ChunkedDecoder(Stream &s);
  3355. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3356. size_t &out_chunk_total);
  3357. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3358. };
  3359. // A regular file opened to be served: mapped on Windows, read with pread()
  3360. // elsewhere.
  3361. class mmap {
  3362. public:
  3363. mmap(const char *path);
  3364. ~mmap();
  3365. bool open(const char *path);
  3366. void close();
  3367. bool is_open() const;
  3368. size_t size() const;
  3369. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3370. // down to 0, if the file has shrunk since it was opened.
  3371. size_t read(size_t offset, char *buf, size_t len) const;
  3372. private:
  3373. #if defined(_WIN32)
  3374. HANDLE hFile_ = NULL;
  3375. HANDLE hMapping_ = NULL;
  3376. void *addr_ = nullptr;
  3377. bool is_open_empty_file = false;
  3378. #else
  3379. int fd_ = -1;
  3380. #endif
  3381. size_t size_ = 0;
  3382. };
  3383. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3384. namespace fields {
  3385. bool is_token_char(char c);
  3386. bool is_token(const std::string &s);
  3387. bool is_field_name(const std::string &s);
  3388. bool is_vchar(char c);
  3389. bool is_obs_text(char c);
  3390. bool is_field_vchar(char c);
  3391. bool is_field_content(const std::string &s);
  3392. bool is_field_value(const std::string &s);
  3393. bool is_field_valid(const std::string &name, const std::string &value);
  3394. bool is_request_target(const std::string &s);
  3395. bool is_host(const std::string &s);
  3396. } // namespace fields
  3397. } // namespace detail
  3398. /*
  3399. * TLS Abstraction Layer Declarations
  3400. */
  3401. #ifdef CPPHTTPLIB_SSL_ENABLED
  3402. // TLS abstraction layer - backend-specific type declarations
  3403. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3404. namespace tls {
  3405. namespace impl {
  3406. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3407. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3408. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3409. struct MbedTlsContext {
  3410. mbedtls_ssl_config conf;
  3411. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3412. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3413. mbedtls_entropy_context entropy;
  3414. mbedtls_ctr_drbg_context ctr_drbg;
  3415. #endif
  3416. mbedtls_x509_crt ca_chain;
  3417. mbedtls_x509_crt own_cert;
  3418. mbedtls_pk_context own_key;
  3419. bool is_server = false;
  3420. // Peer certificate required (set_verify_client()); a client defaults to true
  3421. bool verify_client = false;
  3422. // Set by tls::set_verify_callback().
  3423. VerifyCallback verify_callback;
  3424. MbedTlsContext();
  3425. ~MbedTlsContext();
  3426. MbedTlsContext(const MbedTlsContext &) = delete;
  3427. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3428. };
  3429. } // namespace impl
  3430. } // namespace tls
  3431. #endif
  3432. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3433. namespace tls {
  3434. namespace impl {
  3435. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3436. // This struct is accessible via tls::impl for use in SSL context
  3437. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3438. struct WolfSSLContext {
  3439. WOLFSSL_CTX *ctx = nullptr;
  3440. bool is_server = false;
  3441. // Peer certificate required (set_verify_client()); a client defaults to true
  3442. bool verify_client = false;
  3443. // Replaced under verify_callback_mutex()
  3444. std::shared_ptr<VerifyCallback> verify_callback;
  3445. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3446. WolfSSLContext();
  3447. ~WolfSSLContext();
  3448. WolfSSLContext(const WolfSSLContext &) = delete;
  3449. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3450. };
  3451. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3452. struct WolfSSLCAStore {
  3453. std::string pem_data;
  3454. };
  3455. } // namespace impl
  3456. } // namespace tls
  3457. #endif
  3458. #endif // CPPHTTPLIB_SSL_ENABLED
  3459. namespace stream {
  3460. class Result {
  3461. public:
  3462. Result();
  3463. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3464. Result(Result &&other) noexcept;
  3465. Result &operator=(Result &&other) noexcept;
  3466. Result(const Result &) = delete;
  3467. Result &operator=(const Result &) = delete;
  3468. // Response info
  3469. bool is_valid() const;
  3470. explicit operator bool() const;
  3471. int status() const;
  3472. const Headers &headers() const;
  3473. std::string get_header_value(const std::string &key,
  3474. const char *def = "") const;
  3475. bool has_header(const std::string &key) const;
  3476. Error error() const;
  3477. Error read_error() const;
  3478. bool has_read_error() const;
  3479. // Stream reading
  3480. bool next();
  3481. const char *data() const;
  3482. size_t size() const;
  3483. std::string read_all();
  3484. private:
  3485. ClientImpl::StreamHandle handle_;
  3486. std::string buffer_;
  3487. size_t current_size_ = 0;
  3488. size_t chunk_size_;
  3489. bool finished_ = false;
  3490. };
  3491. // GET
  3492. template <typename ClientType>
  3493. inline Result Get(ClientType &cli, const std::string &path,
  3494. size_t chunk_size = 8192) {
  3495. return Result{cli.open_stream("GET", path), chunk_size};
  3496. }
  3497. template <typename ClientType>
  3498. inline Result Get(ClientType &cli, const std::string &path,
  3499. const Headers &headers, size_t chunk_size = 8192) {
  3500. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3501. }
  3502. template <typename ClientType>
  3503. inline Result Get(ClientType &cli, const std::string &path,
  3504. const Params &params, size_t chunk_size = 8192) {
  3505. return Result{cli.open_stream("GET", path, params), chunk_size};
  3506. }
  3507. template <typename ClientType>
  3508. inline Result Get(ClientType &cli, const std::string &path,
  3509. const Params &params, const Headers &headers,
  3510. size_t chunk_size = 8192) {
  3511. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3512. }
  3513. // POST
  3514. template <typename ClientType>
  3515. inline Result Post(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("POST", path, {}, {}, body, content_type),
  3519. chunk_size};
  3520. }
  3521. template <typename ClientType>
  3522. inline Result Post(ClientType &cli, const std::string &path,
  3523. const Headers &headers, const std::string &body,
  3524. const std::string &content_type, size_t chunk_size = 8192) {
  3525. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3526. chunk_size};
  3527. }
  3528. template <typename ClientType>
  3529. inline Result Post(ClientType &cli, const std::string &path,
  3530. const Params &params, const std::string &body,
  3531. const std::string &content_type, size_t chunk_size = 8192) {
  3532. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3533. chunk_size};
  3534. }
  3535. template <typename ClientType>
  3536. inline Result Post(ClientType &cli, const std::string &path,
  3537. const Params &params, const Headers &headers,
  3538. const std::string &body, const std::string &content_type,
  3539. size_t chunk_size = 8192) {
  3540. return Result{
  3541. cli.open_stream("POST", path, params, headers, body, content_type),
  3542. chunk_size};
  3543. }
  3544. // PUT
  3545. template <typename ClientType>
  3546. inline Result Put(ClientType &cli, const std::string &path,
  3547. const std::string &body, const std::string &content_type,
  3548. size_t chunk_size = 8192) {
  3549. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3550. chunk_size};
  3551. }
  3552. template <typename ClientType>
  3553. inline Result Put(ClientType &cli, const std::string &path,
  3554. const Headers &headers, const std::string &body,
  3555. const std::string &content_type, size_t chunk_size = 8192) {
  3556. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3557. chunk_size};
  3558. }
  3559. template <typename ClientType>
  3560. inline Result Put(ClientType &cli, const std::string &path,
  3561. const Params &params, const std::string &body,
  3562. const std::string &content_type, size_t chunk_size = 8192) {
  3563. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3564. chunk_size};
  3565. }
  3566. template <typename ClientType>
  3567. inline Result Put(ClientType &cli, const std::string &path,
  3568. const Params &params, const Headers &headers,
  3569. const std::string &body, const std::string &content_type,
  3570. size_t chunk_size = 8192) {
  3571. return Result{
  3572. cli.open_stream("PUT", path, params, headers, body, content_type),
  3573. chunk_size};
  3574. }
  3575. // PATCH
  3576. template <typename ClientType>
  3577. inline Result Patch(ClientType &cli, const std::string &path,
  3578. const std::string &body, const std::string &content_type,
  3579. size_t chunk_size = 8192) {
  3580. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3581. chunk_size};
  3582. }
  3583. template <typename ClientType>
  3584. inline Result Patch(ClientType &cli, const std::string &path,
  3585. const Headers &headers, const std::string &body,
  3586. const std::string &content_type, size_t chunk_size = 8192) {
  3587. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3588. chunk_size};
  3589. }
  3590. template <typename ClientType>
  3591. inline Result Patch(ClientType &cli, const std::string &path,
  3592. const Params &params, const std::string &body,
  3593. const std::string &content_type, size_t chunk_size = 8192) {
  3594. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3595. chunk_size};
  3596. }
  3597. template <typename ClientType>
  3598. inline Result Patch(ClientType &cli, const std::string &path,
  3599. const Params &params, const Headers &headers,
  3600. const std::string &body, const std::string &content_type,
  3601. size_t chunk_size = 8192) {
  3602. return Result{
  3603. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3604. chunk_size};
  3605. }
  3606. // DELETE
  3607. template <typename ClientType>
  3608. inline Result Delete(ClientType &cli, const std::string &path,
  3609. size_t chunk_size = 8192) {
  3610. return Result{cli.open_stream("DELETE", path), chunk_size};
  3611. }
  3612. template <typename ClientType>
  3613. inline Result Delete(ClientType &cli, const std::string &path,
  3614. const Headers &headers, size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3616. }
  3617. template <typename ClientType>
  3618. inline Result Delete(ClientType &cli, const std::string &path,
  3619. const std::string &body, const std::string &content_type,
  3620. size_t chunk_size = 8192) {
  3621. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3622. chunk_size};
  3623. }
  3624. template <typename ClientType>
  3625. inline Result Delete(ClientType &cli, const std::string &path,
  3626. const Headers &headers, const std::string &body,
  3627. const std::string &content_type,
  3628. size_t chunk_size = 8192) {
  3629. return Result{
  3630. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3631. chunk_size};
  3632. }
  3633. template <typename ClientType>
  3634. inline Result Delete(ClientType &cli, const std::string &path,
  3635. const Params &params, size_t chunk_size = 8192) {
  3636. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3637. }
  3638. template <typename ClientType>
  3639. inline Result Delete(ClientType &cli, const std::string &path,
  3640. const Params &params, const Headers &headers,
  3641. size_t chunk_size = 8192) {
  3642. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3643. }
  3644. template <typename ClientType>
  3645. inline Result Delete(ClientType &cli, const std::string &path,
  3646. const Params &params, const std::string &body,
  3647. const std::string &content_type,
  3648. size_t chunk_size = 8192) {
  3649. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3650. chunk_size};
  3651. }
  3652. template <typename ClientType>
  3653. inline Result Delete(ClientType &cli, const std::string &path,
  3654. const Params &params, const Headers &headers,
  3655. const std::string &body, const std::string &content_type,
  3656. size_t chunk_size = 8192) {
  3657. return Result{
  3658. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3659. chunk_size};
  3660. }
  3661. // HEAD
  3662. template <typename ClientType>
  3663. inline Result Head(ClientType &cli, const std::string &path,
  3664. size_t chunk_size = 8192) {
  3665. return Result{cli.open_stream("HEAD", path), chunk_size};
  3666. }
  3667. template <typename ClientType>
  3668. inline Result Head(ClientType &cli, const std::string &path,
  3669. const Headers &headers, size_t chunk_size = 8192) {
  3670. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3671. }
  3672. template <typename ClientType>
  3673. inline Result Head(ClientType &cli, const std::string &path,
  3674. const Params &params, size_t chunk_size = 8192) {
  3675. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3676. }
  3677. template <typename ClientType>
  3678. inline Result Head(ClientType &cli, const std::string &path,
  3679. const Params &params, const Headers &headers,
  3680. size_t chunk_size = 8192) {
  3681. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3682. }
  3683. // OPTIONS
  3684. template <typename ClientType>
  3685. inline Result Options(ClientType &cli, const std::string &path,
  3686. size_t chunk_size = 8192) {
  3687. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3688. }
  3689. template <typename ClientType>
  3690. inline Result Options(ClientType &cli, const std::string &path,
  3691. const Headers &headers, size_t chunk_size = 8192) {
  3692. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3693. }
  3694. template <typename ClientType>
  3695. inline Result Options(ClientType &cli, const std::string &path,
  3696. const Params &params, size_t chunk_size = 8192) {
  3697. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3698. }
  3699. template <typename ClientType>
  3700. inline Result Options(ClientType &cli, const std::string &path,
  3701. const Params &params, const Headers &headers,
  3702. size_t chunk_size = 8192) {
  3703. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3704. }
  3705. } // namespace stream
  3706. namespace sse {
  3707. struct SSEMessage {
  3708. std::string event; // Event type (default: "message")
  3709. std::string data; // Event payload
  3710. std::string id; // Event ID for Last-Event-ID header
  3711. SSEMessage();
  3712. void clear();
  3713. };
  3714. class SSEClient {
  3715. public:
  3716. using MessageHandler = std::function<void(const SSEMessage &)>;
  3717. using ErrorHandler = std::function<void(Error)>;
  3718. using OpenHandler = std::function<void()>;
  3719. SSEClient(Client &client, const std::string &path);
  3720. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3721. ~SSEClient();
  3722. SSEClient(const SSEClient &) = delete;
  3723. SSEClient &operator=(const SSEClient &) = delete;
  3724. // Event handlers
  3725. SSEClient &on_message(MessageHandler handler);
  3726. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3727. SSEClient &on_open(OpenHandler handler);
  3728. SSEClient &on_error(ErrorHandler handler);
  3729. SSEClient &set_reconnect_interval(int ms);
  3730. SSEClient &set_max_reconnect_attempts(int n);
  3731. // Update headers (thread-safe)
  3732. SSEClient &set_headers(const Headers &headers);
  3733. // State accessors
  3734. bool is_connected() const;
  3735. std::string last_event_id() const;
  3736. // Blocking start - runs event loop with auto-reconnect
  3737. void start();
  3738. // Non-blocking start - runs in background thread
  3739. void start_async();
  3740. // Stop the client (thread-safe)
  3741. void stop();
  3742. private:
  3743. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3744. bool &has_data, bool &has_id);
  3745. void run_event_loop();
  3746. void dispatch_event(const SSEMessage &msg);
  3747. bool should_reconnect(int count) const;
  3748. void wait_for_reconnect();
  3749. // Client and path
  3750. Client &client_;
  3751. std::string path_;
  3752. Headers headers_;
  3753. mutable std::mutex headers_mutex_;
  3754. // Callbacks
  3755. MessageHandler on_message_;
  3756. std::map<std::string, MessageHandler> event_handlers_;
  3757. OpenHandler on_open_;
  3758. ErrorHandler on_error_;
  3759. // Configuration
  3760. int reconnect_interval_ms_ = 3000;
  3761. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3762. // State
  3763. std::atomic<bool> running_{false};
  3764. std::atomic<bool> connected_{false};
  3765. // Written by the event loop, which start_async() runs on its own thread
  3766. std::string last_event_id_;
  3767. mutable std::mutex last_event_id_mutex_;
  3768. // Async support
  3769. std::thread async_thread_;
  3770. };
  3771. } // namespace sse
  3772. namespace ws {
  3773. class WebSocketClient;
  3774. enum class Opcode : uint8_t {
  3775. Continuation = 0x0,
  3776. Text = 0x1,
  3777. Binary = 0x2,
  3778. Close = 0x8,
  3779. Ping = 0x9,
  3780. Pong = 0xA,
  3781. };
  3782. enum class CloseStatus : uint16_t {
  3783. Normal = 1000,
  3784. GoingAway = 1001,
  3785. ProtocolError = 1002,
  3786. UnsupportedData = 1003,
  3787. NoStatus = 1005,
  3788. Abnormal = 1006,
  3789. InvalidPayload = 1007,
  3790. PolicyViolation = 1008,
  3791. MessageTooBig = 1009,
  3792. MandatoryExtension = 1010,
  3793. InternalError = 1011,
  3794. };
  3795. // Timeout is returned only when a read timeout was set and it elapsed before
  3796. // any byte of a frame arrived: nothing was consumed and the connection is
  3797. // still open, so the caller can send on it and read again. `msg` is left
  3798. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3799. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3800. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3801. // upgrade handshake fully succeeded. On failure error() identifies the
  3802. // failing layer; status()/headers() expose the server's upgrade response
  3803. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3804. // CONNECT when error() is ProxyConnection.
  3805. class Result {
  3806. public:
  3807. Result() = default;
  3808. Result(Error err, int status, Headers &&headers)
  3809. : err_(err), status_(status), headers_(std::move(headers)) {}
  3810. explicit operator bool() const { return err_ == Error::Success; }
  3811. Error error() const { return err_; }
  3812. // Upgrade response info
  3813. int status() const { return status_; }
  3814. const Headers &headers() const { return headers_; }
  3815. std::string get_header_value(const std::string &key,
  3816. const char *def = "") const {
  3817. return detail::get_header_value(headers_, key, def, 0);
  3818. }
  3819. bool has_header(const std::string &key) const {
  3820. return headers_.find(key) != headers_.end();
  3821. }
  3822. #ifdef CPPHTTPLIB_SSL_ENABLED
  3823. Result(Error err, int status, Headers &&headers, int ssl_error,
  3824. uint64_t ssl_backend_error)
  3825. : err_(err), status_(status), headers_(std::move(headers)),
  3826. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3827. int ssl_error() const { return ssl_error_; }
  3828. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3829. #endif
  3830. private:
  3831. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3832. int status_ = -1;
  3833. Headers headers_;
  3834. #ifdef CPPHTTPLIB_SSL_ENABLED
  3835. int ssl_error_ = 0;
  3836. uint64_t ssl_backend_error_ = 0;
  3837. #endif
  3838. };
  3839. class WebSocket {
  3840. public:
  3841. WebSocket(const WebSocket &) = delete;
  3842. WebSocket &operator=(const WebSocket &) = delete;
  3843. ~WebSocket();
  3844. ReadResult read(std::string &msg);
  3845. bool send(const std::string &data);
  3846. bool send(const char *data, size_t len);
  3847. void close(CloseStatus status = CloseStatus::Normal,
  3848. const std::string &reason = "");
  3849. const Request &request() const;
  3850. bool is_open() const;
  3851. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3852. // A server handler owns its connection's timeout this way; a client sets it
  3853. // through WebSocketClient. Safe to call while another thread is in read().
  3854. //
  3855. // Only a timeout set here is reported as Timeout. The compile-time default
  3856. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3857. // than a request for control, so when it elapses read() returns Fail and
  3858. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3859. void set_read_timeout(time_t sec, time_t usec = 0);
  3860. template <class Rep, class Period>
  3861. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3862. private:
  3863. friend class httplib::Server;
  3864. friend class httplib::ws::WebSocketClient;
  3865. WebSocket(
  3866. Stream &strm, const Request &req, bool is_server,
  3867. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3868. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3869. : strm_(strm), req_(req), is_server_(is_server),
  3870. ping_interval_sec_(ping_interval_sec),
  3871. max_missed_pongs_(max_missed_pongs) {
  3872. start_heartbeat();
  3873. }
  3874. WebSocket(
  3875. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3876. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3877. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3878. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3879. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3880. max_missed_pongs_(max_missed_pongs) {
  3881. start_heartbeat();
  3882. }
  3883. void start_heartbeat();
  3884. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3885. Stream &strm_;
  3886. std::unique_ptr<Stream> owned_strm_;
  3887. Request req_;
  3888. bool is_server_;
  3889. time_t ping_interval_sec_;
  3890. int max_missed_pongs_;
  3891. int unacked_pings_ = 0;
  3892. std::atomic<bool> closed_{false};
  3893. // Set when the peer stopped answering pings, to end a read() waiting on it
  3894. std::atomic<bool> pong_timed_out_{false};
  3895. // Set once the caller has bounded read() through set_read_timeout(). Until
  3896. // then the timeout in effect is the compile-time default, and elapsing it
  3897. // is a failure that closes the connection, not a Timeout.
  3898. std::atomic<bool> read_timeout_set_{false};
  3899. std::mutex write_mutex_;
  3900. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3901. // may do so: read_websocket_frame() reads a payload until it has the whole
  3902. // declared length, so a second parser stealing bytes silently corrupts the
  3903. // message the first one is assembling.
  3904. std::mutex read_mutex_;
  3905. std::thread ping_thread_;
  3906. std::mutex ping_mutex_;
  3907. std::condition_variable ping_cv_;
  3908. };
  3909. class WebSocketClient {
  3910. public:
  3911. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3912. const Headers &headers = {});
  3913. ~WebSocketClient();
  3914. WebSocketClient(const WebSocketClient &) = delete;
  3915. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3916. bool is_valid() const;
  3917. Result connect();
  3918. ReadResult read(std::string &msg);
  3919. bool send(const std::string &data);
  3920. bool send(const char *data, size_t len);
  3921. void close(CloseStatus status = CloseStatus::Normal,
  3922. const std::string &reason = "");
  3923. bool is_open() const;
  3924. const std::string &subprotocol() const;
  3925. void set_read_timeout(time_t sec, time_t usec = 0);
  3926. template <class Rep, class Period>
  3927. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3928. void set_write_timeout(time_t sec, time_t usec = 0);
  3929. template <class Rep, class Period>
  3930. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3931. void set_websocket_ping_interval(time_t sec);
  3932. void set_websocket_max_missed_pongs(int count);
  3933. void set_tcp_nodelay(bool on);
  3934. void set_address_family(int family);
  3935. void set_ipv6_v6only(bool on);
  3936. void set_socket_options(SocketOptions socket_options);
  3937. void set_connection_timeout(time_t sec, time_t usec = 0);
  3938. template <class Rep, class Period>
  3939. void
  3940. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3941. void set_interface(const std::string &intf);
  3942. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  3943. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3944. void
  3945. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3946. void
  3947. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3948. void set_basic_auth(const std::string &username, const std::string &password);
  3949. void set_bearer_token_auth(const std::string &token);
  3950. void set_proxy(const std::string &host, int port);
  3951. void set_proxy_basic_auth(const std::string &username,
  3952. const std::string &password);
  3953. void set_proxy_bearer_token_auth(const std::string &token);
  3954. void set_no_proxy(const std::vector<std::string> &patterns);
  3955. #ifdef CPPHTTPLIB_SSL_ENABLED
  3956. struct PemMemory {
  3957. const char *cert_pem;
  3958. size_t cert_pem_len;
  3959. const char *key_pem;
  3960. size_t key_pem_len;
  3961. const char *private_key_password;
  3962. };
  3963. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3964. const PemMemory &pem, const Headers &headers = {});
  3965. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3966. const std::string &ca_cert_dir_path = std::string());
  3967. void set_ca_cert_store(tls::ca_store_t store);
  3968. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3969. void enable_server_certificate_verification(bool enabled);
  3970. void enable_server_hostname_verification(bool enabled);
  3971. void enable_system_ca(bool enabled);
  3972. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3973. void set_session_verifier(
  3974. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3975. void set_proxy_digest_auth(const std::string &username,
  3976. const std::string &password);
  3977. #endif
  3978. private:
  3979. void shutdown_and_close();
  3980. std::pair<time_t, time_t> handshake_timeout() const;
  3981. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3982. int &ssl_error, uint64_t &ssl_backend_error);
  3983. void prepare_default_headers(Request &req);
  3984. bool is_proxy_enabled() const;
  3985. bool create_and_connect_socket(Error &error);
  3986. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3987. bool connect_with_proxy(Response &proxy_res, Error &error);
  3988. std::string host_;
  3989. int port_;
  3990. std::string path_;
  3991. Headers headers_;
  3992. std::string subprotocol_;
  3993. bool is_valid_ = false;
  3994. socket_t sock_ = INVALID_SOCKET;
  3995. std::unique_ptr<WebSocket> ws_;
  3996. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3997. time_t read_timeout_usec_ = 0;
  3998. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3999. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  4000. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  4001. time_t websocket_ping_interval_sec_ =
  4002. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  4003. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  4004. int address_family_ = AF_UNSPEC;
  4005. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  4006. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  4007. SocketOptions socket_options_ = nullptr;
  4008. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  4009. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  4010. std::string interface_;
  4011. // Hostname to connection target map. The value is an IP literal or another
  4012. // hostname; only the connection target changes, never the identity.
  4013. std::map<std::string, std::string> addr_map_;
  4014. // Hostname to CONNECT target map, used only through a proxy.
  4015. std::map<std::string, std::string> tunnel_addr_map_;
  4016. std::string basic_auth_username_;
  4017. std::string basic_auth_password_;
  4018. std::string bearer_token_auth_token_;
  4019. std::string proxy_host_;
  4020. int proxy_port_ = -1;
  4021. std::string proxy_basic_auth_username_;
  4022. std::string proxy_basic_auth_password_;
  4023. std::string proxy_bearer_token_auth_token_;
  4024. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  4025. #ifdef CPPHTTPLIB_SSL_ENABLED
  4026. bool is_ssl_ = false;
  4027. tls::ctx_t tls_ctx_ = nullptr;
  4028. tls::session_t tls_session_ = nullptr;
  4029. std::string ca_cert_file_path_;
  4030. std::string ca_cert_dir_path_;
  4031. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  4032. // no certificate, so that a CA that failed to come through fails
  4033. // verification instead of letting the system CAs in.
  4034. bool custom_ca_loaded_ = false;
  4035. bool certs_loaded_ = false;
  4036. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  4037. bool server_certificate_verification_ = true;
  4038. bool server_hostname_verification_ = true;
  4039. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  4040. std::string proxy_digest_auth_username_;
  4041. std::string proxy_digest_auth_password_;
  4042. #endif
  4043. };
  4044. template <class Rep, class Period>
  4045. inline void WebSocket::set_read_timeout(
  4046. const std::chrono::duration<Rep, Period> &duration) {
  4047. detail::duration_to_sec_and_usec(
  4048. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4049. }
  4050. template <class Rep, class Period>
  4051. inline void WebSocketClient::set_read_timeout(
  4052. const std::chrono::duration<Rep, Period> &duration) {
  4053. detail::duration_to_sec_and_usec(
  4054. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4055. }
  4056. template <class Rep, class Period>
  4057. inline void WebSocketClient::set_write_timeout(
  4058. const std::chrono::duration<Rep, Period> &duration) {
  4059. detail::duration_to_sec_and_usec(
  4060. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4061. }
  4062. template <class Rep, class Period>
  4063. inline void WebSocketClient::set_connection_timeout(
  4064. const std::chrono::duration<Rep, Period> &duration) {
  4065. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4066. set_connection_timeout(sec, usec);
  4067. });
  4068. }
  4069. namespace impl {
  4070. bool is_valid_utf8(const std::string &s);
  4071. // Three states, because a failure that consumed bytes and one that consumed
  4072. // none are not the same thing: the first has left the stream in the middle of
  4073. // a frame and the connection cannot be reused, the second can just be retried.
  4074. enum class FrameRead { Ok, Fail, Timeout };
  4075. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4076. std::string &payload, bool &fin,
  4077. bool expect_masked, size_t max_len);
  4078. } // namespace impl
  4079. } // namespace ws
  4080. // ----------------------------------------------------------------------------
  4081. /*
  4082. * Implementation that will be part of the .cc file if split into .h + .cc.
  4083. */
  4084. namespace stream {
  4085. // stream::Result implementations
  4086. inline Result::Result() : chunk_size_(8192) {}
  4087. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4088. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4089. inline Result::Result(Result &&other) noexcept
  4090. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4091. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4092. finished_(other.finished_) {
  4093. other.current_size_ = 0;
  4094. other.finished_ = true;
  4095. }
  4096. inline Result &Result::operator=(Result &&other) noexcept {
  4097. if (this != &other) {
  4098. handle_ = std::move(other.handle_);
  4099. buffer_ = std::move(other.buffer_);
  4100. current_size_ = other.current_size_;
  4101. chunk_size_ = other.chunk_size_;
  4102. finished_ = other.finished_;
  4103. other.current_size_ = 0;
  4104. other.finished_ = true;
  4105. }
  4106. return *this;
  4107. }
  4108. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4109. inline Result::operator bool() const { return is_valid(); }
  4110. inline int Result::status() const {
  4111. return handle_.response ? handle_.response->status : -1;
  4112. }
  4113. inline const Headers &Result::headers() const {
  4114. static const Headers empty_headers;
  4115. return handle_.response ? handle_.response->headers : empty_headers;
  4116. }
  4117. inline std::string Result::get_header_value(const std::string &key,
  4118. const char *def) const {
  4119. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4120. }
  4121. inline bool Result::has_header(const std::string &key) const {
  4122. return handle_.response ? handle_.response->has_header(key) : false;
  4123. }
  4124. inline Error Result::error() const { return handle_.error; }
  4125. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4126. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4127. inline bool Result::next() {
  4128. if (!handle_.is_valid() || finished_) { return false; }
  4129. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4130. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4131. if (n > 0) {
  4132. current_size_ = static_cast<size_t>(n);
  4133. return true;
  4134. }
  4135. current_size_ = 0;
  4136. finished_ = true;
  4137. return false;
  4138. }
  4139. inline const char *Result::data() const { return buffer_.data(); }
  4140. inline size_t Result::size() const { return current_size_; }
  4141. inline std::string Result::read_all() {
  4142. std::string result;
  4143. while (next()) {
  4144. result.append(data(), size());
  4145. }
  4146. return result;
  4147. }
  4148. } // namespace stream
  4149. namespace sse {
  4150. // SSEMessage implementations
  4151. inline SSEMessage::SSEMessage() : event("message") {}
  4152. inline void SSEMessage::clear() {
  4153. event = "message";
  4154. data.clear();
  4155. id.clear();
  4156. }
  4157. // SSEClient implementations
  4158. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4159. : client_(client), path_(path) {}
  4160. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4161. const Headers &headers)
  4162. : client_(client), path_(path), headers_(headers) {}
  4163. inline SSEClient::~SSEClient() { stop(); }
  4164. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4165. on_message_ = std::move(handler);
  4166. return *this;
  4167. }
  4168. inline SSEClient &SSEClient::on_event(const std::string &type,
  4169. MessageHandler handler) {
  4170. event_handlers_[type] = std::move(handler);
  4171. return *this;
  4172. }
  4173. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4174. on_open_ = std::move(handler);
  4175. return *this;
  4176. }
  4177. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4178. on_error_ = std::move(handler);
  4179. return *this;
  4180. }
  4181. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4182. reconnect_interval_ms_ = ms;
  4183. return *this;
  4184. }
  4185. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4186. max_reconnect_attempts_ = n;
  4187. return *this;
  4188. }
  4189. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4190. std::lock_guard<std::mutex> lock(headers_mutex_);
  4191. headers_ = headers;
  4192. return *this;
  4193. }
  4194. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4195. inline std::string SSEClient::last_event_id() const {
  4196. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4197. return last_event_id_;
  4198. }
  4199. inline void SSEClient::start() {
  4200. running_.store(true);
  4201. run_event_loop();
  4202. }
  4203. inline void SSEClient::start_async() {
  4204. running_.store(true);
  4205. async_thread_ = std::thread([this]() { run_event_loop(); });
  4206. }
  4207. inline void SSEClient::stop() {
  4208. running_.store(false);
  4209. client_.stop(); // Cancel any pending operations
  4210. if (async_thread_.joinable()) { async_thread_.join(); }
  4211. }
  4212. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4213. int &retry_ms, bool &has_data,
  4214. bool &has_id) {
  4215. // Blank line signals end of event
  4216. if (line.empty()) { return true; }
  4217. // Lines starting with ':' are comments (ignored)
  4218. if (line[0] == ':') { return false; }
  4219. // Find the colon separator
  4220. auto colon_pos = line.find(':');
  4221. auto field = line.substr(0, colon_pos);
  4222. std::string value;
  4223. // Value starts after colon, skip optional single space
  4224. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4225. auto value_start = colon_pos + 1;
  4226. if (line[value_start] == ' ') { value_start++; }
  4227. value = line.substr(value_start);
  4228. }
  4229. // Handle known fields
  4230. if (field == "event") {
  4231. // An empty event type is dispatched as "message" per the SSE spec
  4232. msg.event = value.empty() ? std::string("message") : std::move(value);
  4233. } else if (field == "data") {
  4234. // Multiple data lines are concatenated with newlines
  4235. if (has_data) { msg.data += "\n"; }
  4236. msg.data += value;
  4237. has_data = true;
  4238. } else if (field == "id") {
  4239. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4240. // valid (clears the last event ID)
  4241. if (detail::fields::is_field_value(value)) {
  4242. msg.id = value;
  4243. has_id = true;
  4244. }
  4245. } else if (field == "retry") {
  4246. // Parse retry interval in milliseconds
  4247. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4248. if (detail::is_numeric(value)) {
  4249. int v = 0;
  4250. auto res =
  4251. detail::from_chars(value.data(), value.data() + value.size(), v);
  4252. if (res.ec == std::errc{}) { retry_ms = v; }
  4253. }
  4254. }
  4255. // Unknown fields are ignored per SSE spec
  4256. return false;
  4257. }
  4258. inline void SSEClient::run_event_loop() {
  4259. auto reconnect_count = 0;
  4260. while (running_.load()) {
  4261. // Build headers, including Last-Event-ID if we have one
  4262. Headers request_headers;
  4263. {
  4264. std::lock_guard<std::mutex> lock(headers_mutex_);
  4265. request_headers = headers_;
  4266. }
  4267. if (!last_event_id_.empty()) {
  4268. request_headers.emplace("Last-Event-ID", last_event_id_);
  4269. }
  4270. // Open streaming connection. An event stream has no end, so each event is
  4271. // bounded instead of the whole body.
  4272. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4273. handle.body_reader_.payload_max_length = 0;
  4274. // stop() ends a read that is waiting for the next event
  4275. if (handle.stream_) {
  4276. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4277. }
  4278. stream::Result result{std::move(handle)};
  4279. // Connection error handling
  4280. if (!result) {
  4281. connected_.store(false);
  4282. if (on_error_) { on_error_(result.error()); }
  4283. if (!should_reconnect(reconnect_count)) { break; }
  4284. wait_for_reconnect();
  4285. reconnect_count++;
  4286. continue;
  4287. }
  4288. if (result.status() != StatusCode::OK_200) {
  4289. connected_.store(false);
  4290. if (on_error_) { on_error_(Error::Connection); }
  4291. // For certain errors, don't reconnect.
  4292. // Note: 401 is intentionally absent so that handlers can refresh
  4293. // credentials via set_headers() and let the client reconnect.
  4294. if (result.status() == StatusCode::NoContent_204 ||
  4295. result.status() == StatusCode::NotFound_404 ||
  4296. result.status() == StatusCode::Forbidden_403) {
  4297. break;
  4298. }
  4299. if (!should_reconnect(reconnect_count)) { break; }
  4300. wait_for_reconnect();
  4301. reconnect_count++;
  4302. continue;
  4303. }
  4304. // Connection successful
  4305. connected_.store(true);
  4306. reconnect_count = 0;
  4307. if (on_open_) { on_open_(); }
  4308. // Event receiving loop
  4309. std::string buffer;
  4310. SSEMessage current_msg;
  4311. auto has_data = false;
  4312. auto has_id = false;
  4313. auto first_line = true;
  4314. auto after_cr = false;
  4315. auto event_too_long = false;
  4316. while (running_.load() && result.next()) {
  4317. // What is left in the buffer has no line ending
  4318. auto search_pos = buffer.size();
  4319. buffer.append(result.data(), result.size());
  4320. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4321. // per the SSE spec
  4322. size_t line_start = 0;
  4323. size_t eol_pos;
  4324. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4325. std::string::npos) {
  4326. auto line = buffer.substr(line_start, eol_pos - line_start);
  4327. line_start = eol_pos + 1;
  4328. search_pos = line_start;
  4329. // The \n of a \r\n may arrive in a later chunk than its \r
  4330. auto is_lf_of_crlf =
  4331. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4332. after_cr = buffer[eol_pos] == '\r';
  4333. if (is_lf_of_crlf) { continue; }
  4334. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4335. if (first_line) {
  4336. first_line = false;
  4337. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4338. }
  4339. // Parse the line and check if event is complete
  4340. auto event_complete = parse_sse_line(
  4341. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4342. if (event_complete) {
  4343. // Update last_event_id for reconnection, even for an event that
  4344. // has no data. An empty id clears it.
  4345. if (has_id) {
  4346. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4347. last_event_id_ = current_msg.id;
  4348. }
  4349. // An event without a data field is not dispatched
  4350. if (has_data) { dispatch_event(current_msg); }
  4351. // Reset the message for the next event either way
  4352. current_msg.clear();
  4353. has_data = false;
  4354. has_id = false;
  4355. }
  4356. }
  4357. // Keep unprocessed data in buffer
  4358. buffer.erase(0, line_start);
  4359. // Neither an event nor a line still waiting for its end may grow
  4360. // without bound. 0 means no limit.
  4361. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4362. buffer.size() + current_msg.data.size() >
  4363. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4364. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4365. event_too_long = true;
  4366. break;
  4367. }
  4368. }
  4369. // Connection ended
  4370. connected_.store(false);
  4371. // Reconnecting would only get the same event again
  4372. if (!running_.load() || event_too_long) { break; }
  4373. // Check for read errors
  4374. if (result.has_read_error()) {
  4375. if (on_error_) { on_error_(result.read_error()); }
  4376. }
  4377. if (!should_reconnect(reconnect_count)) { break; }
  4378. wait_for_reconnect();
  4379. reconnect_count++;
  4380. }
  4381. connected_.store(false);
  4382. }
  4383. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4384. // Check for specific event type handler first
  4385. auto it = event_handlers_.find(msg.event);
  4386. if (it != event_handlers_.end()) {
  4387. it->second(msg);
  4388. return;
  4389. }
  4390. // Fall back to generic message handler
  4391. if (on_message_) { on_message_(msg); }
  4392. }
  4393. inline bool SSEClient::should_reconnect(int count) const {
  4394. if (!running_.load()) { return false; }
  4395. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4396. return count < max_reconnect_attempts_;
  4397. }
  4398. inline void SSEClient::wait_for_reconnect() {
  4399. // Use small increments to check running_ flag frequently.
  4400. // Always wait at least one increment, so that a zero interval (e.g.
  4401. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4402. const auto step_ms = 100;
  4403. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4404. auto waited = 0;
  4405. while (running_.load() && waited < interval_ms) {
  4406. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4407. waited += step_ms;
  4408. }
  4409. }
  4410. } // namespace sse
  4411. #ifdef CPPHTTPLIB_SSL_ENABLED
  4412. /*
  4413. * TLS abstraction layer - internal function declarations
  4414. * These are implementation details and not part of the public API.
  4415. */
  4416. namespace tls {
  4417. // Client context
  4418. ctx_t create_client_context();
  4419. void free_context(ctx_t ctx);
  4420. bool set_min_version(ctx_t ctx, Version version);
  4421. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4422. bool load_ca_file(ctx_t ctx, const char *file_path);
  4423. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4424. bool load_system_certs(ctx_t ctx);
  4425. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4426. const char *password);
  4427. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4428. const char *key_path, const char *password);
  4429. // Server context
  4430. ctx_t create_server_context();
  4431. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4432. const char *password);
  4433. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4434. const char *key_path, const char *password);
  4435. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4436. void set_verify_client(ctx_t ctx, bool require);
  4437. // Session management
  4438. session_t create_session(ctx_t ctx, socket_t sock);
  4439. void free_session(session_t session);
  4440. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4441. // Handshake (non-blocking capable)
  4442. TlsError connect(session_t session);
  4443. TlsError accept(session_t session);
  4444. // Handshake with timeout (blocking until timeout)
  4445. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4446. time_t timeout_usec, TlsError *err);
  4447. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4448. time_t timeout_usec, TlsError *err);
  4449. // I/O (non-blocking capable)
  4450. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4451. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4452. int pending(const_session_t session);
  4453. void shutdown(session_t session, bool graceful);
  4454. // Connection state
  4455. bool is_peer_closed(session_t session, socket_t sock);
  4456. // Certificate verification
  4457. cert_t get_peer_cert(const_session_t session);
  4458. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4459. // do not use them after free_session(), as with get_peer_cert().
  4460. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4461. void free_cert(cert_t cert);
  4462. // Matches the host against the subjectAltName entries only, never the Common
  4463. // Name (RFC 9525).
  4464. bool verify_hostname(cert_t cert, const char *hostname);
  4465. uint64_t hostname_mismatch_code();
  4466. long get_verify_result(const_session_t session);
  4467. // Certificate introspection
  4468. std::string get_cert_subject_cn(cert_t cert);
  4469. std::string get_cert_issuer_name(cert_t cert);
  4470. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4471. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4472. std::string get_cert_serial(cert_t cert);
  4473. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4474. const char *get_sni(const_session_t session);
  4475. // CA store management
  4476. ca_store_t create_ca_store(const char *pem, size_t len);
  4477. void free_ca_store(ca_store_t store);
  4478. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4479. // Free each with free_cert(), and do not use them once the context's CA
  4480. // certificates change.
  4481. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4482. std::vector<std::string> get_ca_names(ctx_t ctx);
  4483. // Dynamic certificate update (for servers)
  4484. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4485. const char *password);
  4486. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4487. // Certificate verification callback
  4488. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4489. long get_verify_error(const_session_t session);
  4490. std::string verify_error_string(long error_code);
  4491. // TlsError information
  4492. uint64_t peek_error();
  4493. uint64_t get_error();
  4494. std::string error_string(uint64_t code);
  4495. } // namespace tls
  4496. #endif // CPPHTTPLIB_SSL_ENABLED
  4497. /*
  4498. * Group 1: detail namespace - Non-SSL utilities
  4499. */
  4500. namespace detail {
  4501. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4502. const void *optval, socklen_t optlen) {
  4503. return setsockopt(sock, level, optname,
  4504. #ifdef _WIN32
  4505. reinterpret_cast<const char *>(optval),
  4506. #else
  4507. optval,
  4508. #endif
  4509. optlen) == 0;
  4510. }
  4511. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4512. time_t sec, time_t usec) {
  4513. #ifdef _WIN32
  4514. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4515. #else
  4516. timeval timeout;
  4517. timeout.tv_sec = static_cast<long>(sec);
  4518. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4519. #endif
  4520. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4521. }
  4522. inline bool is_hex(char c, int &v) {
  4523. if (is_ascii_digit(c)) {
  4524. v = c - '0';
  4525. return true;
  4526. } else if ('A' <= c && c <= 'F') {
  4527. v = c - 'A' + 10;
  4528. return true;
  4529. } else if ('a' <= c && c <= 'f') {
  4530. v = c - 'a' + 10;
  4531. return true;
  4532. }
  4533. return false;
  4534. }
  4535. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4536. int &val) {
  4537. if (i >= s.size()) { return false; }
  4538. val = 0;
  4539. for (; cnt; i++, cnt--) {
  4540. if (!s[i]) { return false; }
  4541. auto v = 0;
  4542. if (is_hex(s[i], v)) {
  4543. val = val * 16 + v;
  4544. } else {
  4545. return false;
  4546. }
  4547. }
  4548. return true;
  4549. }
  4550. inline std::string from_i_to_hex(size_t n) {
  4551. static const auto charset = "0123456789abcdef";
  4552. std::string ret;
  4553. do {
  4554. ret = charset[n & 15] + ret;
  4555. n >>= 4;
  4556. } while (n > 0);
  4557. return ret;
  4558. }
  4559. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4560. // builds and trips -Wtautological-type-limit-compare.
  4561. inline bool fits_in_size_t(uint64_t n) {
  4562. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4563. }
  4564. inline std::string compute_etag(const FileStat &fs,
  4565. const std::string &suffix = std::string()) {
  4566. if (!fs.is_file()) { return std::string(); }
  4567. // If mtime cannot be determined (negative value indicates an error
  4568. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4569. // value like 0 could collide with a real file that legitimately has
  4570. // mtime == 0 (epoch) and lead to misleading validators.
  4571. auto mtime_raw = fs.mtime();
  4572. if (mtime_raw < 0) { return std::string(); }
  4573. auto mtime = static_cast<size_t>(mtime_raw);
  4574. auto size = fs.size();
  4575. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4576. from_i_to_hex(size) + suffix + "\"";
  4577. }
  4578. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4579. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4580. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4581. inline std::string file_mtime_to_http_date(time_t mtime) {
  4582. if (mtime < 0) { return std::string(); }
  4583. struct tm tm_buf;
  4584. #ifdef _WIN32
  4585. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4586. #else
  4587. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4588. #endif
  4589. char buf[64];
  4590. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4591. return std::string();
  4592. }
  4593. return std::string(buf);
  4594. }
  4595. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4596. inline time_t parse_http_date(const std::string &date_str) {
  4597. struct tm tm_buf;
  4598. // Create a classic locale object once for all parsing attempts
  4599. const std::locale classic_locale = std::locale::classic();
  4600. // Try to parse using std::get_time (C++11, cross-platform)
  4601. auto try_parse = [&](const char *fmt) -> bool {
  4602. std::istringstream ss(date_str);
  4603. ss.imbue(classic_locale);
  4604. memset(&tm_buf, 0, sizeof(tm_buf));
  4605. ss >> std::get_time(&tm_buf, fmt);
  4606. return !ss.fail();
  4607. };
  4608. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4609. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4610. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4611. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4612. // asctime format: "Sun Nov 6 08:49:37 1994"
  4613. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4614. return static_cast<time_t>(-1);
  4615. }
  4616. }
  4617. }
  4618. #ifdef _WIN32
  4619. return _mkgmtime(&tm_buf);
  4620. #elif defined _AIX
  4621. return mktime(&tm_buf);
  4622. #else
  4623. return timegm(&tm_buf);
  4624. #endif
  4625. }
  4626. inline bool is_weak_etag(const std::string &s) {
  4627. // Check if the string is a weak ETag (starts with 'W/"')
  4628. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4629. }
  4630. inline bool is_strong_etag(const std::string &s) {
  4631. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4632. // chars)
  4633. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4634. }
  4635. inline size_t to_utf8(int code, char *buff) {
  4636. if (code < 0x0080) {
  4637. buff[0] = static_cast<char>(code & 0x7F);
  4638. return 1;
  4639. } else if (code < 0x0800) {
  4640. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4641. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4642. return 2;
  4643. } else if (code < 0xD800) {
  4644. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4645. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4646. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4647. return 3;
  4648. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4649. return 0;
  4650. } else if (code < 0x10000) {
  4651. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4652. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4653. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4654. return 3;
  4655. } else if (code < 0x110000) {
  4656. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4657. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4658. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4659. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4660. return 4;
  4661. }
  4662. // NOTREACHED
  4663. return 0;
  4664. }
  4665. } // namespace detail
  4666. namespace ws {
  4667. namespace impl {
  4668. inline bool is_valid_utf8(const std::string &s) {
  4669. size_t i = 0;
  4670. auto n = s.size();
  4671. while (i < n) {
  4672. auto c = static_cast<unsigned char>(s[i]);
  4673. size_t len;
  4674. uint32_t cp;
  4675. if (c < 0x80) {
  4676. i++;
  4677. continue;
  4678. } else if ((c & 0xE0) == 0xC0) {
  4679. len = 2;
  4680. cp = c & 0x1F;
  4681. } else if ((c & 0xF0) == 0xE0) {
  4682. len = 3;
  4683. cp = c & 0x0F;
  4684. } else if ((c & 0xF8) == 0xF0) {
  4685. len = 4;
  4686. cp = c & 0x07;
  4687. } else {
  4688. return false;
  4689. }
  4690. if (i + len > n) { return false; }
  4691. for (size_t j = 1; j < len; j++) {
  4692. auto b = static_cast<unsigned char>(s[i + j]);
  4693. if ((b & 0xC0) != 0x80) { return false; }
  4694. cp = (cp << 6) | (b & 0x3F);
  4695. }
  4696. // Overlong encoding check
  4697. if (len == 2 && cp < 0x80) { return false; }
  4698. if (len == 3 && cp < 0x800) { return false; }
  4699. if (len == 4 && cp < 0x10000) { return false; }
  4700. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4701. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4702. if (cp > 0x10FFFF) { return false; }
  4703. i += len;
  4704. }
  4705. return true;
  4706. }
  4707. } // namespace impl
  4708. } // namespace ws
  4709. namespace detail {
  4710. // NOTE: This code came up with the following stackoverflow post:
  4711. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4712. inline std::string base64_encode(const std::string &in) {
  4713. static const auto lookup =
  4714. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4715. std::string out;
  4716. out.reserve(in.size());
  4717. // Unsigned: the accumulator is never masked, so with a signed int the
  4718. // `val << 8` below overflows once enough bytes are folded in (undefined
  4719. // behaviour before C++20). Only the low bits are ever emitted, so the
  4720. // wrap-around of an unsigned accumulator does not affect the output.
  4721. uint32_t val = 0;
  4722. auto valb = -6;
  4723. for (auto c : in) {
  4724. val = (val << 8) + static_cast<uint8_t>(c);
  4725. valb += 8;
  4726. while (valb >= 0) {
  4727. out.push_back(lookup[(val >> valb) & 0x3F]);
  4728. valb -= 6;
  4729. }
  4730. }
  4731. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4732. while (out.size() % 4) {
  4733. out.push_back('=');
  4734. }
  4735. return out;
  4736. }
  4737. inline std::string sha1(const std::string &input) {
  4738. // RFC 3174 SHA-1 implementation
  4739. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4740. return (x << n) | (x >> (32 - n));
  4741. };
  4742. uint32_t h0 = 0x67452301;
  4743. uint32_t h1 = 0xEFCDAB89;
  4744. uint32_t h2 = 0x98BADCFE;
  4745. uint32_t h3 = 0x10325476;
  4746. uint32_t h4 = 0xC3D2E1F0;
  4747. // Pre-processing: adding padding bits
  4748. std::string msg = input;
  4749. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4750. msg.push_back(static_cast<char>(0x80u));
  4751. while (msg.size() % 64 != 56) {
  4752. msg.push_back(0);
  4753. }
  4754. // Append original length in bits as 64-bit big-endian
  4755. for (int i = 56; i >= 0; i -= 8) {
  4756. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4757. }
  4758. // Process each 512-bit chunk
  4759. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4760. uint32_t w[80];
  4761. for (size_t i = 0; i < 16; i++) {
  4762. w[i] =
  4763. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4764. << 24) |
  4765. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4766. << 16) |
  4767. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4768. << 8) |
  4769. (static_cast<uint32_t>(
  4770. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4771. }
  4772. for (int i = 16; i < 80; i++) {
  4773. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4774. }
  4775. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4776. for (int i = 0; i < 80; i++) {
  4777. uint32_t f, k;
  4778. if (i < 20) {
  4779. f = (b & c) | ((~b) & d);
  4780. k = 0x5A827999;
  4781. } else if (i < 40) {
  4782. f = b ^ c ^ d;
  4783. k = 0x6ED9EBA1;
  4784. } else if (i < 60) {
  4785. f = (b & c) | (b & d) | (c & d);
  4786. k = 0x8F1BBCDC;
  4787. } else {
  4788. f = b ^ c ^ d;
  4789. k = 0xCA62C1D6;
  4790. }
  4791. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4792. e = d;
  4793. d = c;
  4794. c = left_rotate(b, 30);
  4795. b = a;
  4796. a = temp;
  4797. }
  4798. h0 += a;
  4799. h1 += b;
  4800. h2 += c;
  4801. h3 += d;
  4802. h4 += e;
  4803. }
  4804. // Produce the final hash as a 20-byte binary string
  4805. std::string hash(20, '\0');
  4806. for (size_t i = 0; i < 4; i++) {
  4807. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4808. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4809. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4810. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4811. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4812. }
  4813. return hash;
  4814. }
  4815. inline std::string websocket_accept_key(const std::string &client_key) {
  4816. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4817. return base64_encode(sha1(client_key + magic));
  4818. }
  4819. inline bool is_websocket_upgrade(const Request &req) {
  4820. if (req.method != "GET") { return false; }
  4821. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4822. // list of protocols and asks recipients to match each name
  4823. // case-insensitively, so look for the token rather than compare the whole
  4824. // field value.
  4825. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4826. // Check Connection: Upgrade
  4827. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4828. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4829. // RFC 6455 Section 4.2.1
  4830. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4831. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4832. return false;
  4833. }
  4834. static const std::string b64chars =
  4835. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4836. for (size_t i = 0; i < 22; i++) {
  4837. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4838. }
  4839. // Check Sec-WebSocket-Version: 13
  4840. auto version = req.get_header_value("Sec-WebSocket-Version");
  4841. if (version != "13") { return false; }
  4842. return true;
  4843. }
  4844. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4845. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4846. thread_local std::random_device rd;
  4847. size_t filled = 0;
  4848. while (filled < n) {
  4849. auto v = rd();
  4850. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4851. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4852. }
  4853. }
  4854. }
  4855. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4856. const char *data, size_t len, bool fin,
  4857. bool mask) {
  4858. // First byte: FIN + opcode
  4859. uint8_t header[2];
  4860. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4861. (static_cast<uint8_t>(opcode) & 0x0F));
  4862. // Second byte: MASK + payload length
  4863. if (len < 126) {
  4864. header[1] = static_cast<uint8_t>(len);
  4865. if (mask) { header[1] |= 0x80; }
  4866. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4867. return false;
  4868. }
  4869. } else if (len <= 0xFFFF) {
  4870. header[1] = 126;
  4871. if (mask) { header[1] |= 0x80; }
  4872. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4873. return false;
  4874. }
  4875. uint8_t ext[2];
  4876. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4877. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4878. if (!write_data(strm, reinterpret_cast<char *>(ext), 2)) { return false; }
  4879. } else {
  4880. header[1] = 127;
  4881. if (mask) { header[1] |= 0x80; }
  4882. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4883. return false;
  4884. }
  4885. uint8_t ext[8];
  4886. for (int i = 7; i >= 0; i--) {
  4887. ext[7 - i] =
  4888. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4889. }
  4890. if (!write_data(strm, reinterpret_cast<char *>(ext), 8)) { return false; }
  4891. }
  4892. if (mask) {
  4893. // Generate random mask key
  4894. uint8_t mask_key[4];
  4895. fill_random_bytes(mask_key, sizeof(mask_key));
  4896. if (!write_data(strm, reinterpret_cast<char *>(mask_key), 4)) {
  4897. return false;
  4898. }
  4899. // Write masked payload in chunks
  4900. const size_t chunk_size = 4096;
  4901. std::vector<char> buf((std::min)(len, chunk_size));
  4902. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4903. size_t n = (std::min)(chunk_size, len - offset);
  4904. for (size_t i = 0; i < n; i++) {
  4905. buf[i] =
  4906. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4907. }
  4908. if (!write_data(strm, buf.data(), n)) { return false; }
  4909. }
  4910. } else {
  4911. if (len > 0) {
  4912. if (!write_data(strm, data, len)) { return false; }
  4913. }
  4914. }
  4915. return true;
  4916. }
  4917. } // namespace detail
  4918. namespace ws {
  4919. namespace impl {
  4920. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4921. // hands back whatever its buffer already holds -- so every multi-byte field has
  4922. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4923. // header straddles the read buffer's boundary.
  4924. //
  4925. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4926. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4927. // there is a failure like any other. (When read() fails it always records why,
  4928. // so the error belongs to this call and not to an earlier one.)
  4929. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4930. auto p = static_cast<char *>(buf);
  4931. size_t total = 0;
  4932. while (total < size) {
  4933. auto n = strm.read(p + total, size - total);
  4934. if (n <= 0) {
  4935. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4936. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4937. }
  4938. total += static_cast<size_t>(n);
  4939. }
  4940. return FrameRead::Ok;
  4941. }
  4942. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4943. std::string &payload, bool &fin,
  4944. bool expect_masked, size_t max_len) {
  4945. // Read first 2 bytes. This is the only read that may report a timeout: it
  4946. // sits on a frame boundary, where nothing has been consumed yet.
  4947. uint8_t header[2];
  4948. FrameRead first = read_exact(strm, header, 2);
  4949. if (first != FrameRead::Ok) { return first; }
  4950. fin = (header[0] & 0x80) != 0;
  4951. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4952. if (header[0] & 0x70) { return FrameRead::Fail; }
  4953. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4954. bool masked = (header[1] & 0x80) != 0;
  4955. uint64_t payload_len = header[1] & 0x7F;
  4956. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4957. // MUST have a payload length of 125 bytes or less
  4958. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4959. if (is_control) {
  4960. if (!fin) { return FrameRead::Fail; }
  4961. if (payload_len > 125) { return FrameRead::Fail; }
  4962. }
  4963. if (masked != expect_masked) { return FrameRead::Fail; }
  4964. // Extended payload length
  4965. if (payload_len == 126) {
  4966. uint8_t ext[2];
  4967. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4968. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4969. } else if (payload_len == 127) {
  4970. uint8_t ext[8];
  4971. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4972. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4973. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4974. payload_len = 0;
  4975. for (int i = 0; i < 8; i++) {
  4976. payload_len = (payload_len << 8) | ext[i];
  4977. }
  4978. }
  4979. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4980. // size_t cannot hold (32-bit builds) is refused either way.
  4981. if ((max_len > 0 && payload_len > max_len) ||
  4982. !detail::fits_in_size_t(payload_len)) {
  4983. return FrameRead::Fail;
  4984. }
  4985. // Read mask key if present
  4986. uint8_t mask_key[4] = {0};
  4987. if (masked) {
  4988. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4989. return FrameRead::Fail;
  4990. }
  4991. }
  4992. // Grow the payload only as it arrives, since a header alone can announce
  4993. // max_len bytes that never come.
  4994. payload.clear();
  4995. auto len = static_cast<size_t>(payload_len);
  4996. while (payload.size() < len) {
  4997. auto offset = payload.size();
  4998. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4999. payload.resize(offset + n);
  5000. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  5001. return FrameRead::Fail;
  5002. }
  5003. }
  5004. // Unmask if needed
  5005. if (masked) {
  5006. for (size_t i = 0; i < payload.size(); i++) {
  5007. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  5008. }
  5009. }
  5010. return FrameRead::Ok;
  5011. }
  5012. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  5013. // be sent followed by a UTF-8 reason.
  5014. inline bool is_valid_close_payload(const std::string &payload) {
  5015. if (payload.empty()) { return true; }
  5016. if (payload.size() < 2) { return false; }
  5017. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  5018. static_cast<uint8_t>(payload[1]);
  5019. auto may_be_sent = (1000 <= code && code <= 1003) ||
  5020. (1007 <= code && code <= 1014) ||
  5021. (3000 <= code && code <= 4999);
  5022. return may_be_sent && is_valid_utf8(payload.substr(2));
  5023. }
  5024. } // namespace impl
  5025. } // namespace ws
  5026. namespace detail {
  5027. // A path a mount point serves: absolute, with no empty segment except a
  5028. // trailing '/', no segment ending in '.' or a space (which covers "." and
  5029. // ".." and names Windows trims into another file's name) and, on Windows, no
  5030. // ':' (which names an NTFS stream, so "a.txt::$DATA" is a.txt), so the file
  5031. // served is the one that req.path names to the handlers that ran before it.
  5032. inline bool is_valid_path(const std::string &path) {
  5033. if (path.empty() || path[0] != '/') { return false; }
  5034. auto beg = size_t{1};
  5035. for (auto i = beg; i <= path.size(); i++) {
  5036. if (i < path.size() && path[i] != '/') {
  5037. if (path[i] == '\0' || path[i] == '\\') { return false; }
  5038. #ifdef _WIN32
  5039. if (path[i] == ':') { return false; }
  5040. #endif
  5041. continue;
  5042. }
  5043. auto len = i - beg;
  5044. if ((len == 0 && i < path.size()) ||
  5045. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5046. return false;
  5047. }
  5048. beg = i + 1;
  5049. }
  5050. return true;
  5051. }
  5052. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5053. #if defined(_WIN32)
  5054. char buf[_MAX_PATH];
  5055. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  5056. resolved = buf;
  5057. #elif defined(PATH_MAX)
  5058. char buf[PATH_MAX];
  5059. if (realpath(path, buf) == nullptr) { return false; }
  5060. resolved = buf;
  5061. #else
  5062. auto buf = realpath(path, nullptr);
  5063. auto guard = scope_exit([&]() { std::free(buf); });
  5064. if (buf == nullptr) { return false; }
  5065. resolved = buf;
  5066. #endif
  5067. return true;
  5068. }
  5069. inline bool is_path_within_base(const std::string &resolved_path,
  5070. const std::string &resolved_base) {
  5071. #if defined(_WIN32)
  5072. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5073. resolved_base.size()) == 0;
  5074. #else
  5075. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5076. resolved_base.size()) == 0;
  5077. #endif
  5078. }
  5079. inline FileStat::FileStat(const std::string &path) {
  5080. #if defined(_WIN32)
  5081. auto wpath = u8string_to_wstring(path.c_str());
  5082. ret_ = _wstat(wpath.c_str(), &st_);
  5083. #else
  5084. ret_ = stat(path.c_str(), &st_);
  5085. #endif
  5086. }
  5087. inline bool FileStat::is_file() const {
  5088. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5089. }
  5090. inline bool FileStat::is_dir() const {
  5091. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5092. }
  5093. inline time_t FileStat::mtime() const {
  5094. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5095. : static_cast<time_t>(-1);
  5096. }
  5097. inline size_t FileStat::size() const {
  5098. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5099. }
  5100. inline std::string encode_path(const std::string &s) {
  5101. std::string result;
  5102. result.reserve(s.size());
  5103. for (size_t i = 0; s[i]; i++) {
  5104. switch (s[i]) {
  5105. case ' ': result += "%20"; break;
  5106. case '+': result += "%2B"; break;
  5107. case '\'': result += "%27"; break;
  5108. case ',': result += "%2C"; break;
  5109. // case ':': result += "%3A"; break; // ok? probably...
  5110. case ';': result += "%3B"; break;
  5111. default:
  5112. auto c = static_cast<uint8_t>(s[i]);
  5113. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5114. // in a request-target as-is.
  5115. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5116. result += '%';
  5117. char hex[4];
  5118. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5119. assert(len == 2);
  5120. result.append(hex, static_cast<size_t>(len));
  5121. } else {
  5122. result += s[i];
  5123. }
  5124. break;
  5125. }
  5126. }
  5127. return result;
  5128. }
  5129. inline std::string file_extension(const std::string &path) {
  5130. auto i = path.size();
  5131. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5132. i--;
  5133. }
  5134. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5135. return std::string();
  5136. }
  5137. return path.substr(i);
  5138. }
  5139. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5140. template <typename T>
  5141. inline bool parse_header(const char *beg, const char *end, T fn);
  5142. template <typename T>
  5143. inline bool parse_header(const char *beg, const char *end, T fn) {
  5144. // Skip trailing spaces and tabs.
  5145. while (beg < end && is_space_or_tab(end[-1])) {
  5146. end--;
  5147. }
  5148. auto p = beg;
  5149. while (p < end && *p != ':') {
  5150. p++;
  5151. }
  5152. auto name = std::string(beg, p);
  5153. if (!detail::fields::is_field_name(name)) { return false; }
  5154. if (p == end) { return false; }
  5155. auto key_end = p;
  5156. if (*p++ != ':') { return false; }
  5157. while (p < end && is_space_or_tab(*p)) {
  5158. p++;
  5159. }
  5160. if (p <= end) {
  5161. auto key_len = key_end - beg;
  5162. if (!key_len) { return false; }
  5163. auto key = std::string(beg, key_end);
  5164. auto val = std::string(p, end);
  5165. if (!detail::fields::is_field_value(val)) { return false; }
  5166. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5167. // percent-decoded by the recipient. Applications that need to interpret a
  5168. // value as a URI component should call httplib::decode_uri_component()
  5169. // (or decode_path_component()) explicitly.
  5170. fn(key, val);
  5171. return true;
  5172. }
  5173. return false;
  5174. }
  5175. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5176. const Headers &src_headers) {
  5177. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5178. // transfer coding is complete when a chunk with a chunk-size of zero is
  5179. // received, possibly followed by a trailer section, and finally terminated by
  5180. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5181. //
  5182. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5183. // doesn't care for the existence of the final CRLF. In other words, it seems
  5184. // to be ok whether the final CRLF exists or not in the chunked data.
  5185. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5186. //
  5187. // According to the reference code in RFC 9112, cpp-httplib now allows
  5188. // chunked transfer coding data without the final CRLF.
  5189. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5190. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5191. "transfer-encoding",
  5192. "content-length",
  5193. "host",
  5194. "authorization",
  5195. "www-authenticate",
  5196. "proxy-authenticate",
  5197. "proxy-authorization",
  5198. "cookie",
  5199. "set-cookie",
  5200. "cache-control",
  5201. "expect",
  5202. "max-forwards",
  5203. "pragma",
  5204. "range",
  5205. "te",
  5206. "age",
  5207. "expires",
  5208. "date",
  5209. "location",
  5210. "retry-after",
  5211. "vary",
  5212. "warning",
  5213. "content-encoding",
  5214. "content-type",
  5215. "content-range",
  5216. "trailer"};
  5217. case_ignore::unordered_set<std::string> declared_trailers;
  5218. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5219. if (!trailer_header.empty()) {
  5220. // split() trims each token and skips empty ones, so the name arrives ready
  5221. // to look up.
  5222. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5223. ',', [&](const char *b, const char *e) {
  5224. // A legitimate message declares only a handful of trailers. Cap the
  5225. // set so a peer cannot grow it without bound: an oversized set only
  5226. // arises from an attempt to force many colliding names into
  5227. // quadratic lookups (case_ignore::hash is unkeyed).
  5228. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5229. return;
  5230. }
  5231. std::string key(b, e);
  5232. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5233. declared_trailers.insert(key);
  5234. }
  5235. });
  5236. }
  5237. size_t trailer_header_count = 0;
  5238. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5239. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5240. // Count every received trailer field, not only the declared ones stored in
  5241. // dest, so undeclared fields cannot keep this loop running past the limit.
  5242. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5243. constexpr auto line_terminator_len = 2;
  5244. auto line_beg = line_reader.ptr();
  5245. auto line_end =
  5246. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5247. if (!parse_header(line_beg, line_end,
  5248. [&](const std::string &key, const std::string &val) {
  5249. if (declared_trailers.find(key) !=
  5250. declared_trailers.end()) {
  5251. dest.emplace(key, val);
  5252. }
  5253. })) {
  5254. return false;
  5255. }
  5256. trailer_header_count++;
  5257. if (!line_reader.getline()) { return false; }
  5258. }
  5259. return true;
  5260. }
  5261. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5262. size_t right) {
  5263. while (b + left < e && is_space_or_tab(b[left])) {
  5264. left++;
  5265. }
  5266. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5267. right--;
  5268. }
  5269. return std::make_pair(left, right);
  5270. }
  5271. inline std::string trim_copy(const std::string &s) {
  5272. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5273. return s.substr(r.first, r.second - r.first);
  5274. }
  5275. inline std::string trim_double_quotes_copy(const std::string &s) {
  5276. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5277. return s.substr(1, s.size() - 2);
  5278. }
  5279. return s;
  5280. }
  5281. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5282. // here, as browsers send any other backslash, such as one in a Windows path,
  5283. // as it is.
  5284. inline std::string unquote_param(const std::string &s) {
  5285. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5286. std::string out;
  5287. for (size_t i = 1; i + 1 < s.size(); i++) {
  5288. if (s[i] == '\\' && i + 2 < s.size() &&
  5289. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5290. i++;
  5291. }
  5292. out += s[i];
  5293. }
  5294. return out;
  5295. }
  5296. inline void
  5297. divide(const char *data, std::size_t size, char d,
  5298. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5299. fn) {
  5300. const auto it = std::find(data, data + size, d);
  5301. const auto found = static_cast<std::size_t>(it != data + size);
  5302. const auto lhs_data = data;
  5303. const auto lhs_size = static_cast<std::size_t>(it - data);
  5304. const auto rhs_data = it + found;
  5305. const auto rhs_size = size - lhs_size - found;
  5306. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5307. }
  5308. inline void
  5309. divide(const std::string &str, char d,
  5310. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5311. fn) {
  5312. divide(str.data(), str.size(), d, std::move(fn));
  5313. }
  5314. inline void split(const char *b, const char *e, char d,
  5315. std::function<void(const char *, const char *)> fn) {
  5316. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5317. }
  5318. inline void split(const char *b, const char *e, char d, size_t m,
  5319. std::function<void(const char *, const char *)> fn) {
  5320. size_t i = 0;
  5321. size_t beg = 0;
  5322. size_t count = 1;
  5323. while (e ? (b + i < e) : (b[i] != '\0')) {
  5324. if (b[i] == d && count < m) {
  5325. auto r = trim(b, e, beg, i);
  5326. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5327. beg = i + 1;
  5328. count++;
  5329. }
  5330. i++;
  5331. }
  5332. if (i) {
  5333. auto r = trim(b, e, beg, i);
  5334. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5335. }
  5336. }
  5337. // Same contract as split(), except that a delimiter inside a quoted-string is
  5338. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5339. // quoted-string, and ';' and '=' are legal characters inside one.
  5340. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5341. std::function<void(const char *, const char *)> fn) {
  5342. size_t i = 0;
  5343. size_t beg = 0;
  5344. size_t count = 1;
  5345. auto in_quotes = false;
  5346. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5347. while (has(i)) {
  5348. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5349. // A quoted-pair, whose second character does not end the string.
  5350. i++;
  5351. } else if (b[i] == '"') {
  5352. in_quotes = !in_quotes;
  5353. } else if (b[i] == d && !in_quotes && count < m) {
  5354. auto r = trim(b, e, beg, i);
  5355. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5356. beg = i + 1;
  5357. count++;
  5358. }
  5359. i++;
  5360. }
  5361. if (i) {
  5362. auto r = trim(b, e, beg, i);
  5363. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5364. }
  5365. }
  5366. inline void split_unquoted(const char *b, const char *e, char d,
  5367. std::function<void(const char *, const char *)> fn) {
  5368. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5369. std::move(fn));
  5370. }
  5371. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5372. // key a token, so the first '=' is the separator even when the value is a
  5373. // quoted-string carrying more of them.
  5374. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5375. std::string &val) {
  5376. divide(
  5377. b, static_cast<std::size_t>(e - b), '=',
  5378. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5379. const auto kr = trim(kb, kb + klen, 0, klen);
  5380. key.assign(kb + kr.first, kb + kr.second);
  5381. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5382. val.assign(vb + vr.first, vb + vr.second);
  5383. });
  5384. }
  5385. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5386. std::function<bool(const char *, const char *)> fn) {
  5387. size_t i = 0;
  5388. size_t beg = 0;
  5389. size_t count = 1;
  5390. while (e ? (b + i < e) : (b[i] != '\0')) {
  5391. if (b[i] == d && count < m) {
  5392. auto r = trim(b, e, beg, i);
  5393. if (r.first < r.second) {
  5394. auto found = fn(&b[r.first], &b[r.second]);
  5395. if (found) { return true; }
  5396. }
  5397. beg = i + 1;
  5398. count++;
  5399. }
  5400. i++;
  5401. }
  5402. if (i) {
  5403. auto r = trim(b, e, beg, i);
  5404. if (r.first < r.second) {
  5405. auto found = fn(&b[r.first], &b[r.second]);
  5406. if (found) { return true; }
  5407. }
  5408. }
  5409. return false;
  5410. }
  5411. inline bool split_find(const char *b, const char *e, char d,
  5412. std::function<bool(const char *, const char *)> fn) {
  5413. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5414. std::move(fn));
  5415. }
  5416. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5417. size_t fixed_buffer_size)
  5418. : strm_(strm), fixed_buffer_(fixed_buffer),
  5419. fixed_buffer_size_(fixed_buffer_size) {}
  5420. inline const char *stream_line_reader::ptr() const {
  5421. if (growable_buffer_.empty()) {
  5422. return fixed_buffer_;
  5423. } else {
  5424. return growable_buffer_.data();
  5425. }
  5426. }
  5427. inline size_t stream_line_reader::size() const {
  5428. if (growable_buffer_.empty()) {
  5429. return fixed_buffer_used_size_;
  5430. } else {
  5431. return growable_buffer_.size();
  5432. }
  5433. }
  5434. inline bool stream_line_reader::end_with_crlf() const {
  5435. auto end = ptr() + size();
  5436. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5437. }
  5438. inline bool stream_line_reader::getline() {
  5439. fixed_buffer_used_size_ = 0;
  5440. growable_buffer_.clear();
  5441. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5442. char prev_byte = 0;
  5443. #endif
  5444. for (size_t i = 0;; i++) {
  5445. // Fast path: whatever the stream has already buffered can be scanned for
  5446. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5447. // call, a bounds check and a one-byte copy per character of the request.
  5448. size_t buffered_size = 0;
  5449. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5450. auto take = buffered_size;
  5451. auto terminated = false;
  5452. for (size_t at = 0; at < buffered_size;) {
  5453. auto nl = static_cast<const char *>(
  5454. memchr(buffered + at, '\n', buffered_size - at));
  5455. if (!nl) { break; }
  5456. auto pos = static_cast<size_t>(nl - buffered);
  5457. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5458. take = pos + 1;
  5459. terminated = true;
  5460. break;
  5461. #else
  5462. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5463. // be the last byte of an earlier chunk, hence prev_byte.
  5464. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5465. take = pos + 1;
  5466. terminated = true;
  5467. break;
  5468. }
  5469. at = pos + 1;
  5470. #endif
  5471. }
  5472. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5473. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5474. prev_byte = buffered[take - 1];
  5475. #endif
  5476. append(buffered, take);
  5477. strm_.consume_buffered(take);
  5478. i += take;
  5479. if (terminated) { return true; }
  5480. continue;
  5481. }
  5482. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5483. // Treat exceptionally long lines as an error to
  5484. // prevent infinite loops/memory exhaustion
  5485. return false;
  5486. }
  5487. char byte;
  5488. auto n = strm_.read(&byte, 1);
  5489. if (n < 0) {
  5490. return false;
  5491. } else if (n == 0) {
  5492. if (i == 0) {
  5493. return false;
  5494. } else {
  5495. break;
  5496. }
  5497. }
  5498. append(byte);
  5499. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5500. if (byte == '\n') { break; }
  5501. #else
  5502. if (prev_byte == '\r' && byte == '\n') { break; }
  5503. prev_byte = byte;
  5504. #endif
  5505. }
  5506. return true;
  5507. }
  5508. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5509. inline void stream_line_reader::append(const char *data, size_t size) {
  5510. // Once the line has outgrown the fixed buffer everything must keep going to
  5511. // the growable one, even if a later chunk would have fit. Without the
  5512. // emptiness check a short append after a long one would land in the fixed
  5513. // buffer, which ptr() and size() no longer look at, and be lost.
  5514. if (growable_buffer_.empty() &&
  5515. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5516. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5517. fixed_buffer_used_size_ += size;
  5518. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5519. } else {
  5520. // Unlike the per-character overload, this can be the very first append of
  5521. // the line, so the fixed buffer may hold nothing and carry no terminator
  5522. // yet. assign() takes an explicit length and does not need one.
  5523. if (growable_buffer_.empty()) {
  5524. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5525. }
  5526. growable_buffer_.append(data, size);
  5527. }
  5528. }
  5529. inline mmap::mmap(const char *path) { open(path); }
  5530. inline mmap::~mmap() { close(); }
  5531. inline bool mmap::open(const char *path) {
  5532. close();
  5533. #if defined(_WIN32)
  5534. auto wpath = u8string_to_wstring(path);
  5535. if (wpath.empty()) { return false; }
  5536. hFile_ =
  5537. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5538. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5539. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5540. LARGE_INTEGER size{};
  5541. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5542. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5543. // See:
  5544. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5545. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5546. size_ = static_cast<size_t>(size.QuadPart);
  5547. hMapping_ =
  5548. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5549. // Special treatment for an empty file...
  5550. if (hMapping_ == NULL && size_ == 0) {
  5551. close();
  5552. is_open_empty_file = true;
  5553. return true;
  5554. }
  5555. if (hMapping_ == NULL) {
  5556. close();
  5557. return false;
  5558. }
  5559. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5560. if (addr_ == nullptr) {
  5561. close();
  5562. return false;
  5563. }
  5564. #else
  5565. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5566. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5567. if (fd_ == -1) { return false; }
  5568. // Only a regular file has a size to serve, unlike a directory or a device.
  5569. struct stat sb;
  5570. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5571. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5572. close();
  5573. return false;
  5574. }
  5575. size_ = static_cast<size_t>(sb.st_size);
  5576. #endif
  5577. return true;
  5578. }
  5579. inline bool mmap::is_open() const {
  5580. #if defined(_WIN32)
  5581. return is_open_empty_file ? true : addr_ != nullptr;
  5582. #else
  5583. return fd_ != -1;
  5584. #endif
  5585. }
  5586. inline size_t mmap::size() const { return size_; }
  5587. inline void mmap::close() {
  5588. #if defined(_WIN32)
  5589. if (addr_) {
  5590. ::UnmapViewOfFile(addr_);
  5591. addr_ = nullptr;
  5592. }
  5593. if (hMapping_) {
  5594. ::CloseHandle(hMapping_);
  5595. hMapping_ = NULL;
  5596. }
  5597. if (hFile_ != INVALID_HANDLE_VALUE) {
  5598. ::CloseHandle(hFile_);
  5599. hFile_ = INVALID_HANDLE_VALUE;
  5600. }
  5601. is_open_empty_file = false;
  5602. #else
  5603. if (fd_ != -1) {
  5604. ::close(fd_);
  5605. fd_ = -1;
  5606. }
  5607. #endif
  5608. size_ = 0;
  5609. }
  5610. inline int close_socket(socket_t sock) noexcept {
  5611. #ifdef _WIN32
  5612. return closesocket(sock);
  5613. #else
  5614. return close(sock);
  5615. #endif
  5616. }
  5617. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5618. ssize_t res = 0;
  5619. while (true) {
  5620. res = fn();
  5621. if (res < 0 && errno == EINTR) {
  5622. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5623. continue;
  5624. }
  5625. break;
  5626. }
  5627. return res;
  5628. }
  5629. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5630. if (offset >= size_) { return 0; }
  5631. len = (std::min)(len, size_ - offset);
  5632. #if defined(_WIN32)
  5633. // Windows does not let a mapped file be truncated.
  5634. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5635. return len;
  5636. #else
  5637. auto n = handle_EINTR(
  5638. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5639. return n > 0 ? static_cast<size_t>(n) : 0;
  5640. #endif
  5641. }
  5642. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5643. return handle_EINTR([&]() {
  5644. return recv(sock,
  5645. #ifdef _WIN32
  5646. static_cast<char *>(ptr), static_cast<int>(size),
  5647. #else
  5648. ptr, size,
  5649. #endif
  5650. flags);
  5651. });
  5652. }
  5653. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5654. int flags) {
  5655. return handle_EINTR([&]() {
  5656. return send(sock,
  5657. #ifdef _WIN32
  5658. static_cast<const char *>(ptr), static_cast<int>(size),
  5659. #else
  5660. ptr, size,
  5661. #endif
  5662. flags);
  5663. });
  5664. }
  5665. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5666. #ifdef _WIN32
  5667. return ::WSAPoll(fds, nfds, timeout);
  5668. #else
  5669. return ::poll(fds, nfds, timeout);
  5670. #endif
  5671. }
  5672. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5673. time_t usec) {
  5674. struct pollfd pfd;
  5675. pfd.fd = sock;
  5676. pfd.events = events;
  5677. pfd.revents = 0;
  5678. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5679. // "return immediately", which callers here rely on to probe a socket.
  5680. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5681. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5682. }
  5683. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5684. return select_impl(sock, POLLIN, sec, usec);
  5685. }
  5686. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5687. return select_impl(sock, POLLOUT, sec, usec);
  5688. }
  5689. // The point sec and usec from now, for select_until(). A negative sec never
  5690. // comes, as a negative timeout waits forever in select_impl().
  5691. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5692. time_t usec) {
  5693. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5694. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5695. std::chrono::microseconds(usec);
  5696. }
  5697. // Waits only for the time left until deadline, so that all the waits of one
  5698. // TLS handshake come out of a single timeout.
  5699. inline ssize_t select_until(socket_t sock, short events,
  5700. std::chrono::steady_clock::time_point deadline) {
  5701. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5702. return select_impl(sock, events, -1, 0);
  5703. }
  5704. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5705. deadline - std::chrono::steady_clock::now())
  5706. .count();
  5707. if (left <= 0) { return 0; }
  5708. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5709. static_cast<time_t>(left % 1000000));
  5710. }
  5711. // select_read(), but waits in slices and gives up once interrupted() returns
  5712. // true. A local shutdown() would not wake the wait on Windows.
  5713. inline ssize_t
  5714. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5715. const std::function<bool()> &interrupted) {
  5716. if (!interrupted) { return select_read(sock, sec, usec); }
  5717. const auto slice = std::chrono::microseconds(100000);
  5718. auto deadline = deadline_after(sec, usec);
  5719. while (!interrupted()) {
  5720. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5721. deadline - std::chrono::steady_clock::now());
  5722. auto last = left < slice;
  5723. // poll() takes whole milliseconds, so round the last wait up to keep it
  5724. // from ending before the deadline.
  5725. auto wait_usec = last ? (std::max)((left.count() + 999) / 1000 * 1000,
  5726. static_cast<decltype(left.count())>(0))
  5727. : slice.count();
  5728. auto ret = select_impl(sock, POLLIN, 0, static_cast<time_t>(wait_usec));
  5729. if (ret != 0 || last) { return ret; }
  5730. }
  5731. return 0;
  5732. }
  5733. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5734. time_t usec) {
  5735. struct pollfd pfd_read;
  5736. pfd_read.fd = sock;
  5737. pfd_read.events = POLLIN | POLLOUT;
  5738. pfd_read.revents = 0;
  5739. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5740. auto poll_res =
  5741. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5742. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5743. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5744. auto error = 0;
  5745. socklen_t len = sizeof(error);
  5746. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5747. reinterpret_cast<char *>(&error), &len);
  5748. auto successful = res >= 0 && !error;
  5749. return successful ? Error::Success : Error::Connection;
  5750. }
  5751. return Error::Connection;
  5752. }
  5753. inline bool is_socket_alive(socket_t sock) {
  5754. const auto val = detail::select_read(sock, 0, 0);
  5755. if (val == 0) {
  5756. return true;
  5757. } else if (val < 0 && errno == EBADF) {
  5758. return false;
  5759. }
  5760. char buf[1];
  5761. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5762. }
  5763. class SocketStream final : public Stream {
  5764. public:
  5765. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5766. time_t write_timeout_sec, time_t write_timeout_usec,
  5767. time_t max_timeout_msec = 0,
  5768. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5769. (std::chrono::steady_clock::time_point::min)());
  5770. ~SocketStream() override;
  5771. bool is_readable() const override;
  5772. bool wait_readable() const override;
  5773. bool wait_writable() const override;
  5774. bool is_peer_alive() const override;
  5775. ssize_t read(char *ptr, size_t size) override;
  5776. ssize_t write(const char *ptr, size_t size) override;
  5777. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5778. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5779. socket_t socket() const override;
  5780. time_t duration() const override;
  5781. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5782. void set_max_timeout(time_t msec) override;
  5783. void set_read_interrupt(std::function<bool()> interrupted) override;
  5784. const char *buffered_data(size_t &size) const override;
  5785. void consume_buffered(size_t size) override;
  5786. // The caller has just seen this socket become readable. Lets the next read
  5787. // skip its own readiness wait, which would otherwise ask the kernel a
  5788. // question that was answered a moment ago. Consumed by that read.
  5789. void set_readable_hint() { readable_hint_ = true; }
  5790. private:
  5791. bool ensure_readable();
  5792. socket_t sock_;
  5793. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5794. // thread while a read is in flight -- that is the point of it, for a caller
  5795. // holding one connection and wanting control back to send on it.
  5796. std::atomic<time_t> read_timeout_sec_;
  5797. std::atomic<time_t> read_timeout_usec_;
  5798. time_t write_timeout_sec_;
  5799. time_t write_timeout_usec_;
  5800. time_t max_timeout_msec_;
  5801. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5802. std::function<bool()> read_interrupted_;
  5803. std::vector<char> read_buff_;
  5804. size_t read_buff_off_ = 0;
  5805. size_t read_buff_content_size_ = 0;
  5806. bool readable_hint_ = false;
  5807. static const size_t read_buff_size_ = 1024l * 4;
  5808. };
  5809. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5810. time_t keep_alive_timeout_sec) {
  5811. using namespace std::chrono;
  5812. const auto interval_usec =
  5813. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5814. // Avoid expensive `steady_clock::now()` call for the first time
  5815. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5816. const auto start = steady_clock::now() - microseconds{interval_usec};
  5817. const auto timeout = seconds{keep_alive_timeout_sec};
  5818. while (true) {
  5819. if (svr_sock == INVALID_SOCKET) {
  5820. break; // Server socket is closed
  5821. }
  5822. auto val = select_read(sock, 0, interval_usec);
  5823. if (val < 0) {
  5824. break; // Ssocket error
  5825. } else if (val == 0) {
  5826. if (steady_clock::now() - start > timeout) {
  5827. break; // Timeout
  5828. }
  5829. } else {
  5830. return true; // Ready for read
  5831. }
  5832. }
  5833. return false;
  5834. }
  5835. // `has_buffered_request` reports whether the connection's stream already holds
  5836. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5837. // 9.3.2), so reading one request can pull the start of the next one into the
  5838. // stream's buffer; that request must be served without waiting for the socket
  5839. // to become readable again, since its bytes are no longer on the socket.
  5840. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5841. template <typename P, typename T>
  5842. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5843. socket_t sock,
  5844. size_t keep_alive_max_count,
  5845. time_t keep_alive_timeout_sec,
  5846. P has_buffered_request, T callback) {
  5847. auto ret = false;
  5848. // A keep_alive_max_count of 0 sets no limit.
  5849. for (size_t served = 0;
  5850. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5851. auto socket_readable = false;
  5852. if (!has_buffered_request()) {
  5853. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5854. socket_readable = true;
  5855. }
  5856. auto close_connection = served + 1 == keep_alive_max_count;
  5857. auto connection_closed = false;
  5858. ret = callback(socket_readable, close_connection, connection_closed);
  5859. if (!ret || connection_closed) { break; }
  5860. }
  5861. return ret;
  5862. }
  5863. template <typename T>
  5864. inline bool
  5865. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5866. size_t keep_alive_max_count,
  5867. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5868. time_t read_timeout_usec, time_t write_timeout_sec,
  5869. time_t write_timeout_usec, T callback) {
  5870. // One stream per connection: its read buffer can already hold the start of
  5871. // the next, pipelined request.
  5872. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5873. write_timeout_sec, write_timeout_usec);
  5874. return process_server_socket_core(
  5875. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5876. [&]() { return strm.is_readable(); },
  5877. [&](bool socket_readable, bool close_connection,
  5878. bool &connection_closed) {
  5879. if (socket_readable) { strm.set_readable_hint(); }
  5880. return callback(strm, close_connection, connection_closed);
  5881. });
  5882. }
  5883. inline bool process_client_socket(
  5884. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5885. time_t write_timeout_sec, time_t write_timeout_usec,
  5886. time_t max_timeout_msec,
  5887. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5888. std::function<bool(Stream &)> callback) {
  5889. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5890. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5891. start_time);
  5892. return callback(strm);
  5893. }
  5894. inline int shutdown_socket(socket_t sock) noexcept {
  5895. #ifdef _WIN32
  5896. return shutdown(sock, SD_BOTH);
  5897. #else
  5898. return shutdown(sock, SHUT_RDWR);
  5899. #endif
  5900. }
  5901. // Half-closes the write side and drains any in-flight/queued bytes before
  5902. // the final shutdown+close. Closing with unread data in the receive queue
  5903. // (or bytes arriving after the receive side is closed) makes the stack send
  5904. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5905. // response as a failed read even though it was fully written.
  5906. inline void drain_and_close_socket(socket_t sock) noexcept {
  5907. #ifdef _WIN32
  5908. shutdown(sock, SD_SEND);
  5909. #else
  5910. shutdown(sock, SHUT_WR);
  5911. #endif
  5912. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5913. size_t total = 0;
  5914. const auto deadline = std::chrono::steady_clock::now() +
  5915. std::chrono::milliseconds(100); // bound #1
  5916. while (total < size_t(1024u * 1024u)) { // bound #2
  5917. const auto remaining =
  5918. std::chrono::duration_cast<std::chrono::microseconds>(
  5919. deadline - std::chrono::steady_clock::now())
  5920. .count();
  5921. if (remaining <= 0) { break; }
  5922. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5923. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5924. if (n <= 0) { break; }
  5925. total += static_cast<size_t>(n);
  5926. }
  5927. shutdown_socket(sock);
  5928. close_socket(sock);
  5929. }
  5930. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5931. if (s.size() > 1 && s[0] == '\0') {
  5932. auto ret = s;
  5933. ret[0] = '@';
  5934. return ret;
  5935. }
  5936. return s;
  5937. }
  5938. inline std::string
  5939. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5940. if (s.size() > 1 && s[0] == '@') {
  5941. auto ret = s;
  5942. ret[0] = '\0';
  5943. return ret;
  5944. }
  5945. return s;
  5946. }
  5947. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5948. const struct addrinfo *hints,
  5949. struct addrinfo **res, time_t timeout_sec) {
  5950. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5951. if (timeout_sec <= 0) {
  5952. // No timeout specified, use standard getaddrinfo
  5953. return getaddrinfo(node, service, hints, res);
  5954. }
  5955. #ifdef _WIN32
  5956. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5957. OVERLAPPED overlapped = {};
  5958. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5959. if (!event) { return EAI_FAIL; }
  5960. overlapped.hEvent = event;
  5961. PADDRINFOEXW result_addrinfo = nullptr;
  5962. HANDLE cancel_handle = nullptr;
  5963. ADDRINFOEXW hints_ex = {};
  5964. if (hints) {
  5965. hints_ex.ai_flags = hints->ai_flags;
  5966. hints_ex.ai_family = hints->ai_family;
  5967. hints_ex.ai_socktype = hints->ai_socktype;
  5968. hints_ex.ai_protocol = hints->ai_protocol;
  5969. }
  5970. auto wnode = u8string_to_wstring(node);
  5971. auto wservice = u8string_to_wstring(service);
  5972. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5973. hints ? &hints_ex : nullptr, &result_addrinfo,
  5974. nullptr, &overlapped, nullptr, &cancel_handle);
  5975. if (ret == WSA_IO_PENDING) {
  5976. auto wait_result =
  5977. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5978. if (wait_result == WAIT_TIMEOUT) {
  5979. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5980. ::CloseHandle(event);
  5981. return EAI_AGAIN;
  5982. }
  5983. DWORD bytes_returned;
  5984. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5985. &bytes_returned, FALSE)) {
  5986. ::CloseHandle(event);
  5987. return ::WSAGetLastError();
  5988. }
  5989. }
  5990. ::CloseHandle(event);
  5991. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5992. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5993. return 0;
  5994. }
  5995. return ret;
  5996. #elif TARGET_OS_MAC && defined(__clang__)
  5997. if (!node) { return EAI_NONAME; }
  5998. // macOS implementation using CFHost API for asynchronous DNS resolution
  5999. CFStringRef hostname_ref = CFStringCreateWithCString(
  6000. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  6001. if (!hostname_ref) { return EAI_MEMORY; }
  6002. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  6003. CFRelease(hostname_ref);
  6004. if (!host_ref) { return EAI_MEMORY; }
  6005. // Set up context for callback
  6006. struct CFHostContext {
  6007. bool completed = false;
  6008. bool success = false;
  6009. CFArrayRef addresses = nullptr;
  6010. std::mutex mutex;
  6011. std::condition_variable cv;
  6012. } context;
  6013. CFHostClientContext client_context;
  6014. memset(&client_context, 0, sizeof(client_context));
  6015. client_context.info = &context;
  6016. // Set callback
  6017. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  6018. const CFStreamError *error, void *info) {
  6019. auto ctx = static_cast<CFHostContext *>(info);
  6020. std::lock_guard<std::mutex> lock(ctx->mutex);
  6021. if (error && error->error != 0) {
  6022. ctx->success = false;
  6023. } else {
  6024. Boolean hasBeenResolved;
  6025. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6026. if (ctx->addresses && hasBeenResolved) {
  6027. CFRetain(ctx->addresses);
  6028. ctx->success = true;
  6029. } else {
  6030. ctx->success = false;
  6031. }
  6032. }
  6033. ctx->completed = true;
  6034. ctx->cv.notify_one();
  6035. };
  6036. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6037. CFRelease(host_ref);
  6038. return EAI_SYSTEM;
  6039. }
  6040. // Schedule on run loop
  6041. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6042. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6043. // Start resolution
  6044. CFStreamError stream_error;
  6045. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6046. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6047. CFRelease(host_ref);
  6048. return EAI_FAIL;
  6049. }
  6050. // Wait for completion with timeout
  6051. auto timeout_time =
  6052. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6053. bool timed_out = false;
  6054. {
  6055. std::unique_lock<std::mutex> lock(context.mutex);
  6056. while (!context.completed) {
  6057. auto now = std::chrono::steady_clock::now();
  6058. if (now >= timeout_time) {
  6059. timed_out = true;
  6060. break;
  6061. }
  6062. // Run the runloop for a short time
  6063. lock.unlock();
  6064. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6065. lock.lock();
  6066. }
  6067. }
  6068. // Clean up
  6069. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6070. CFHostSetClient(host_ref, nullptr, nullptr);
  6071. if (timed_out || !context.completed) {
  6072. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6073. CFRelease(host_ref);
  6074. return EAI_AGAIN;
  6075. }
  6076. if (!context.success || !context.addresses) {
  6077. CFRelease(host_ref);
  6078. return EAI_NODATA;
  6079. }
  6080. // Convert CFArray to addrinfo
  6081. CFIndex count = CFArrayGetCount(context.addresses);
  6082. if (count == 0) {
  6083. CFRelease(context.addresses);
  6084. CFRelease(host_ref);
  6085. return EAI_NODATA;
  6086. }
  6087. struct addrinfo *result_addrinfo = nullptr;
  6088. struct addrinfo **current = &result_addrinfo;
  6089. for (CFIndex i = 0; i < count; i++) {
  6090. CFDataRef addr_data =
  6091. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6092. if (!addr_data) continue;
  6093. const struct sockaddr *sockaddr_ptr =
  6094. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6095. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6096. // Allocate addrinfo structure
  6097. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6098. if (!*current) {
  6099. freeaddrinfo(result_addrinfo);
  6100. CFRelease(context.addresses);
  6101. CFRelease(host_ref);
  6102. return EAI_MEMORY;
  6103. }
  6104. memset(*current, 0, sizeof(struct addrinfo));
  6105. // Set up addrinfo fields
  6106. (*current)->ai_family = sockaddr_ptr->sa_family;
  6107. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6108. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6109. (*current)->ai_addrlen = sockaddr_len;
  6110. // Copy sockaddr
  6111. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6112. if (!(*current)->ai_addr) {
  6113. freeaddrinfo(result_addrinfo);
  6114. CFRelease(context.addresses);
  6115. CFRelease(host_ref);
  6116. return EAI_MEMORY;
  6117. }
  6118. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6119. // Set port if service is specified
  6120. if (service && *service) {
  6121. int port = 0;
  6122. if (parse_port(service, strlen(service), port)) {
  6123. if (sockaddr_ptr->sa_family == AF_INET) {
  6124. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6125. ->sin_port = htons(static_cast<uint16_t>(port));
  6126. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6127. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6128. ->sin6_port = htons(static_cast<uint16_t>(port));
  6129. }
  6130. }
  6131. }
  6132. current = &((*current)->ai_next);
  6133. }
  6134. CFRelease(context.addresses);
  6135. CFRelease(host_ref);
  6136. *res = result_addrinfo;
  6137. return 0;
  6138. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6139. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6140. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6141. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6142. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6143. // the resolver worker still references the stack-local gaicb. The cancel
  6144. // path therefore waits (gai_suspend with no timeout) for the worker to
  6145. // actually finish before letting the stack frame go. The trade-off is that
  6146. // a wedged DNS server can hold this thread for the system resolver timeout
  6147. // (~30s by default) past the caller's connection timeout.
  6148. struct gaicb request{};
  6149. struct gaicb *requests[1] = {&request};
  6150. struct sigevent sevp{};
  6151. struct timespec timeout{timeout_sec, 0};
  6152. request.ar_name = node;
  6153. request.ar_service = service;
  6154. request.ar_request = hints;
  6155. sevp.sigev_notify = SIGEV_NONE;
  6156. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6157. if (rc != 0) { return rc; }
  6158. auto cleanup = scope_exit([&] {
  6159. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6160. });
  6161. int wait_result = gai_suspend(requests, 1, &timeout);
  6162. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6163. int gai_result = gai_error(&request);
  6164. if (gai_result == 0) {
  6165. *res = request.ar_result;
  6166. request.ar_result = nullptr;
  6167. return 0;
  6168. }
  6169. return gai_result;
  6170. }
  6171. gai_cancel(&request);
  6172. while (gai_error(&request) == EAI_INPROGRESS) {
  6173. gai_suspend(requests, 1, nullptr);
  6174. }
  6175. return wait_result;
  6176. #else
  6177. // Fallback implementation using thread-based timeout for other Unix systems.
  6178. struct GetAddrInfoState {
  6179. ~GetAddrInfoState() {
  6180. if (info) { freeaddrinfo(info); }
  6181. }
  6182. std::mutex mutex;
  6183. std::condition_variable result_cv;
  6184. bool completed = false;
  6185. int result = EAI_SYSTEM;
  6186. std::string node;
  6187. std::string service;
  6188. struct addrinfo hints;
  6189. struct addrinfo *info = nullptr;
  6190. };
  6191. // Allocate on the heap, so the resolver thread can keep using the data.
  6192. auto state = std::make_shared<GetAddrInfoState>();
  6193. if (node) { state->node = node; }
  6194. state->service = service;
  6195. state->hints = *hints;
  6196. std::thread resolve_thread([state]() {
  6197. auto thread_result =
  6198. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6199. &state->info);
  6200. std::lock_guard<std::mutex> lock(state->mutex);
  6201. state->result = thread_result;
  6202. state->completed = true;
  6203. state->result_cv.notify_one();
  6204. });
  6205. // Wait for completion or timeout
  6206. std::unique_lock<std::mutex> lock(state->mutex);
  6207. auto finished =
  6208. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6209. [&] { return state->completed; });
  6210. if (finished) {
  6211. // Operation completed within timeout
  6212. resolve_thread.join();
  6213. *res = state->info;
  6214. state->info = nullptr; // Pass ownership to caller
  6215. return state->result;
  6216. } else {
  6217. // Timeout occurred
  6218. resolve_thread.detach(); // Let the thread finish in background
  6219. return EAI_AGAIN; // Return timeout error
  6220. }
  6221. #endif
  6222. #else
  6223. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6224. return getaddrinfo(node, service, hints, res);
  6225. #endif
  6226. }
  6227. template <typename BindOrConnect>
  6228. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6229. int address_family, int socket_flags, bool tcp_nodelay,
  6230. bool ipv6_v6only, SocketOptions socket_options,
  6231. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6232. // Get address info
  6233. const char *node = nullptr;
  6234. struct addrinfo hints;
  6235. struct addrinfo *result;
  6236. memset(&hints, 0, sizeof(struct addrinfo));
  6237. hints.ai_socktype = SOCK_STREAM;
  6238. hints.ai_protocol = IPPROTO_IP;
  6239. if (!ip.empty()) {
  6240. node = ip.c_str();
  6241. // Ask getaddrinfo to convert IP in c-string to address
  6242. hints.ai_family = AF_UNSPEC;
  6243. hints.ai_flags = AI_NUMERICHOST;
  6244. } else {
  6245. if (!host.empty()) { node = host.c_str(); }
  6246. hints.ai_family = address_family;
  6247. hints.ai_flags = socket_flags;
  6248. }
  6249. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6250. if (hints.ai_family == AF_UNIX) {
  6251. const auto addrlen = host.length();
  6252. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6253. #ifdef SOCK_CLOEXEC
  6254. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6255. hints.ai_protocol);
  6256. #else
  6257. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6258. #endif
  6259. if (sock != INVALID_SOCKET) {
  6260. sockaddr_un addr{};
  6261. addr.sun_family = AF_UNIX;
  6262. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6263. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6264. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6265. hints.ai_addrlen = static_cast<socklen_t>(
  6266. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6267. #ifndef SOCK_CLOEXEC
  6268. #ifndef _WIN32
  6269. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6270. #endif
  6271. #endif
  6272. if (socket_options) { socket_options(sock); }
  6273. #ifdef _WIN32
  6274. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6275. // remove the option.
  6276. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6277. #endif
  6278. bool dummy;
  6279. if (!bind_or_connect(sock, hints, dummy)) {
  6280. close_socket(sock);
  6281. sock = INVALID_SOCKET;
  6282. }
  6283. }
  6284. return sock;
  6285. }
  6286. #endif
  6287. auto service = std::to_string(port);
  6288. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6289. timeout_sec)) {
  6290. #if defined __linux__ && !defined __ANDROID__
  6291. res_init();
  6292. #endif
  6293. return INVALID_SOCKET;
  6294. }
  6295. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6296. for (auto rp = result; rp; rp = rp->ai_next) {
  6297. // Create a socket
  6298. #ifdef _WIN32
  6299. auto sock =
  6300. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6301. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6302. /**
  6303. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6304. * and above the socket creation fails on older Windows Systems.
  6305. *
  6306. * Let's try to create a socket the old way in this case.
  6307. *
  6308. * Reference:
  6309. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6310. *
  6311. * WSA_FLAG_NO_HANDLE_INHERIT:
  6312. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6313. * SP1, and later
  6314. *
  6315. */
  6316. if (sock == INVALID_SOCKET) {
  6317. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6318. }
  6319. #else
  6320. #ifdef SOCK_CLOEXEC
  6321. auto sock =
  6322. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6323. #else
  6324. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6325. #endif
  6326. #endif
  6327. if (sock == INVALID_SOCKET) { continue; }
  6328. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6329. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6330. close_socket(sock);
  6331. continue;
  6332. }
  6333. #endif
  6334. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6335. if (rp->ai_family == AF_INET6) {
  6336. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6337. }
  6338. if (socket_options) { socket_options(sock); }
  6339. // bind or connect
  6340. auto quit = false;
  6341. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6342. close_socket(sock);
  6343. if (quit) { break; }
  6344. }
  6345. return INVALID_SOCKET;
  6346. }
  6347. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6348. #ifdef _WIN32
  6349. auto flags = nonblocking ? 1UL : 0UL;
  6350. ioctlsocket(sock, FIONBIO, &flags);
  6351. #else
  6352. auto flags = fcntl(sock, F_GETFL, 0);
  6353. fcntl(sock, F_SETFL,
  6354. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6355. #endif
  6356. }
  6357. inline bool is_connection_error() {
  6358. #ifdef _WIN32
  6359. return WSAGetLastError() != WSAEWOULDBLOCK;
  6360. #else
  6361. return errno != EINPROGRESS;
  6362. #endif
  6363. }
  6364. // accept() failed because the process or the network stack is temporarily out
  6365. // of resources. The listening socket is still usable, so back off briefly and
  6366. // try again.
  6367. inline bool is_accept_resource_error() {
  6368. #ifdef _WIN32
  6369. auto err = WSAGetLastError();
  6370. return err == WSAEMFILE || err == WSAENOBUFS;
  6371. #else
  6372. auto err = errno;
  6373. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6374. #endif
  6375. }
  6376. // accept() failed for a reason that says nothing about the listening socket:
  6377. // the pending connection went away before it could be accepted, or the call
  6378. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6379. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6380. // connection that way.
  6381. inline bool is_accept_transient_error() {
  6382. #ifdef _WIN32
  6383. auto err = WSAGetLastError();
  6384. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6385. err == WSAECONNABORTED;
  6386. #else
  6387. auto err = errno;
  6388. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6389. err == ECONNABORTED;
  6390. #endif
  6391. }
  6392. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6393. struct addrinfo hints;
  6394. struct addrinfo *result;
  6395. memset(&hints, 0, sizeof(struct addrinfo));
  6396. hints.ai_family = AF_UNSPEC;
  6397. hints.ai_socktype = SOCK_STREAM;
  6398. hints.ai_protocol = 0;
  6399. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6400. return false;
  6401. }
  6402. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6403. auto ret = false;
  6404. for (auto rp = result; rp; rp = rp->ai_next) {
  6405. const auto &ai = *rp;
  6406. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6407. ret = true;
  6408. break;
  6409. }
  6410. }
  6411. return ret;
  6412. }
  6413. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6414. #define USE_IF2IP
  6415. #endif
  6416. #ifdef USE_IF2IP
  6417. inline std::string if2ip(int address_family, const std::string &ifn) {
  6418. struct ifaddrs *ifap;
  6419. getifaddrs(&ifap);
  6420. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6421. std::string addr_candidate;
  6422. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6423. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6424. (AF_UNSPEC == address_family ||
  6425. ifa->ifa_addr->sa_family == address_family)) {
  6426. if (ifa->ifa_addr->sa_family == AF_INET) {
  6427. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6428. char buf[INET_ADDRSTRLEN];
  6429. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6430. return std::string(buf, INET_ADDRSTRLEN);
  6431. }
  6432. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6433. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6434. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6435. char buf[INET6_ADDRSTRLEN] = {};
  6436. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6437. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6438. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6439. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6440. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6441. } else {
  6442. return std::string(buf, INET6_ADDRSTRLEN);
  6443. }
  6444. }
  6445. }
  6446. }
  6447. }
  6448. }
  6449. return addr_candidate;
  6450. }
  6451. #endif
  6452. inline socket_t create_client_socket(
  6453. const std::string &host, const std::string &ip, int port,
  6454. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6455. SocketOptions socket_options, time_t connection_timeout_sec,
  6456. time_t connection_timeout_usec, time_t read_timeout_sec,
  6457. time_t read_timeout_usec, time_t write_timeout_sec,
  6458. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6459. auto sock = create_socket(
  6460. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6461. std::move(socket_options),
  6462. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6463. if (!intf.empty()) {
  6464. #ifdef USE_IF2IP
  6465. auto ip_from_if = if2ip(address_family, intf);
  6466. if (ip_from_if.empty()) { ip_from_if = intf; }
  6467. if (!bind_ip_address(sock2, ip_from_if)) {
  6468. error = Error::BindIPAddress;
  6469. return false;
  6470. }
  6471. #endif
  6472. }
  6473. set_nonblocking(sock2, true);
  6474. auto ret =
  6475. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6476. if (ret < 0) {
  6477. if (is_connection_error()) {
  6478. error = Error::Connection;
  6479. return false;
  6480. }
  6481. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6482. connection_timeout_usec);
  6483. if (error != Error::Success) {
  6484. if (error == Error::ConnectionTimeout) { quit = true; }
  6485. return false;
  6486. }
  6487. }
  6488. set_nonblocking(sock2, false);
  6489. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6490. read_timeout_usec);
  6491. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6492. write_timeout_usec);
  6493. error = Error::Success;
  6494. return true;
  6495. },
  6496. connection_timeout_sec); // Pass DNS timeout
  6497. if (sock != INVALID_SOCKET) {
  6498. error = Error::Success;
  6499. } else {
  6500. if (error == Error::Success) { error = Error::Connection; }
  6501. }
  6502. return sock;
  6503. }
  6504. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6505. socklen_t addr_len, std::string &ip, int &port) {
  6506. if (addr.ss_family == AF_INET) {
  6507. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6508. } else if (addr.ss_family == AF_INET6) {
  6509. port =
  6510. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6511. } else {
  6512. return false;
  6513. }
  6514. std::array<char, NI_MAXHOST> ipstr{};
  6515. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6516. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6517. 0, NI_NUMERICHOST)) {
  6518. return false;
  6519. }
  6520. ip = ipstr.data();
  6521. return true;
  6522. }
  6523. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6524. struct sockaddr_storage addr;
  6525. socklen_t addr_len = sizeof(addr);
  6526. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6527. &addr_len)) {
  6528. get_ip_and_port(addr, addr_len, ip, port);
  6529. }
  6530. }
  6531. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6532. struct sockaddr_storage addr;
  6533. socklen_t addr_len = sizeof(addr);
  6534. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6535. &addr_len)) {
  6536. #ifndef _WIN32
  6537. if (addr.ss_family == AF_UNIX) {
  6538. #if defined(__linux__)
  6539. struct ucred ucred;
  6540. socklen_t len = sizeof(ucred);
  6541. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6542. port = ucred.pid;
  6543. }
  6544. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6545. pid_t pid;
  6546. socklen_t len = sizeof(pid);
  6547. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6548. port = pid;
  6549. }
  6550. #endif
  6551. return;
  6552. }
  6553. #endif
  6554. get_ip_and_port(addr, addr_len, ip, port);
  6555. }
  6556. }
  6557. inline std::string
  6558. find_content_type(const std::string &path,
  6559. const std::map<std::string, std::string> &user_data,
  6560. const std::string &default_content_type) {
  6561. // Extensions are matched regardless of case, as web servers do
  6562. auto ext = case_ignore::to_lower(file_extension(path));
  6563. auto it = user_data.find(ext);
  6564. if (it != user_data.end()) { return it->second; }
  6565. static const struct {
  6566. const char *ext;
  6567. const char *type;
  6568. } types[] = {
  6569. {"css", "text/css"},
  6570. {"csv", "text/csv"},
  6571. {"htm", "text/html"},
  6572. {"html", "text/html"},
  6573. {"js", "text/javascript"},
  6574. {"mjs", "text/javascript"},
  6575. {"txt", "text/plain"},
  6576. {"vtt", "text/vtt"},
  6577. {"apng", "image/apng"},
  6578. {"avif", "image/avif"},
  6579. {"bmp", "image/bmp"},
  6580. {"gif", "image/gif"},
  6581. {"png", "image/png"},
  6582. {"svg", "image/svg+xml"},
  6583. {"webp", "image/webp"},
  6584. {"ico", "image/x-icon"},
  6585. {"tif", "image/tiff"},
  6586. {"tiff", "image/tiff"},
  6587. {"jpg", "image/jpeg"},
  6588. {"jpeg", "image/jpeg"},
  6589. {"mp4", "video/mp4"},
  6590. {"mpeg", "video/mpeg"},
  6591. {"webm", "video/webm"},
  6592. {"mp3", "audio/mp3"},
  6593. {"mpga", "audio/mpeg"},
  6594. {"weba", "audio/webm"},
  6595. {"wav", "audio/wave"},
  6596. {"otf", "font/otf"},
  6597. {"ttf", "font/ttf"},
  6598. {"woff", "font/woff"},
  6599. {"woff2", "font/woff2"},
  6600. {"7z", "application/x-7z-compressed"},
  6601. {"atom", "application/atom+xml"},
  6602. {"pdf", "application/pdf"},
  6603. {"json", "application/json"},
  6604. {"rss", "application/rss+xml"},
  6605. {"tar", "application/x-tar"},
  6606. {"xht", "application/xhtml+xml"},
  6607. {"xhtml", "application/xhtml+xml"},
  6608. {"xslt", "application/xslt+xml"},
  6609. {"xml", "application/xml"},
  6610. {"gz", "application/gzip"},
  6611. {"zip", "application/zip"},
  6612. {"wasm", "application/wasm"},
  6613. };
  6614. for (const auto &t : types) {
  6615. if (ext == t.ext) { return t.type; }
  6616. }
  6617. return default_content_type;
  6618. }
  6619. inline std::string
  6620. extract_media_type(const std::string &content_type,
  6621. std::map<std::string, std::string> *params = nullptr) {
  6622. // Extract type/subtype from Content-Type value (RFC 2045)
  6623. // e.g. "application/json; charset=utf-8" -> "application/json"
  6624. auto media_type = content_type;
  6625. auto semicolon_pos = media_type.find(';');
  6626. if (semicolon_pos != std::string::npos) {
  6627. auto param_str = media_type.substr(semicolon_pos + 1);
  6628. media_type = media_type.substr(0, semicolon_pos);
  6629. if (params) {
  6630. // Parse parameters: key=value pairs separated by ';'
  6631. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6632. [&](const char *b, const char *e) {
  6633. std::string key;
  6634. std::string val;
  6635. divide_param_pair(b, e, key, val);
  6636. // Parameter names are case-insensitive (RFC 9110
  6637. // §5.6.6)
  6638. if (!key.empty()) {
  6639. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6640. unquote_param(val));
  6641. }
  6642. });
  6643. }
  6644. }
  6645. // Trim whitespace from media type
  6646. return trim_copy(media_type);
  6647. }
  6648. inline bool can_compress_content_type(const std::string &content_type) {
  6649. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6650. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6651. static const char *const compressible[] = {
  6652. "image/svg+xml",
  6653. "application/javascript",
  6654. "application/x-javascript",
  6655. "application/json",
  6656. "application/ld+json",
  6657. "application/xml",
  6658. "application/xhtml+xml",
  6659. "application/rss+xml",
  6660. "application/atom+xml",
  6661. "application/xslt+xml",
  6662. "application/protobuf",
  6663. };
  6664. for (auto type : compressible) {
  6665. if (mime_type == type) { return true; }
  6666. }
  6667. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6668. }
  6669. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6670. double &quality) {
  6671. quality = 1.0;
  6672. token.clear();
  6673. // Split on first ';': left = token name, right = parameters
  6674. const char *params_b = nullptr;
  6675. std::size_t params_len = 0;
  6676. divide(
  6677. b, static_cast<std::size_t>(e - b), ';',
  6678. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6679. auto r = trim(lb, lb + llen, 0, llen);
  6680. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6681. params_b = rb;
  6682. params_len = rlen;
  6683. });
  6684. if (token.empty()) { return false; }
  6685. if (params_len == 0) { return true; }
  6686. // Scan parameters for q= (stops on first match)
  6687. bool invalid = false;
  6688. split_find(params_b, params_b + params_len, ';',
  6689. (std::numeric_limits<size_t>::max)(),
  6690. [&](const char *pb, const char *pe) -> bool {
  6691. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6692. auto len = static_cast<size_t>(pe - pb);
  6693. if (len < 2) { return false; }
  6694. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6695. return false;
  6696. }
  6697. // Trim the value portion
  6698. auto r = trim(pb, pe, 2, len);
  6699. if (r.first >= r.second) {
  6700. invalid = true;
  6701. return true;
  6702. }
  6703. double v = 0.0;
  6704. auto res = from_chars(pb + r.first, pb + r.second, v);
  6705. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6706. v < 0.0 || v > 1.0) {
  6707. invalid = true;
  6708. return true;
  6709. }
  6710. quality = v;
  6711. return true;
  6712. });
  6713. return !invalid;
  6714. }
  6715. inline EncodingType encoding_type(const Request &req,
  6716. const std::string &content_type) {
  6717. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6718. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6719. if (s.empty()) { return EncodingType::None; }
  6720. // Single-pass: iterate tokens and track the best supported encoding.
  6721. // Server preference breaks ties (br > gzip > zstd).
  6722. EncodingType best = EncodingType::None;
  6723. double best_q = 0.0; // q=0 means "not acceptable"
  6724. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6725. auto priority = [](EncodingType t) -> int {
  6726. switch (t) {
  6727. case EncodingType::Brotli: return 0;
  6728. case EncodingType::Gzip: return 1;
  6729. case EncodingType::Zstd: return 2;
  6730. default: return 3;
  6731. }
  6732. };
  6733. std::string name;
  6734. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6735. double quality = 1.0;
  6736. if (!parse_quality(b, e, name, quality)) { return; }
  6737. if (quality <= 0.0) { return; }
  6738. EncodingType type = EncodingType::None;
  6739. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6740. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6741. #endif
  6742. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6743. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6744. type = EncodingType::Gzip;
  6745. }
  6746. #endif
  6747. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6748. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6749. type = EncodingType::Zstd;
  6750. }
  6751. #endif
  6752. if (type == EncodingType::None) { return; }
  6753. // Higher q-value wins; for equal q, server preference breaks ties
  6754. if (quality > best_q ||
  6755. (quality == best_q && priority(type) < priority(best))) {
  6756. best_q = quality;
  6757. best = type;
  6758. }
  6759. });
  6760. return best;
  6761. }
  6762. // `content_type` is taken separately because a file-backed response has not
  6763. // been given one yet when its coding has to be decided.
  6764. inline EncodingType encoding_type(const Request &req, const Response &res,
  6765. const std::string &content_type) {
  6766. // The response already names a content coding of its own: a handler serving
  6767. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6768. // point whose headers name the coding its files are stored in. Applying one
  6769. // on top of that would double-encode the body and append a second
  6770. // `Content-Encoding` field line.
  6771. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6772. return encoding_type(req, content_type);
  6773. }
  6774. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6775. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6776. }
  6777. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6778. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6779. if (type == EncodingType::Gzip) {
  6780. return detail::make_unique<gzip_compressor>();
  6781. }
  6782. #endif
  6783. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6784. if (type == EncodingType::Brotli) {
  6785. return detail::make_unique<brotli_compressor>();
  6786. }
  6787. #endif
  6788. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6789. if (type == EncodingType::Zstd) {
  6790. return detail::make_unique<zstd_compressor>();
  6791. }
  6792. #endif
  6793. (void)type;
  6794. return nullptr;
  6795. }
  6796. inline const char *encoding_name(EncodingType type) {
  6797. switch (type) {
  6798. case EncodingType::Gzip: return "gzip";
  6799. case EncodingType::Brotli: return "br";
  6800. case EncodingType::Zstd: return "zstd";
  6801. default: return "";
  6802. }
  6803. }
  6804. inline bool nocompressor::compress(const char *data, size_t data_length,
  6805. bool /*last*/, Callback callback) {
  6806. if (!data_length) { return true; }
  6807. return callback(data, data_length);
  6808. }
  6809. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6810. inline gzip_compressor::gzip_compressor() {
  6811. std::memset(&strm_, 0, sizeof(strm_));
  6812. strm_.zalloc = Z_NULL;
  6813. strm_.zfree = Z_NULL;
  6814. strm_.opaque = Z_NULL;
  6815. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6816. Z_DEFAULT_STRATEGY) == Z_OK;
  6817. }
  6818. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6819. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6820. bool last, Callback callback) {
  6821. assert(is_valid_);
  6822. do {
  6823. constexpr size_t max_avail_in =
  6824. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6825. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6826. (std::min)(data_length, max_avail_in));
  6827. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6828. data_length -= strm_.avail_in;
  6829. data += strm_.avail_in;
  6830. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6831. auto ret = Z_OK;
  6832. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6833. do {
  6834. strm_.avail_out = static_cast<uInt>(buff.size());
  6835. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6836. ret = deflate(&strm_, flush);
  6837. if (ret == Z_STREAM_ERROR) { return false; }
  6838. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6839. return false;
  6840. }
  6841. } while (strm_.avail_out == 0);
  6842. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6843. (flush == Z_NO_FLUSH && ret == Z_OK));
  6844. assert(strm_.avail_in == 0);
  6845. } while (data_length > 0);
  6846. return true;
  6847. }
  6848. inline gzip_decompressor::gzip_decompressor() {
  6849. std::memset(&strm_, 0, sizeof(strm_));
  6850. strm_.zalloc = Z_NULL;
  6851. strm_.zfree = Z_NULL;
  6852. strm_.opaque = Z_NULL;
  6853. // 15 is the value of wbits, which should be at the maximum possible value
  6854. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6855. // that the stream type should be automatically detected either gzip or
  6856. // deflate.
  6857. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6858. }
  6859. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6860. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6861. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6862. Callback callback) {
  6863. assert(is_valid_);
  6864. auto ret = Z_OK;
  6865. do {
  6866. constexpr size_t max_avail_in =
  6867. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6868. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6869. (std::min)(data_length, max_avail_in));
  6870. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6871. data_length -= strm_.avail_in;
  6872. data += strm_.avail_in;
  6873. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6874. while (strm_.avail_in > 0 && ret == Z_OK) {
  6875. strm_.avail_out = static_cast<uInt>(buff.size());
  6876. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6877. ret = inflate(&strm_, Z_NO_FLUSH);
  6878. assert(ret != Z_STREAM_ERROR);
  6879. switch (ret) {
  6880. case Z_NEED_DICT:
  6881. case Z_DATA_ERROR:
  6882. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6883. }
  6884. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6885. return false;
  6886. }
  6887. }
  6888. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6889. } while (data_length > 0);
  6890. return true;
  6891. }
  6892. #endif
  6893. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6894. inline brotli_compressor::brotli_compressor() {
  6895. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6896. }
  6897. inline brotli_compressor::~brotli_compressor() {
  6898. BrotliEncoderDestroyInstance(state_);
  6899. }
  6900. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6901. bool last, Callback callback) {
  6902. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6903. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6904. auto available_in = data_length;
  6905. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6906. for (;;) {
  6907. if (last) {
  6908. if (BrotliEncoderIsFinished(state_)) { break; }
  6909. } else {
  6910. if (!available_in) { break; }
  6911. }
  6912. auto available_out = buff.size();
  6913. auto next_out = buff.data();
  6914. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6915. &available_out, &next_out, nullptr)) {
  6916. return false;
  6917. }
  6918. auto output_bytes = buff.size() - available_out;
  6919. if (output_bytes) {
  6920. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6921. }
  6922. }
  6923. return true;
  6924. }
  6925. inline brotli_decompressor::brotli_decompressor() {
  6926. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6927. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6928. : BROTLI_DECODER_RESULT_ERROR;
  6929. }
  6930. inline brotli_decompressor::~brotli_decompressor() {
  6931. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6932. }
  6933. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6934. inline bool brotli_decompressor::decompress(const char *data,
  6935. size_t data_length,
  6936. Callback callback) {
  6937. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6938. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6939. return 0;
  6940. }
  6941. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6942. size_t avail_in = data_length;
  6943. size_t total_out;
  6944. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6945. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6946. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6947. char *next_out = buff.data();
  6948. size_t avail_out = buff.size();
  6949. decoder_r = BrotliDecoderDecompressStream(
  6950. decoder_s, &avail_in, &next_in, &avail_out,
  6951. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6952. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6953. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6954. }
  6955. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6956. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6957. }
  6958. #endif
  6959. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6960. inline zstd_compressor::zstd_compressor() {
  6961. ctx_ = ZSTD_createCCtx();
  6962. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6963. }
  6964. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6965. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6966. bool last, Callback callback) {
  6967. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6968. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6969. ZSTD_inBuffer input = {data, data_length, 0};
  6970. bool finished;
  6971. do {
  6972. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6973. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6974. if (ZSTD_isError(remaining)) { return false; }
  6975. if (!callback(buff.data(), output.pos)) { return false; }
  6976. finished = last ? (remaining == 0) : (input.pos == input.size);
  6977. } while (!finished);
  6978. return true;
  6979. }
  6980. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6981. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6982. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6983. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6984. Callback callback) {
  6985. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6986. ZSTD_inBuffer input = {data, data_length, 0};
  6987. while (input.pos < input.size) {
  6988. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6989. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6990. if (ZSTD_isError(remaining)) { return false; }
  6991. if (!callback(buff.data(), output.pos)) { return false; }
  6992. }
  6993. return true;
  6994. }
  6995. #endif
  6996. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6997. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6998. // unknown coding, and its payload would be handed back still compressed.
  6999. inline bool is_zlib_encoding(const std::string &encoding) {
  7000. return case_ignore::equal(encoding, "gzip") ||
  7001. case_ignore::equal(encoding, "deflate");
  7002. }
  7003. inline bool is_brotli_encoding(const std::string &encoding) {
  7004. return case_ignore::equal(encoding, "br");
  7005. }
  7006. inline bool is_zstd_encoding(const std::string &encoding) {
  7007. return case_ignore::equal(encoding, "zstd");
  7008. }
  7009. // Returns true if the content coding is one cpp-httplib is able to decompress
  7010. // when the corresponding support is compiled in.
  7011. inline bool is_known_content_encoding(const std::string &encoding) {
  7012. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  7013. is_zstd_encoding(encoding);
  7014. }
  7015. inline std::unique_ptr<decompressor>
  7016. create_decompressor(const std::string &encoding) {
  7017. std::unique_ptr<decompressor> decompressor;
  7018. if (is_zlib_encoding(encoding)) {
  7019. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7020. decompressor = detail::make_unique<gzip_decompressor>();
  7021. #endif
  7022. } else if (is_brotli_encoding(encoding)) {
  7023. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7024. decompressor = detail::make_unique<brotli_decompressor>();
  7025. #endif
  7026. } else if (is_zstd_encoding(encoding)) {
  7027. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7028. decompressor = detail::make_unique<zstd_decompressor>();
  7029. #endif
  7030. }
  7031. return decompressor;
  7032. }
  7033. // Returns the best available compressor and its Content-Encoding name.
  7034. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7035. inline std::pair<std::unique_ptr<compressor>, const char *>
  7036. create_compressor() {
  7037. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7038. return {detail::make_unique<brotli_compressor>(), "br"};
  7039. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7040. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7041. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7042. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7043. #else
  7044. return {nullptr, nullptr};
  7045. #endif
  7046. }
  7047. inline bool is_prohibited_header_name(const std::string &name) {
  7048. // Field names are case-insensitive (RFC 9110 §5.1)
  7049. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7050. case_ignore::equal(name, "REMOTE_PORT") ||
  7051. case_ignore::equal(name, "LOCAL_ADDR") ||
  7052. case_ignore::equal(name, "LOCAL_PORT");
  7053. }
  7054. inline bool has_header(const Headers &headers, const std::string &key) {
  7055. if (is_prohibited_header_name(key)) { return false; }
  7056. return headers.find(key) != headers.end();
  7057. }
  7058. inline const char *get_header_value(const Headers &headers,
  7059. const std::string &key, const char *def,
  7060. size_t id) {
  7061. if (is_prohibited_header_name(key)) {
  7062. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7063. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7064. throw std::invalid_argument(msg);
  7065. #else
  7066. return "";
  7067. #endif
  7068. }
  7069. auto rng = headers.equal_range(key);
  7070. auto it = bounded_next(rng.first, id, rng.second);
  7071. if (it != rng.second) { return it->second.c_str(); }
  7072. return def;
  7073. }
  7074. inline size_t get_header_value_count(const Headers &headers,
  7075. const std::string &key) {
  7076. return headers.count(key);
  7077. }
  7078. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7079. // list may be sent as several field lines, and the combined field value is
  7080. // those values joined by commas in the order they were received. Callers that
  7081. // parse such a list must work on the combined value; reading only the first
  7082. // occurrence silently drops whatever the later field lines carry.
  7083. inline std::string get_combined_header_value(const Headers &headers,
  7084. const std::string &key) {
  7085. std::string combined;
  7086. auto rng = headers.equal_range(key);
  7087. for (auto it = rng.first; it != rng.second; ++it) {
  7088. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7089. // elements, so an empty field line must not contribute a bare comma to the
  7090. // combined value.
  7091. if (it->second.empty()) { continue; }
  7092. if (!combined.empty()) { combined += ", "; }
  7093. combined += it->second;
  7094. }
  7095. return combined;
  7096. }
  7097. inline bool has_header_token(const Headers &headers, const std::string &key,
  7098. const std::string &token) {
  7099. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7100. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7101. // several lines. Match complete tokens rather than searching the raw value,
  7102. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7103. auto rng = headers.equal_range(key);
  7104. for (auto it = rng.first; it != rng.second; ++it) {
  7105. const auto &value = it->second;
  7106. if (split_find(value.data(), value.data() + value.size(), ',',
  7107. [&](const char *b, const char *e) {
  7108. return case_ignore::equal(std::string(b, e), token);
  7109. })) {
  7110. return true;
  7111. }
  7112. }
  7113. return false;
  7114. }
  7115. template <typename Map>
  7116. inline typename Map::mapped_type
  7117. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7118. auto rng = m.equal_range(key);
  7119. auto it = bounded_next(rng.first, id, rng.second);
  7120. if (it != rng.second) { return it->second; }
  7121. return typename Map::mapped_type();
  7122. }
  7123. inline void set_header(Headers &headers, const std::string &key,
  7124. const std::string &val) {
  7125. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7126. }
  7127. // Drops the fields set_header() would refuse, from headers an application can
  7128. // fill directly: CR/LF in one would split the message.
  7129. inline void erase_invalid_fields(Headers &headers) {
  7130. for (auto it = headers.begin(); it != headers.end();) {
  7131. if (fields::is_field_valid(it->first, it->second)) {
  7132. ++it;
  7133. } else {
  7134. it = headers.erase(it);
  7135. }
  7136. }
  7137. }
  7138. inline bool read_headers(Stream &strm, Headers &headers) {
  7139. const auto bufsiz = 2048;
  7140. char buf[bufsiz];
  7141. stream_line_reader line_reader(strm, buf, bufsiz);
  7142. size_t header_count = 0;
  7143. for (;;) {
  7144. if (!line_reader.getline()) { return false; }
  7145. // Check if the line ends with CRLF.
  7146. auto line_terminator_len = 2;
  7147. if (line_reader.end_with_crlf()) {
  7148. // Blank line indicates end of headers.
  7149. if (line_reader.size() == 2) { break; }
  7150. } else {
  7151. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7152. // Blank line indicates end of headers.
  7153. if (line_reader.size() == 1) { break; }
  7154. line_terminator_len = 1;
  7155. #else
  7156. continue; // Skip invalid line.
  7157. #endif
  7158. }
  7159. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7160. // Check header count limit
  7161. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7162. // Exclude line terminator
  7163. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7164. if (!parse_header(line_reader.ptr(), end,
  7165. [&](const std::string &key, const std::string &val) {
  7166. headers.emplace(key, val);
  7167. })) {
  7168. return false;
  7169. }
  7170. header_count++;
  7171. }
  7172. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7173. // headers that have different values to prevent request smuggling.
  7174. auto cl_range = headers.equal_range("Content-Length");
  7175. if (cl_range.first != cl_range.second) {
  7176. const auto &first_val = cl_range.first->second;
  7177. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7178. if (it->second != first_val) { return false; }
  7179. }
  7180. }
  7181. return true;
  7182. }
  7183. // Parsed by hand: std::regex_match recurses once per character of the reason
  7184. // phrase, which a server can make as long as a whole line.
  7185. inline bool parse_status_line(const char *line, std::string &version,
  7186. int &status, std::string &reason) {
  7187. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7188. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7189. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7190. !is_ascii_digit(line[11])) {
  7191. return false;
  7192. }
  7193. auto p = line + 12;
  7194. auto reason_begin = p;
  7195. if (*p == ' ') {
  7196. reason_begin = ++p;
  7197. p += std::strcspn(p, "\r\n");
  7198. }
  7199. auto reason_end = p;
  7200. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7201. if (*p == '\r') { p++; }
  7202. #else
  7203. if (*p++ != '\r') { return false; }
  7204. #endif
  7205. if (*p++ != '\n' || *p != '\0') { return false; }
  7206. version.assign(line, 8);
  7207. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7208. reason.assign(reason_begin, reason_end);
  7209. return true;
  7210. }
  7211. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7212. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7213. struct WebSocketUpgradeResponse {
  7214. Error error = Error::Success;
  7215. int status = -1;
  7216. Headers headers;
  7217. std::string selected_subprotocol;
  7218. };
  7219. // Reads a response's status line and headers, leaving any body unread. An
  7220. // unparsable status line is no stream error; it just leaves `status` as is.
  7221. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7222. const auto bufsiz = 2048;
  7223. char buf[bufsiz];
  7224. stream_line_reader line_reader(strm, buf, bufsiz);
  7225. if (!line_reader.getline()) { return false; }
  7226. std::string version;
  7227. std::string reason;
  7228. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7229. return true;
  7230. }
  7231. return read_headers(strm, headers);
  7232. }
  7233. inline bool
  7234. read_websocket_upgrade_response(Stream &strm,
  7235. const std::string &expected_accept,
  7236. const std::string &offered_subprotocols,
  7237. WebSocketUpgradeResponse &upgrade) {
  7238. // The headers of a rejection are kept so the caller can see why the server
  7239. // refused the upgrade.
  7240. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7241. upgrade.error = Error::Read;
  7242. return false;
  7243. }
  7244. const auto &headers = upgrade.headers;
  7245. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7246. upgrade.error = Error::WebSocketHandshake;
  7247. return false;
  7248. }
  7249. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7250. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7251. upgrade.error = Error::WebSocketHandshake;
  7252. return false;
  7253. }
  7254. // Verify Connection: Upgrade
  7255. if (!has_header_token(headers, "Connection", "upgrade")) {
  7256. upgrade.error = Error::WebSocketHandshake;
  7257. return false;
  7258. }
  7259. // Verify Sec-WebSocket-Accept header value
  7260. auto it = headers.find("Sec-WebSocket-Accept");
  7261. if (it == headers.end() || it->second != expected_accept) {
  7262. upgrade.error = Error::WebSocketHandshake;
  7263. return false;
  7264. }
  7265. // Extract negotiated subprotocol
  7266. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7267. if (proto_it != headers.end()) {
  7268. upgrade.selected_subprotocol = proto_it->second;
  7269. }
  7270. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7271. if (!upgrade.selected_subprotocol.empty()) {
  7272. auto was_offered = false;
  7273. split(offered_subprotocols.data(),
  7274. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7275. [&](const char *b, const char *e) {
  7276. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7277. was_offered = true;
  7278. }
  7279. });
  7280. if (!was_offered) {
  7281. upgrade.error = Error::WebSocketHandshake;
  7282. return false;
  7283. }
  7284. }
  7285. return true;
  7286. }
  7287. enum class ReadContentResult {
  7288. Success, // Successfully read the content
  7289. PayloadTooLarge, // The content exceeds the specified payload limit
  7290. Error // An error occurred while reading the content
  7291. };
  7292. inline ReadContentResult read_content_with_length(
  7293. Stream &strm, size_t len, DownloadProgress progress,
  7294. ContentReceiverWithProgress out,
  7295. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7296. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7297. detail::BodyReader br;
  7298. br.stream = &strm;
  7299. br.has_content_length = true;
  7300. br.content_length = len;
  7301. br.payload_max_length = payload_max_length;
  7302. br.chunked = false;
  7303. br.bytes_read = 0;
  7304. br.last_error = Error::Success;
  7305. size_t r = 0;
  7306. while (r < len) {
  7307. auto read_len = static_cast<size_t>(len - r);
  7308. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7309. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7310. if (n <= 0) {
  7311. // Check if it was a payload size error
  7312. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7313. return ReadContentResult::PayloadTooLarge;
  7314. }
  7315. return ReadContentResult::Error;
  7316. }
  7317. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7318. return ReadContentResult::Error;
  7319. }
  7320. r += static_cast<size_t>(n);
  7321. if (progress) {
  7322. if (!progress(r, len)) { return ReadContentResult::Error; }
  7323. }
  7324. }
  7325. return ReadContentResult::Success;
  7326. }
  7327. inline ReadContentResult
  7328. read_content_without_length(Stream &strm, size_t payload_max_length,
  7329. ContentReceiverWithProgress out) {
  7330. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7331. size_t r = 0;
  7332. for (;;) {
  7333. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7334. if (n == 0) { return ReadContentResult::Success; }
  7335. if (n < 0) { return ReadContentResult::Error; }
  7336. // Check if adding this data would exceed the payload limit
  7337. if (payload_max_length > 0 &&
  7338. (r > payload_max_length ||
  7339. payload_max_length - r < static_cast<size_t>(n))) {
  7340. return ReadContentResult::PayloadTooLarge;
  7341. }
  7342. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7343. return ReadContentResult::Error;
  7344. }
  7345. r += static_cast<size_t>(n);
  7346. }
  7347. return ReadContentResult::Success;
  7348. }
  7349. template <typename T>
  7350. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7351. size_t payload_max_length,
  7352. ContentReceiverWithProgress out) {
  7353. detail::ChunkedDecoder dec(strm);
  7354. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7355. size_t total_len = 0;
  7356. for (;;) {
  7357. size_t chunk_offset = 0;
  7358. size_t chunk_total = 0;
  7359. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7360. if (n < 0) { return ReadContentResult::Error; }
  7361. if (n == 0) {
  7362. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7363. return ReadContentResult::Error;
  7364. }
  7365. return ReadContentResult::Success;
  7366. }
  7367. if (payload_max_length > 0 &&
  7368. (total_len > payload_max_length ||
  7369. payload_max_length - total_len < static_cast<size_t>(n))) {
  7370. return ReadContentResult::PayloadTooLarge;
  7371. }
  7372. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7373. return ReadContentResult::Error;
  7374. }
  7375. total_len += static_cast<size_t>(n);
  7376. }
  7377. }
  7378. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7379. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7380. // is the final transfer coding. A single field value may list several
  7381. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7382. // several Transfer-Encoding lines, which combine into one comma-separated
  7383. // list in the order the lines were received. Headers preserves that order,
  7384. // so the final coding is the last token of the last line. Match it
  7385. // case-insensitively rather than comparing the whole value against
  7386. // "chunked".
  7387. //
  7388. // Security: reading a chunked message as unframed leaves its body in the
  7389. // socket, where a keep-alive connection parses it as a smuggled request.
  7390. // Server::process_request() answers 400 and closes when the final coding is
  7391. // not chunked, so a request whose framing cannot be determined never
  7392. // reaches the "no body" path.
  7393. auto rng = headers.equal_range("Transfer-Encoding");
  7394. if (rng.first == rng.second) { return false; }
  7395. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7396. // combined list ending in nothing rather than inheriting the line before it.
  7397. std::string last_coding;
  7398. for (auto it = rng.first; it != rng.second; ++it) {
  7399. const auto &value = it->second;
  7400. last_coding.clear();
  7401. split(value.data(), value.data() + value.size(), ',',
  7402. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7403. }
  7404. return case_ignore::equal(last_coding, "chunked");
  7405. }
  7406. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7407. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7408. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7409. return msg.has_header("Transfer-Encoding") &&
  7410. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7411. }
  7412. inline bool has_conflicting_content_length(const Headers &headers) {
  7413. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7414. // Content-Length is framed ambiguously. The body readers here delimit it by
  7415. // the transfer coding and drop Content-Length, while an intermediary may do
  7416. // the reverse, so the two disagree on where the body ends and a reused
  7417. // connection is desynchronised (request/response smuggling). Content-Length:
  7418. // 0 is tolerated for compatibility with existing peers.
  7419. return has_header(headers, "Transfer-Encoding") &&
  7420. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7421. }
  7422. template <typename T, typename U>
  7423. bool prepare_content_receiver(T &x, int &status,
  7424. ContentReceiverWithProgress receiver,
  7425. bool decompress, size_t payload_max_length,
  7426. bool &exceed_payload_max_length, U callback) {
  7427. if (decompress) {
  7428. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7429. std::unique_ptr<decompressor> decompressor;
  7430. if (!encoding.empty()) {
  7431. // A coding we know about but were not built with is an error. An
  7432. // unrecognized coding (including "identity") is left alone and the
  7433. // payload is passed through as-is, since some servers misuse the header,
  7434. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7435. decompressor = detail::create_decompressor(encoding);
  7436. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7437. status = StatusCode::UnsupportedMediaType_415;
  7438. return false;
  7439. }
  7440. }
  7441. if (decompressor) {
  7442. if (decompressor->is_valid()) {
  7443. size_t decompressed_size = 0;
  7444. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7445. size_t off, size_t len) {
  7446. return decompressor->decompress(
  7447. buf, n, [&](const char *buf2, size_t n2) {
  7448. // Guard against zip-bomb: check
  7449. // decompressed size against limit.
  7450. if (payload_max_length > 0 &&
  7451. (decompressed_size >= payload_max_length ||
  7452. n2 > payload_max_length - decompressed_size)) {
  7453. exceed_payload_max_length = true;
  7454. return false;
  7455. }
  7456. decompressed_size += n2;
  7457. return receiver(buf2, n2, off, len);
  7458. });
  7459. };
  7460. return callback(std::move(out));
  7461. } else {
  7462. status = StatusCode::InternalServerError_500;
  7463. return false;
  7464. }
  7465. }
  7466. }
  7467. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7468. size_t len) {
  7469. return receiver(buf, n, off, len);
  7470. };
  7471. return callback(std::move(out));
  7472. }
  7473. template <typename T>
  7474. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7475. DownloadProgress progress,
  7476. ContentReceiverWithProgress receiver, bool decompress) {
  7477. bool exceed_payload_max_length = false;
  7478. return prepare_content_receiver(
  7479. x, status, std::move(receiver), decompress, payload_max_length,
  7480. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7481. auto ret = true;
  7482. // Note: exceed_payload_max_length may also be set by the decompressor
  7483. // wrapper in prepare_content_receiver when the decompressed payload
  7484. // size exceeds the limit.
  7485. if (is_chunked_transfer_encoding(x.headers)) {
  7486. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7487. if (result == ReadContentResult::Success) {
  7488. ret = true;
  7489. } else if (result == ReadContentResult::PayloadTooLarge) {
  7490. exceed_payload_max_length = true;
  7491. ret = false;
  7492. } else {
  7493. ret = false;
  7494. }
  7495. } else if (!has_header(x.headers, "Content-Length")) {
  7496. auto result =
  7497. read_content_without_length(strm, payload_max_length, out);
  7498. if (result == ReadContentResult::Success) {
  7499. ret = true;
  7500. } else if (result == ReadContentResult::PayloadTooLarge) {
  7501. exceed_payload_max_length = true;
  7502. ret = false;
  7503. } else {
  7504. ret = false;
  7505. }
  7506. } else {
  7507. auto is_invalid_value = false;
  7508. auto len = get_header_value_u64(x.headers, "Content-Length",
  7509. (std::numeric_limits<size_t>::max)(),
  7510. 0, is_invalid_value);
  7511. if (is_invalid_value) {
  7512. ret = false;
  7513. } else if (len > 0) {
  7514. auto result = read_content_with_length(
  7515. strm, len, std::move(progress), out, payload_max_length);
  7516. ret = (result == ReadContentResult::Success);
  7517. if (result == ReadContentResult::PayloadTooLarge) {
  7518. exceed_payload_max_length = true;
  7519. }
  7520. }
  7521. }
  7522. if (!ret) {
  7523. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7524. : StatusCode::BadRequest_400;
  7525. }
  7526. return ret;
  7527. });
  7528. }
  7529. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7530. const std::string &path) {
  7531. // Neither the method nor the request target may carry CR/LF, SP or other
  7532. // control octets; otherwise a value smuggled into either splits the request
  7533. // line and injects headers or a whole request.
  7534. if (!fields::is_token(method)) { return -1; }
  7535. if (!fields::is_request_target(path)) { return -1; }
  7536. std::string s = method;
  7537. s += ' ';
  7538. s += path;
  7539. s += " HTTP/1.1\r\n";
  7540. return strm.write(s.data(), s.size());
  7541. }
  7542. inline ssize_t write_response_line(Stream &strm, int status) {
  7543. std::string s = "HTTP/1.1 ";
  7544. s += std::to_string(status);
  7545. s += ' ';
  7546. s += httplib::status_message(status);
  7547. s += "\r\n";
  7548. return strm.write(s.data(), s.size());
  7549. }
  7550. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7551. ssize_t write_len = 0;
  7552. for (const auto &x : headers) {
  7553. std::string s;
  7554. s = x.first;
  7555. s += ": ";
  7556. s += x.second;
  7557. s += "\r\n";
  7558. auto len = strm.write(s.data(), s.size());
  7559. if (len < 0) { return len; }
  7560. write_len += len;
  7561. }
  7562. auto len = strm.write("\r\n");
  7563. if (len < 0) { return len; }
  7564. write_len += len;
  7565. return write_len;
  7566. }
  7567. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7568. size_t offset = 0;
  7569. while (offset < l) {
  7570. auto length = strm.write(d + offset, l - offset);
  7571. if (length < 0) { return false; }
  7572. offset += static_cast<size_t>(length);
  7573. }
  7574. return true;
  7575. }
  7576. template <typename T>
  7577. inline bool write_content_with_progress(Stream &strm,
  7578. const ContentProvider &content_provider,
  7579. size_t offset, size_t length,
  7580. T is_shutting_down,
  7581. const UploadProgress &upload_progress,
  7582. Error &error) {
  7583. size_t end_offset = offset + length;
  7584. size_t start_offset = offset;
  7585. auto ok = true;
  7586. auto finished = false;
  7587. DataSink data_sink;
  7588. data_sink.write = [&](const char *d, size_t l) -> bool {
  7589. if (ok) {
  7590. // Bytes past `length` would follow the framed body, where the peer reads
  7591. // them as the next message. Write only what fits and fail the rest.
  7592. if (l > end_offset - offset) {
  7593. l = end_offset - offset;
  7594. ok = false;
  7595. }
  7596. if (write_data(strm, d, l)) {
  7597. offset += l;
  7598. if (upload_progress && length > 0) {
  7599. size_t current_written = offset - start_offset;
  7600. if (!upload_progress(current_written, length)) {
  7601. ok = false;
  7602. return false;
  7603. }
  7604. }
  7605. } else {
  7606. ok = false;
  7607. }
  7608. }
  7609. return ok;
  7610. };
  7611. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7612. // The body is framed by `length`, so a provider that reports itself done
  7613. // early has truncated it. Record that and let the short-body check below
  7614. // fail the write, rather than calling the provider again forever.
  7615. data_sink.done = [&]() { finished = true; };
  7616. while (offset < end_offset && !finished && !is_shutting_down()) {
  7617. auto last_offset = offset;
  7618. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7619. error = Error::Write;
  7620. return false;
  7621. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7622. error = Error::Canceled;
  7623. return false;
  7624. } else if (!ok) {
  7625. error = Error::Write;
  7626. return false;
  7627. }
  7628. // A provider that reports success without writing anything and without
  7629. // reporting itself done gets handed the same offset and length again on
  7630. // the next pass, so it would spin here for as long as the peer stays
  7631. // connected. Treat making no progress as a short body, like done() early.
  7632. if (!finished && offset == last_offset) {
  7633. error = Error::Write;
  7634. return false;
  7635. }
  7636. }
  7637. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7638. error = Error::Write;
  7639. return false;
  7640. }
  7641. error = Error::Success;
  7642. return true;
  7643. }
  7644. template <typename T>
  7645. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7646. size_t offset, size_t length, T is_shutting_down,
  7647. Error &error) {
  7648. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7649. is_shutting_down, nullptr, error);
  7650. }
  7651. template <typename T>
  7652. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7653. size_t offset, size_t length,
  7654. const T &is_shutting_down) {
  7655. auto error = Error::Success;
  7656. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7657. error);
  7658. }
  7659. template <typename T>
  7660. inline bool
  7661. write_content_without_length(Stream &strm,
  7662. const ContentProvider &content_provider,
  7663. const T &is_shutting_down) {
  7664. size_t offset = 0;
  7665. auto data_available = true;
  7666. auto ok = true;
  7667. DataSink data_sink;
  7668. data_sink.write = [&](const char *d, size_t l) -> bool {
  7669. if (ok) {
  7670. offset += l;
  7671. if (!write_data(strm, d, l)) { ok = false; }
  7672. }
  7673. return ok;
  7674. };
  7675. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7676. data_sink.done = [&](void) { data_available = false; };
  7677. while (data_available && !is_shutting_down()) {
  7678. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7679. return false;
  7680. } else if (!content_provider(offset, 0, data_sink)) {
  7681. return false;
  7682. } else if (!ok) {
  7683. return false;
  7684. }
  7685. }
  7686. return !data_available; // true only if done() was called, false if shutting
  7687. // down
  7688. }
  7689. // Runs a known-length content provider to completion and compresses what it
  7690. // writes into `out`, chunk by chunk, without holding the identity form.
  7691. inline bool compress_content_provider(const ContentProvider &content_provider,
  7692. size_t length, compressor &cmp,
  7693. std::string &out) {
  7694. size_t offset = 0;
  7695. auto ok = true;
  7696. auto finished = false;
  7697. DataSink data_sink;
  7698. auto append = [&](const char *data, size_t data_len) {
  7699. out.append(data, data_len);
  7700. return true;
  7701. };
  7702. data_sink.write = [&](const char *d, size_t l) -> bool {
  7703. if (!ok) { return false; }
  7704. offset += l;
  7705. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7706. return ok;
  7707. };
  7708. // The body is framed by `length`, so a provider that reports itself done
  7709. // early has truncated it; the short-body check below turns that into a
  7710. // failure rather than calling the provider again forever.
  7711. data_sink.done = [&]() { finished = true; };
  7712. while (offset < length && !finished) {
  7713. auto prev_offset = offset;
  7714. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7715. return false;
  7716. }
  7717. // No Stream to block on here, so a provider that keeps returning true
  7718. // without writing would spin. Treat a pass that made no progress as a
  7719. // failure.
  7720. if (offset == prev_offset) { return false; }
  7721. }
  7722. if (offset != length) { return false; }
  7723. return cmp.compress(nullptr, 0, true, append);
  7724. }
  7725. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7726. // and the file flag, so recording them has to come after; keeping all of it
  7727. // here means a third file-serving path cannot get that order wrong.
  7728. inline void set_file_content_provider(Response &res,
  7729. const std::shared_ptr<mmap> &m,
  7730. const std::string &content_type,
  7731. EncodingType encoding) {
  7732. // One read and one write move up to this much of the file at a time.
  7733. auto buf = std::make_shared<std::vector<char>>(
  7734. (std::min)(m->size(), size_t(256 * 1024)));
  7735. res.set_content_provider(
  7736. m->size(), content_type,
  7737. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7738. // Never read past the file, which ends the response early if it has
  7739. // shrunk since it was opened.
  7740. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7741. if (n == 0) { return false; }
  7742. sink.write(buf->data(), n);
  7743. return true;
  7744. });
  7745. res.is_file_content_provider_ = true;
  7746. res.content_coding_ = encoding;
  7747. }
  7748. template <typename T, typename U>
  7749. inline bool
  7750. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7751. const T &is_shutting_down, U &compressor, Error &error) {
  7752. size_t offset = 0;
  7753. auto data_available = true;
  7754. auto ok = true;
  7755. DataSink data_sink;
  7756. data_sink.write = [&](const char *d, size_t l) -> bool {
  7757. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7758. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7759. // zero-length chunk is the terminator, so it must not be emitted here.
  7760. if (ok && l > 0) {
  7761. offset += l;
  7762. std::string payload;
  7763. if (compressor.compress(d, l, false,
  7764. [&](const char *data, size_t data_len) {
  7765. payload.append(data, data_len);
  7766. return true;
  7767. })) {
  7768. if (!payload.empty()) {
  7769. // Emit chunked response header and footer for each chunk
  7770. auto chunk =
  7771. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7772. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7773. }
  7774. } else {
  7775. ok = false;
  7776. }
  7777. }
  7778. return ok;
  7779. };
  7780. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7781. auto done_with_trailer = [&](const Headers *trailer) {
  7782. if (!ok) { return; }
  7783. data_available = false;
  7784. std::string payload;
  7785. if (!compressor.compress(nullptr, 0, true,
  7786. [&](const char *data, size_t data_len) {
  7787. payload.append(data, data_len);
  7788. return true;
  7789. })) {
  7790. ok = false;
  7791. return;
  7792. }
  7793. if (!payload.empty()) {
  7794. // Emit chunked response header and footer for each chunk
  7795. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7796. if (!write_data(strm, chunk.data(), chunk.size())) {
  7797. ok = false;
  7798. return;
  7799. }
  7800. }
  7801. constexpr const char done_marker[] = "0\r\n";
  7802. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7803. // Trailer
  7804. if (trailer) {
  7805. for (const auto &kv : *trailer) {
  7806. // Skip fields with invalid names or values to prevent response
  7807. // splitting via CR/LF injection, matching set_header().
  7808. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7809. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7810. if (!write_data(strm, field_line.data(), field_line.size())) {
  7811. ok = false;
  7812. }
  7813. }
  7814. }
  7815. constexpr const char crlf[] = "\r\n";
  7816. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7817. };
  7818. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7819. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7820. done_with_trailer(&trailer);
  7821. };
  7822. while (data_available && !is_shutting_down()) {
  7823. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7824. error = Error::Write;
  7825. return false;
  7826. } else if (!content_provider(offset, 0, data_sink)) {
  7827. error = Error::Canceled;
  7828. return false;
  7829. } else if (!ok) {
  7830. error = Error::Write;
  7831. return false;
  7832. }
  7833. }
  7834. if (data_available) { // exited due to is_shutting_down(), not done()
  7835. error = Error::Write;
  7836. return false;
  7837. }
  7838. error = Error::Success;
  7839. return true;
  7840. }
  7841. template <typename T, typename U>
  7842. inline bool write_content_chunked(Stream &strm,
  7843. const ContentProvider &content_provider,
  7844. const T &is_shutting_down, U &compressor) {
  7845. auto error = Error::Success;
  7846. return write_content_chunked(strm, content_provider, is_shutting_down,
  7847. compressor, error);
  7848. }
  7849. template <typename T>
  7850. inline bool redirect(T &cli, Request &req, Response &res,
  7851. const std::string &path, const std::string &location,
  7852. Error &error) {
  7853. Request new_req = req;
  7854. new_req.path = path;
  7855. new_req.params.clear();
  7856. new_req.redirect_count_ -= 1;
  7857. if (res.status == StatusCode::SeeOther_303 &&
  7858. (req.method != "GET" && req.method != "HEAD")) {
  7859. new_req.method = "GET";
  7860. new_req.body.clear();
  7861. new_req.headers.clear();
  7862. new_req.content_length_ = 0;
  7863. new_req.content_provider_ = nullptr;
  7864. new_req.is_chunked_content_provider_ = false;
  7865. }
  7866. Response new_res;
  7867. auto ret = cli.send(new_req, new_res, error);
  7868. if (ret) {
  7869. req = std::move(new_req);
  7870. res = std::move(new_res);
  7871. if (res.location.empty()) { res.location = location; }
  7872. }
  7873. return ret;
  7874. }
  7875. inline std::string params_to_query_str(const Params &params) {
  7876. std::string query;
  7877. for (auto it = params.begin(); it != params.end(); ++it) {
  7878. if (it != params.begin()) { query += '&'; }
  7879. query += encode_query_component(it->first);
  7880. query += '=';
  7881. query += encode_query_component(it->second);
  7882. }
  7883. return query;
  7884. }
  7885. // Splits one "key=value" span of a query string at its first '='. A span with
  7886. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7887. // "?flag" keeps its name.
  7888. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7889. std::string &val) {
  7890. divide(b, static_cast<std::size_t>(e - b), '=',
  7891. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7892. std::size_t rhs_size) {
  7893. key.assign(lhs_data, lhs_size);
  7894. val.assign(rhs_data, rhs_size);
  7895. });
  7896. }
  7897. inline void parse_query_text(const char *data, std::size_t size,
  7898. Params &params) {
  7899. std::set<std::string> cache;
  7900. split(data, data + size, '&', [&](const char *b, const char *e) {
  7901. std::string kv(b, e);
  7902. if (cache.find(kv) != cache.end()) { return; }
  7903. cache.insert(std::move(kv));
  7904. std::string key;
  7905. std::string val;
  7906. divide_query_pair(b, e, key, val);
  7907. if (!key.empty()) {
  7908. params.emplace(decode_query_component(key), decode_query_component(val));
  7909. }
  7910. });
  7911. }
  7912. inline void parse_query_text(const std::string &s, Params &params) {
  7913. parse_query_text(s.data(), s.size(), params);
  7914. }
  7915. // Normalize a query string by decoding and re-encoding each key/value pair
  7916. // while preserving the original parameter order. This avoids double-encoding
  7917. // and ensures consistent encoding. It works on the raw string rather than
  7918. // parsing into Params and re-serializing, because that round trip cannot
  7919. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7920. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7921. // duplicated pairs.
  7922. inline std::string normalize_query_string(const std::string &query) {
  7923. std::string result;
  7924. split(query.data(), query.data() + query.size(), '&',
  7925. [&](const char *b, const char *e) {
  7926. std::string key;
  7927. std::string val;
  7928. divide_query_pair(b, e, key, val);
  7929. if (!key.empty()) {
  7930. auto dec_key = decode_query_component(key);
  7931. auto dec_val = decode_query_component(val);
  7932. if (!result.empty()) { result += '&'; }
  7933. result += encode_query_component(dec_key);
  7934. if (!val.empty() || std::find(b, e, '=') != e) {
  7935. result += '=';
  7936. result += encode_query_component(dec_val);
  7937. }
  7938. }
  7939. });
  7940. return result;
  7941. }
  7942. // The query of a client's path: what follows '?', up to the fragment.
  7943. inline std::string query_of(const std::string &path) {
  7944. auto fragment_pos = path.find('#');
  7945. auto query_pos = path.find('?');
  7946. return query_pos < fragment_pos
  7947. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7948. : std::string();
  7949. }
  7950. // Build the request target that goes on the wire from a caller-supplied path.
  7951. // Shared by the buffered send path and the streaming API so that both put the
  7952. // same bytes in the request line for the same input.
  7953. inline std::string encode_request_target(const std::string &uri,
  7954. bool path_encode) {
  7955. // The fragment stays with the client (RFC 9110 §7.1).
  7956. auto target = uri.substr(0, uri.find('#'));
  7957. // `substr(0, npos)` yields the whole string, which is what the no-query
  7958. // case needs.
  7959. auto query_pos = target.find('?');
  7960. auto path_part = target.substr(0, query_pos);
  7961. std::string query_part;
  7962. if (query_pos != std::string::npos) {
  7963. query_part = target.substr(query_pos + 1);
  7964. }
  7965. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7966. if (!query_part.empty()) {
  7967. // When path encoding is disabled the caller has supplied an already-encoded
  7968. // target and expects the exact bytes to be sent on the wire, so skip
  7969. // normalization for the query too. Normalizing would decode-then-re-encode
  7970. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7971. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7972. if (path_encode) {
  7973. auto normalized = normalize_query_string(query_part);
  7974. if (!normalized.empty()) {
  7975. result += '?';
  7976. result += normalized;
  7977. }
  7978. } else {
  7979. result += '?';
  7980. result += query_part;
  7981. }
  7982. }
  7983. return result;
  7984. }
  7985. inline bool parse_multipart_boundary(const std::string &content_type,
  7986. std::string &boundary) {
  7987. std::map<std::string, std::string> params;
  7988. extract_media_type(content_type, &params);
  7989. auto it = params.find("boundary");
  7990. if (it == params.end()) { return false; }
  7991. boundary = it->second;
  7992. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7993. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7994. // bytes costs a nearly full comparison at nearly every position: the
  7995. // boundary's length multiplies the worst-case cost of scanning a body.
  7996. return !boundary.empty() && boundary.size() <= 70;
  7997. }
  7998. inline void parse_disposition_params(const std::string &s, Params &params) {
  7999. std::set<std::string> cache;
  8000. split_unquoted(
  8001. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  8002. std::string kv(b, e);
  8003. if (cache.find(kv) != cache.end()) { return; }
  8004. cache.insert(kv);
  8005. std::string key;
  8006. std::string val;
  8007. divide_param_pair(b, e, key, val);
  8008. if (!key.empty()) {
  8009. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  8010. }
  8011. });
  8012. }
  8013. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8014. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  8015. #else
  8016. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  8017. #endif
  8018. auto is_valid = [](const std::string &str) {
  8019. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  8020. };
  8021. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8022. const auto pos = static_cast<size_t>(6);
  8023. const auto len = static_cast<size_t>(s.size() - 6);
  8024. auto all_valid_ranges = true;
  8025. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8026. if (!all_valid_ranges) { return; }
  8027. const auto it = std::find(b, e, '-');
  8028. if (it == e) {
  8029. all_valid_ranges = false;
  8030. return;
  8031. }
  8032. const auto lhs = std::string(b, it);
  8033. const auto rhs = std::string(it + 1, e);
  8034. if (!is_valid(lhs) || !is_valid(rhs)) {
  8035. all_valid_ranges = false;
  8036. return;
  8037. }
  8038. ssize_t first = -1;
  8039. if (!lhs.empty()) {
  8040. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8041. // would turn the range into a suffix range.
  8042. auto res =
  8043. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8044. if (res.ec != std::errc{}) {
  8045. all_valid_ranges = false;
  8046. return;
  8047. }
  8048. }
  8049. ssize_t last = -1;
  8050. if (!rhs.empty()) {
  8051. // An overflowing last-byte-pos is past any content length, so keeping
  8052. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8053. ssize_t v;
  8054. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8055. if (res.ec == std::errc{}) { last = v; }
  8056. }
  8057. if ((first == -1 && last == -1) ||
  8058. (first != -1 && last != -1 && first > last)) {
  8059. all_valid_ranges = false;
  8060. return;
  8061. }
  8062. ranges.emplace_back(first, last);
  8063. });
  8064. return all_valid_ranges && !ranges.empty();
  8065. }
  8066. return false;
  8067. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8068. }
  8069. #else
  8070. } catch (...) { return false; }
  8071. #endif
  8072. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8073. inline std::string remove_quoted_strings(const std::string &s) {
  8074. std::string out;
  8075. auto in_quotes = false;
  8076. for (size_t i = 0; i < s.size(); i++) {
  8077. if (s[i] == '"') {
  8078. in_quotes = !in_quotes;
  8079. } else if (!in_quotes) {
  8080. out += s[i];
  8081. } else if (s[i] == '\\') {
  8082. i++;
  8083. }
  8084. }
  8085. return out;
  8086. }
  8087. inline bool parse_accept_header(const std::string &s,
  8088. std::vector<std::string> &content_types) {
  8089. // Parameter values are not used here, so a quoted-string is dropped rather
  8090. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8091. if (s.find('"') != std::string::npos) {
  8092. return parse_accept_header(remove_quoted_strings(s), content_types);
  8093. }
  8094. content_types.clear();
  8095. // Empty string is considered valid (no preference)
  8096. if (s.empty()) { return true; }
  8097. struct AcceptEntry {
  8098. std::string media_type;
  8099. double quality;
  8100. int order;
  8101. };
  8102. std::vector<AcceptEntry> entries;
  8103. int order = 0;
  8104. bool has_invalid_entry = false;
  8105. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8106. // has to parse and ignore empty list elements, so a leading, trailing or
  8107. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8108. // split() skips them, and the header length limit bounds how many a sender
  8109. // can send, so ignoring all of them cannot be used as a denial-of-service
  8110. // vector.
  8111. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8112. std::string entry(b, e);
  8113. entry = trim_copy(entry);
  8114. AcceptEntry accept_entry;
  8115. accept_entry.order = order++;
  8116. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8117. accept_entry.media_type, accept_entry.quality)) {
  8118. has_invalid_entry = true;
  8119. return;
  8120. }
  8121. // Remove additional parameters from media type
  8122. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8123. // Basic validation of media type format
  8124. if (accept_entry.media_type.empty()) {
  8125. has_invalid_entry = true;
  8126. return;
  8127. }
  8128. // Check for basic media type format (should contain '/' or be '*')
  8129. if (accept_entry.media_type != "*" &&
  8130. accept_entry.media_type.find('/') == std::string::npos) {
  8131. has_invalid_entry = true;
  8132. return;
  8133. }
  8134. entries.push_back(std::move(accept_entry));
  8135. });
  8136. // Return false if any invalid entry was found
  8137. if (has_invalid_entry) { return false; }
  8138. // Sort by quality (descending), then by original order (ascending)
  8139. std::sort(entries.begin(), entries.end(),
  8140. [](const AcceptEntry &a, const AcceptEntry &b) {
  8141. if (a.quality != b.quality) {
  8142. return a.quality > b.quality; // Higher quality first
  8143. }
  8144. return a.order < b.order; // Earlier order first for same quality
  8145. });
  8146. // Extract sorted media types
  8147. content_types.reserve(entries.size());
  8148. for (auto &entry : entries) {
  8149. content_types.push_back(std::move(entry.media_type));
  8150. }
  8151. return true;
  8152. }
  8153. class FormDataParser {
  8154. public:
  8155. FormDataParser() = default;
  8156. void set_boundary(std::string &&boundary) {
  8157. boundary_ = std::move(boundary);
  8158. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8159. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8160. }
  8161. bool is_valid() const { return is_valid_; }
  8162. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8163. const ContentReceiver &content_callback) {
  8164. // Once the close delimiter has been seen the rest of the body is epilogue
  8165. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8166. // spread across reads is not copied in only to be erased right away.
  8167. if (state_ == 5) { return true; }
  8168. buf_append(buf, n);
  8169. while (buf_size() > 0) {
  8170. switch (state_) {
  8171. case 0: { // Initial boundary
  8172. auto pos = buf_find(dash_boundary_crlf_);
  8173. if (pos == buf_size()) {
  8174. // Not found yet: keep only a possible partial boundary at the tail so
  8175. // that a body which never contains the boundary cannot grow the
  8176. // buffer (and get rescanned from the start) without bound.
  8177. auto keep = dash_boundary_crlf_.size() - 1;
  8178. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8179. return true;
  8180. }
  8181. buf_erase(pos + dash_boundary_crlf_.size());
  8182. state_ = 1;
  8183. break;
  8184. }
  8185. case 1: { // New entry
  8186. clear_file_info();
  8187. header_searched_ = 0;
  8188. state_ = 2;
  8189. break;
  8190. }
  8191. case 2: { // Headers
  8192. // Resume where the last call stopped looking, so that a line arriving
  8193. // a few bytes at a time is not searched from its start each time.
  8194. auto pos = buf_find(crlf_, header_searched_);
  8195. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8196. while (pos < buf_size()) {
  8197. // Empty line
  8198. if (pos == 0) {
  8199. if (!header_callback(file_)) {
  8200. is_valid_ = false;
  8201. return false;
  8202. }
  8203. buf_erase(crlf_.size());
  8204. state_ = 3;
  8205. break;
  8206. }
  8207. // Check header count limit
  8208. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8209. is_valid_ = false;
  8210. return false;
  8211. }
  8212. header_count_++;
  8213. const auto header = buf_head(pos);
  8214. if (!parse_header(header.data(), header.data() + header.size(),
  8215. [&](const std::string &, const std::string &) {})) {
  8216. is_valid_ = false;
  8217. return false;
  8218. }
  8219. // Parse and emplace space trimmed headers into a map
  8220. if (!parse_header(
  8221. header.data(), header.data() + header.size(),
  8222. [&](const std::string &key, const std::string &val) {
  8223. file_.headers.emplace(key, val);
  8224. })) {
  8225. is_valid_ = false;
  8226. return false;
  8227. }
  8228. constexpr const char header_content_type[] = "Content-Type:";
  8229. if (start_with_case_ignore(header, header_content_type)) {
  8230. file_.content_type =
  8231. trim_copy(header.substr(str_len(header_content_type)));
  8232. } else {
  8233. std::string disposition_params;
  8234. if (parse_content_disposition(header, disposition_params)) {
  8235. Params params;
  8236. parse_disposition_params(disposition_params, params);
  8237. auto it = params.find("name");
  8238. if (it != params.end()) {
  8239. file_.name = it->second;
  8240. } else {
  8241. is_valid_ = false;
  8242. return false;
  8243. }
  8244. it = params.find("filename");
  8245. if (it != params.end()) { file_.filename = it->second; }
  8246. it = params.find("filename*");
  8247. if (it != params.end()) {
  8248. // RFC 5987: only UTF-8 encoding is allowed
  8249. const auto &val = it->second;
  8250. constexpr const char utf8_prefix[] = "UTF-8''";
  8251. constexpr size_t prefix_len = str_len(utf8_prefix);
  8252. if (val.size() > prefix_len &&
  8253. start_with_case_ignore(val, utf8_prefix)) {
  8254. file_.filename = decode_path_component(
  8255. val.substr(prefix_len)); // override...
  8256. } else {
  8257. is_valid_ = false;
  8258. return false;
  8259. }
  8260. }
  8261. }
  8262. }
  8263. buf_erase(pos + crlf_.size());
  8264. pos = buf_find(crlf_);
  8265. }
  8266. if (state_ != 3) {
  8267. // The CR of the CRLF may be the last byte so far.
  8268. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8269. return true;
  8270. }
  8271. break;
  8272. }
  8273. case 3: { // Body
  8274. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8275. auto pos = buf_find(crlf_dash_boundary_);
  8276. if (pos < buf_size()) {
  8277. if (!content_callback(buf_data(), pos)) {
  8278. is_valid_ = false;
  8279. return false;
  8280. }
  8281. buf_erase(pos + crlf_dash_boundary_.size());
  8282. state_ = 4;
  8283. } else {
  8284. auto len = buf_size() - crlf_dash_boundary_.size();
  8285. if (len > 0) {
  8286. if (!content_callback(buf_data(), len)) {
  8287. is_valid_ = false;
  8288. return false;
  8289. }
  8290. buf_erase(len);
  8291. }
  8292. return true;
  8293. }
  8294. break;
  8295. }
  8296. case 4: { // Boundary
  8297. if (crlf_.size() > buf_size()) { return true; }
  8298. if (buf_start_with(crlf_)) {
  8299. buf_erase(crlf_.size());
  8300. state_ = 1;
  8301. } else if (buf_start_with(dash_)) {
  8302. buf_erase(dash_.size());
  8303. is_valid_ = true;
  8304. state_ = 5;
  8305. } else {
  8306. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8307. // accepted after a boundary; RFC 2046 allows transport-padding in
  8308. // between, but this parser has never supported it. Either way the
  8309. // body is already destined to be rejected, so fail now instead of
  8310. // buffering the rest of it. Both are two bytes, so the check above
  8311. // already guarantees enough buffered data to decide.
  8312. is_valid_ = false;
  8313. return false;
  8314. }
  8315. break;
  8316. }
  8317. case 5: { // Epilogue
  8318. buf_erase(buf_size());
  8319. break;
  8320. }
  8321. }
  8322. }
  8323. return true;
  8324. }
  8325. private:
  8326. void clear_file_info() {
  8327. file_.name.clear();
  8328. file_.filename.clear();
  8329. file_.content_type.clear();
  8330. file_.headers.clear();
  8331. header_count_ = 0;
  8332. }
  8333. bool start_with_case_ignore(const std::string &a, const char *b,
  8334. size_t offset = 0) const {
  8335. const auto b_len = strlen(b);
  8336. if (a.size() < offset + b_len) { return false; }
  8337. for (size_t i = 0; i < b_len; i++) {
  8338. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8339. return false;
  8340. }
  8341. }
  8342. return true;
  8343. }
  8344. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8345. // Returns true if header matches, with the params portion in `params_out`.
  8346. bool parse_content_disposition(const std::string &header,
  8347. std::string &params_out) const {
  8348. constexpr const char prefix[] = "Content-Disposition:";
  8349. constexpr size_t prefix_len = str_len(prefix);
  8350. if (!start_with_case_ignore(header, prefix)) { return false; }
  8351. // Skip whitespace after "Content-Disposition:"
  8352. auto pos = prefix_len;
  8353. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8354. pos++;
  8355. }
  8356. // Match "form-data;" (case-insensitive)
  8357. constexpr const char form_data[] = "form-data;";
  8358. constexpr size_t form_data_len = str_len(form_data);
  8359. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8360. pos += form_data_len;
  8361. // Skip whitespace after "form-data;"
  8362. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8363. pos++;
  8364. }
  8365. params_out = header.substr(pos);
  8366. return true;
  8367. }
  8368. const std::string dash_ = "--";
  8369. const std::string crlf_ = "\r\n";
  8370. std::string boundary_;
  8371. std::string dash_boundary_crlf_;
  8372. std::string crlf_dash_boundary_;
  8373. size_t state_ = 0;
  8374. bool is_valid_ = false;
  8375. FormData file_;
  8376. size_t header_count_ = 0;
  8377. size_t header_searched_ = 0;
  8378. // Buffer
  8379. bool start_with(const std::string &a, size_t spos, size_t epos,
  8380. const std::string &b) const {
  8381. if (epos - spos < b.size()) { return false; }
  8382. for (size_t i = 0; i < b.size(); i++) {
  8383. if (a[i + spos] != b[i]) { return false; }
  8384. }
  8385. return true;
  8386. }
  8387. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8388. const char *buf_data() const { return &buf_[buf_spos_]; }
  8389. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8390. bool buf_start_with(const std::string &s) const {
  8391. return start_with(buf_, buf_spos_, buf_epos_, s);
  8392. }
  8393. size_t buf_find(const std::string &s, size_t from = 0) const {
  8394. auto c = s.front();
  8395. size_t off = buf_spos_ + from;
  8396. while (off < buf_epos_) {
  8397. auto pos = off;
  8398. while (true) {
  8399. if (pos == buf_epos_) { return buf_size(); }
  8400. if (buf_[pos] == c) { break; }
  8401. pos++;
  8402. }
  8403. auto remaining_size = buf_epos_ - pos;
  8404. if (s.size() > remaining_size) { return buf_size(); }
  8405. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8406. off = pos + 1;
  8407. }
  8408. return buf_size();
  8409. }
  8410. void buf_append(const char *data, size_t n) {
  8411. auto remaining_size = buf_size();
  8412. if (remaining_size > 0 && buf_spos_ > 0) {
  8413. for (size_t i = 0; i < remaining_size; i++) {
  8414. buf_[i] = buf_[buf_spos_ + i];
  8415. }
  8416. }
  8417. buf_spos_ = 0;
  8418. buf_epos_ = remaining_size;
  8419. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8420. for (size_t i = 0; i < n; i++) {
  8421. buf_[buf_epos_ + i] = data[i];
  8422. }
  8423. buf_epos_ += n;
  8424. }
  8425. void buf_erase(size_t size) { buf_spos_ += size; }
  8426. std::string buf_;
  8427. size_t buf_spos_ = 0;
  8428. size_t buf_epos_ = 0;
  8429. };
  8430. inline std::string random_string(size_t length) {
  8431. constexpr const char data[] =
  8432. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8433. std::string result(length, '\0');
  8434. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8435. for (auto &c : result) {
  8436. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8437. }
  8438. return result;
  8439. }
  8440. inline std::string make_multipart_data_boundary() {
  8441. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8442. }
  8443. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8444. auto valid = true;
  8445. for (size_t i = 0; i < boundary.size(); i++) {
  8446. auto c = boundary[i];
  8447. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8448. valid = false;
  8449. break;
  8450. }
  8451. }
  8452. return valid;
  8453. }
  8454. // Escape a multipart field name/filename following the WHATWG HTML standard
  8455. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8456. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8457. // With quoted = false, only CR and LF are escaped; this is for header values
  8458. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8459. inline std::string escape_multipart_field(const std::string &s,
  8460. bool quoted = true) {
  8461. std::string result;
  8462. result.reserve(s.size());
  8463. for (auto c : s) {
  8464. switch (c) {
  8465. case '"':
  8466. if (quoted) {
  8467. result += "%22";
  8468. } else {
  8469. result += c;
  8470. }
  8471. break;
  8472. case '\\':
  8473. // A lone backslash would escape the character after it (RFC 9110
  8474. // 5.6.4).
  8475. if (quoted) { result += '\\'; }
  8476. result += c;
  8477. break;
  8478. case '\r': result += "%0D"; break;
  8479. case '\n': result += "%0A"; break;
  8480. default: result += c; break;
  8481. }
  8482. }
  8483. return result;
  8484. }
  8485. template <typename T>
  8486. inline std::string
  8487. serialize_multipart_formdata_item_begin(const T &item,
  8488. const std::string &boundary) {
  8489. std::string body = "--" + boundary + "\r\n";
  8490. body += "Content-Disposition: form-data; name=\"" +
  8491. escape_multipart_field(item.name) + "\"";
  8492. if (!item.filename.empty()) {
  8493. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8494. }
  8495. body += "\r\n";
  8496. if (!item.content_type.empty()) {
  8497. body +=
  8498. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8499. "\r\n";
  8500. }
  8501. body += "\r\n";
  8502. return body;
  8503. }
  8504. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8505. inline std::string
  8506. serialize_multipart_formdata_finish(const std::string &boundary) {
  8507. return "--" + boundary + "--\r\n";
  8508. }
  8509. inline std::string
  8510. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8511. return "multipart/form-data; boundary=" + boundary;
  8512. }
  8513. inline std::string
  8514. serialize_multipart_formdata(const UploadFormDataItems &items,
  8515. const std::string &boundary, bool finish = true) {
  8516. std::string body;
  8517. for (const auto &item : items) {
  8518. body += serialize_multipart_formdata_item_begin(item, boundary);
  8519. body += item.content + serialize_multipart_formdata_item_end();
  8520. }
  8521. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8522. return body;
  8523. }
  8524. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8525. const std::string &boundary) {
  8526. size_t total = 0;
  8527. for (const auto &item : items) {
  8528. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8529. total += item.content.size();
  8530. total += serialize_multipart_formdata_item_end().size();
  8531. }
  8532. total += serialize_multipart_formdata_finish(boundary).size();
  8533. return total;
  8534. }
  8535. struct MultipartSegment {
  8536. const char *data;
  8537. size_t size;
  8538. };
  8539. // NOTE: items must outlive the returned ContentProvider
  8540. // (safe for synchronous use inside Post/Put/Patch)
  8541. inline ContentProvider
  8542. make_multipart_content_provider(const UploadFormDataItems &items,
  8543. const std::string &boundary) {
  8544. // Own the per-item header strings and the finish string
  8545. std::vector<std::string> owned;
  8546. owned.reserve(items.size() + 1);
  8547. for (const auto &item : items)
  8548. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8549. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8550. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8551. std::vector<MultipartSegment> segs;
  8552. segs.reserve(items.size() * 3 + 1);
  8553. static const char crlf[] = "\r\n";
  8554. for (size_t i = 0; i < items.size(); i++) {
  8555. segs.push_back({owned[i].data(), owned[i].size()});
  8556. segs.push_back({items[i].content.data(), items[i].content.size()});
  8557. segs.push_back({crlf, 2});
  8558. }
  8559. segs.push_back({owned.back().data(), owned.back().size()});
  8560. struct MultipartState {
  8561. std::vector<std::string> owned;
  8562. std::vector<MultipartSegment> segs;
  8563. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8564. };
  8565. auto state = std::make_shared<MultipartState>();
  8566. state->owned = std::move(owned);
  8567. // `segs` holds raw pointers into owned strings; std::string move preserves
  8568. // the data pointer, so these pointers remain valid after the move above.
  8569. state->segs = std::move(segs);
  8570. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8571. // Buffer multiple small segments into fewer, larger writes to avoid
  8572. // excessive TCP packets when there are many form data items (#2410)
  8573. auto &buf = state->buf;
  8574. auto buf_size = buf.size();
  8575. size_t buf_len = 0;
  8576. size_t remaining = length;
  8577. // Find the first segment containing 'offset'
  8578. size_t pos = 0;
  8579. size_t seg_idx = 0;
  8580. for (; seg_idx < state->segs.size(); seg_idx++) {
  8581. const auto &seg = state->segs[seg_idx];
  8582. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8583. pos += seg.size;
  8584. }
  8585. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8586. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8587. const auto &seg = state->segs[seg_idx];
  8588. size_t available = seg.size - seg_offset;
  8589. size_t to_copy = (std::min)(available, remaining);
  8590. const char *src = seg.data + seg_offset;
  8591. seg_offset = 0; // only the first segment has a non-zero offset
  8592. while (to_copy > 0) {
  8593. size_t space = buf_size - buf_len;
  8594. size_t chunk = (std::min)(to_copy, space);
  8595. std::memcpy(buf.data() + buf_len, src, chunk);
  8596. buf_len += chunk;
  8597. src += chunk;
  8598. to_copy -= chunk;
  8599. remaining -= chunk;
  8600. if (buf_len == buf_size) {
  8601. if (!sink.write(buf.data(), buf_len)) { return false; }
  8602. buf_len = 0;
  8603. }
  8604. }
  8605. }
  8606. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8607. return true;
  8608. };
  8609. }
  8610. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8611. if (ranges.size() <= 1) return;
  8612. // Sort ranges by start position
  8613. std::sort(ranges.begin(), ranges.end(),
  8614. [](const Range &a, const Range &b) { return a.first < b.first; });
  8615. Ranges coalesced;
  8616. coalesced.reserve(ranges.size());
  8617. for (auto &r : ranges) {
  8618. auto first_pos = r.first;
  8619. auto last_pos = r.second;
  8620. // Handle special cases like in range_error
  8621. if (first_pos == -1 && last_pos == -1) {
  8622. first_pos = 0;
  8623. last_pos = static_cast<ssize_t>(content_length);
  8624. }
  8625. if (first_pos == -1) {
  8626. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8627. last_pos = static_cast<ssize_t>(content_length) - 1;
  8628. }
  8629. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8630. last_pos = static_cast<ssize_t>(content_length) - 1;
  8631. }
  8632. // Skip invalid ranges
  8633. if (!(0 <= first_pos && first_pos <= last_pos &&
  8634. last_pos < static_cast<ssize_t>(content_length))) {
  8635. continue;
  8636. }
  8637. // Coalesce with previous range if overlapping or adjacent (but not
  8638. // identical)
  8639. if (!coalesced.empty()) {
  8640. auto &prev = coalesced.back();
  8641. // Check if current range overlaps or is adjacent to previous range
  8642. // but don't coalesce identical ranges (allow duplicates)
  8643. if (first_pos <= prev.second + 1 &&
  8644. !(first_pos == prev.first && last_pos == prev.second)) {
  8645. // Extend the previous range
  8646. prev.second = (std::max)(prev.second, last_pos);
  8647. continue;
  8648. }
  8649. }
  8650. // Add new range
  8651. coalesced.emplace_back(first_pos, last_pos);
  8652. }
  8653. ranges = std::move(coalesced);
  8654. }
  8655. inline bool range_error(Request &req, Response &res) {
  8656. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8657. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8658. req.ranges.clear();
  8659. if (res.status == StatusCode::PartialContent_206) {
  8660. res.status = StatusCode::OK_200;
  8661. }
  8662. return false;
  8663. }
  8664. ssize_t content_len = static_cast<ssize_t>(
  8665. res.content_length_ ? res.content_length_ : res.body.size());
  8666. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8667. size_t overwrapping_count = 0;
  8668. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8669. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8670. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8671. // Too many ranges
  8672. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8673. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8674. return true;
  8675. }
  8676. for (auto &r : req.ranges) {
  8677. auto &first_pos = r.first;
  8678. auto &last_pos = r.second;
  8679. if (first_pos == -1 && last_pos == -1) {
  8680. first_pos = 0;
  8681. last_pos = content_len;
  8682. }
  8683. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8684. // selects the entire representation.
  8685. if (first_pos == -1) {
  8686. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8687. last_pos = content_len - 1;
  8688. }
  8689. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8690. // A client can limit the number of bytes requested without knowing the
  8691. // size of the selected representation. If the last-pos value is absent,
  8692. // or if the value is greater than or equal to the current length of the
  8693. // representation data, the byte range is interpreted as the remainder of
  8694. // the representation (i.e., the server replaces the value of last-pos
  8695. // with a value that is one less than the current length of the selected
  8696. // representation).
  8697. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8698. if (last_pos == -1 || last_pos >= content_len) {
  8699. last_pos = content_len - 1;
  8700. }
  8701. // Range must be within content length
  8702. if (!(0 <= first_pos && first_pos <= last_pos &&
  8703. last_pos <= content_len - 1)) {
  8704. return true;
  8705. }
  8706. // Request must not have more than two overlapping ranges
  8707. for (const auto &processed_range : processed_ranges) {
  8708. if (!(last_pos < processed_range.first ||
  8709. first_pos > processed_range.second)) {
  8710. overwrapping_count++;
  8711. if (overwrapping_count > 2) { return true; }
  8712. break; // Only count once per range
  8713. }
  8714. }
  8715. processed_ranges.emplace_back(first_pos, last_pos);
  8716. }
  8717. // After validation, coalesce overlapping ranges as per RFC 9110
  8718. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8719. }
  8720. return false;
  8721. }
  8722. inline std::pair<size_t, size_t>
  8723. get_range_offset_and_length(Range r, size_t content_length) {
  8724. assert(r.first != -1 && r.second != -1);
  8725. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8726. assert(r.first <= r.second &&
  8727. r.second < static_cast<ssize_t>(content_length));
  8728. (void)(content_length);
  8729. return std::make_pair(static_cast<size_t>(r.first),
  8730. static_cast<size_t>(r.second - r.first) + 1);
  8731. }
  8732. inline std::string make_content_range_header_field(
  8733. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8734. auto st = offset_and_length.first;
  8735. auto ed = st + offset_and_length.second - 1;
  8736. std::string field = "bytes ";
  8737. field += std::to_string(st);
  8738. field += '-';
  8739. field += std::to_string(ed);
  8740. field += '/';
  8741. field += std::to_string(content_length);
  8742. return field;
  8743. }
  8744. template <typename SToken, typename CToken, typename Content>
  8745. bool process_multipart_ranges_data(const Request &req,
  8746. const std::string &boundary,
  8747. const std::string &content_type,
  8748. size_t content_length, SToken stoken,
  8749. CToken ctoken, Content content) {
  8750. for (size_t i = 0; i < req.ranges.size(); i++) {
  8751. ctoken("--");
  8752. stoken(boundary);
  8753. ctoken("\r\n");
  8754. if (!content_type.empty()) {
  8755. ctoken("Content-Type: ");
  8756. stoken(content_type);
  8757. ctoken("\r\n");
  8758. }
  8759. auto offset_and_length =
  8760. get_range_offset_and_length(req.ranges[i], content_length);
  8761. ctoken("Content-Range: ");
  8762. stoken(make_content_range_header_field(offset_and_length, content_length));
  8763. ctoken("\r\n");
  8764. ctoken("\r\n");
  8765. if (!content(offset_and_length.first, offset_and_length.second)) {
  8766. return false;
  8767. }
  8768. ctoken("\r\n");
  8769. }
  8770. ctoken("--");
  8771. stoken(boundary);
  8772. ctoken("--");
  8773. return true;
  8774. }
  8775. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8776. const std::string &boundary,
  8777. const std::string &content_type,
  8778. size_t content_length,
  8779. std::string &data) {
  8780. process_multipart_ranges_data(
  8781. req, boundary, content_type, content_length,
  8782. [&](const std::string &token) { data += token; },
  8783. [&](const std::string &token) { data += token; },
  8784. [&](size_t offset, size_t length) {
  8785. assert(offset + length <= content_length);
  8786. data += res.body.substr(offset, length);
  8787. return true;
  8788. });
  8789. }
  8790. inline size_t get_multipart_ranges_data_length(const Request &req,
  8791. const std::string &boundary,
  8792. const std::string &content_type,
  8793. size_t content_length) {
  8794. size_t data_length = 0;
  8795. process_multipart_ranges_data(
  8796. req, boundary, content_type, content_length,
  8797. [&](const std::string &token) { data_length += token.size(); },
  8798. [&](const std::string &token) { data_length += token.size(); },
  8799. [&](size_t /*offset*/, size_t length) {
  8800. data_length += length;
  8801. return true;
  8802. });
  8803. return data_length;
  8804. }
  8805. template <typename T>
  8806. inline bool
  8807. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8808. const std::string &boundary,
  8809. const std::string &content_type,
  8810. size_t content_length, const T &is_shutting_down) {
  8811. return process_multipart_ranges_data(
  8812. req, boundary, content_type, content_length,
  8813. [&](const std::string &token) { strm.write(token); },
  8814. [&](const std::string &token) { strm.write(token); },
  8815. [&](size_t offset, size_t length) {
  8816. return write_content(strm, res.content_provider_, offset, length,
  8817. is_shutting_down);
  8818. });
  8819. }
  8820. inline bool has_framed_body(const Request &req) {
  8821. return is_chunked_transfer_encoding(req.headers) ||
  8822. req.get_header_value_u64("Content-Length") > 0;
  8823. }
  8824. inline bool expect_content(const Request &req) {
  8825. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8826. req.method == "DELETE") {
  8827. return true;
  8828. }
  8829. return has_framed_body(req);
  8830. }
  8831. #ifdef _WIN32
  8832. class WSInit {
  8833. public:
  8834. WSInit() {
  8835. WSADATA wsaData;
  8836. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8837. }
  8838. ~WSInit() {
  8839. if (is_valid_) WSACleanup();
  8840. }
  8841. bool is_valid_ = false;
  8842. };
  8843. static WSInit wsinit_;
  8844. #endif
  8845. inline std::string unescape_quoted_pairs(const std::string &s) {
  8846. std::string out;
  8847. out.reserve(s.size());
  8848. for (size_t i = 0; i < s.size(); i++) {
  8849. if (s[i] == '\\' && i + 1 < s.size()) {
  8850. out += s[++i];
  8851. } else {
  8852. out += s[i];
  8853. }
  8854. }
  8855. return out;
  8856. }
  8857. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8858. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8859. // quoted-pair, so the recipient recovers the original value.
  8860. inline std::string escape_quoted_pairs(const std::string &s) {
  8861. std::string out;
  8862. out.reserve(s.size());
  8863. for (auto c : s) {
  8864. if (c == '\\' || c == '"') { out += '\\'; }
  8865. out += c;
  8866. }
  8867. return out;
  8868. }
  8869. // RFC 9110 Section 11.6.1 defines a challenge list as
  8870. // WWW-Authenticate = #challenge
  8871. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8872. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8873. // so a server may offer several schemes, each with its own comma-separated
  8874. // auth-param list, in either order and either as separate field lines or
  8875. // packed into one. Splitting on every comma would break apart a challenge's
  8876. // own param list; splitting only on the first space would miss a Digest
  8877. // challenge that isn't first. Split on commas that aren't inside a
  8878. // quoted-string instead (split_unquoted), then track which scheme each
  8879. // resulting segment belongs to: a segment whose text before "=" contains
  8880. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8881. // leading token.
  8882. inline bool parse_www_authenticate(const Response &res,
  8883. std::map<std::string, std::string> &auth,
  8884. bool is_proxy) {
  8885. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8886. auto combined = get_combined_header_value(res.headers, auth_key);
  8887. if (combined.empty()) { return false; }
  8888. auto found_digest = false;
  8889. auto in_digest_challenge = false;
  8890. split_unquoted(
  8891. combined.data(), combined.data() + combined.size(), ',',
  8892. [&](const char *b, const char *e) {
  8893. std::string segment(b, e);
  8894. auto eq_pos = segment.find('=');
  8895. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8896. // for the first segment of a challenge, "<scheme> <key>") must be
  8897. // trimmed before its boundaries are inspected.
  8898. auto key_part = trim_copy(
  8899. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8900. auto space_pos = key_part.find_last_of(" \t");
  8901. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8902. // "<scheme>[ <key>]" starts a new challenge.
  8903. auto scheme_end =
  8904. space_pos == std::string::npos ? key_part.size() : space_pos;
  8905. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8906. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8907. // from one challenge is never paired with another's algorithm.
  8908. in_digest_challenge =
  8909. !found_digest &&
  8910. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8911. if (in_digest_challenge) { found_digest = true; }
  8912. if (space_pos == std::string::npos) {
  8913. // Bare scheme (or a token68), no auth-param on this segment.
  8914. return;
  8915. }
  8916. key_part = key_part.substr(space_pos + 1);
  8917. }
  8918. if (!in_digest_challenge) { return; }
  8919. auto val = trim_copy(segment.substr(eq_pos + 1));
  8920. auto unquoted = trim_double_quotes_copy(val);
  8921. if (unquoted.size() != val.size()) {
  8922. unquoted = unescape_quoted_pairs(unquoted);
  8923. }
  8924. auth[std::move(key_part)] = std::move(unquoted);
  8925. });
  8926. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8927. // make_digest_authentication_header() dereferences both unconditionally, so
  8928. // a challenge missing either can't produce a usable Authorization header.
  8929. // Treat it the same as no Digest challenge at all.
  8930. return found_digest && auth.find("realm") != auth.end() &&
  8931. auth.find("nonce") != auth.end();
  8932. }
  8933. class ContentProviderAdapter {
  8934. public:
  8935. explicit ContentProviderAdapter(
  8936. ContentProviderWithoutLength &&content_provider)
  8937. : content_provider_(std::move(content_provider)) {}
  8938. bool operator()(size_t offset, size_t, DataSink &sink) {
  8939. return content_provider_(offset, sink);
  8940. }
  8941. private:
  8942. ContentProviderWithoutLength content_provider_;
  8943. };
  8944. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8945. namespace fields {
  8946. inline bool is_token_char(char c) {
  8947. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8948. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8949. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8950. }
  8951. inline bool is_token(const std::string &s) {
  8952. if (s.empty()) { return false; }
  8953. for (auto c : s) {
  8954. if (!is_token_char(c)) { return false; }
  8955. }
  8956. return true;
  8957. }
  8958. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8959. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8960. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8961. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8962. inline bool is_field_content(const std::string &s) {
  8963. if (s.empty()) { return true; }
  8964. if (s.size() == 1) {
  8965. return is_field_vchar(s[0]);
  8966. } else if (s.size() == 2) {
  8967. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8968. } else {
  8969. size_t i = 0;
  8970. if (!is_field_vchar(s[i])) { return false; }
  8971. i++;
  8972. while (i < s.size() - 1) {
  8973. auto c = s[i++];
  8974. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8975. } else {
  8976. return false;
  8977. }
  8978. }
  8979. return is_field_vchar(s[i]);
  8980. }
  8981. }
  8982. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8983. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8984. return is_field_name(name) && is_field_value(value);
  8985. }
  8986. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8987. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8988. inline bool is_request_target(const std::string &s) {
  8989. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8990. }
  8991. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8992. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8993. inline bool is_host(const std::string &s) {
  8994. return std::all_of(s.begin(), s.end(), [](char c) {
  8995. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8996. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8997. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8998. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8999. });
  9000. }
  9001. } // namespace fields
  9002. // Built in memory first, like ClientImpl::write_request, so a rejected header
  9003. // never leaves a partial request on the wire.
  9004. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  9005. BufferStream bstrm;
  9006. if (write_request_line(bstrm, req.method, req.path) < 0) {
  9007. error = Error::Write;
  9008. return false;
  9009. }
  9010. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  9011. return false;
  9012. }
  9013. const auto &data = bstrm.get_buffer();
  9014. if (!write_data(strm, data.data(), data.size())) {
  9015. error = Error::Write;
  9016. return false;
  9017. }
  9018. return true;
  9019. }
  9020. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9021. WebSocketUpgradeResponse &upgrade) {
  9022. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9023. std::string key_bytes(16, '\0');
  9024. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9025. key_bytes.size());
  9026. auto client_key = base64_encode(key_bytes);
  9027. req.headers.erase("Upgrade");
  9028. req.headers.erase("Connection");
  9029. req.headers.erase("Sec-WebSocket-Key");
  9030. req.headers.erase("Sec-WebSocket-Version");
  9031. req.headers.emplace("Upgrade", "websocket");
  9032. req.headers.emplace("Connection", "Upgrade");
  9033. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9034. req.headers.emplace("Sec-WebSocket-Version", "13");
  9035. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9036. // Verify 101 response and Sec-WebSocket-Accept header
  9037. auto expected_accept = websocket_accept_key(client_key);
  9038. auto offered_subprotocols =
  9039. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9040. return read_websocket_upgrade_response(strm, expected_accept,
  9041. offered_subprotocols, upgrade);
  9042. }
  9043. inline bool is_ip_address(const std::string &host) {
  9044. struct in_addr addr4;
  9045. struct in6_addr addr6;
  9046. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9047. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9048. }
  9049. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9050. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9051. // else, including an address with a zone ID, is returned as it is.
  9052. inline std::string canonical_ip(const std::string &addr) {
  9053. struct in6_addr addr6;
  9054. if (addr.find('%') != std::string::npos ||
  9055. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9056. return addr;
  9057. }
  9058. char buf[INET6_ADDRSTRLEN];
  9059. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9060. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9061. : addr;
  9062. }
  9063. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9064. }
  9065. // `trusted_proxies` holds canonical_ip() spellings.
  9066. inline bool is_trusted_proxy(const std::string &addr,
  9067. const std::vector<std::string> &trusted_proxies) {
  9068. if (trusted_proxies.empty()) { return false; }
  9069. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9070. canonical_ip(addr)) != trusted_proxies.end();
  9071. }
  9072. // Resolve where a client should connect for `host`, honoring a user-supplied
  9073. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9074. // supplying the Host header and SNI; only the connection target changes.
  9075. //
  9076. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9077. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9078. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9079. // absent or empty mapping leaves `host` as the connection target; without the
  9080. // empty check the value would reach getaddrinfo as a null node and silently
  9081. // resolve to loopback.
  9082. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9083. const std::string &host, std::string &connect_host,
  9084. std::string &ip) {
  9085. connect_host = host;
  9086. ip.clear();
  9087. auto it = addr_map.find(host);
  9088. if (it == addr_map.end() || it->second.empty()) { return; }
  9089. if (is_ip_address(it->second)) {
  9090. ip = it->second;
  9091. } else {
  9092. connect_host = it->second;
  9093. }
  9094. }
  9095. } // namespace detail
  9096. /*
  9097. * Group 2: detail namespace - SSL common utilities
  9098. */
  9099. #ifdef CPPHTTPLIB_SSL_ENABLED
  9100. namespace detail {
  9101. class SSLSocketStream final : public Stream {
  9102. public:
  9103. SSLSocketStream(
  9104. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9105. time_t read_timeout_usec, time_t write_timeout_sec,
  9106. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9107. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9108. (std::chrono::steady_clock::time_point::min)());
  9109. ~SSLSocketStream() override;
  9110. bool is_readable() const override;
  9111. bool wait_readable() const override;
  9112. bool wait_writable() const override;
  9113. bool is_peer_alive() const override;
  9114. ssize_t read(char *ptr, size_t size) override;
  9115. ssize_t write(const char *ptr, size_t size) override;
  9116. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9117. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9118. socket_t socket() const override;
  9119. time_t duration() const override;
  9120. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9121. void set_max_timeout(time_t msec) override;
  9122. void set_read_interrupt(std::function<bool()> interrupted) override;
  9123. // See SocketStream::set_readable_hint().
  9124. void set_readable_hint() { readable_hint_ = true; }
  9125. // The error from the last read() or write() that failed in the TLS layer,
  9126. // with code Success if none did
  9127. const tls::TlsError &tls_error() const { return tls_error_; }
  9128. private:
  9129. bool ensure_readable();
  9130. socket_t sock_;
  9131. tls::session_t session_;
  9132. time_t read_timeout_sec_;
  9133. time_t read_timeout_usec_;
  9134. time_t write_timeout_sec_;
  9135. time_t write_timeout_usec_;
  9136. time_t max_timeout_msec_;
  9137. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9138. std::function<bool()> read_interrupted_;
  9139. bool readable_hint_ = false;
  9140. tls::TlsError tls_error_;
  9141. };
  9142. // A TLS stream for WebSocket connections, where the receive path and the
  9143. // send path (application send() plus the heartbeat ping thread) run on
  9144. // different threads. A single TLS session must never be entered
  9145. // concurrently, so every call into the session is serialized by one mutex.
  9146. //
  9147. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9148. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9149. // call under the lock, then waits for readiness with select() outside the
  9150. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9151. // blocked waiting for data never stalls a concurrent sender.
  9152. //
  9153. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9154. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9155. class WebSocketSSLStream final : public Stream {
  9156. public:
  9157. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9158. time_t read_timeout_sec, time_t read_timeout_usec,
  9159. time_t write_timeout_sec, time_t write_timeout_usec);
  9160. ~WebSocketSSLStream() override;
  9161. bool is_readable() const override;
  9162. bool wait_readable() const override;
  9163. bool wait_writable() const override;
  9164. ssize_t read(char *ptr, size_t size) override;
  9165. ssize_t write(const char *ptr, size_t size) override;
  9166. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9167. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9168. socket_t socket() const override;
  9169. time_t duration() const override;
  9170. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9171. void set_read_interrupt(std::function<bool()> interrupted) override;
  9172. private:
  9173. mutable std::mutex session_mutex_;
  9174. socket_t sock_;
  9175. tls::session_t session_;
  9176. // WebSocket::close() shortens the read timeout from the closing thread
  9177. // while the receive thread is inside wait_readable(), so these two are read
  9178. // and written concurrently. The write timeouts are never mutated.
  9179. std::atomic<time_t> read_timeout_sec_;
  9180. std::atomic<time_t> read_timeout_usec_;
  9181. time_t write_timeout_sec_;
  9182. time_t write_timeout_usec_;
  9183. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9184. std::function<bool()> read_interrupted_;
  9185. };
  9186. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9187. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9188. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9189. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9190. unsigned int hash_length = 0;
  9191. unsigned char hash[EVP_MAX_MD_SIZE];
  9192. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9193. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9194. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9195. std::stringstream ss;
  9196. for (auto i = 0u; i < hash_length; ++i) {
  9197. ss << std::hex << std::setw(2) << std::setfill('0')
  9198. << static_cast<unsigned int>(hash[i]);
  9199. }
  9200. return ss.str();
  9201. }
  9202. inline std::string MD5(const std::string &s) {
  9203. return message_digest(s, EVP_md5());
  9204. }
  9205. inline std::string SHA_256(const std::string &s) {
  9206. return message_digest(s, EVP_sha256());
  9207. }
  9208. inline std::string SHA_512(const std::string &s) {
  9209. return message_digest(s, EVP_sha512());
  9210. }
  9211. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9212. namespace {
  9213. template <size_t N>
  9214. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9215. std::stringstream ss;
  9216. for (size_t i = 0; i < N; ++i) {
  9217. ss << std::hex << std::setw(2) << std::setfill('0')
  9218. << static_cast<unsigned int>(hash[i]);
  9219. }
  9220. return ss.str();
  9221. }
  9222. } // namespace
  9223. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9224. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9225. // initialized once. PSA state is process-global; do not free it.
  9226. inline bool ensure_mbedtls_psa_crypto() {
  9227. static std::once_flag once;
  9228. static bool ok = false;
  9229. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9230. return ok;
  9231. }
  9232. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9233. unsigned char *out, size_t out_size) {
  9234. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9235. size_t olen = 0;
  9236. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9237. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9238. olen == out_size;
  9239. }
  9240. #endif
  9241. inline std::string MD5(const std::string &s) {
  9242. unsigned char hash[16];
  9243. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9244. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9245. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9246. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9247. hash);
  9248. #else
  9249. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9250. hash);
  9251. #endif
  9252. return hash_to_hex(hash);
  9253. }
  9254. inline std::string SHA_256(const std::string &s) {
  9255. unsigned char hash[32];
  9256. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9257. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9258. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9259. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9260. hash, 0);
  9261. #else
  9262. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9263. s.size(), hash, 0);
  9264. #endif
  9265. return hash_to_hex(hash);
  9266. }
  9267. inline std::string SHA_512(const std::string &s) {
  9268. unsigned char hash[64];
  9269. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9270. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9271. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9272. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9273. hash, 0);
  9274. #else
  9275. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9276. s.size(), hash, 0);
  9277. #endif
  9278. return hash_to_hex(hash);
  9279. }
  9280. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9281. namespace {
  9282. template <size_t N>
  9283. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9284. std::stringstream ss;
  9285. for (size_t i = 0; i < N; ++i) {
  9286. ss << std::hex << std::setw(2) << std::setfill('0')
  9287. << static_cast<unsigned int>(hash[i]);
  9288. }
  9289. return ss.str();
  9290. }
  9291. } // namespace
  9292. inline std::string MD5(const std::string &s) {
  9293. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9294. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9295. static_cast<word32>(s.size()), hash);
  9296. return hash_to_hex(hash);
  9297. }
  9298. inline std::string SHA_256(const std::string &s) {
  9299. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9300. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9301. static_cast<word32>(s.size()), hash);
  9302. return hash_to_hex(hash);
  9303. }
  9304. inline std::string SHA_512(const std::string &s) {
  9305. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9306. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9307. static_cast<word32>(s.size()), hash);
  9308. return hash_to_hex(hash);
  9309. }
  9310. #endif
  9311. template <typename T>
  9312. inline bool process_server_socket_ssl(
  9313. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9314. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9315. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9316. time_t write_timeout_usec, T callback) {
  9317. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9318. // of a pipelined request, which keep_alive() cannot see on the socket.
  9319. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9320. write_timeout_sec, write_timeout_usec);
  9321. return process_server_socket_core(
  9322. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9323. [&]() { return strm.is_readable(); },
  9324. [&](bool socket_readable, bool close_connection,
  9325. bool &connection_closed) {
  9326. if (socket_readable) { strm.set_readable_hint(); }
  9327. return callback(strm, close_connection, connection_closed);
  9328. });
  9329. }
  9330. template <typename T>
  9331. inline bool process_client_socket_ssl(
  9332. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9333. time_t read_timeout_usec, time_t write_timeout_sec,
  9334. time_t write_timeout_usec, time_t max_timeout_msec,
  9335. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9336. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9337. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9338. start_time);
  9339. return callback(strm);
  9340. }
  9341. // `uri` is req's request-target in origin form, as curl sends it, also when
  9342. // the request line carries the absolute form for a proxy.
  9343. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9344. const Request &req, const std::string &uri,
  9345. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9346. const std::string &cnonce, const std::string &username,
  9347. const std::string &password, bool is_proxy = false) {
  9348. std::string nc;
  9349. {
  9350. std::stringstream ss;
  9351. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9352. nc = ss.str();
  9353. }
  9354. std::string qop;
  9355. if (auth.find("qop") != auth.end()) {
  9356. qop = auth.at("qop");
  9357. if (qop.find("auth-int") != std::string::npos) {
  9358. qop = "auth-int";
  9359. } else if (qop.find("auth") != std::string::npos) {
  9360. qop = "auth";
  9361. } else {
  9362. qop.clear();
  9363. }
  9364. }
  9365. std::string algo = "MD5";
  9366. if (auth.find("algorithm") != auth.end()) {
  9367. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9368. // not a token would otherwise be emitted verbatim and could carry commas
  9369. // or quotes that inject further auth-params into the header below.
  9370. const auto &a = auth.at("algorithm");
  9371. if (fields::is_token(a)) { algo = a; }
  9372. }
  9373. std::string response;
  9374. {
  9375. auto H = algo == "SHA-256" ? detail::SHA_256
  9376. : algo == "SHA-512" ? detail::SHA_512
  9377. : detail::MD5;
  9378. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9379. auto A2 = req.method + ":" + uri;
  9380. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9381. if (qop.empty()) {
  9382. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9383. } else {
  9384. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9385. ":" + qop + ":" + H(A2));
  9386. }
  9387. }
  9388. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9389. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9390. // close the string early. realm, nonce and opaque come straight from the
  9391. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9392. // without this a crafted challenge injects extra auth-params into the header.
  9393. auto field =
  9394. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9395. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9396. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9397. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9398. "\", algorithm=" + algo +
  9399. (qop.empty() ? ", response=\""
  9400. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9401. "\", response=\"") +
  9402. response + "\"" +
  9403. (opaque.empty()
  9404. ? ""
  9405. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9406. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9407. return std::make_pair(key, field);
  9408. }
  9409. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9410. // backend accepts the same names.
  9411. inline bool match_hostname(const std::string &pattern,
  9412. const std::string &hostname) {
  9413. // A trailing dot on the host is ignored
  9414. auto host = hostname;
  9415. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9416. // Exact match (case-insensitive)
  9417. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9418. // Split both pattern and hostname into components by '.', keeping any empty
  9419. // one, which no name may have
  9420. auto labels = [](const std::string &s) {
  9421. std::vector<std::string> v;
  9422. size_t b = 0;
  9423. while (true) {
  9424. auto e = s.find('.', b);
  9425. v.push_back(s.substr(b, e - b));
  9426. if (e == std::string::npos) { return v; }
  9427. b = e + 1;
  9428. }
  9429. };
  9430. auto pattern_components = labels(pattern);
  9431. auto host_components = labels(host);
  9432. auto has_empty_label = [](const std::vector<std::string> &v) {
  9433. return std::any_of(v.begin(), v.end(),
  9434. [](const std::string &l) { return l.empty(); });
  9435. };
  9436. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9437. return false;
  9438. }
  9439. // Component count must match
  9440. if (host_components.size() != pattern_components.size()) { return false; }
  9441. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9442. // and an IDNA label may not have one
  9443. const auto &leftmost = pattern_components.front();
  9444. if (leftmost.find('*') != std::string::npos &&
  9445. (pattern_components.size() < 3 ||
  9446. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9447. return false;
  9448. }
  9449. // Compare each component with wildcard support
  9450. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9451. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9452. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9453. auto itr = pattern_components.begin();
  9454. for (const auto &h : host_components) {
  9455. auto &p = *itr;
  9456. auto is_leftmost = itr == pattern_components.begin();
  9457. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9458. bool partial_match = false;
  9459. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9460. const auto prefix_length = p.size() - 1;
  9461. if (prefix_length == 0) {
  9462. partial_match = true;
  9463. } else if (h.size() >= prefix_length) {
  9464. partial_match =
  9465. std::equal(p.begin(),
  9466. p.begin() + static_cast<std::string::difference_type>(
  9467. prefix_length),
  9468. h.begin(), [](const char ca, const char cb) {
  9469. return detail::case_ignore::to_lower(ca) ==
  9470. detail::case_ignore::to_lower(cb);
  9471. });
  9472. }
  9473. }
  9474. if (!partial_match) { return false; }
  9475. }
  9476. ++itr;
  9477. }
  9478. return true;
  9479. }
  9480. #ifdef _WIN32
  9481. // Verify certificate using Windows CertGetCertificateChain API.
  9482. // This provides real-time certificate validation with Windows Update
  9483. // integration, independent of the TLS backend.
  9484. inline bool verify_cert_with_windows_schannel(
  9485. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9486. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9487. if (der_cert.empty()) { return false; }
  9488. out_error = 0;
  9489. // Create Windows certificate context from DER data
  9490. auto cert_context = CertCreateCertificateContext(
  9491. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9492. static_cast<DWORD>(der_cert.size()));
  9493. if (!cert_context) {
  9494. out_error = GetLastError();
  9495. return false;
  9496. }
  9497. auto cert_guard =
  9498. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9499. // Give CryptoAPI the certificates the server sent. Without them it follows
  9500. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9501. std::vector<tls::cert_t> peer_certs;
  9502. tls::get_peer_certs(session, peer_certs);
  9503. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9504. auto store_guard = scope_exit([&] {
  9505. for (auto cert : peer_certs) {
  9506. tls::free_cert(cert);
  9507. }
  9508. if (store) { CertCloseStore(store, 0); }
  9509. });
  9510. for (auto cert : peer_certs) {
  9511. std::vector<unsigned char> der;
  9512. if (store && tls::get_cert_der(cert, der)) {
  9513. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9514. static_cast<DWORD>(der.size()),
  9515. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9516. }
  9517. }
  9518. // Setup chain parameters
  9519. CERT_CHAIN_PARA chain_para = {};
  9520. chain_para.cbSize = sizeof(chain_para);
  9521. // Require the server authentication usage along the chain, which also
  9522. // rejects roots that Windows trusts only for other purposes.
  9523. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9524. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9525. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9526. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9527. // Build certificate chain with revocation checking
  9528. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9529. auto chain_result = CertGetCertificateChain(
  9530. nullptr, cert_context, nullptr, store, &chain_para,
  9531. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9532. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9533. nullptr, &chain_context);
  9534. if (!chain_result || !chain_context) {
  9535. out_error = GetLastError();
  9536. return false;
  9537. }
  9538. auto chain_guard =
  9539. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9540. // Verify SSL policy
  9541. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9542. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9543. #ifdef AUTHTYPE_SERVER
  9544. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9545. #endif
  9546. std::wstring whost;
  9547. if (verify_hostname) {
  9548. whost = u8string_to_wstring(hostname.c_str());
  9549. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9550. }
  9551. CERT_CHAIN_POLICY_PARA policy_para = {};
  9552. policy_para.cbSize = sizeof(policy_para);
  9553. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9554. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9555. #else
  9556. policy_para.dwFlags = 0;
  9557. #endif
  9558. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9559. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9560. policy_status.cbSize = sizeof(policy_status);
  9561. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9562. &policy_para, &policy_status)) {
  9563. out_error = GetLastError();
  9564. return false;
  9565. }
  9566. if (policy_status.dwError != 0) {
  9567. out_error = policy_status.dwError;
  9568. return false;
  9569. }
  9570. return true;
  9571. }
  9572. #endif // _WIN32
  9573. // Loads CA file/dir configuration and applies the system CA policy to a
  9574. // client TLS context. PEM data and native stores are applied to the context
  9575. // directly at set time; has_custom_store reflects them for the Auto policy
  9576. // decision.
  9577. inline bool load_client_ca_config(tls::ctx_t ctx,
  9578. const std::string &ca_cert_file_path,
  9579. const std::string &ca_cert_dir_path,
  9580. bool has_custom_store, SystemCAMode mode,
  9581. uint64_t &backend_error) {
  9582. auto ret = true;
  9583. if (!ca_cert_file_path.empty()) {
  9584. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9585. backend_error = tls::get_error();
  9586. ret = false;
  9587. }
  9588. } else if (!ca_cert_dir_path.empty()) {
  9589. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9590. backend_error = tls::get_error();
  9591. ret = false;
  9592. }
  9593. }
  9594. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9595. !ca_cert_dir_path.empty() || has_custom_store;
  9596. if (mode == SystemCAMode::Enabled ||
  9597. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9598. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9599. }
  9600. return ret;
  9601. }
  9602. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9603. // loaded into another context.
  9604. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9605. std::string pem;
  9606. std::vector<tls::cert_t> certs;
  9607. tls::get_ca_certs(ctx, certs);
  9608. for (auto cert : certs) {
  9609. std::vector<unsigned char> der;
  9610. if (tls::get_cert_der(cert, der)) {
  9611. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9612. pem += "-----BEGIN CERTIFICATE-----\n";
  9613. for (size_t i = 0; i < b64.size(); i += 64) {
  9614. pem += b64.substr(i, 64);
  9615. pem += '\n';
  9616. }
  9617. pem += "-----END CERTIFICATE-----\n";
  9618. }
  9619. tls::free_cert(cert);
  9620. }
  9621. return pem;
  9622. }
  9623. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9624. // copied to buf, or pem itself when len is 0.
  9625. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9626. if (!pem || len == 0) { return pem; }
  9627. buf.assign(pem, len);
  9628. return buf.c_str();
  9629. }
  9630. // The parts of session setup that only SSLClient needs, plus the handful
  9631. // WebSocketClient also exposes; everything else takes the defaults, which is
  9632. // what keeps the two clients on one implementation.
  9633. struct ClientTlsSessionOptions {
  9634. // Both SSLClient and WebSocketClient expose this independently of
  9635. // certificate verification.
  9636. bool server_hostname_verification = true;
  9637. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9638. // When non-null, guards session creation against concurrent use of the
  9639. // context. A WebSocketClient is not safe to use from several threads to
  9640. // begin with, so it passes nothing.
  9641. std::mutex *ctx_mutex = nullptr;
  9642. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9643. // The caller decides whether Schannel has anything to say about this
  9644. // connection; see SSLClient::initialize_ssl().
  9645. bool windows_cert_verification = false;
  9646. // A server certificate verifier works on the backend's chain verification,
  9647. // so the backend keeps deciding and Schannel only adds its own check.
  9648. bool server_certificate_verifier_set = false;
  9649. #endif
  9650. };
  9651. // Filled in on failure for callers that report error details.
  9652. struct ClientTlsSessionError {
  9653. Error error = Error::Success;
  9654. int ssl_error = 0;
  9655. uint64_t backend_error = 0;
  9656. };
  9657. // Establishes a client TLS session on an already connected socket. On failure
  9658. // the session is left for the caller to free: SSLClient frees it right away,
  9659. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9660. inline bool setup_client_tls_session(
  9661. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9662. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9663. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9664. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9665. using namespace tls;
  9666. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9667. if (out_error) {
  9668. out_error->error = error;
  9669. out_error->ssl_error = ssl_error;
  9670. out_error->backend_error = backend_error;
  9671. }
  9672. return false;
  9673. };
  9674. // A TLS failure, whose verification codes name the Error too
  9675. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9676. auto error = Error::SSLConnection;
  9677. if (code == ErrorCode::CertVerifyFailed) {
  9678. error = Error::SSLServerVerification;
  9679. } else if (code == ErrorCode::HostnameMismatch) {
  9680. error = Error::SSLServerHostnameVerification;
  9681. }
  9682. return fail(error, static_cast<int>(code), backend_error);
  9683. };
  9684. if (!ctx) {
  9685. session = nullptr;
  9686. return fail(Error::SSLConnection, 0, 0);
  9687. }
  9688. // With Windows verification on and no server certificate verifier set,
  9689. // Schannel is the only chain verifier. The backend's trust store is a
  9690. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9691. // demand, so the backend's verdict is not used.
  9692. auto windows_verifies_chain = false;
  9693. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9694. windows_verifies_chain = options.windows_cert_verification &&
  9695. !options.server_certificate_verifier_set;
  9696. #endif
  9697. // The chain, and a host name, are verified during the handshake, so that a
  9698. // server failing them never gets to see a client certificate. Unless
  9699. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9700. // identity is checked after the handshake by verify_hostname().
  9701. auto verify_in_handshake =
  9702. server_certificate_verification && !windows_verifies_chain;
  9703. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9704. // A session verifier may accept a certificate the built-in check rejects,
  9705. // and runs only after the handshake
  9706. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9707. #endif
  9708. {
  9709. std::unique_lock<std::mutex> guard;
  9710. if (options.ctx_mutex) {
  9711. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9712. }
  9713. // The mode is set on the context, so under the same lock
  9714. set_verify_client(ctx, verify_in_handshake);
  9715. session = create_session(ctx, sock);
  9716. }
  9717. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9718. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9719. // their identity is checked post-handshake below instead.
  9720. if (!is_ip_address(host)) {
  9721. if (!set_sni(session, host.c_str(),
  9722. verify_in_handshake && options.server_hostname_verification)) {
  9723. return fail(Error::SSLConnection, 0, get_error());
  9724. }
  9725. }
  9726. TlsError tls_err;
  9727. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9728. &tls_err)) {
  9729. return fail_tls(tls_err.code, tls_err.backend_code);
  9730. }
  9731. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9732. if (options.session_verifier) {
  9733. verification_status = options.session_verifier(session);
  9734. }
  9735. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9736. return fail(Error::SSLServerVerification, 0, get_error());
  9737. }
  9738. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9739. server_certificate_verification) {
  9740. if (!windows_verifies_chain) {
  9741. auto verify_result = get_verify_result(session);
  9742. if (verify_result != 0) {
  9743. return fail_tls(ErrorCode::CertVerifyFailed,
  9744. static_cast<uint64_t>(verify_result));
  9745. }
  9746. }
  9747. auto server_cert = get_peer_cert(session);
  9748. if (!server_cert) {
  9749. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9750. }
  9751. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9752. // Identity check against the peer certificate, post-handshake for all
  9753. // backends. For IP hosts this is the only identity verification, since no
  9754. // hostname is bound during the handshake.
  9755. if (options.server_hostname_verification) {
  9756. if (!verify_hostname(server_cert, host.c_str())) {
  9757. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9758. }
  9759. }
  9760. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9761. // Windows Schannel verification, which lets Windows fetch missing roots
  9762. // and intermediates on demand. It must not be skipped: unless a server
  9763. // certificate verifier is set, it is the only chain check.
  9764. if (options.windows_cert_verification) {
  9765. std::vector<unsigned char> der;
  9766. uint64_t wincrypt_error = 0;
  9767. if (!get_cert_der(server_cert, der) ||
  9768. !verify_cert_with_windows_schannel(
  9769. der, host, options.server_hostname_verification, wincrypt_error,
  9770. session)) {
  9771. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9772. }
  9773. }
  9774. #endif
  9775. }
  9776. return true;
  9777. }
  9778. } // namespace detail
  9779. #endif // CPPHTTPLIB_SSL_ENABLED
  9780. /*
  9781. * Group 3: httplib namespace - Non-SSL public API implementations
  9782. */
  9783. inline void default_socket_options(socket_t sock) {
  9784. set_socket_opt(sock, SOL_SOCKET,
  9785. #ifdef SO_REUSEPORT
  9786. SO_REUSEPORT,
  9787. #else
  9788. SO_REUSEADDR,
  9789. #endif
  9790. 1);
  9791. }
  9792. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9793. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9794. sizeof(optval));
  9795. }
  9796. inline std::string get_bearer_token_auth(const Request &req) {
  9797. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9798. // than the prefix carries no token.
  9799. constexpr const char bearer_prefix[] = "Bearer ";
  9800. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9801. auto value = req.get_header_value("Authorization");
  9802. if (value.size() >= bearer_prefix_len &&
  9803. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9804. bearer_prefix)) {
  9805. return value.substr(bearer_prefix_len);
  9806. }
  9807. return "";
  9808. }
  9809. inline const char *status_message(int status) {
  9810. switch (status) {
  9811. case StatusCode::Continue_100: return "Continue";
  9812. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9813. case StatusCode::Processing_102: return "Processing";
  9814. case StatusCode::EarlyHints_103: return "Early Hints";
  9815. case StatusCode::OK_200: return "OK";
  9816. case StatusCode::Created_201: return "Created";
  9817. case StatusCode::Accepted_202: return "Accepted";
  9818. case StatusCode::NonAuthoritativeInformation_203:
  9819. return "Non-Authoritative Information";
  9820. case StatusCode::NoContent_204: return "No Content";
  9821. case StatusCode::ResetContent_205: return "Reset Content";
  9822. case StatusCode::PartialContent_206: return "Partial Content";
  9823. case StatusCode::MultiStatus_207: return "Multi-Status";
  9824. case StatusCode::AlreadyReported_208: return "Already Reported";
  9825. case StatusCode::IMUsed_226: return "IM Used";
  9826. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9827. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9828. case StatusCode::Found_302: return "Found";
  9829. case StatusCode::SeeOther_303: return "See Other";
  9830. case StatusCode::NotModified_304: return "Not Modified";
  9831. case StatusCode::UseProxy_305: return "Use Proxy";
  9832. case StatusCode::unused_306: return "unused";
  9833. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9834. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9835. case StatusCode::BadRequest_400: return "Bad Request";
  9836. case StatusCode::Unauthorized_401: return "Unauthorized";
  9837. case StatusCode::PaymentRequired_402: return "Payment Required";
  9838. case StatusCode::Forbidden_403: return "Forbidden";
  9839. case StatusCode::NotFound_404: return "Not Found";
  9840. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9841. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9842. case StatusCode::ProxyAuthenticationRequired_407:
  9843. return "Proxy Authentication Required";
  9844. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9845. case StatusCode::Conflict_409: return "Conflict";
  9846. case StatusCode::Gone_410: return "Gone";
  9847. case StatusCode::LengthRequired_411: return "Length Required";
  9848. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9849. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9850. case StatusCode::UriTooLong_414: return "URI Too Long";
  9851. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9852. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9853. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9854. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9855. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9856. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9857. case StatusCode::Locked_423: return "Locked";
  9858. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9859. case StatusCode::TooEarly_425: return "Too Early";
  9860. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9861. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9862. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9863. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9864. return "Request Header Fields Too Large";
  9865. case StatusCode::UnavailableForLegalReasons_451:
  9866. return "Unavailable For Legal Reasons";
  9867. case StatusCode::NotImplemented_501: return "Not Implemented";
  9868. case StatusCode::BadGateway_502: return "Bad Gateway";
  9869. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9870. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9871. case StatusCode::HttpVersionNotSupported_505:
  9872. return "HTTP Version Not Supported";
  9873. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9874. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9875. case StatusCode::LoopDetected_508: return "Loop Detected";
  9876. case StatusCode::NotExtended_510: return "Not Extended";
  9877. case StatusCode::NetworkAuthenticationRequired_511:
  9878. return "Network Authentication Required";
  9879. default:
  9880. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9881. }
  9882. }
  9883. inline std::string to_string(const Error error) {
  9884. switch (error) {
  9885. case Error::Success: return "Success (no error)";
  9886. case Error::Unknown: return "Unknown";
  9887. case Error::Connection: return "Could not establish connection";
  9888. case Error::BindIPAddress: return "Failed to bind IP address";
  9889. case Error::Read: return "Failed to read connection";
  9890. case Error::Write: return "Failed to write connection";
  9891. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9892. case Error::Canceled: return "Connection handling canceled";
  9893. case Error::SSLConnection: return "SSL connection failed";
  9894. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9895. case Error::SSLServerVerification: return "SSL server verification failed";
  9896. case Error::SSLServerHostnameVerification:
  9897. return "SSL server hostname verification failed";
  9898. case Error::UnsupportedMultipartBoundaryChars:
  9899. return "Unsupported HTTP multipart boundary characters";
  9900. case Error::Compression: return "Compression failed";
  9901. case Error::ConnectionTimeout: return "Connection timed out";
  9902. case Error::ProxyConnection: return "Proxy connection failed";
  9903. case Error::ConnectionClosed: return "Connection closed by server";
  9904. case Error::Timeout: return "Read timeout";
  9905. case Error::ResourceExhaustion: return "Resource exhaustion";
  9906. case Error::TooManyFormDataFiles: return "Too many form data files";
  9907. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9908. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9909. case Error::ExceedMaxSocketDescriptorCount:
  9910. return "Exceeded maximum socket descriptor count";
  9911. case Error::InvalidRequestLine: return "Invalid request line";
  9912. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9913. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9914. case Error::InvalidHeaders: return "Invalid headers";
  9915. case Error::MultipartParsing: return "Multipart parsing failed";
  9916. case Error::OpenFile: return "Failed to open file";
  9917. case Error::Listen: return "Failed to listen on socket";
  9918. case Error::GetSockName: return "Failed to get socket name";
  9919. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9920. case Error::HTTPParsing: return "HTTP parsing failed";
  9921. case Error::InvalidRangeHeader: return "Invalid Range header";
  9922. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9923. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9924. case Error::UserCallbackException: return "User callback threw an exception";
  9925. default: break;
  9926. }
  9927. return "Invalid";
  9928. }
  9929. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9930. os << to_string(obj);
  9931. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9932. return os;
  9933. }
  9934. inline std::string hosted_at(const std::string &hostname) {
  9935. std::vector<std::string> addrs;
  9936. hosted_at(hostname, addrs);
  9937. if (addrs.empty()) { return std::string(); }
  9938. return addrs[0];
  9939. }
  9940. inline void hosted_at(const std::string &hostname,
  9941. std::vector<std::string> &addrs) {
  9942. struct addrinfo hints;
  9943. struct addrinfo *result;
  9944. memset(&hints, 0, sizeof(struct addrinfo));
  9945. hints.ai_family = AF_UNSPEC;
  9946. hints.ai_socktype = SOCK_STREAM;
  9947. hints.ai_protocol = 0;
  9948. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9949. &result, 0)) {
  9950. #if defined __linux__ && !defined __ANDROID__
  9951. res_init();
  9952. #endif
  9953. return;
  9954. }
  9955. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9956. for (auto rp = result; rp; rp = rp->ai_next) {
  9957. const auto &addr =
  9958. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9959. std::string ip;
  9960. auto dummy = -1;
  9961. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9962. dummy)) {
  9963. addrs.emplace_back(std::move(ip));
  9964. }
  9965. }
  9966. }
  9967. inline std::string encode_uri_component(const std::string &value) {
  9968. std::ostringstream escaped;
  9969. escaped.fill('0');
  9970. escaped << std::hex;
  9971. for (auto c : value) {
  9972. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9973. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9974. escaped << c;
  9975. } else {
  9976. escaped << std::uppercase;
  9977. escaped << '%' << std::setw(2)
  9978. << static_cast<int>(static_cast<unsigned char>(c));
  9979. escaped << std::nouppercase;
  9980. }
  9981. }
  9982. return escaped.str();
  9983. }
  9984. inline std::string encode_uri(const std::string &value) {
  9985. std::ostringstream escaped;
  9986. escaped.fill('0');
  9987. escaped << std::hex;
  9988. for (auto c : value) {
  9989. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9990. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9991. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9992. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9993. escaped << c;
  9994. } else {
  9995. escaped << std::uppercase;
  9996. escaped << '%' << std::setw(2)
  9997. << static_cast<int>(static_cast<unsigned char>(c));
  9998. escaped << std::nouppercase;
  9999. }
  10000. }
  10001. return escaped.str();
  10002. }
  10003. inline std::string decode_uri_component(const std::string &value) {
  10004. std::string result;
  10005. for (size_t i = 0; i < value.size(); i++) {
  10006. if (value[i] == '%' && i + 2 < value.size()) {
  10007. auto val = 0;
  10008. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10009. result += static_cast<char>(val);
  10010. i += 2;
  10011. } else {
  10012. result += value[i];
  10013. }
  10014. } else {
  10015. result += value[i];
  10016. }
  10017. }
  10018. return result;
  10019. }
  10020. inline std::string decode_uri(const std::string &value) {
  10021. std::string result;
  10022. for (size_t i = 0; i < value.size(); i++) {
  10023. if (value[i] == '%' && i + 2 < value.size()) {
  10024. auto val = 0;
  10025. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10026. auto c = static_cast<char>(val);
  10027. // Keep escapes of the reserved characters that encode_uri leaves
  10028. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10029. // delimiter is not promoted into a real one (as with JS decodeURI).
  10030. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10031. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10032. c == '#') {
  10033. result += value[i];
  10034. result += value[i + 1];
  10035. result += value[i + 2];
  10036. } else {
  10037. result += c;
  10038. }
  10039. i += 2;
  10040. } else {
  10041. result += value[i];
  10042. }
  10043. } else {
  10044. result += value[i];
  10045. }
  10046. }
  10047. return result;
  10048. }
  10049. inline std::string encode_path_component(const std::string &component) {
  10050. std::string result;
  10051. result.reserve(component.size() * 3);
  10052. for (size_t i = 0; i < component.size(); i++) {
  10053. auto c = static_cast<unsigned char>(component[i]);
  10054. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10055. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10056. c == '_' || c == '~') {
  10057. result += static_cast<char>(c);
  10058. }
  10059. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10060. // "," / ";" / "="
  10061. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10062. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10063. c == '=') {
  10064. result += static_cast<char>(c);
  10065. }
  10066. // Colon is allowed in path segments except first segment
  10067. else if (c == ':') {
  10068. result += static_cast<char>(c);
  10069. }
  10070. // @ is allowed in path
  10071. else if (c == '@') {
  10072. result += static_cast<char>(c);
  10073. } else {
  10074. result += '%';
  10075. char hex[3];
  10076. snprintf(hex, sizeof(hex), "%02X", c);
  10077. result.append(hex, 2);
  10078. }
  10079. }
  10080. return result;
  10081. }
  10082. inline std::string decode_path_component(const std::string &component) {
  10083. std::string result;
  10084. result.reserve(component.size());
  10085. for (size_t i = 0; i < component.size(); i++) {
  10086. if (component[i] == '%' && i + 1 < component.size()) {
  10087. if (component[i + 1] == 'u') {
  10088. // Unicode %uXXXX encoding
  10089. auto val = 0;
  10090. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10091. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10092. char buff[4];
  10093. size_t len = 0;
  10094. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10095. (len = detail::to_utf8(val, buff)) > 0) {
  10096. result.append(buff, len);
  10097. i += 5; // 'u0000'
  10098. } else {
  10099. // Not 4 hex digits, or a surrogate, which is no character: the
  10100. // escape is kept as it is rather than joining its neighbours
  10101. result += component[i];
  10102. }
  10103. } else {
  10104. // Standard %XX encoding
  10105. auto val = 0;
  10106. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10107. // 2 digits hex codes
  10108. result += static_cast<char>(val);
  10109. i += 2; // 'XX'
  10110. } else {
  10111. result += component[i];
  10112. }
  10113. }
  10114. } else {
  10115. result += component[i];
  10116. }
  10117. }
  10118. return result;
  10119. }
  10120. inline std::string encode_query_component(const std::string &component,
  10121. bool space_as_plus) {
  10122. std::string result;
  10123. result.reserve(component.size() * 3);
  10124. for (size_t i = 0; i < component.size(); i++) {
  10125. auto c = static_cast<unsigned char>(component[i]);
  10126. // Unreserved characters per RFC 3986
  10127. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10128. c == '_' || c == '~') {
  10129. result += static_cast<char>(c);
  10130. }
  10131. // Space handling
  10132. else if (c == ' ') {
  10133. if (space_as_plus) {
  10134. result += '+';
  10135. } else {
  10136. result += "%20";
  10137. }
  10138. }
  10139. // Plus sign handling
  10140. else if (c == '+') {
  10141. if (space_as_plus) {
  10142. result += "%2B";
  10143. } else {
  10144. result += static_cast<char>(c);
  10145. }
  10146. }
  10147. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10148. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10149. c == '*' || c == ',' || c == ';') {
  10150. result += static_cast<char>(c);
  10151. }
  10152. // Colon and @ are allowed in query
  10153. else if (c == ':' || c == '@') {
  10154. result += static_cast<char>(c);
  10155. }
  10156. // Forward slash is allowed in query values
  10157. else if (c == '/') {
  10158. result += static_cast<char>(c);
  10159. }
  10160. // Question mark is allowed in query values (after first ?)
  10161. else if (c == '?') {
  10162. result += static_cast<char>(c);
  10163. } else {
  10164. result += '%';
  10165. char hex[3];
  10166. snprintf(hex, sizeof(hex), "%02X", c);
  10167. result.append(hex, 2);
  10168. }
  10169. }
  10170. return result;
  10171. }
  10172. inline std::string decode_query_component(const std::string &component,
  10173. bool plus_as_space) {
  10174. std::string result;
  10175. result.reserve(component.size());
  10176. for (size_t i = 0; i < component.size(); i++) {
  10177. if (component[i] == '%' && i + 2 < component.size()) {
  10178. auto val = 0;
  10179. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10180. result += static_cast<char>(val);
  10181. i += 2;
  10182. } else {
  10183. result += component[i];
  10184. }
  10185. } else if (component[i] == '+' && plus_as_space) {
  10186. result += ' '; // + becomes space in form-urlencoded
  10187. } else {
  10188. result += component[i];
  10189. }
  10190. }
  10191. return result;
  10192. }
  10193. inline std::string sanitize_filename(const std::string &filename) {
  10194. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10195. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10196. #ifdef _WIN32
  10197. auto pos = filename.find_last_of("/\\:");
  10198. #else
  10199. auto pos = filename.find_last_of("/\\");
  10200. #endif
  10201. auto result =
  10202. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10203. // Strip null bytes
  10204. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10205. // Trim whitespace
  10206. {
  10207. auto start = result.find_first_not_of(" \t");
  10208. auto end = result.find_last_not_of(" \t");
  10209. result = (start == std::string::npos)
  10210. ? ""
  10211. : result.substr(start, end - start + 1);
  10212. }
  10213. // Reject . and ..
  10214. if (result == "." || result == "..") { return ""; }
  10215. return result;
  10216. }
  10217. inline std::string append_query_params(const std::string &path,
  10218. const Params &params) {
  10219. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10220. auto fragment_pos = path.find('#');
  10221. auto path_with_query = path.substr(0, fragment_pos);
  10222. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10223. path_with_query += detail::params_to_query_str(params);
  10224. if (fragment_pos != std::string::npos) {
  10225. path_with_query.append(path, fragment_pos, std::string::npos);
  10226. }
  10227. return path_with_query;
  10228. }
  10229. // Header utilities
  10230. inline std::pair<std::string, std::string>
  10231. make_range_header(const Ranges &ranges) {
  10232. std::string field = "bytes=";
  10233. auto i = 0;
  10234. for (const auto &r : ranges) {
  10235. if (i != 0) { field += ", "; }
  10236. if (r.first != -1) { field += std::to_string(r.first); }
  10237. field += '-';
  10238. if (r.second != -1) { field += std::to_string(r.second); }
  10239. i++;
  10240. }
  10241. return std::make_pair("Range", std::move(field));
  10242. }
  10243. inline std::pair<std::string, std::string>
  10244. make_basic_authentication_header(const std::string &username,
  10245. const std::string &password, bool is_proxy) {
  10246. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10247. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10248. return std::make_pair(key, std::move(field));
  10249. }
  10250. inline std::pair<std::string, std::string>
  10251. make_bearer_token_authentication_header(const std::string &token,
  10252. bool is_proxy = false) {
  10253. auto field = "Bearer " + token;
  10254. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10255. return std::make_pair(key, std::move(field));
  10256. }
  10257. namespace detail {
  10258. // Basic auth when a username or password is set, otherwise a bearer token,
  10259. // unless the request already carries the header.
  10260. inline void add_authorization_header(Request &req, const std::string &username,
  10261. const std::string &password,
  10262. const std::string &token, bool is_proxy) {
  10263. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10264. return;
  10265. }
  10266. if (!username.empty() || !password.empty()) {
  10267. req.headers.insert(
  10268. make_basic_authentication_header(username, password, is_proxy));
  10269. } else if (!token.empty()) {
  10270. req.headers.insert(
  10271. make_bearer_token_authentication_header(token, is_proxy));
  10272. }
  10273. }
  10274. } // namespace detail
  10275. // Request implementation
  10276. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10277. size_t id) const {
  10278. return detail::get_header_value_u64(headers, key, def, id);
  10279. }
  10280. inline bool Request::has_header(const std::string &key) const {
  10281. return detail::has_header(headers, key);
  10282. }
  10283. inline std::string Request::get_header_value(const std::string &key,
  10284. const char *def, size_t id) const {
  10285. return detail::get_header_value(headers, key, def, id);
  10286. }
  10287. inline size_t Request::get_header_value_count(const std::string &key) const {
  10288. return detail::get_header_value_count(headers, key);
  10289. }
  10290. inline void Request::set_header(const std::string &key,
  10291. const std::string &val) {
  10292. detail::set_header(headers, key, val);
  10293. }
  10294. inline bool Request::has_trailer(const std::string &key) const {
  10295. return trailers.find(key) != trailers.end();
  10296. }
  10297. inline std::string Request::get_trailer_value(const std::string &key,
  10298. size_t id) const {
  10299. return detail::get_multimap_value(trailers, key, id);
  10300. }
  10301. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10302. return trailers.count(key);
  10303. }
  10304. inline bool Request::has_param(const std::string &key) const {
  10305. return params.find(key) != params.end();
  10306. }
  10307. inline std::string Request::get_param_value(const std::string &key,
  10308. size_t id) const {
  10309. return detail::get_multimap_value(params, key, id);
  10310. }
  10311. inline std::vector<std::string>
  10312. Request::get_param_values(const std::string &key) const {
  10313. auto rng = params.equal_range(key);
  10314. std::vector<std::string> values;
  10315. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10316. for (auto it = rng.first; it != rng.second; ++it) {
  10317. values.push_back(it->second);
  10318. }
  10319. return values;
  10320. }
  10321. inline size_t Request::get_param_value_count(const std::string &key) const {
  10322. return params.count(key);
  10323. }
  10324. inline bool Request::is_multipart_form_data() const {
  10325. const auto &content_type = get_header_value("Content-Type");
  10326. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10327. "multipart/form-data");
  10328. }
  10329. // Multipart FormData implementation
  10330. inline std::string MultipartFormData::get_field(const std::string &key,
  10331. size_t id) const {
  10332. auto rng = fields.equal_range(key);
  10333. auto it = detail::bounded_next(rng.first, id, rng.second);
  10334. if (it != rng.second) { return it->second.content; }
  10335. return std::string();
  10336. }
  10337. inline std::vector<std::string>
  10338. MultipartFormData::get_fields(const std::string &key) const {
  10339. std::vector<std::string> values;
  10340. auto rng = fields.equal_range(key);
  10341. for (auto it = rng.first; it != rng.second; it++) {
  10342. values.push_back(it->second.content);
  10343. }
  10344. return values;
  10345. }
  10346. inline bool MultipartFormData::has_field(const std::string &key) const {
  10347. return fields.find(key) != fields.end();
  10348. }
  10349. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10350. return fields.count(key);
  10351. }
  10352. inline FormData MultipartFormData::get_file(const std::string &key,
  10353. size_t id) const {
  10354. return detail::get_multimap_value(files, key, id);
  10355. }
  10356. inline std::vector<FormData>
  10357. MultipartFormData::get_files(const std::string &key) const {
  10358. std::vector<FormData> values;
  10359. auto rng = files.equal_range(key);
  10360. for (auto it = rng.first; it != rng.second; it++) {
  10361. values.push_back(it->second);
  10362. }
  10363. return values;
  10364. }
  10365. inline bool MultipartFormData::has_file(const std::string &key) const {
  10366. return files.find(key) != files.end();
  10367. }
  10368. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10369. return files.count(key);
  10370. }
  10371. // Multipart FormData writer implementation
  10372. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10373. return detail::is_multipart_boundary_chars_valid(boundary);
  10374. }
  10375. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10376. : boundary_(detail::make_multipart_data_boundary()) {}
  10377. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10378. : boundary_(std::move(boundary)) {}
  10379. inline const std::string &MultipartFormDataWriter::boundary() const {
  10380. return boundary_;
  10381. }
  10382. inline std::string MultipartFormDataWriter::content_type() const {
  10383. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10384. }
  10385. inline std::string
  10386. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10387. return detail::serialize_multipart_formdata(items, boundary_);
  10388. }
  10389. inline size_t MultipartFormDataWriter::content_length(
  10390. const UploadFormDataItems &items) const {
  10391. return detail::get_multipart_content_length(items, boundary_);
  10392. }
  10393. inline std::string
  10394. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10395. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10396. }
  10397. inline std::string MultipartFormDataWriter::item_end() {
  10398. return detail::serialize_multipart_formdata_item_end();
  10399. }
  10400. inline std::string MultipartFormDataWriter::finish() const {
  10401. return detail::serialize_multipart_formdata_finish(boundary_);
  10402. }
  10403. // Response implementation
  10404. namespace detail {
  10405. // A response has one content source: `body`, a content provider, or a file.
  10406. // Each content setter calls this so that the one called last wins.
  10407. inline void clear_content_provider(Response &res) {
  10408. auto releaser = std::move(res.content_provider_resource_releaser_);
  10409. auto success = res.content_provider_success_;
  10410. res.content_length_ = 0;
  10411. res.content_provider_ = nullptr;
  10412. res.content_provider_resource_releaser_ = nullptr;
  10413. res.is_chunked_content_provider_ = false;
  10414. res.is_file_content_provider_ = false;
  10415. res.content_provider_success_ = false;
  10416. res.content_coding_ = EncodingType::None;
  10417. res.file_content_path_.clear();
  10418. res.file_content_content_type_.clear();
  10419. if (releaser) { releaser(success); }
  10420. }
  10421. inline void clear_content(Response &res) {
  10422. res.body.clear();
  10423. clear_content_provider(res);
  10424. }
  10425. // The Content-Type of the old content goes with it.
  10426. inline void set_content_type(Response &res, const std::string &content_type) {
  10427. res.headers.erase("Content-Type");
  10428. res.set_header("Content-Type", content_type);
  10429. }
  10430. // `body` is public, so it can be assigned directly after a provider or a file
  10431. // was set. It came last, so it wins.
  10432. inline void prefer_assigned_body(Response &res) {
  10433. if (!res.body.empty() &&
  10434. (res.content_provider_ || !res.file_content_path_.empty())) {
  10435. clear_content_provider(res);
  10436. }
  10437. }
  10438. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10439. inline bool body_allowed_for_status(int status) {
  10440. return status >= 200 && status != StatusCode::NoContent_204 &&
  10441. status != StatusCode::NotModified_304;
  10442. }
  10443. // Only a 206 response is served as a partial representation. range_error()
  10444. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10445. // status would start from an unchecked offset.
  10446. inline bool is_partial_content(const Request &req, const Response &res) {
  10447. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10448. }
  10449. // Sets the Content-Length or Transfer-Encoding framing the body that
  10450. // Server::write_response_core() writes, or closes the connection after a body
  10451. // that has neither. Only the library sets them: one from a handler would go
  10452. // out next to it, or describe some other body.
  10453. inline void set_framing_headers(const Request &req, Response &res,
  10454. const std::string &boundary,
  10455. const std::string &content_type) {
  10456. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10457. auto head_length = req.method == "HEAD"
  10458. ? res.get_header_value("Content-Length")
  10459. : std::string();
  10460. res.headers.erase("Content-Length");
  10461. res.headers.erase("Transfer-Encoding");
  10462. if (!body_allowed_for_status(res.status)) { return; }
  10463. if (res.content_provider_) {
  10464. if (res.content_length_ == 0) {
  10465. if (res.is_chunked_content_provider_) {
  10466. res.set_header("Transfer-Encoding", "chunked");
  10467. } else if (req.method != "HEAD") {
  10468. // RFC 9112 6.3: a body with neither ends where the connection does.
  10469. res.headers.erase("Keep-Alive");
  10470. if (!has_header_token(res.headers, "Connection", "close")) {
  10471. res.set_header("Connection", "close");
  10472. }
  10473. }
  10474. return;
  10475. }
  10476. // The part Server::write_content_with_provider() writes.
  10477. auto length = res.content_length_;
  10478. if (is_partial_content(req, res)) {
  10479. length = req.ranges.size() == 1
  10480. ? get_range_offset_and_length(req.ranges[0], length).second
  10481. : get_multipart_ranges_data_length(req, boundary,
  10482. content_type, length);
  10483. }
  10484. res.set_header("Content-Length", std::to_string(length));
  10485. } else if (!res.body.empty()) {
  10486. res.set_header("Content-Length", std::to_string(res.body.size()));
  10487. } else {
  10488. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10489. }
  10490. }
  10491. } // namespace detail
  10492. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10493. size_t id) const {
  10494. return detail::get_header_value_u64(headers, key, def, id);
  10495. }
  10496. inline bool Response::has_header(const std::string &key) const {
  10497. return headers.find(key) != headers.end();
  10498. }
  10499. inline std::string Response::get_header_value(const std::string &key,
  10500. const char *def,
  10501. size_t id) const {
  10502. return detail::get_header_value(headers, key, def, id);
  10503. }
  10504. inline size_t Response::get_header_value_count(const std::string &key) const {
  10505. return detail::get_header_value_count(headers, key);
  10506. }
  10507. inline void Response::set_header(const std::string &key,
  10508. const std::string &val) {
  10509. detail::set_header(headers, key, val);
  10510. }
  10511. inline bool Response::has_trailer(const std::string &key) const {
  10512. return trailers.find(key) != trailers.end();
  10513. }
  10514. inline std::string Response::get_trailer_value(const std::string &key,
  10515. size_t id) const {
  10516. return detail::get_multimap_value(trailers, key, id);
  10517. }
  10518. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10519. return trailers.count(key);
  10520. }
  10521. inline void Response::set_redirect(const std::string &url, int stat) {
  10522. if (detail::fields::is_field_value(url)) {
  10523. set_header("Location", url);
  10524. if (300 <= stat && stat < 400) {
  10525. this->status = stat;
  10526. } else {
  10527. this->status = StatusCode::Found_302;
  10528. }
  10529. }
  10530. }
  10531. inline void Response::set_content(const char *s, size_t n,
  10532. const std::string &content_type) {
  10533. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10534. detail::clear_content_provider(*this);
  10535. detail::set_content_type(*this, content_type);
  10536. }
  10537. inline void Response::set_content(const std::string &s,
  10538. const std::string &content_type) {
  10539. set_content(s.data(), s.size(), content_type);
  10540. }
  10541. inline void Response::set_content(std::string &&s,
  10542. const std::string &content_type) {
  10543. body = std::move(s);
  10544. detail::clear_content_provider(*this);
  10545. detail::set_content_type(*this, content_type);
  10546. }
  10547. inline void Response::set_content_provider(
  10548. size_t in_length, const std::string &content_type, ContentProvider provider,
  10549. ContentProviderResourceReleaser resource_releaser) {
  10550. detail::clear_content(*this);
  10551. detail::set_content_type(*this, content_type);
  10552. content_length_ = in_length;
  10553. if (in_length > 0) { content_provider_ = std::move(provider); }
  10554. content_provider_resource_releaser_ = std::move(resource_releaser);
  10555. }
  10556. inline void Response::set_content_provider(
  10557. const std::string &content_type, ContentProviderWithoutLength provider,
  10558. ContentProviderResourceReleaser resource_releaser) {
  10559. detail::clear_content(*this);
  10560. detail::set_content_type(*this, content_type);
  10561. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10562. content_provider_resource_releaser_ = std::move(resource_releaser);
  10563. }
  10564. inline void Response::set_chunked_content_provider(
  10565. const std::string &content_type, ContentProviderWithoutLength provider,
  10566. ContentProviderResourceReleaser resource_releaser) {
  10567. set_content_provider(content_type, std::move(provider),
  10568. std::move(resource_releaser));
  10569. is_chunked_content_provider_ = true;
  10570. }
  10571. inline void Response::set_file_content(const std::string &path,
  10572. const std::string &content_type) {
  10573. detail::clear_content(*this);
  10574. headers.erase("Content-Type");
  10575. file_content_path_ = path;
  10576. file_content_content_type_ = content_type;
  10577. }
  10578. inline void Response::set_file_content(const std::string &path) {
  10579. set_file_content(path, std::string());
  10580. }
  10581. // Result implementation
  10582. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10583. size_t def,
  10584. size_t id) const {
  10585. return detail::get_header_value_u64(request_headers_, key, def, id);
  10586. }
  10587. inline bool Result::has_request_header(const std::string &key) const {
  10588. return request_headers_.find(key) != request_headers_.end();
  10589. }
  10590. inline std::string Result::get_request_header_value(const std::string &key,
  10591. const char *def,
  10592. size_t id) const {
  10593. return detail::get_header_value(request_headers_, key, def, id);
  10594. }
  10595. inline size_t
  10596. Result::get_request_header_value_count(const std::string &key) const {
  10597. return request_headers_.count(key);
  10598. }
  10599. // Stream implementation
  10600. inline ssize_t Stream::write(const char *ptr) {
  10601. return write(ptr, strlen(ptr));
  10602. }
  10603. inline ssize_t Stream::write(const std::string &s) {
  10604. return write(s.data(), s.size());
  10605. }
  10606. // BodyReader implementation
  10607. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10608. if (!stream) {
  10609. last_error = Error::Connection;
  10610. return -1;
  10611. }
  10612. if (eof) { return 0; }
  10613. if (!chunked) {
  10614. // Content-Length based reading
  10615. if (has_content_length && bytes_read >= content_length) {
  10616. eof = true;
  10617. return 0;
  10618. }
  10619. auto to_read = len;
  10620. if (has_content_length) {
  10621. auto remaining = content_length - bytes_read;
  10622. to_read = (std::min)(len, remaining);
  10623. }
  10624. auto n = stream->read(buf, to_read);
  10625. // Without Content-Length the body ends when the connection closes
  10626. // (RFC 9112 §6.3); with one, an EOF here came too early
  10627. if (n < 0 || (n == 0 && has_content_length)) {
  10628. last_error = stream->get_error();
  10629. if (last_error == Error::Success) { last_error = Error::Read; }
  10630. }
  10631. if (n <= 0) {
  10632. eof = true;
  10633. return n;
  10634. }
  10635. bytes_read += static_cast<size_t>(n);
  10636. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10637. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10638. last_error = Error::ExceedMaxPayloadSize;
  10639. eof = true;
  10640. return -1;
  10641. }
  10642. return n;
  10643. }
  10644. // Chunked transfer encoding: delegate to shared decoder instance.
  10645. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10646. size_t chunk_offset = 0;
  10647. size_t chunk_total = 0;
  10648. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10649. if (n < 0) {
  10650. last_error = stream->get_error();
  10651. if (last_error == Error::Success) { last_error = Error::Read; }
  10652. eof = true;
  10653. return n;
  10654. }
  10655. if (n == 0) {
  10656. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10657. eof = true;
  10658. return 0;
  10659. }
  10660. bytes_read += static_cast<size_t>(n);
  10661. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10662. last_error = Error::ExceedMaxPayloadSize;
  10663. eof = true;
  10664. return -1;
  10665. }
  10666. return n;
  10667. }
  10668. // ThreadPool implementation
  10669. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10670. time_t idle_timeout_sec)
  10671. : base_thread_count_(n), max_queued_requests_(mqr),
  10672. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10673. shutdown_(false) {
  10674. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10675. if (max_n != 0 && max_n < n) {
  10676. std::string msg = "max_threads must be >= base_threads";
  10677. throw std::invalid_argument(msg);
  10678. }
  10679. #endif
  10680. max_thread_count_ = max_n == 0 ? n : max_n;
  10681. threads_.reserve(base_thread_count_);
  10682. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10683. try {
  10684. #endif
  10685. for (size_t i = 0; i < base_thread_count_; i++) {
  10686. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10687. }
  10688. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10689. } catch (...) {
  10690. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10691. // signal the workers we already spawned to exit and join them so the
  10692. // vector destructor does not see joinable threads (which would call
  10693. // std::terminate). Then rethrow so the caller learns of the failure.
  10694. {
  10695. std::unique_lock<std::mutex> lock(mutex_);
  10696. shutdown_ = true;
  10697. }
  10698. cond_.notify_all();
  10699. for (auto &t : threads_) {
  10700. if (t.joinable()) { t.join(); }
  10701. }
  10702. throw;
  10703. }
  10704. #endif
  10705. }
  10706. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10707. {
  10708. std::unique_lock<std::mutex> lock(mutex_);
  10709. if (shutdown_) { return false; }
  10710. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10711. return false;
  10712. }
  10713. jobs_.push_back(std::move(fn));
  10714. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10715. if (jobs_.size() > idle_thread_count_ &&
  10716. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10717. cleanup_finished_threads();
  10718. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10719. }
  10720. }
  10721. cond_.notify_one();
  10722. return true;
  10723. }
  10724. inline void ThreadPool::shutdown() {
  10725. {
  10726. std::unique_lock<std::mutex> lock(mutex_);
  10727. shutdown_ = true;
  10728. }
  10729. cond_.notify_all();
  10730. for (auto &t : threads_) {
  10731. if (t.joinable()) { t.join(); }
  10732. }
  10733. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10734. // with worker threads that call move_to_finished() concurrently.
  10735. std::list<std::thread> remaining_dynamic;
  10736. {
  10737. std::unique_lock<std::mutex> lock(mutex_);
  10738. remaining_dynamic = std::move(dynamic_threads_);
  10739. }
  10740. for (auto &t : remaining_dynamic) {
  10741. if (t.joinable()) { t.join(); }
  10742. }
  10743. std::unique_lock<std::mutex> lock(mutex_);
  10744. cleanup_finished_threads();
  10745. }
  10746. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10747. // Must be called with mutex_ held
  10748. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10749. if (it->get_id() == id) {
  10750. finished_threads_.push_back(std::move(*it));
  10751. dynamic_threads_.erase(it);
  10752. return;
  10753. }
  10754. }
  10755. }
  10756. inline void ThreadPool::cleanup_finished_threads() {
  10757. // Must be called with mutex_ held
  10758. for (auto &t : finished_threads_) {
  10759. if (t.joinable()) { t.join(); }
  10760. }
  10761. finished_threads_.clear();
  10762. }
  10763. inline void ThreadPool::worker(bool is_dynamic) {
  10764. for (;;) {
  10765. std::function<void()> fn;
  10766. {
  10767. std::unique_lock<std::mutex> lock(mutex_);
  10768. idle_thread_count_++;
  10769. if (is_dynamic) {
  10770. auto has_work =
  10771. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10772. [&] { return !jobs_.empty() || shutdown_; });
  10773. if (!has_work) {
  10774. // Timed out with no work - exit this dynamic thread
  10775. idle_thread_count_--;
  10776. move_to_finished(std::this_thread::get_id());
  10777. break;
  10778. }
  10779. } else {
  10780. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10781. }
  10782. idle_thread_count_--;
  10783. if (shutdown_ && jobs_.empty()) { break; }
  10784. fn = std::move(jobs_.front());
  10785. jobs_.pop_front();
  10786. }
  10787. assert(true == static_cast<bool>(fn));
  10788. fn();
  10789. }
  10790. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10791. !defined(LIBRESSL_VERSION_NUMBER)
  10792. OPENSSL_thread_stop();
  10793. #endif
  10794. }
  10795. /*
  10796. * Group 1 (continued): detail namespace - Stream implementations
  10797. */
  10798. namespace detail {
  10799. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10800. time_t timeout_sec, time_t timeout_usec,
  10801. time_t &actual_timeout_sec,
  10802. time_t &actual_timeout_usec) {
  10803. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10804. auto actual_timeout_msec =
  10805. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10806. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10807. actual_timeout_sec = actual_timeout_msec / 1000;
  10808. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10809. }
  10810. // Socket stream implementation
  10811. inline SocketStream::SocketStream(
  10812. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10813. time_t write_timeout_sec, time_t write_timeout_usec,
  10814. time_t max_timeout_msec,
  10815. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10816. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10817. read_timeout_usec_(read_timeout_usec),
  10818. write_timeout_sec_(write_timeout_sec),
  10819. write_timeout_usec_(write_timeout_usec),
  10820. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10821. read_buff_(read_buff_size_, 0) {}
  10822. inline SocketStream::~SocketStream() = default;
  10823. inline bool SocketStream::is_readable() const {
  10824. return read_buff_off_ < read_buff_content_size_;
  10825. }
  10826. inline bool SocketStream::wait_readable() const {
  10827. if (max_timeout_msec_ <= 0) {
  10828. return select_read_interruptible(sock_, read_timeout_sec_,
  10829. read_timeout_usec_, read_interrupted_) > 0;
  10830. }
  10831. time_t read_timeout_sec;
  10832. time_t read_timeout_usec;
  10833. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10834. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10835. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10836. read_interrupted_) > 0;
  10837. }
  10838. inline bool SocketStream::wait_writable() const {
  10839. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10840. }
  10841. inline bool SocketStream::ensure_readable() {
  10842. if (readable_hint_) {
  10843. readable_hint_ = false;
  10844. return true;
  10845. }
  10846. return wait_readable();
  10847. }
  10848. inline const char *SocketStream::buffered_data(size_t &size) const {
  10849. size = read_buff_content_size_ - read_buff_off_;
  10850. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10851. }
  10852. inline void SocketStream::consume_buffered(size_t size) {
  10853. assert(size <= read_buff_content_size_ - read_buff_off_);
  10854. read_buff_off_ += size;
  10855. }
  10856. inline bool SocketStream::is_peer_alive() const {
  10857. return detail::is_socket_alive(sock_);
  10858. }
  10859. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10860. #ifdef _WIN32
  10861. size =
  10862. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10863. #else
  10864. size = (std::min)(size,
  10865. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10866. #endif
  10867. if (read_buff_off_ < read_buff_content_size_) {
  10868. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10869. if (size <= remaining_size) {
  10870. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10871. read_buff_off_ += size;
  10872. return static_cast<ssize_t>(size);
  10873. } else {
  10874. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10875. read_buff_off_ += remaining_size;
  10876. return static_cast<ssize_t>(remaining_size);
  10877. }
  10878. }
  10879. if (!ensure_readable()) {
  10880. error_ = Error::Timeout;
  10881. return -1;
  10882. }
  10883. read_buff_off_ = 0;
  10884. read_buff_content_size_ = 0;
  10885. if (size < read_buff_size_) {
  10886. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10887. CPPHTTPLIB_RECV_FLAGS);
  10888. if (n <= 0) {
  10889. if (n == 0) {
  10890. error_ = Error::ConnectionClosed;
  10891. } else {
  10892. error_ = Error::Read;
  10893. }
  10894. return n;
  10895. } else if (n <= static_cast<ssize_t>(size)) {
  10896. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10897. return n;
  10898. } else {
  10899. memcpy(ptr, read_buff_.data(), size);
  10900. read_buff_off_ = size;
  10901. read_buff_content_size_ = static_cast<size_t>(n);
  10902. return static_cast<ssize_t>(size);
  10903. }
  10904. } else {
  10905. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10906. if (n <= 0) {
  10907. if (n == 0) {
  10908. error_ = Error::ConnectionClosed;
  10909. } else {
  10910. error_ = Error::Read;
  10911. }
  10912. }
  10913. return n;
  10914. }
  10915. }
  10916. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10917. if (!wait_writable()) { return -1; }
  10918. // Winsock's send() takes an int length, even on 64-bit Windows
  10919. #ifdef _WIN32
  10920. size =
  10921. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10922. #endif
  10923. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10924. }
  10925. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10926. int &port) const {
  10927. return detail::get_remote_ip_and_port(sock_, ip, port);
  10928. }
  10929. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10930. int &port) const {
  10931. return detail::get_local_ip_and_port(sock_, ip, port);
  10932. }
  10933. inline socket_t SocketStream::socket() const { return sock_; }
  10934. inline time_t SocketStream::duration() const {
  10935. return static_cast<time_t>(
  10936. std::chrono::duration_cast<std::chrono::milliseconds>(
  10937. std::chrono::steady_clock::now() - start_time_)
  10938. .count());
  10939. }
  10940. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10941. read_timeout_sec_ = sec;
  10942. read_timeout_usec_ = usec;
  10943. }
  10944. inline void SocketStream::set_max_timeout(time_t msec) {
  10945. max_timeout_msec_ = msec;
  10946. start_time_ = std::chrono::steady_clock::now();
  10947. }
  10948. inline void
  10949. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  10950. read_interrupted_ = std::move(interrupted);
  10951. }
  10952. // Buffer stream implementation
  10953. inline bool BufferStream::is_readable() const { return true; }
  10954. inline bool BufferStream::wait_readable() const { return true; }
  10955. inline bool BufferStream::wait_writable() const { return true; }
  10956. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10957. #if defined(_MSC_VER) && _MSC_VER < 1910
  10958. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10959. #else
  10960. auto len_read = buffer.copy(ptr, size, position);
  10961. #endif
  10962. position += static_cast<size_t>(len_read);
  10963. return static_cast<ssize_t>(len_read);
  10964. }
  10965. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10966. buffer.append(ptr, size);
  10967. return static_cast<ssize_t>(size);
  10968. }
  10969. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10970. int & /*port*/) const {}
  10971. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10972. int & /*port*/) const {}
  10973. inline socket_t BufferStream::socket() const { return 0; }
  10974. inline time_t BufferStream::duration() const { return 0; }
  10975. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10976. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10977. : MatcherBase(pattern) {
  10978. constexpr const char marker[] = "/:";
  10979. // One past the last ending position of a path param substring
  10980. std::size_t last_param_end = 0;
  10981. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10982. // Needed to ensure that parameter names are unique during matcher
  10983. // construction
  10984. // If exceptions are disabled, only last duplicate path
  10985. // parameter will be set
  10986. std::unordered_set<std::string> param_name_set;
  10987. #endif
  10988. while (true) {
  10989. const auto marker_pos = pattern.find(
  10990. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10991. if (marker_pos == std::string::npos) { break; }
  10992. static_fragments_.push_back(
  10993. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10994. const auto param_name_start = marker_pos + str_len(marker);
  10995. auto sep_pos = pattern.find(separator, param_name_start);
  10996. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10997. auto param_name =
  10998. pattern.substr(param_name_start, sep_pos - param_name_start);
  10999. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11000. if (param_name_set.find(param_name) != param_name_set.cend()) {
  11001. std::string msg = "Encountered path parameter '" + param_name +
  11002. "' multiple times in route pattern '" + pattern + "'.";
  11003. throw std::invalid_argument(msg);
  11004. }
  11005. #endif
  11006. param_names_.push_back(std::move(param_name));
  11007. last_param_end = sep_pos + 1;
  11008. }
  11009. if (last_param_end < pattern.length()) {
  11010. static_fragments_.push_back(pattern.substr(last_param_end));
  11011. }
  11012. }
  11013. inline bool PathParamsMatcher::match(Request &request) const {
  11014. request.matches = std::smatch();
  11015. request.path_params.clear();
  11016. // A pattern without parameters is just a literal path to compare against
  11017. if (param_names_.empty()) { return request.path == pattern(); }
  11018. request.path_params.reserve(param_names_.size());
  11019. // One past the position at which the path matched the pattern last time
  11020. std::size_t starting_pos = 0;
  11021. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11022. const auto &fragment = static_fragments_[i];
  11023. if (starting_pos + fragment.length() > request.path.length()) {
  11024. return false;
  11025. }
  11026. // Avoid unnecessary allocation by using strncmp instead of substr +
  11027. // comparison
  11028. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11029. fragment.length()) != 0) {
  11030. return false;
  11031. }
  11032. starting_pos += fragment.length();
  11033. // Should only happen when we have a static fragment after a param
  11034. // Example: '/users/:id/subscriptions'
  11035. // The 'subscriptions' fragment here does not have a corresponding param
  11036. if (i >= param_names_.size()) { continue; }
  11037. auto sep_pos = request.path.find(separator, starting_pos);
  11038. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11039. const auto &param_name = param_names_[i];
  11040. request.path_params.emplace(
  11041. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11042. // Mark everything up to '/' as matched
  11043. starting_pos = sep_pos + 1;
  11044. }
  11045. // Returns false if the path is longer than the pattern
  11046. return starting_pos >= request.path.length();
  11047. }
  11048. inline bool RegexMatcher::match(Request &request) const {
  11049. request.path_params.clear();
  11050. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11051. // a non-match rather than risking a stack overflow in std::regex_match.
  11052. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11053. return false;
  11054. }
  11055. return std::regex_match(request.path, request.matches, regex_);
  11056. }
  11057. // Enclose IPv6 address in brackets if needed
  11058. inline std::string prepare_host_string(const std::string &host) {
  11059. // Enclose IPv6 address in brackets (but not if already enclosed)
  11060. if (host.find(':') == std::string::npos ||
  11061. (!host.empty() && host[0] == '[')) {
  11062. // IPv4, hostname, or already bracketed IPv6
  11063. return host;
  11064. } else {
  11065. // IPv6 address without brackets
  11066. return "[" + host + "]";
  11067. }
  11068. }
  11069. inline std::string make_host_and_port_string(const std::string &host, int port,
  11070. bool is_ssl) {
  11071. auto result = prepare_host_string(host);
  11072. // Append port if not default
  11073. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11074. ; // do nothing
  11075. } else {
  11076. result += ":" + std::to_string(port);
  11077. }
  11078. return result;
  11079. }
  11080. // Create "host:port" string always including port number (for CONNECT method)
  11081. inline std::string
  11082. make_host_and_port_string_always_port(const std::string &host, int port) {
  11083. return prepare_host_string(host) + ":" + std::to_string(port);
  11084. }
  11085. // Where a client connects for `host`, as one string: the mapped address or
  11086. // name, or `host` itself.
  11087. inline std::string
  11088. addr_map_target(const std::map<std::string, std::string> &addr_map,
  11089. const std::string &host) {
  11090. std::string connect_host;
  11091. std::string ip;
  11092. apply_addr_map(addr_map, host, connect_host, ip);
  11093. return ip.empty() ? connect_host : ip;
  11094. }
  11095. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11096. inline std::string
  11097. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11098. const std::string &host, int port) {
  11099. return make_host_and_port_string_always_port(addr_map_target(addr_map, host),
  11100. port);
  11101. }
  11102. // Value for the Host header a client sends when the caller supplied none.
  11103. // Only the value: callers decide where in their header list it goes.
  11104. inline std::string make_default_host_header_value(const std::string &host,
  11105. int port, bool is_ssl,
  11106. int address_family) {
  11107. if (address_family == AF_UNIX) { return "localhost"; }
  11108. return make_host_and_port_string(host, port, is_ssl);
  11109. }
  11110. inline void add_default_user_agent_header(Request &req) {
  11111. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11112. if (!req.has_header("User-Agent")) {
  11113. req.set_header("User-Agent",
  11114. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11115. }
  11116. #else
  11117. (void)req;
  11118. #endif
  11119. }
  11120. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11121. NormalizedTarget normalize_target(const std::string &host);
  11122. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11123. bool host_matches_no_proxy(const NormalizedTarget &target,
  11124. const std::vector<NoProxyEntry> &entries);
  11125. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11126. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11127. if (prefix_bits == 0) { return true; }
  11128. int full_bytes = prefix_bits / 8;
  11129. int rem_bits = prefix_bits % 8;
  11130. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11131. static_cast<size_t>(full_bytes)) != 0) {
  11132. return false;
  11133. }
  11134. if (rem_bits == 0) { return true; }
  11135. auto i = static_cast<size_t>(full_bytes);
  11136. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11137. return (ip[i] & mask) == (net[i] & mask);
  11138. }
  11139. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11140. if (token.empty()) { return false; }
  11141. if (token == "*") {
  11142. out.kind = NoProxyKind::Wildcard;
  11143. return true;
  11144. }
  11145. auto slash = token.find('/');
  11146. std::string addr_part =
  11147. (slash == std::string::npos) ? token : token.substr(0, slash);
  11148. std::string prefix_part =
  11149. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11150. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11151. // don't silently treat it as a /32 (or /128).
  11152. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11153. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11154. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11155. // when brackets are present.
  11156. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11157. addr_part.back() == ']';
  11158. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11159. if (!bracketed) {
  11160. struct in_addr v4;
  11161. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11162. int prefix = 32;
  11163. if (!prefix_part.empty() &&
  11164. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11165. prefix)) {
  11166. return false;
  11167. }
  11168. out.kind = NoProxyKind::IPv4Cidr;
  11169. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11170. out.prefix_bits = prefix;
  11171. return true;
  11172. }
  11173. }
  11174. struct in6_addr v6;
  11175. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11176. int prefix = 128;
  11177. if (!prefix_part.empty() &&
  11178. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11179. prefix)) {
  11180. return false;
  11181. }
  11182. out.kind = NoProxyKind::IPv6Cidr;
  11183. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11184. out.prefix_bits = prefix;
  11185. return true;
  11186. }
  11187. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11188. // the entry is malformed — don't fall through to the hostname branch.
  11189. if (bracketed) { return false; }
  11190. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11191. if (slash != std::string::npos) { return false; }
  11192. // Port-specific entries (host:port) are not supported.
  11193. if (token.find(':') != std::string::npos) { return false; }
  11194. std::string hostname = case_ignore::to_lower(token);
  11195. while (!hostname.empty() && hostname.front() == '.') {
  11196. hostname.erase(hostname.begin());
  11197. }
  11198. while (!hostname.empty() && hostname.back() == '.') {
  11199. hostname.pop_back();
  11200. }
  11201. if (hostname.empty()) { return false; }
  11202. out.kind = NoProxyKind::HostnameSuffix;
  11203. out.hostname_pattern = std::move(hostname);
  11204. return true;
  11205. }
  11206. inline std::vector<NoProxyEntry>
  11207. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11208. std::vector<NoProxyEntry> entries;
  11209. entries.reserve(patterns.size());
  11210. for (const auto &p : patterns) {
  11211. auto trimmed = trim_copy(p);
  11212. if (trimmed.empty()) { continue; }
  11213. NoProxyEntry entry;
  11214. if (parse_no_proxy_entry(trimmed, entry)) {
  11215. entries.push_back(std::move(entry));
  11216. }
  11217. }
  11218. return entries;
  11219. }
  11220. inline NormalizedTarget normalize_target(const std::string &host) {
  11221. NormalizedTarget t;
  11222. std::string h = host;
  11223. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11224. h = h.substr(1, h.size() - 2);
  11225. }
  11226. // Strip a single trailing dot so "example.com." canonicalizes to
  11227. // "example.com".
  11228. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11229. t.hostname = case_ignore::to_lower(h);
  11230. if (!t.hostname.empty()) {
  11231. struct in_addr v4;
  11232. struct in6_addr v6;
  11233. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11234. t.is_ipv4 = true;
  11235. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11236. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11237. t.is_ipv6 = true;
  11238. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11239. }
  11240. }
  11241. return t;
  11242. }
  11243. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11244. const std::vector<NoProxyEntry> &entries) {
  11245. if (target.hostname.empty()) { return false; }
  11246. for (const auto &e : entries) {
  11247. switch (e.kind) {
  11248. case NoProxyKind::Wildcard: return true;
  11249. case NoProxyKind::IPv4Cidr:
  11250. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11251. return true;
  11252. }
  11253. break;
  11254. case NoProxyKind::IPv6Cidr:
  11255. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11256. return true;
  11257. }
  11258. break;
  11259. case NoProxyKind::HostnameSuffix:
  11260. if (target.is_ipv4 || target.is_ipv6) { break; }
  11261. if (target.hostname == e.hostname_pattern) { return true; }
  11262. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11263. // an entry of "example.com".
  11264. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11265. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11266. if (target.hostname[offset - 1] == '.' &&
  11267. target.hostname.compare(offset, e.hostname_pattern.size(),
  11268. e.hostname_pattern) == 0) {
  11269. return true;
  11270. }
  11271. }
  11272. break;
  11273. }
  11274. }
  11275. return false;
  11276. }
  11277. template <typename T>
  11278. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11279. T header_writer, Error &error) {
  11280. for (const auto &h : headers) {
  11281. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11282. error = Error::InvalidHeaders;
  11283. return false;
  11284. }
  11285. }
  11286. if (header_writer(strm, headers) <= 0) {
  11287. error = Error::Write;
  11288. return false;
  11289. }
  11290. return true;
  11291. }
  11292. } // namespace detail
  11293. /*
  11294. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11295. */
  11296. #ifdef CPPHTTPLIB_SSL_ENABLED
  11297. namespace detail {
  11298. // SSL socket stream implementation
  11299. inline SSLSocketStream::SSLSocketStream(
  11300. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11301. time_t read_timeout_usec, time_t write_timeout_sec,
  11302. time_t write_timeout_usec, time_t max_timeout_msec,
  11303. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11304. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11305. read_timeout_usec_(read_timeout_usec),
  11306. write_timeout_sec_(write_timeout_sec),
  11307. write_timeout_usec_(write_timeout_usec),
  11308. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11309. tls_error_.code = tls::ErrorCode::Success;
  11310. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11311. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11312. // Note: create_session() also clears this, but SSLClient currently
  11313. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11314. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11315. // SSL session was created.
  11316. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11317. #endif
  11318. }
  11319. inline SSLSocketStream::~SSLSocketStream() = default;
  11320. inline bool SSLSocketStream::is_readable() const {
  11321. return tls::pending(session_) > 0;
  11322. }
  11323. inline bool SSLSocketStream::wait_readable() const {
  11324. if (max_timeout_msec_ <= 0) {
  11325. return select_read_interruptible(sock_, read_timeout_sec_,
  11326. read_timeout_usec_, read_interrupted_) > 0;
  11327. }
  11328. time_t read_timeout_sec;
  11329. time_t read_timeout_usec;
  11330. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11331. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11332. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11333. read_interrupted_) > 0;
  11334. }
  11335. inline bool SSLSocketStream::wait_writable() const {
  11336. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11337. !tls::is_peer_closed(session_, sock_);
  11338. }
  11339. inline bool SSLSocketStream::ensure_readable() {
  11340. if (readable_hint_) {
  11341. readable_hint_ = false;
  11342. return true;
  11343. }
  11344. return wait_readable();
  11345. }
  11346. inline bool SSLSocketStream::is_peer_alive() const {
  11347. return !tls::is_peer_closed(session_, sock_);
  11348. }
  11349. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11350. if (tls::pending(session_) > 0) {
  11351. tls::TlsError err;
  11352. auto ret = tls::read(session_, ptr, size, err);
  11353. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11354. error_ = Error::ConnectionClosed;
  11355. } else if (ret < 0) {
  11356. tls_error_ = err;
  11357. }
  11358. return ret;
  11359. } else if (ensure_readable()) {
  11360. tls::TlsError err;
  11361. auto ret = tls::read(session_, ptr, size, err);
  11362. if (ret < 0) {
  11363. auto n = 1000;
  11364. #ifdef _WIN32
  11365. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11366. (err.code == tls::ErrorCode::SyscallError &&
  11367. WSAGetLastError() == WSAETIMEDOUT))) {
  11368. #else
  11369. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11370. #endif
  11371. if (tls::pending(session_) > 0) {
  11372. ret = tls::read(session_, ptr, size, err);
  11373. if (ret >= 0) { return ret; }
  11374. break;
  11375. } else if (wait_readable()) {
  11376. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11377. ret = tls::read(session_, ptr, size, err);
  11378. if (ret >= 0) { return ret; }
  11379. } else {
  11380. break;
  11381. }
  11382. }
  11383. assert(ret < 0);
  11384. tls_error_ = err;
  11385. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11386. error_ = Error::ConnectionClosed;
  11387. }
  11388. return ret;
  11389. } else {
  11390. error_ = Error::Timeout;
  11391. return -1;
  11392. }
  11393. }
  11394. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11395. if (wait_writable()) {
  11396. auto handle_size =
  11397. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11398. tls::TlsError err;
  11399. auto ret = tls::write(session_, ptr, handle_size, err);
  11400. if (ret < 0) {
  11401. auto n = 1000;
  11402. #ifdef _WIN32
  11403. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11404. (err.code == tls::ErrorCode::SyscallError &&
  11405. WSAGetLastError() == WSAETIMEDOUT))) {
  11406. #else
  11407. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11408. #endif
  11409. if (wait_writable()) {
  11410. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11411. ret = tls::write(session_, ptr, handle_size, err);
  11412. if (ret >= 0) { return ret; }
  11413. } else {
  11414. break;
  11415. }
  11416. }
  11417. assert(ret < 0);
  11418. tls_error_ = err;
  11419. }
  11420. return ret;
  11421. }
  11422. return -1;
  11423. }
  11424. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11425. int &port) const {
  11426. detail::get_remote_ip_and_port(sock_, ip, port);
  11427. }
  11428. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11429. int &port) const {
  11430. detail::get_local_ip_and_port(sock_, ip, port);
  11431. }
  11432. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11433. inline time_t SSLSocketStream::duration() const {
  11434. return static_cast<time_t>(
  11435. std::chrono::duration_cast<std::chrono::milliseconds>(
  11436. std::chrono::steady_clock::now() - start_time_)
  11437. .count());
  11438. }
  11439. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11440. read_timeout_sec_ = sec;
  11441. read_timeout_usec_ = usec;
  11442. }
  11443. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11444. max_timeout_msec_ = msec;
  11445. start_time_ = std::chrono::steady_clock::now();
  11446. }
  11447. inline void
  11448. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11449. read_interrupted_ = std::move(interrupted);
  11450. }
  11451. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11452. tls::session_t session,
  11453. time_t read_timeout_sec,
  11454. time_t read_timeout_usec,
  11455. time_t write_timeout_sec,
  11456. time_t write_timeout_usec)
  11457. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11458. read_timeout_usec_(read_timeout_usec),
  11459. write_timeout_sec_(write_timeout_sec),
  11460. write_timeout_usec_(write_timeout_usec),
  11461. start_time_(std::chrono::steady_clock::now()) {
  11462. // The receive and send paths run on different threads, so each TLS call is
  11463. // driven in non-blocking mode and readiness is awaited with select()
  11464. // outside the session lock. Set the socket non-blocking once here; it is
  11465. // never flipped back, so no thread races on the flag.
  11466. detail::set_nonblocking(sock_, true);
  11467. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11468. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11469. #endif
  11470. }
  11471. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11472. inline bool WebSocketSSLStream::is_readable() const {
  11473. std::lock_guard<std::mutex> guard(session_mutex_);
  11474. return tls::pending(session_) > 0;
  11475. }
  11476. inline bool WebSocketSSLStream::wait_readable() const {
  11477. return select_read_interruptible(sock_, read_timeout_sec_, read_timeout_usec_,
  11478. read_interrupted_) > 0;
  11479. }
  11480. inline bool WebSocketSSLStream::wait_writable() const {
  11481. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11482. // that probe toggles the socket's blocking flag, which would race with the
  11483. // concurrent reader on a permanently non-blocking socket.
  11484. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11485. }
  11486. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11487. tls::TlsError err;
  11488. auto n = 1000;
  11489. while (--n >= 0) {
  11490. {
  11491. std::lock_guard<std::mutex> guard(session_mutex_);
  11492. auto ret = tls::read(session_, ptr, size, err);
  11493. if (ret > 0) { return ret; }
  11494. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11495. error_ = Error::ConnectionClosed;
  11496. return ret;
  11497. }
  11498. }
  11499. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11500. // direction: the send path shares this session, so output it left pending
  11501. // has to be flushed before more input can be decrypted. Anything else is
  11502. // a hard error.
  11503. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11504. #ifdef _WIN32
  11505. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11506. needs_readable =
  11507. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11508. WSAGetLastError() == WSAETIMEDOUT);
  11509. #endif
  11510. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11511. error_ = Error::Read;
  11512. return -1;
  11513. }
  11514. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11515. error_ = Error::Timeout;
  11516. return -1;
  11517. }
  11518. }
  11519. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11520. // to tell a timeout from a close would otherwise see whatever the previous
  11521. // failure left behind (error_ is never cleared on success).
  11522. error_ = Error::Read;
  11523. return -1;
  11524. }
  11525. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11526. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11527. tls::TlsError err;
  11528. auto n = 1000;
  11529. while (--n >= 0) {
  11530. {
  11531. std::lock_guard<std::mutex> guard(session_mutex_);
  11532. auto ret = tls::write(session_, ptr, handle_size, err);
  11533. if (ret >= 0) { return ret; }
  11534. }
  11535. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11536. // or a post-handshake message must be consumed before the record goes
  11537. // out. Anything else is a hard error.
  11538. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11539. #ifdef _WIN32
  11540. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11541. needs_writable =
  11542. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11543. WSAGetLastError() == WSAETIMEDOUT);
  11544. #endif
  11545. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11546. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11547. }
  11548. return -1;
  11549. }
  11550. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11551. int &port) const {
  11552. detail::get_remote_ip_and_port(sock_, ip, port);
  11553. }
  11554. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11555. int &port) const {
  11556. detail::get_local_ip_and_port(sock_, ip, port);
  11557. }
  11558. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11559. inline time_t WebSocketSSLStream::duration() const {
  11560. return static_cast<time_t>(
  11561. std::chrono::duration_cast<std::chrono::milliseconds>(
  11562. std::chrono::steady_clock::now() - start_time_)
  11563. .count());
  11564. }
  11565. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11566. read_timeout_sec_ = sec;
  11567. read_timeout_usec_ = usec;
  11568. }
  11569. inline void
  11570. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11571. read_interrupted_ = std::move(interrupted);
  11572. }
  11573. } // namespace detail
  11574. #endif // CPPHTTPLIB_SSL_ENABLED
  11575. /*
  11576. * Group 4: Server implementation
  11577. */
  11578. // HTTP server implementation
  11579. inline Server::Server()
  11580. : new_task_queue([] {
  11581. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11582. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11583. }) {
  11584. #ifndef _WIN32
  11585. signal(SIGPIPE, SIG_IGN);
  11586. #endif
  11587. }
  11588. inline Server::~Server() = default;
  11589. inline std::unique_ptr<detail::MatcherBase>
  11590. Server::make_matcher(const std::string &pattern) {
  11591. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11592. // a path params pattern
  11593. if (pattern.find("/:") != std::string::npos) {
  11594. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11595. }
  11596. // A pattern with no regex metacharacter only has to be compared literally,
  11597. // which is what PathParamsMatcher already does when it captures no
  11598. // parameter, so std::regex is only worth building for the patterns that
  11599. // actually need it
  11600. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11601. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11602. }
  11603. return detail::make_unique<detail::RegexMatcher>(pattern);
  11604. }
  11605. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11606. return add_handler(get_handlers_, pattern, std::move(handler));
  11607. }
  11608. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11609. return add_handler(post_handlers_, pattern, std::move(handler));
  11610. }
  11611. inline Server &Server::Post(const std::string &pattern,
  11612. HandlerWithContentReader handler) {
  11613. return add_handler(post_handlers_for_content_reader_, pattern,
  11614. std::move(handler));
  11615. }
  11616. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11617. return add_handler(put_handlers_, pattern, std::move(handler));
  11618. }
  11619. inline Server &Server::Put(const std::string &pattern,
  11620. HandlerWithContentReader handler) {
  11621. return add_handler(put_handlers_for_content_reader_, pattern,
  11622. std::move(handler));
  11623. }
  11624. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11625. return add_handler(patch_handlers_, pattern, std::move(handler));
  11626. }
  11627. inline Server &Server::Patch(const std::string &pattern,
  11628. HandlerWithContentReader handler) {
  11629. return add_handler(patch_handlers_for_content_reader_, pattern,
  11630. std::move(handler));
  11631. }
  11632. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11633. return add_handler(delete_handlers_, pattern, std::move(handler));
  11634. }
  11635. inline Server &Server::Delete(const std::string &pattern,
  11636. HandlerWithContentReader handler) {
  11637. return add_handler(delete_handlers_for_content_reader_, pattern,
  11638. std::move(handler));
  11639. }
  11640. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11641. return add_handler(options_handlers_, pattern, std::move(handler));
  11642. }
  11643. inline const std::set<std::string> &Server::builtin_methods() {
  11644. thread_local const std::set<std::string> methods{
  11645. "GET", "HEAD", "POST", "PUT", "DELETE",
  11646. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11647. return methods;
  11648. }
  11649. inline Server::CustomHandlerEntry *
  11650. Server::custom_entry_for_registration(const std::string &method) {
  11651. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11652. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11653. // routing() before the custom tables are consulted, so a route registered
  11654. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11655. // there and would be reachable, but they carry protocol-level meaning
  11656. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11657. // library does not route.
  11658. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11659. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11660. has_invalid_registration_ = true;
  11661. return nullptr;
  11662. }
  11663. return &custom_handlers_[method];
  11664. }
  11665. inline Server &Server::CustomRoute(const std::string &method,
  11666. const std::string &pattern,
  11667. Handler handler) {
  11668. auto *entry = custom_entry_for_registration(method);
  11669. if (!entry) { return *this; }
  11670. return add_handler(entry->handlers, pattern, std::move(handler));
  11671. }
  11672. inline Server &Server::CustomRoute(const std::string &method,
  11673. const std::string &pattern,
  11674. HandlerWithContentReader handler) {
  11675. auto *entry = custom_entry_for_registration(method);
  11676. if (!entry) { return *this; }
  11677. return add_handler(entry->handlers_for_content_reader, pattern,
  11678. std::move(handler));
  11679. }
  11680. inline const Server::CustomHandlerEntry *
  11681. Server::find_custom_entry(const std::string &method) const {
  11682. // find() alone would be correct here. The empty() check is what keeps the
  11683. // per-request cost off servers that never call CustomRoute(), which is the
  11684. // overwhelmingly common case; keep it rather than walking into the tree.
  11685. if (custom_handlers_.empty()) { return nullptr; }
  11686. auto it = custom_handlers_.find(method);
  11687. return it == custom_handlers_.end() ? nullptr : &it->second;
  11688. }
  11689. inline Server &Server::WebSocket(const std::string &pattern,
  11690. WebSocketHandler handler) {
  11691. websocket_handlers_.push_back(
  11692. {make_matcher(pattern), std::move(handler), nullptr});
  11693. return *this;
  11694. }
  11695. inline Server &Server::WebSocket(const std::string &pattern,
  11696. WebSocketHandler handler,
  11697. SubProtocolSelector sub_protocol_selector) {
  11698. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11699. std::move(sub_protocol_selector)});
  11700. return *this;
  11701. }
  11702. inline bool Server::set_base_dir(const std::string &dir,
  11703. const std::string &mount_point) {
  11704. return set_mount_point(mount_point, dir);
  11705. }
  11706. inline bool Server::set_mount_point(const std::string &mount_point,
  11707. const std::string &dir, Headers headers) {
  11708. detail::FileStat stat(dir);
  11709. if (stat.is_dir()) {
  11710. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11711. if (!mnt.empty() && mnt[0] == '/') {
  11712. // Without the resolved directory, a file could not be checked to be
  11713. // inside it.
  11714. std::string resolved_base;
  11715. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11716. return false;
  11717. }
  11718. #if defined(_WIN32)
  11719. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11720. resolved_base += '\\';
  11721. }
  11722. #else
  11723. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11724. #endif
  11725. base_dirs_.push_back(
  11726. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11727. return true;
  11728. }
  11729. }
  11730. return false;
  11731. }
  11732. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11733. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11734. if (it->mount_point == mount_point) {
  11735. base_dirs_.erase(it);
  11736. return true;
  11737. }
  11738. }
  11739. return false;
  11740. }
  11741. inline Server &
  11742. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11743. const std::string &mime) {
  11744. // Keyed as find_content_type() looks it up
  11745. auto key = detail::case_ignore::to_lower(ext);
  11746. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  11747. file_extension_and_mimetype_map_[key] = mime;
  11748. return *this;
  11749. }
  11750. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11751. default_file_mimetype_ = mime;
  11752. return *this;
  11753. }
  11754. inline Server &Server::set_file_request_handler(Handler handler) {
  11755. file_request_handler_ = std::move(handler);
  11756. return *this;
  11757. }
  11758. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11759. std::true_type) {
  11760. error_handler_ = std::move(handler);
  11761. return *this;
  11762. }
  11763. inline Server &Server::set_error_handler_core(Handler handler,
  11764. std::false_type) {
  11765. error_handler_ = [handler](const Request &req, Response &res) {
  11766. handler(req, res);
  11767. return HandlerResponse::Handled;
  11768. };
  11769. return *this;
  11770. }
  11771. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11772. exception_handler_ = std::move(handler);
  11773. return *this;
  11774. }
  11775. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11776. pre_routing_handler_ = std::move(handler);
  11777. return *this;
  11778. }
  11779. inline Server &Server::set_post_routing_handler(Handler handler) {
  11780. post_routing_handler_ = std::move(handler);
  11781. return *this;
  11782. }
  11783. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11784. pre_request_handler_ = std::move(handler);
  11785. return *this;
  11786. }
  11787. inline Server &Server::set_logger(Logger logger) {
  11788. logger_ = std::move(logger);
  11789. return *this;
  11790. }
  11791. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11792. error_logger_ = std::move(error_logger);
  11793. return *this;
  11794. }
  11795. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11796. pre_compression_logger_ = std::move(logger);
  11797. return *this;
  11798. }
  11799. inline Server &
  11800. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11801. expect_100_continue_handler_ = std::move(handler);
  11802. return *this;
  11803. }
  11804. inline Server &Server::set_start_handler(StartHandler handler) {
  11805. start_handler_ = std::move(handler);
  11806. return *this;
  11807. }
  11808. inline Server &Server::set_address_family(int family) {
  11809. address_family_ = family;
  11810. return *this;
  11811. }
  11812. inline Server &Server::set_tcp_nodelay(bool on) {
  11813. tcp_nodelay_ = on;
  11814. return *this;
  11815. }
  11816. inline Server &Server::set_ipv6_v6only(bool on) {
  11817. ipv6_v6only_ = on;
  11818. return *this;
  11819. }
  11820. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11821. socket_options_ = std::move(socket_options);
  11822. return *this;
  11823. }
  11824. inline Server &Server::set_default_headers(Headers headers) {
  11825. default_headers_ = std::move(headers);
  11826. return *this;
  11827. }
  11828. inline Server &Server::set_header_writer(
  11829. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11830. header_writer_ = writer;
  11831. return *this;
  11832. }
  11833. inline Server &
  11834. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11835. trusted_proxies_.clear();
  11836. trusted_proxies_.reserve(proxies.size());
  11837. for (const auto &proxy : proxies) {
  11838. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  11839. }
  11840. return *this;
  11841. }
  11842. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11843. keep_alive_max_count_ = count;
  11844. return *this;
  11845. }
  11846. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11847. keep_alive_timeout_sec_ = sec;
  11848. return *this;
  11849. }
  11850. template <class Rep, class Period>
  11851. inline Server &Server::set_keep_alive_timeout(
  11852. const std::chrono::duration<Rep, Period> &duration) {
  11853. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11854. set_keep_alive_timeout(sec);
  11855. });
  11856. return *this;
  11857. }
  11858. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11859. read_timeout_sec_ = sec;
  11860. read_timeout_usec_ = usec;
  11861. return *this;
  11862. }
  11863. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11864. write_timeout_sec_ = sec;
  11865. write_timeout_usec_ = usec;
  11866. return *this;
  11867. }
  11868. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11869. idle_interval_sec_ = sec;
  11870. idle_interval_usec_ = usec;
  11871. return *this;
  11872. }
  11873. inline Server &Server::set_payload_max_length(size_t length) {
  11874. payload_max_length_ = length;
  11875. return *this;
  11876. }
  11877. inline Server &Server::set_compress(bool on) {
  11878. compress_ = on;
  11879. return *this;
  11880. }
  11881. inline Server &Server::set_static_file_compression(bool on) {
  11882. static_file_compression_ = on;
  11883. return *this;
  11884. }
  11885. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11886. static_file_compression_min_length_ = length;
  11887. return *this;
  11888. }
  11889. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11890. static_file_compression_max_length_ = length;
  11891. return *this;
  11892. }
  11893. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11894. websocket_max_missed_pongs_ = count;
  11895. return *this;
  11896. }
  11897. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11898. websocket_ping_interval_sec_ = sec;
  11899. return *this;
  11900. }
  11901. template <class Rep, class Period>
  11902. inline Server &Server::set_websocket_ping_interval(
  11903. const std::chrono::duration<Rep, Period> &duration) {
  11904. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11905. set_websocket_ping_interval(sec);
  11906. });
  11907. return *this;
  11908. }
  11909. inline bool Server::bind_to_port(const std::string &host, int port,
  11910. int socket_flags) {
  11911. auto ret = bind_internal(host, port, socket_flags);
  11912. if (ret == -1) { is_decommissioned = true; }
  11913. return ret >= 0;
  11914. }
  11915. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11916. auto ret = bind_internal(host, 0, socket_flags);
  11917. if (ret == -1) { is_decommissioned = true; }
  11918. return ret;
  11919. }
  11920. inline bool Server::listen_after_bind() { return listen_internal(); }
  11921. inline bool Server::listen(const std::string &host, int port,
  11922. int socket_flags) {
  11923. return bind_to_port(host, port, socket_flags) && listen_internal();
  11924. }
  11925. inline bool Server::is_running() const { return is_running_; }
  11926. inline void Server::wait_until_ready() const {
  11927. while (!is_running_ && !is_decommissioned) {
  11928. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11929. }
  11930. }
  11931. inline void Server::stop() noexcept {
  11932. // Release the listening socket whether or not the accept loop is running:
  11933. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11934. // exchange is what makes this safe to call concurrently with the accept loop.
  11935. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11936. if (sock != INVALID_SOCKET) {
  11937. detail::shutdown_socket(sock);
  11938. detail::close_socket(sock);
  11939. }
  11940. is_decommissioned = false;
  11941. }
  11942. inline void Server::decommission() { is_decommissioned = true; }
  11943. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11944. auto len = strlen(s);
  11945. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11946. len -= 2;
  11947. {
  11948. // RFC 9112 §3: exactly one SP between the method, the target and the
  11949. // version. Taking other whitespace as a separator too lets recipients
  11950. // that parse more strictly see a different request.
  11951. auto end = s + len;
  11952. if (std::count(s, end, ' ') != 2) { return false; }
  11953. auto sp1 = std::find(s, end, ' ');
  11954. auto sp2 = std::find(sp1 + 1, end, ' ');
  11955. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11956. req.method.assign(s, sp1);
  11957. req.target.assign(sp1 + 1, sp2);
  11958. req.version.assign(sp2 + 1, end);
  11959. }
  11960. // A method outside the built-in set is accepted only when a handler has been
  11961. // registered for it with CustomRoute().
  11962. const auto &methods = builtin_methods();
  11963. if (methods.find(req.method) == methods.end() &&
  11964. !find_custom_entry(req.method)) {
  11965. output_error_log(Error::InvalidHTTPMethod, &req);
  11966. return false;
  11967. }
  11968. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11969. output_error_log(Error::InvalidHTTPVersion, &req);
  11970. return false;
  11971. }
  11972. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11973. // would leave this server routing a different path than a cache or a
  11974. // filter in front of it sees.
  11975. if (!detail::fields::is_request_target(req.target) ||
  11976. req.target.find('#') != std::string::npos) {
  11977. return false;
  11978. }
  11979. {
  11980. detail::divide(req.target, '?',
  11981. [&](const char *lhs_data, std::size_t lhs_size,
  11982. const char *rhs_data, std::size_t rhs_size) {
  11983. req.path =
  11984. decode_path_component(std::string(lhs_data, lhs_size));
  11985. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11986. });
  11987. }
  11988. return true;
  11989. }
  11990. inline bool Server::write_response(Stream &strm, bool close_connection,
  11991. Request &req, Response &res) {
  11992. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11993. // incorrectly to the error content.
  11994. req.ranges.clear();
  11995. return write_response_core(strm, close_connection, req, res, false);
  11996. }
  11997. inline bool Server::write_response_with_content(Stream &strm,
  11998. bool close_connection,
  11999. const Request &req,
  12000. Response &res) {
  12001. return write_response_core(strm, close_connection, req, res, true);
  12002. }
  12003. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  12004. const Request &req, Response &res,
  12005. bool need_apply_ranges) {
  12006. assert(res.status != -1);
  12007. if (400 <= res.status && error_handler_ &&
  12008. error_handler_(req, res) == HandlerResponse::Handled) {
  12009. need_apply_ranges = true;
  12010. }
  12011. // Before anything below reads res.headers, which the handlers may have
  12012. // filled directly
  12013. detail::erase_invalid_fields(res.headers);
  12014. if (!detail::body_allowed_for_status(res.status)) {
  12015. detail::clear_content(res);
  12016. }
  12017. detail::prefer_assigned_body(res);
  12018. std::string content_type;
  12019. std::string boundary;
  12020. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  12021. // Prepare additional headers
  12022. if (close_connection ||
  12023. detail::has_header_token(req.headers, "Connection", "close") ||
  12024. 400 <= res.status || // Don't leave connections open after errors
  12025. // The client withholds the body until `100 Continue`, which was never
  12026. // sent, so whether and when the body follows is unknown.
  12027. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  12028. // The body was left partway, e.g. by a content receiver that returned
  12029. // false, so the rest of it cannot be told from the next request.
  12030. (req.body_read_started_ && !req.body_consumed_)) {
  12031. res.set_header("Connection", "close");
  12032. } else {
  12033. std::string s = "timeout=";
  12034. s += std::to_string(keep_alive_timeout_sec_);
  12035. if (keep_alive_max_count_ > 0) {
  12036. s += ", max=";
  12037. s += std::to_string(keep_alive_max_count_);
  12038. }
  12039. res.set_header("Keep-Alive", s);
  12040. }
  12041. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12042. !res.has_header("Content-Type")) {
  12043. res.set_header("Content-Type", "text/plain");
  12044. }
  12045. detail::set_framing_headers(req, res, boundary, content_type);
  12046. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12047. res.set_header("Accept-Ranges", "bytes");
  12048. }
  12049. if (post_routing_handler_) {
  12050. post_routing_handler_(req, res);
  12051. detail::erase_invalid_fields(res.headers);
  12052. // Again, for a body or framing headers the handler changed.
  12053. detail::set_framing_headers(req, res, boundary, content_type);
  12054. }
  12055. // Response line and headers
  12056. detail::BufferStream bstrm;
  12057. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12058. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12059. // Combine a small body with the headers so the whole response leaves in a
  12060. // single write. A large body is written on its own instead: a copy of it
  12061. // costs more than the extra write saves.
  12062. auto send_body =
  12063. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12064. auto body_is_separate = false;
  12065. auto provider_done = false;
  12066. if (send_body && !res.body.empty() && !res.content_provider_) {
  12067. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12068. bstrm.write(res.body.data(), res.body.size());
  12069. } else {
  12070. body_is_separate = true;
  12071. }
  12072. } else if (send_body && res.content_provider_ &&
  12073. res.is_file_content_provider_ &&
  12074. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12075. // A small file is read into the same buffer. Other providers may produce
  12076. // their data over time, so they are never held back.
  12077. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12078. return false;
  12079. }
  12080. provider_done = true;
  12081. }
  12082. // Log before writing to avoid race condition with client-side code that
  12083. // accesses logger-captured data immediately after receiving the response.
  12084. output_log(req, res);
  12085. // Flush buffer
  12086. auto &data = bstrm.get_buffer();
  12087. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12088. if (body_is_separate) {
  12089. return detail::write_data(strm, res.body.data(), res.body.size());
  12090. }
  12091. // Streaming body
  12092. if (send_body && res.content_provider_) {
  12093. if (!provider_done &&
  12094. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12095. return false;
  12096. }
  12097. res.content_provider_success_ = true;
  12098. }
  12099. return true;
  12100. }
  12101. inline bool
  12102. Server::write_content_with_provider(Stream &strm, const Request &req,
  12103. Response &res, const std::string &boundary,
  12104. const std::string &content_type) {
  12105. auto is_shutting_down = [this]() {
  12106. return this->svr_sock_ == INVALID_SOCKET;
  12107. };
  12108. if (res.content_length_ > 0) {
  12109. if (!detail::is_partial_content(req, res)) {
  12110. return detail::write_content(strm, res.content_provider_, 0,
  12111. res.content_length_, is_shutting_down);
  12112. } else if (req.ranges.size() == 1) {
  12113. auto offset_and_length = detail::get_range_offset_and_length(
  12114. req.ranges[0], res.content_length_);
  12115. return detail::write_content(strm, res.content_provider_,
  12116. offset_and_length.first,
  12117. offset_and_length.second, is_shutting_down);
  12118. } else {
  12119. return detail::write_multipart_ranges_data(
  12120. strm, req, res, boundary, content_type, res.content_length_,
  12121. is_shutting_down);
  12122. }
  12123. } else {
  12124. if (res.is_chunked_content_provider_) {
  12125. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12126. // re-negotiating here would disagree with them, e.g. once a handler's
  12127. // own Content-Encoding header suppresses the negotiation.
  12128. auto compressor = detail::make_compressor(res.content_coding_);
  12129. if (!compressor) {
  12130. compressor = detail::make_unique<detail::nocompressor>();
  12131. }
  12132. return detail::write_content_chunked(strm, res.content_provider_,
  12133. is_shutting_down, *compressor);
  12134. } else {
  12135. return detail::write_content_without_length(strm, res.content_provider_,
  12136. is_shutting_down);
  12137. }
  12138. }
  12139. }
  12140. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12141. FormFields::iterator cur_field;
  12142. FormFiles::iterator cur_file;
  12143. auto is_text_field = false;
  12144. size_t count = 0;
  12145. if (read_content_core(
  12146. strm, req, res,
  12147. // Regular
  12148. [&](const char *buf, size_t n) {
  12149. // Prevent arithmetic overflow when checking sizes.
  12150. // Avoid computing (req.body.size() + n) directly because
  12151. // adding two unsigned `size_t` values can wrap around and
  12152. // produce a small result instead of indicating overflow.
  12153. // Instead, check using subtraction: ensure `n` does not
  12154. // exceed the remaining capacity `max_size() - size()`.
  12155. if (req.body.size() >= req.body.max_size() ||
  12156. n > req.body.max_size() - req.body.size()) {
  12157. return false;
  12158. }
  12159. // Limit decompressed body size to payload_max_length_ to protect
  12160. // against "zip bomb" attacks where a small compressed payload
  12161. // decompresses to a massive size.
  12162. if (payload_max_length_ > 0 &&
  12163. (req.body.size() >= payload_max_length_ ||
  12164. n > payload_max_length_ - req.body.size())) {
  12165. return false;
  12166. }
  12167. req.body.append(buf, n);
  12168. return true;
  12169. },
  12170. // Multipart FormData
  12171. [&](const FormData &file) {
  12172. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12173. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12174. output_error_log(Error::TooManyFormDataFiles, &req);
  12175. return false;
  12176. }
  12177. if (file.filename.empty()) {
  12178. cur_field = req.form.fields.emplace(
  12179. file.name, FormField{file.name, file.content, file.headers});
  12180. is_text_field = true;
  12181. } else {
  12182. cur_file = req.form.files.emplace(file.name, file);
  12183. is_text_field = false;
  12184. }
  12185. return true;
  12186. },
  12187. [&](const char *buf, size_t n) {
  12188. if (is_text_field) {
  12189. auto &content = cur_field->second.content;
  12190. if (content.size() + n > content.max_size()) { return false; }
  12191. content.append(buf, n);
  12192. } else {
  12193. auto &content = cur_file->second.content;
  12194. if (content.size() + n > content.max_size()) { return false; }
  12195. content.append(buf, n);
  12196. }
  12197. return true;
  12198. })) {
  12199. const auto &content_type = req.get_header_value("Content-Type");
  12200. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12201. "application/x-www-form-urlencoded")) {
  12202. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12203. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12204. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12205. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12206. return false;
  12207. }
  12208. detail::parse_query_text(req.body, req.params);
  12209. }
  12210. return true;
  12211. }
  12212. return false;
  12213. }
  12214. inline bool Server::read_content_with_content_receiver(
  12215. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12216. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12217. return read_content_core(strm, req, res, std::move(receiver),
  12218. std::move(multipart_header),
  12219. std::move(multipart_receiver));
  12220. }
  12221. inline bool Server::read_content_core(
  12222. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12223. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12224. detail::FormDataParser multipart_form_data_parser;
  12225. ContentReceiverWithProgress out;
  12226. if (req.is_multipart_form_data()) {
  12227. const auto &content_type = req.get_header_value("Content-Type");
  12228. std::string boundary;
  12229. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12230. res.status = StatusCode::BadRequest_400;
  12231. output_error_log(Error::MultipartParsing, &req);
  12232. return false;
  12233. }
  12234. multipart_form_data_parser.set_boundary(std::move(boundary));
  12235. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12236. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12237. multipart_receiver);
  12238. };
  12239. } else {
  12240. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12241. size_t /*len*/) { return receiver(buf, n); };
  12242. }
  12243. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12244. if (!req.has_header("Content-Length") &&
  12245. !detail::is_chunked_transfer_encoding(req.headers)) {
  12246. return true;
  12247. }
  12248. // A second read would start where the first one stopped, or in the next
  12249. // request.
  12250. if (req.body_read_started_) { return false; }
  12251. // The client is waiting for this before it sends the body.
  12252. if (req.expect_100_continue_pending_) {
  12253. req.expect_100_continue_pending_ = false;
  12254. detail::write_response_line(strm, StatusCode::Continue_100);
  12255. strm.write("\r\n");
  12256. }
  12257. // Set before reading, since a receiver may also stop by throwing.
  12258. req.body_read_started_ = true;
  12259. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12260. out, true)) {
  12261. return false;
  12262. }
  12263. req.body_consumed_ = true;
  12264. if (req.is_multipart_form_data()) {
  12265. if (!multipart_form_data_parser.is_valid()) {
  12266. res.status = StatusCode::BadRequest_400;
  12267. output_error_log(Error::MultipartParsing, &req);
  12268. return false;
  12269. }
  12270. }
  12271. return true;
  12272. }
  12273. inline bool Server::handle_file_request(Request &req, Response &res) {
  12274. if (!detail::is_valid_path(req.path)) { return false; }
  12275. for (const auto &entry : base_dirs_) {
  12276. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12277. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12278. // One that already ends in '/' (the root mount among them) carries its own
  12279. // boundary; set_mount_point() guarantees the mount point is not empty.
  12280. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12281. (entry.mount_point.back() == '/' ||
  12282. req.path.size() == entry.mount_point.size() ||
  12283. req.path[entry.mount_point.size()] == '/')) {
  12284. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12285. auto path = entry.base_dir + sub_path;
  12286. if (path.back() == '/') { path += "index.html"; }
  12287. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12288. // but symlinks/junctions can still escape the base directory. A path
  12289. // that cannot be resolved, which includes one that does not exist, is
  12290. // not served from here.
  12291. std::string resolved_path;
  12292. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12293. if (!detail::is_path_within_base(resolved_path,
  12294. entry.resolved_base_dir)) {
  12295. res.status = StatusCode::Forbidden_403;
  12296. return true;
  12297. }
  12298. detail::FileStat stat(path);
  12299. if (stat.is_dir()) {
  12300. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12301. // in the name from reading as a scheme.
  12302. auto name = req.path.substr(req.path.rfind('/') + 1);
  12303. res.set_redirect("./" + encode_path_component(name) + "/",
  12304. StatusCode::MovedPermanently_301);
  12305. return true;
  12306. }
  12307. if (stat.is_file()) {
  12308. for (const auto &kv : entry.headers) {
  12309. res.set_header(kv.first, kv.second);
  12310. }
  12311. auto content_type = detail::find_content_type(
  12312. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12313. auto encoding = detail::EncodingType::None;
  12314. if (static_file_compression_) {
  12315. encoding = static_file_encoding(req, res, content_type, stat.size());
  12316. }
  12317. // The ETag names the representation actually sent, so a client that
  12318. // cached the compressed form revalidates against the compressed ETag
  12319. // and still gets a 304, while one that took identity keeps the plain
  12320. // ETag.
  12321. auto etag = detail::compute_etag(
  12322. stat, encoding == detail::EncodingType::None
  12323. ? std::string()
  12324. : std::string("-") + detail::encoding_name(encoding));
  12325. if (!etag.empty()) { res.set_header("ETag", etag); }
  12326. auto mtime = stat.mtime();
  12327. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12328. if (!last_modified.empty()) {
  12329. res.set_header("Last-Modified", last_modified);
  12330. }
  12331. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12332. check_if_range(req, etag, mtime);
  12333. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12334. if (!mm->is_open()) {
  12335. output_error_log(Error::OpenFile, &req);
  12336. return false;
  12337. }
  12338. detail::set_file_content_provider(res, mm, content_type, encoding);
  12339. if (req.method != "HEAD" && file_request_handler_) {
  12340. file_request_handler_(req, res);
  12341. }
  12342. return true;
  12343. } else {
  12344. output_error_log(Error::OpenFile, &req);
  12345. }
  12346. }
  12347. }
  12348. return false;
  12349. }
  12350. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12351. const std::string &etag,
  12352. time_t mtime) const {
  12353. // Handle conditional GET:
  12354. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12355. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12356. if (req.has_header("If-None-Match")) {
  12357. if (!etag.empty()) {
  12358. auto val =
  12359. detail::get_combined_header_value(req.headers, "If-None-Match");
  12360. // NOTE: We use exact string matching here. This works correctly
  12361. // because our server always generates weak ETags (W/"..."), and
  12362. // clients typically send back the same ETag they received.
  12363. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12364. // If-None-Match, where W/"x" and "x" would match, but this
  12365. // simplified implementation requires exact matches.
  12366. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12367. [&](const char *b, const char *e) {
  12368. auto seg_len = static_cast<size_t>(e - b);
  12369. return (seg_len == 1 && *b == '*') ||
  12370. (seg_len == etag.size() &&
  12371. std::equal(b, e, etag.begin()));
  12372. });
  12373. if (ret) {
  12374. res.status = StatusCode::NotModified_304;
  12375. return true;
  12376. }
  12377. }
  12378. } else if (req.has_header("If-Modified-Since")) {
  12379. auto val = req.get_header_value("If-Modified-Since");
  12380. auto t = detail::parse_http_date(val);
  12381. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12382. res.status = StatusCode::NotModified_304;
  12383. return true;
  12384. }
  12385. }
  12386. return false;
  12387. }
  12388. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12389. time_t mtime) const {
  12390. // Handle If-Range for partial content requests (RFC 9110
  12391. // Section 13.1.5). If-Range is only evaluated when Range header is
  12392. // present. If the validator matches, serve partial content; otherwise
  12393. // serve full content.
  12394. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12395. auto val = req.get_header_value("If-Range");
  12396. auto is_valid_range = [&]() {
  12397. if (detail::is_strong_etag(val)) {
  12398. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12399. // comparison.
  12400. return (!etag.empty() && val == etag);
  12401. } else if (detail::is_weak_etag(val)) {
  12402. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12403. return false;
  12404. } else {
  12405. // HTTP-date comparison
  12406. auto t = detail::parse_http_date(val);
  12407. return (t != static_cast<time_t>(-1) && mtime <= t);
  12408. }
  12409. };
  12410. if (!is_valid_range()) {
  12411. // Validator doesn't match: ignore Range and serve full content
  12412. req.ranges.clear();
  12413. return false;
  12414. }
  12415. }
  12416. return true;
  12417. }
  12418. inline socket_t
  12419. Server::create_server_socket(const std::string &host, int port,
  12420. int socket_flags,
  12421. SocketOptions socket_options) const {
  12422. return detail::create_socket(
  12423. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12424. ipv6_v6only_, std::move(socket_options),
  12425. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12426. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12427. output_error_log(Error::BindIPAddress, nullptr);
  12428. return false;
  12429. }
  12430. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12431. output_error_log(Error::Listen, nullptr);
  12432. return false;
  12433. }
  12434. return true;
  12435. });
  12436. }
  12437. inline int Server::bind_internal(const std::string &host, int port,
  12438. int socket_flags) {
  12439. if (is_decommissioned) { return -1; }
  12440. if (!is_valid()) { return -1; }
  12441. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12442. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12443. if (port == 0) {
  12444. struct sockaddr_storage addr;
  12445. socklen_t addr_len = sizeof(addr);
  12446. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12447. &addr_len) == -1) {
  12448. output_error_log(Error::GetSockName, nullptr);
  12449. return -1;
  12450. }
  12451. if (addr.ss_family == AF_INET) {
  12452. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12453. } else if (addr.ss_family == AF_INET6) {
  12454. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12455. } else {
  12456. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12457. return -1;
  12458. }
  12459. } else {
  12460. return port;
  12461. }
  12462. }
  12463. inline bool Server::listen_internal() {
  12464. // A stop() between bind and listen leaves nothing to accept on. Report
  12465. // failure instead of returning success without ever serving, and mark the
  12466. // server decommissioned the way any failed listen does so that a concurrent
  12467. // wait_until_ready() wakes up instead of spinning forever.
  12468. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12469. is_decommissioned = true;
  12470. return false;
  12471. }
  12472. auto ret = true;
  12473. is_running_ = true;
  12474. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12475. if (start_handler_) { start_handler_(); }
  12476. {
  12477. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12478. while (svr_sock_ != INVALID_SOCKET) {
  12479. #ifndef _WIN32
  12480. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12481. #endif
  12482. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12483. idle_interval_usec_);
  12484. if (val == 0) { // Timeout
  12485. task_queue->on_idle();
  12486. continue;
  12487. }
  12488. #ifndef _WIN32
  12489. }
  12490. #endif
  12491. #if defined _WIN32
  12492. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12493. // OVERLAPPED
  12494. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12495. #elif defined SOCK_CLOEXEC
  12496. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12497. #else
  12498. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12499. #endif
  12500. if (sock == INVALID_SOCKET) {
  12501. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12502. // touches the CRT errno, so the two have to be asked platform by
  12503. // platform rather than by testing errno here.
  12504. if (detail::is_accept_resource_error()) {
  12505. // The per-process descriptor limit or the network stack's buffer
  12506. // space has been reached. Try to accept new connections after a
  12507. // short sleep.
  12508. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12509. continue;
  12510. } else if (detail::is_accept_transient_error()) {
  12511. continue;
  12512. }
  12513. // Take the descriptor out of svr_sock_ before closing it: a later
  12514. // stop() would otherwise shutdown()/close() a value the OS may have
  12515. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12516. // gone. The exchange also settles the race with a concurrent stop(),
  12517. // since whichever side takes the descriptor closes it exactly once.
  12518. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12519. if (listen_sock != INVALID_SOCKET) {
  12520. detail::close_socket(listen_sock);
  12521. ret = false;
  12522. output_error_log(Error::Connection, nullptr);
  12523. } else {
  12524. ; // The server socket was closed by user.
  12525. }
  12526. break;
  12527. }
  12528. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12529. read_timeout_sec_, read_timeout_usec_);
  12530. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12531. write_timeout_sec_, write_timeout_usec_);
  12532. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12533. if (!task_queue->enqueue(
  12534. [this, sock]() { process_and_close_socket(sock); })) {
  12535. output_error_log(Error::ResourceExhaustion, nullptr);
  12536. detail::shutdown_socket(sock);
  12537. detail::close_socket(sock);
  12538. }
  12539. }
  12540. task_queue->shutdown();
  12541. }
  12542. is_decommissioned = !ret;
  12543. return ret;
  12544. }
  12545. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  12546. // Call from a catch block. The response is a 500 unless the exception handler
  12547. // sets another status. Returns whether the exception handler ran.
  12548. inline bool Server::handle_exception(Request &req, Response &res) {
  12549. res.status = StatusCode::InternalServerError_500;
  12550. if (!exception_handler_) { return false; }
  12551. exception_handler_(req, res, std::current_exception());
  12552. return true;
  12553. }
  12554. #endif
  12555. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12556. bool skip_pre_routing) {
  12557. if (!skip_pre_routing && pre_routing_handler_ &&
  12558. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12559. return true;
  12560. }
  12561. // File handler
  12562. if ((req.method == "GET" || req.method == "HEAD") &&
  12563. handle_file_request(req, res)) {
  12564. return true;
  12565. }
  12566. const auto *custom = find_custom_entry(req.method);
  12567. // The second clause mirrors what expect_content() does unconditionally for
  12568. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12569. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12570. // `allprop`) would skip its handler and fall through to 404.
  12571. if (detail::expect_content(req) ||
  12572. (custom && !custom->handlers_for_content_reader.empty())) {
  12573. // Content reader handler
  12574. {
  12575. // Track whether the ContentReader was aborted due to the decompressed
  12576. // payload exceeding `payload_max_length_`.
  12577. // The user handler runs after the lambda returns, so we must restore the
  12578. // 413 status if the handler overwrites it.
  12579. bool content_reader_payload_too_large = false;
  12580. ContentReader reader(
  12581. [&](ContentReceiver receiver) {
  12582. auto result = read_content_with_content_receiver(
  12583. strm, req, res, std::move(receiver), nullptr, nullptr);
  12584. if (!result) {
  12585. output_error_log(Error::Read, &req);
  12586. if (res.status == StatusCode::PayloadTooLarge_413) {
  12587. content_reader_payload_too_large = true;
  12588. }
  12589. }
  12590. return result;
  12591. },
  12592. [&](FormDataHeader header, ContentReceiver receiver) {
  12593. auto result = read_content_with_content_receiver(
  12594. strm, req, res, nullptr, std::move(header),
  12595. std::move(receiver));
  12596. if (!result) {
  12597. output_error_log(Error::Read, &req);
  12598. if (res.status == StatusCode::PayloadTooLarge_413) {
  12599. content_reader_payload_too_large = true;
  12600. }
  12601. }
  12602. return result;
  12603. });
  12604. bool dispatched = false;
  12605. if (req.method == "POST") {
  12606. dispatched = dispatch_request_for_content_reader(
  12607. req, res, std::move(reader), post_handlers_for_content_reader_);
  12608. } else if (req.method == "PUT") {
  12609. dispatched = dispatch_request_for_content_reader(
  12610. req, res, std::move(reader), put_handlers_for_content_reader_);
  12611. } else if (req.method == "PATCH") {
  12612. dispatched = dispatch_request_for_content_reader(
  12613. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12614. } else if (req.method == "DELETE") {
  12615. dispatched = dispatch_request_for_content_reader(
  12616. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12617. } else if (custom) {
  12618. dispatched = dispatch_request_for_content_reader(
  12619. req, res, std::move(reader), custom->handlers_for_content_reader);
  12620. }
  12621. if (dispatched) {
  12622. if (content_reader_payload_too_large) {
  12623. // Enforce the limit: override any status the handler may have set
  12624. // and return false so the error path sends a plain 413 response.
  12625. res.status = StatusCode::PayloadTooLarge_413;
  12626. detail::clear_content(res);
  12627. return false;
  12628. }
  12629. return true;
  12630. }
  12631. }
  12632. // NOTE: `req.body` is not read here. For a regular handler the body is
  12633. // read inside dispatch_request(), after the route has matched and the
  12634. // pre-request handler has approved the request, so that a rejected
  12635. // request (e.g. failed authentication) never forces us to buffer a
  12636. // potentially large body.
  12637. }
  12638. // Regular handler
  12639. if (req.method == "GET" || req.method == "HEAD") {
  12640. return dispatch_request(req, res, get_handlers_, strm);
  12641. } else if (req.method == "POST") {
  12642. return dispatch_request(req, res, post_handlers_, strm);
  12643. } else if (req.method == "PUT") {
  12644. return dispatch_request(req, res, put_handlers_, strm);
  12645. } else if (req.method == "DELETE") {
  12646. return dispatch_request(req, res, delete_handlers_, strm);
  12647. } else if (req.method == "OPTIONS") {
  12648. return dispatch_request(req, res, options_handlers_, strm);
  12649. } else if (req.method == "PATCH") {
  12650. return dispatch_request(req, res, patch_handlers_, strm);
  12651. } else if (custom) {
  12652. return dispatch_request(req, res, custom->handlers, strm);
  12653. }
  12654. res.status = StatusCode::BadRequest_400;
  12655. return false;
  12656. }
  12657. inline bool Server::dispatch_request(Request &req, Response &res,
  12658. const Handlers &handlers, Stream &strm) {
  12659. for (const auto &x : handlers) {
  12660. const auto &matcher = x.first;
  12661. const auto &handler = x.second;
  12662. if (matcher->match(req)) {
  12663. req.matched_route = matcher->pattern();
  12664. // Run the pre-request handler before reading the body so a rejected
  12665. // request (e.g. failed authentication) never forces us to buffer a
  12666. // potentially large body. `req.matched_route` is available here.
  12667. if (pre_request_handler_ &&
  12668. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12669. return true;
  12670. }
  12671. // The route matched and the request was approved; read the body now.
  12672. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12673. output_error_log(Error::Read, &req);
  12674. return false;
  12675. }
  12676. handler(req, res);
  12677. return true;
  12678. }
  12679. }
  12680. return false;
  12681. }
  12682. // Decides the content coding for a response served straight from a file. Both
  12683. // the ETag, which has to name the representation actually sent, and
  12684. // `apply_static_file_compression()` go through this, so the two cannot drift
  12685. // apart.
  12686. inline detail::EncodingType
  12687. Server::static_file_encoding(const Request &req, const Response &res,
  12688. const std::string &content_type,
  12689. size_t length) const {
  12690. if (!static_file_compression_) { return detail::EncodingType::None; }
  12691. // Nothing to compress, and an empty file already answers with
  12692. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12693. // turn an empty body into a 20-byte gzip stream.
  12694. if (length == 0) { return detail::EncodingType::None; }
  12695. // A file that already fits in a single packet gains nothing from being made
  12696. // smaller, since it still travels in that one segment, and a file of a few
  12697. // bytes comes out larger than it went in.
  12698. if (length < static_file_compression_min_length_) {
  12699. return detail::EncodingType::None;
  12700. }
  12701. // RFC 9110 applies Range to the representation after content coding, so a
  12702. // compressed 206 would mean compressing the whole file and then slicing it.
  12703. // Serve ranges from the identity representation instead.
  12704. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12705. if (static_file_compression_max_length_ > 0 &&
  12706. length > static_file_compression_max_length_) {
  12707. return detail::EncodingType::None;
  12708. }
  12709. return detail::encoding_type(req, res, content_type);
  12710. }
  12711. // Compresses a file-backed content provider into `res.body`. Returns false when
  12712. // the response is left untouched.
  12713. inline bool Server::apply_static_file_compression(const Request &req,
  12714. Response &res) const {
  12715. auto type = res.content_coding_;
  12716. if (type == detail::EncodingType::None || !res.content_provider_) {
  12717. return false;
  12718. }
  12719. auto compressor = detail::make_compressor(type);
  12720. if (!compressor) { return false; }
  12721. output_pre_compression_log(req, res);
  12722. std::string compressed;
  12723. if (!detail::compress_content_provider(res.content_provider_,
  12724. res.content_length_, *compressor,
  12725. compressed)) {
  12726. return false;
  12727. }
  12728. res.body.swap(compressed);
  12729. // The provider was consumed in full, so its releaser hears about a success.
  12730. res.content_provider_success_ = true;
  12731. detail::clear_content_provider(res);
  12732. res.set_header("Content-Encoding", detail::encoding_name(type));
  12733. res.set_header("Vary", "Accept-Encoding");
  12734. return true;
  12735. }
  12736. inline void Server::apply_ranges(const Request &req, Response &res,
  12737. std::string &content_type,
  12738. std::string &boundary) const {
  12739. // A known-length content provider leaves `res.body` empty, so the compressor
  12740. // at the end of this function never runs for one (issue #2545). A file-backed
  12741. // provider is fully readable right here, so compress it and answer with an
  12742. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12743. // takes the same path as `set_content()` from here on. Range requests never
  12744. // get a content coding, so `Content-Range` still names identity bytes and
  12745. // none of the range handling below applies.
  12746. if (apply_static_file_compression(req, res)) { return; }
  12747. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12748. auto it = res.headers.find("Content-Type");
  12749. if (it != res.headers.end()) {
  12750. content_type = it->second;
  12751. res.headers.erase(it);
  12752. }
  12753. boundary = detail::make_multipart_data_boundary();
  12754. res.set_header("Content-Type",
  12755. "multipart/byteranges; boundary=" + boundary);
  12756. }
  12757. auto type =
  12758. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  12759. if (res.body.empty()) {
  12760. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12761. res.status == StatusCode::PartialContent_206) {
  12762. auto offset_and_length = detail::get_range_offset_and_length(
  12763. req.ranges[0], res.content_length_);
  12764. auto content_range = detail::make_content_range_header_field(
  12765. offset_and_length, res.content_length_);
  12766. res.set_header("Content-Range", content_range);
  12767. } else if (res.is_chunked_content_provider_) {
  12768. res.content_coding_ = type;
  12769. if (type != detail::EncodingType::None) {
  12770. res.set_header("Content-Encoding", detail::encoding_name(type));
  12771. res.set_header("Vary", "Accept-Encoding");
  12772. }
  12773. }
  12774. } else {
  12775. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12776. ;
  12777. } else if (req.ranges.size() == 1) {
  12778. auto offset_and_length =
  12779. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12780. auto offset = offset_and_length.first;
  12781. auto length = offset_and_length.second;
  12782. auto content_range = detail::make_content_range_header_field(
  12783. offset_and_length, res.body.size());
  12784. res.set_header("Content-Range", content_range);
  12785. assert(offset + length <= res.body.size());
  12786. res.body = res.body.substr(offset, length);
  12787. } else {
  12788. std::string data;
  12789. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12790. res.body.size(), data);
  12791. res.body.swap(data);
  12792. }
  12793. if (type != detail::EncodingType::None) {
  12794. output_pre_compression_log(req, res);
  12795. if (auto compressor = detail::make_compressor(type)) {
  12796. std::string compressed;
  12797. if (compressor->compress(res.body.data(), res.body.size(), true,
  12798. [&](const char *data, size_t data_len) {
  12799. compressed.append(data, data_len);
  12800. return true;
  12801. })) {
  12802. res.body.swap(compressed);
  12803. res.set_header("Content-Encoding", detail::encoding_name(type));
  12804. res.set_header("Vary", "Accept-Encoding");
  12805. }
  12806. }
  12807. }
  12808. res.content_length_ = res.body.size();
  12809. }
  12810. }
  12811. inline bool Server::dispatch_request_for_content_reader(
  12812. Request &req, Response &res, ContentReader content_reader,
  12813. const HandlersForContentReader &handlers) const {
  12814. for (const auto &x : handlers) {
  12815. const auto &matcher = x.first;
  12816. const auto &handler = x.second;
  12817. if (matcher->match(req)) {
  12818. req.matched_route = matcher->pattern();
  12819. if (!pre_request_handler_ ||
  12820. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12821. handler(req, res, content_reader);
  12822. }
  12823. return true;
  12824. }
  12825. }
  12826. return false;
  12827. }
  12828. inline std::string
  12829. get_client_ip(const std::string &x_forwarded_for,
  12830. const std::vector<std::string> &trusted_proxies) {
  12831. // X-Forwarded-For is a comma-separated list per RFC 7239
  12832. std::vector<std::string> ip_list;
  12833. detail::split(x_forwarded_for.data(),
  12834. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12835. [&](const char *b, const char *e) {
  12836. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12837. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12838. });
  12839. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12840. // no segments. Signal "no client IP derived" with an empty string so the
  12841. // caller can fall back to the connection-level remote address.
  12842. if (ip_list.empty()) { return std::string(); }
  12843. // Each hop appends the address it received the request from, so the rightmost
  12844. // entries are the ones written by our own infrastructure while the leftmost
  12845. // are whatever the original client chose to send. Walk from the right and
  12846. // skip trusted proxies; the first address that is not a trusted proxy is the
  12847. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12848. // from the left instead lets a client forge an arbitrary address by following
  12849. // it with a trusted proxy's address, which the left-to-right scan then
  12850. // returned as the client.
  12851. for (size_t i = ip_list.size(); i-- > 0;) {
  12852. const auto &ip = ip_list[i];
  12853. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  12854. }
  12855. // Every hop was a trusted proxy; fall back to the first entry.
  12856. return ip_list.front();
  12857. }
  12858. inline bool
  12859. Server::process_request(Stream &strm, const std::string &remote_addr,
  12860. int remote_port, const std::string &local_addr,
  12861. int local_port, bool close_connection,
  12862. bool &connection_closed,
  12863. const std::function<void(Request &)> &setup_request,
  12864. bool *websocket_upgraded) {
  12865. std::array<char, 2048> buf{};
  12866. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12867. // The read timeout bounds the request line and headers as a whole, so a
  12868. // client sending them a byte at a time cannot hold the worker any longer.
  12869. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  12870. strm.set_max_timeout(read_timeout_msec);
  12871. // Connection has been closed on client
  12872. if (!line_reader.getline()) { return false; }
  12873. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12874. // clients send an extra CRLF after a request body, which would otherwise be
  12875. // parsed as the next request on a persistent connection.
  12876. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12877. return false;
  12878. }
  12879. Request req;
  12880. req.start_time_ = std::chrono::steady_clock::now();
  12881. req.remote_addr = remote_addr;
  12882. req.remote_port = remote_port;
  12883. req.local_addr = local_addr;
  12884. req.local_port = local_port;
  12885. Response res;
  12886. res.version = "HTTP/1.1";
  12887. res.headers = default_headers_;
  12888. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12889. // close the connection after that response, whichever path wrote it (an
  12890. // error status, a handler, or a rejected request). Reading on would also
  12891. // parse whatever the client sent next on a connection it considers done.
  12892. auto honor_connection_close = detail::scope_exit([&] {
  12893. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12894. connection_closed = true;
  12895. }
  12896. });
  12897. // Request line and headers. A rejected message leaves the rest of it (and
  12898. // any body) unread, so the connection cannot be reused: the leftover bytes
  12899. // would be parsed as the next request.
  12900. if (!parse_request_line(line_reader.ptr(), req)) {
  12901. connection_closed = true;
  12902. res.status = StatusCode::BadRequest_400;
  12903. output_error_log(Error::InvalidRequestLine, &req);
  12904. return write_response(strm, close_connection, req, res);
  12905. }
  12906. // Request headers
  12907. if (!detail::read_headers(strm, req.headers)) {
  12908. connection_closed = true;
  12909. res.status = StatusCode::BadRequest_400;
  12910. output_error_log(Error::InvalidHeaders, &req);
  12911. return write_response(strm, close_connection, req, res);
  12912. }
  12913. strm.set_max_timeout(0);
  12914. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12915. // which would otherwise let an intermediary and this parser disagree on
  12916. // where the body ends and enable request smuggling. Three cases: a
  12917. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12918. // or empty), which would otherwise be read as "no body"; a non-zero
  12919. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12920. // tolerated for compatibility with existing clients); and a
  12921. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12922. // length undeterminable. None of them may fall through to the "no body"
  12923. // path, or the body bytes are parsed as the next request on a persistent
  12924. // connection.
  12925. auto is_invalid_content_length = false;
  12926. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12927. is_invalid_content_length);
  12928. if (is_invalid_content_length ||
  12929. detail::has_conflicting_content_length(req.headers) ||
  12930. (req.has_header("Transfer-Encoding") &&
  12931. !detail::is_chunked_transfer_encoding(req.headers))) {
  12932. connection_closed = true;
  12933. res.status = StatusCode::BadRequest_400;
  12934. return write_response(strm, close_connection, req, res);
  12935. }
  12936. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  12937. if (req.has_header("Transfer-Encoding") &&
  12938. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  12939. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  12940. "chunked"))) {
  12941. connection_closed = true;
  12942. res.status = StatusCode::NotImplemented_501;
  12943. return write_response(strm, close_connection, req, res);
  12944. }
  12945. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12946. // HTTP/1.0 request, is honoured, but the connection closes after the
  12947. // response.
  12948. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12949. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12950. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12951. // the same authority.
  12952. auto host_count = req.get_header_value_count("Host");
  12953. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12954. !detail::fields::is_host(req.get_header_value("Host"))) {
  12955. connection_closed = true;
  12956. res.status = StatusCode::BadRequest_400;
  12957. output_error_log(Error::InvalidHeaders, &req);
  12958. return write_response(strm, close_connection, req, res);
  12959. }
  12960. // Check if the request URI doesn't exceed the limit
  12961. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12962. connection_closed = true;
  12963. res.status = StatusCode::UriTooLong_414;
  12964. output_error_log(Error::ExceedUriMaxLength, &req);
  12965. return write_response(strm, close_connection, req, res);
  12966. }
  12967. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12968. connection_closed = true;
  12969. }
  12970. if (req.version == "HTTP/1.0" &&
  12971. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12972. connection_closed = true;
  12973. }
  12974. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12975. // itself a trusted proxy. Otherwise any direct client could spoof
  12976. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12977. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  12978. req.has_header("X-Forwarded-For")) {
  12979. // Some proxies append the address they observed as a separate
  12980. // X-Forwarded-For field line instead of extending the one the client sent
  12981. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12982. // be scanned. Reading only the first occurrence would hand back the
  12983. // client-supplied, and therefore forgeable, value.
  12984. auto x_forwarded_for =
  12985. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12986. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12987. req.remote_addr = derived.empty() ? remote_addr : derived;
  12988. } else {
  12989. req.remote_addr = remote_addr;
  12990. }
  12991. req.remote_port = remote_port;
  12992. req.local_addr = local_addr;
  12993. req.local_port = local_port;
  12994. if (req.has_header("Accept")) {
  12995. auto accept_header =
  12996. detail::get_combined_header_value(req.headers, "Accept");
  12997. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12998. connection_closed = true;
  12999. res.status = StatusCode::BadRequest_400;
  13000. output_error_log(Error::HTTPParsing, &req);
  13001. return write_response(strm, close_connection, req, res);
  13002. }
  13003. }
  13004. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  13005. if ((req.method == "GET" || req.method == "HEAD") &&
  13006. req.has_header("Range")) {
  13007. const auto &range_header_value = req.get_header_value("Range");
  13008. // RFC 9110 14.2: a range unit other than bytes must be ignored
  13009. auto unit = range_header_value.substr(0, range_header_value.find('='));
  13010. if (detail::case_ignore::equal(unit, "bytes") &&
  13011. !detail::parse_range_header(range_header_value, req.ranges)) {
  13012. connection_closed = true;
  13013. res.status = StatusCode::RangeNotSatisfiable_416;
  13014. output_error_log(Error::InvalidRangeHeader, &req);
  13015. return write_response(strm, close_connection, req, res);
  13016. }
  13017. }
  13018. if (setup_request) { setup_request(req); }
  13019. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  13020. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  13021. // must be ignored. An expectation we do not recognize is left alone; the
  13022. // 417 the section allows for one is a MAY, not a requirement.
  13023. //
  13024. // `100 Continue` itself is deferred until the body is actually read (see
  13025. // read_content_core), so a request rejected by a later handler never
  13026. // invites the client to send a body nobody will read.
  13027. if (req.version != "HTTP/1.0" &&
  13028. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  13029. int status = StatusCode::Continue_100;
  13030. if (expect_100_continue_handler_) {
  13031. status = expect_100_continue_handler_(req, res);
  13032. }
  13033. if (status == StatusCode::Continue_100) {
  13034. req.expect_100_continue_pending_ = true;
  13035. } else {
  13036. if (res.status == -1) { res.status = status; }
  13037. connection_closed = true;
  13038. return write_response(strm, true, req, res);
  13039. }
  13040. }
  13041. // Setup `is_connection_closed` method
  13042. auto sock = strm.socket();
  13043. req.is_connection_closed = [sock]() {
  13044. return !detail::is_socket_alive(sock);
  13045. };
  13046. // WebSocket upgrade
  13047. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13048. // that authentication and other middleware can reject the request with an
  13049. // HTTP response (e.g., 401) before the protocol switches.
  13050. // The response says so when this connection closes after it.
  13051. auto close_after_response = close_connection || connection_closed;
  13052. // An upgrade request has been through pre-routing before it reaches routing()
  13053. auto is_upgrade = detail::is_websocket_upgrade(req);
  13054. if (is_upgrade) {
  13055. // A response given here leaves the body unread, and it would be parsed as
  13056. // the next request.
  13057. auto close_if_answered =
  13058. close_after_response || detail::has_framed_body(req);
  13059. const WebSocketHandlerEntry *ws_route = nullptr;
  13060. std::string selected_subprotocol;
  13061. auto answer_before_upgrade = [&]() -> bool {
  13062. if (pre_routing_handler_ &&
  13063. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13064. return true;
  13065. }
  13066. for (const auto &entry : websocket_handlers_) {
  13067. if (!entry.matcher->match(req)) { continue; }
  13068. req.matched_route = entry.matcher->pattern();
  13069. if (pre_request_handler_ &&
  13070. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13071. return true;
  13072. }
  13073. ws_route = &entry;
  13074. if (entry.sub_protocol_selector) {
  13075. auto protocol_header = detail::get_combined_header_value(
  13076. req.headers, "Sec-WebSocket-Protocol");
  13077. if (!protocol_header.empty()) {
  13078. std::vector<std::string> protocols;
  13079. detail::split(protocol_header.data(),
  13080. protocol_header.data() + protocol_header.size(), ',',
  13081. [&](const char *b, const char *e) {
  13082. protocols.emplace_back(b, e);
  13083. });
  13084. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13085. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13086. if (std::find(protocols.begin(), protocols.end(),
  13087. selected_subprotocol) == protocols.end()) {
  13088. selected_subprotocol.clear();
  13089. }
  13090. }
  13091. }
  13092. return false;
  13093. }
  13094. return false;
  13095. };
  13096. auto answered = false;
  13097. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13098. answered = answer_before_upgrade();
  13099. #else
  13100. try {
  13101. answered = answer_before_upgrade();
  13102. } catch (...) {
  13103. if (!handle_exception(req, res)) {
  13104. return write_response(strm, close_if_answered, req, res);
  13105. }
  13106. answered = true;
  13107. }
  13108. #endif
  13109. if (answered) {
  13110. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13111. return write_response_with_content(strm, close_if_answered, req, res);
  13112. }
  13113. if (ws_route) {
  13114. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13115. auto accept_key = detail::websocket_accept_key(client_key);
  13116. // Send 101 Switching Protocols
  13117. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13118. "Upgrade: websocket\r\n"
  13119. "Connection: Upgrade\r\n"
  13120. "Sec-WebSocket-Accept: " +
  13121. accept_key + "\r\n";
  13122. if (!selected_subprotocol.empty()) {
  13123. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13124. return false;
  13125. }
  13126. handshake_response +=
  13127. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13128. }
  13129. handshake_response += "\r\n";
  13130. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13131. 0) {
  13132. return false;
  13133. }
  13134. connection_closed = true;
  13135. if (websocket_upgraded) { *websocket_upgraded = true; }
  13136. #ifdef CPPHTTPLIB_SSL_ENABLED
  13137. if (req.ssl) {
  13138. // wss: the heartbeat ping thread and the read path enter the same
  13139. // TLS session from different threads. Hand the WebSocket a stream
  13140. // that serializes every TLS call, so the shared SSLSocketStream on
  13141. // the plain HTTP/HTTPS paths stays untouched.
  13142. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13143. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13144. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13145. write_timeout_sec_, write_timeout_usec_));
  13146. ws::WebSocket ws(std::move(ws_strm), req, true,
  13147. websocket_ping_interval_sec_,
  13148. websocket_max_missed_pongs_);
  13149. ws_route->handler(req, ws);
  13150. return true;
  13151. }
  13152. #endif
  13153. // Use WebSocket-specific read timeout instead of HTTP timeout
  13154. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13155. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13156. websocket_max_missed_pongs_);
  13157. ws_route->handler(req, ws);
  13158. return true;
  13159. }
  13160. // No WebSocket route: route it as a plain HTTP request
  13161. }
  13162. // Routing
  13163. auto routed = false;
  13164. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13165. routed = routing(req, res, strm, is_upgrade);
  13166. #else
  13167. try {
  13168. routed = routing(req, res, strm, is_upgrade);
  13169. } catch (...) { routed = handle_exception(req, res); }
  13170. #endif
  13171. auto ret = false;
  13172. if (routed) {
  13173. if (res.status == -1) {
  13174. res.status = req.ranges.empty() ? StatusCode::OK_200
  13175. : StatusCode::PartialContent_206;
  13176. }
  13177. // Before the Range checks below, so they see the body's own length.
  13178. detail::prefer_assigned_body(res);
  13179. // Serve file content by using a content provider
  13180. auto file_open_error = false;
  13181. if (!res.file_content_path_.empty()) {
  13182. const auto &path = res.file_content_path_;
  13183. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13184. if (!mm->is_open()) {
  13185. res.status = StatusCode::NotFound_404;
  13186. output_error_log(Error::OpenFile, &req);
  13187. file_open_error = true;
  13188. } else {
  13189. auto content_type = res.file_content_content_type_;
  13190. if (content_type.empty()) {
  13191. // One the handler set after set_file_content()
  13192. content_type = res.get_header_value("Content-Type");
  13193. }
  13194. if (content_type.empty()) {
  13195. content_type = detail::find_content_type(
  13196. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13197. }
  13198. detail::set_file_content_provider(
  13199. res, mm, content_type,
  13200. static_file_encoding(req, res, content_type, mm->size()));
  13201. }
  13202. }
  13203. if (file_open_error) {
  13204. ret = write_response(strm, close_after_response, req, res);
  13205. } else if (detail::range_error(req, res)) {
  13206. detail::clear_content(res);
  13207. res.status = StatusCode::RangeNotSatisfiable_416;
  13208. ret = write_response(strm, close_after_response, req, res);
  13209. } else {
  13210. ret = write_response_with_content(strm, close_after_response, req, res);
  13211. }
  13212. } else {
  13213. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13214. ret = write_response(strm, close_after_response, req, res);
  13215. }
  13216. // Drain any unconsumed framed body to prevent request smuggling on
  13217. // keep-alive. Without framing there is no body to drain — reading would
  13218. // consume the next request (issue #2450). If the response has committed the
  13219. // connection to close, there is no next request to protect. A body read in
  13220. // part cannot be drained from where it stopped, so the connection closes,
  13221. // as it does when the body is longer than the drain limit or does not
  13222. // arrive within the read timeout.
  13223. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13224. !detail::has_header_token(res.headers, "Connection", "close")) {
  13225. strm.set_max_timeout(read_timeout_msec);
  13226. int dummy_status;
  13227. if (req.body_read_started_ ||
  13228. !detail::read_content(
  13229. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13230. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13231. false)) {
  13232. connection_closed = true;
  13233. }
  13234. }
  13235. return ret;
  13236. }
  13237. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13238. inline bool Server::process_and_close_socket(socket_t sock) {
  13239. std::string remote_addr;
  13240. int remote_port = 0;
  13241. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13242. std::string local_addr;
  13243. int local_port = 0;
  13244. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13245. bool websocket_upgraded = false;
  13246. auto ret = serve_guarded([&]() {
  13247. return detail::process_server_socket(
  13248. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13249. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13250. write_timeout_usec_,
  13251. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13252. return process_request(strm, remote_addr, remote_port, local_addr,
  13253. local_port, close_connection,
  13254. connection_closed, nullptr,
  13255. &websocket_upgraded);
  13256. });
  13257. });
  13258. detail::drain_and_close_socket(sock);
  13259. return ret;
  13260. }
  13261. inline void Server::output_log(const Request &req, const Response &res) const {
  13262. if (logger_) {
  13263. std::lock_guard<std::mutex> guard(logger_mutex_);
  13264. logger_(req, res);
  13265. }
  13266. }
  13267. inline void Server::output_pre_compression_log(const Request &req,
  13268. const Response &res) const {
  13269. if (pre_compression_logger_) {
  13270. std::lock_guard<std::mutex> guard(logger_mutex_);
  13271. pre_compression_logger_(req, res);
  13272. }
  13273. }
  13274. inline void Server::output_error_log(const Error &err,
  13275. const Request *req) const {
  13276. if (error_logger_) {
  13277. std::lock_guard<std::mutex> guard(logger_mutex_);
  13278. error_logger_(err, req);
  13279. }
  13280. }
  13281. /*
  13282. * Group 5: ClientImpl and Client (Universal) implementation
  13283. */
  13284. // HTTP client implementation
  13285. inline ClientImpl::ClientImpl(const std::string &host)
  13286. : ClientImpl(host, 80, std::string(), std::string()) {}
  13287. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13288. : ClientImpl(host, port, std::string(), std::string()) {}
  13289. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13290. const std::string &client_cert_path,
  13291. const std::string &client_key_path)
  13292. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13293. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13294. inline ClientImpl::~ClientImpl() {
  13295. // Wait until all the requests in flight are handled.
  13296. size_t retry_count = 10;
  13297. while (retry_count-- > 0) {
  13298. {
  13299. std::lock_guard<std::mutex> guard(socket_mutex_);
  13300. if (socket_requests_in_flight_ == 0) { break; }
  13301. }
  13302. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13303. }
  13304. std::lock_guard<std::mutex> guard(socket_mutex_);
  13305. shutdown_socket(socket_);
  13306. close_socket(socket_);
  13307. }
  13308. inline bool ClientImpl::is_valid() const { return true; }
  13309. inline bool
  13310. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13311. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13312. if (no_proxy_entries_.empty()) { return true; }
  13313. // host_ is const so its normalized form is invariant; cache it. The
  13314. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13315. if (host == host_) {
  13316. if (!host_normalized_valid_) {
  13317. host_normalized_ = detail::normalize_target(host_);
  13318. host_normalized_valid_ = true;
  13319. }
  13320. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13321. }
  13322. auto target = detail::normalize_target(host);
  13323. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13324. }
  13325. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13326. if (is_proxy_enabled_for_host(host_)) {
  13327. return detail::create_client_socket(
  13328. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13329. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13330. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13331. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13332. }
  13333. // Check is custom IP or hostname specified for host_
  13334. std::string connect_host;
  13335. std::string ip;
  13336. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13337. return detail::create_client_socket(
  13338. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13339. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13340. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13341. write_timeout_usec_, interface_, error);
  13342. }
  13343. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13344. Error &error) {
  13345. auto sock = create_client_socket(error);
  13346. if (sock == INVALID_SOCKET) { return false; }
  13347. socket.sock = sock;
  13348. return true;
  13349. }
  13350. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13351. socket_tls_settings_version_ = tls_settings_version_;
  13352. return create_and_connect_socket(socket, error);
  13353. }
  13354. inline bool ClientImpl::setup_proxy_connection(
  13355. Socket & /*socket*/,
  13356. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13357. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13358. return true;
  13359. }
  13360. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13361. bool /*shutdown_gracefully*/) {
  13362. // If there are any requests in flight from threads other than us, then it's
  13363. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13364. assert(socket_requests_in_flight_ == 0 ||
  13365. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13366. }
  13367. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13368. if (socket.sock == INVALID_SOCKET) { return; }
  13369. detail::shutdown_socket(socket.sock);
  13370. }
  13371. inline void ClientImpl::close_socket(Socket &socket) {
  13372. // If there are requests in flight in another thread, usually closing
  13373. // the socket will be fine and they will simply receive an error when
  13374. // using the closed socket, but it is still a bug since rarely the OS
  13375. // may reassign the socket id to be used for a new socket, and then
  13376. // suddenly they will be operating on a live socket that is different
  13377. // than the one they intended!
  13378. assert(socket_requests_in_flight_ == 0 ||
  13379. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13380. // It is also a bug if this happens while SSL is still active
  13381. #ifdef CPPHTTPLIB_SSL_ENABLED
  13382. assert(socket.ssl == nullptr);
  13383. #endif
  13384. if (socket.sock == INVALID_SOCKET) { return; }
  13385. detail::close_socket(socket.sock);
  13386. socket.sock = INVALID_SOCKET;
  13387. }
  13388. inline void ClientImpl::disconnect(bool gracefully) {
  13389. shutdown_ssl(socket_, gracefully);
  13390. shutdown_socket(socket_);
  13391. close_socket(socket_);
  13392. }
  13393. inline bool ClientImpl::socket_reusable() {
  13394. if (!socket_.is_open()) { return false; }
  13395. auto is_alive = detail::is_socket_alive(socket_.sock);
  13396. #ifdef CPPHTTPLIB_SSL_ENABLED
  13397. if (is_alive && is_ssl() && tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13398. is_alive = false;
  13399. }
  13400. #endif
  13401. if (!is_alive) {
  13402. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13403. disconnect(/*gracefully=*/false);
  13404. return false;
  13405. }
  13406. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13407. disconnect(/*gracefully=*/true);
  13408. return false;
  13409. }
  13410. return true;
  13411. }
  13412. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13413. Response &res,
  13414. bool skip_100_continue) const {
  13415. std::array<char, 2048> buf{};
  13416. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13417. if (!line_reader.getline()) { return false; }
  13418. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13419. res.reason)) {
  13420. return req.method == "CONNECT";
  13421. }
  13422. // Skip interim (1xx) responses along with their header fields, except a 100
  13423. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13424. // HTTP on the connection, so it is final. A server sending them without end
  13425. // would hold the client, so there may be only so many.
  13426. size_t interim_count = 0;
  13427. while (100 <= res.status && res.status < 200 &&
  13428. res.status != StatusCode::SwitchingProtocol_101 &&
  13429. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13430. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13431. return false;
  13432. }
  13433. Headers interim_headers;
  13434. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13435. if (!line_reader.getline()) { return false; } // next response line
  13436. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13437. res.reason)) {
  13438. return false;
  13439. }
  13440. }
  13441. return true;
  13442. }
  13443. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13444. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13445. // A same-origin redirect and a digest retry send through here again. Only
  13446. // the call the caller made reports a failure, once, with its request.
  13447. auto outermost = send_depth_++ == 0;
  13448. auto se = detail::scope_exit([&] { send_depth_--; });
  13449. if (outermost) { error = Error::Success; }
  13450. auto ret = send_(req, res, error);
  13451. if (error == Error::SSLPeerCouldBeClosed_) {
  13452. assert(!ret);
  13453. ret = send_(req, res, error);
  13454. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13455. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13456. }
  13457. // Also an answer that carries an error, such as a proxy's 407
  13458. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13459. return ret;
  13460. }
  13461. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13462. #ifdef CPPHTTPLIB_SSL_ENABLED
  13463. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13464. // client that failed to set up its TLS context keeps reporting why.
  13465. if (is_valid()) {
  13466. last_ssl_error_ = 0;
  13467. last_backend_error_ = 0;
  13468. }
  13469. #endif
  13470. {
  13471. std::lock_guard<std::mutex> guard(socket_mutex_);
  13472. // Set this to false immediately - if it ever gets set to true by the end
  13473. // of the request, we know another thread instructed us to close the
  13474. // socket.
  13475. socket_should_be_closed_when_request_is_done_ = false;
  13476. // A redirect or a retry sent inside a request keeps its stop()
  13477. if (socket_requests_in_flight_ == 0) { stop_requested_ = false; }
  13478. if (!socket_reusable()) {
  13479. if (!ensure_socket_connection(socket_, error)) { return false; }
  13480. {
  13481. auto success = true;
  13482. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13483. error)) {
  13484. return success;
  13485. }
  13486. }
  13487. }
  13488. // Mark the current socket as being in use so that it cannot be closed by
  13489. // anyone else while this request is ongoing, even though we will be
  13490. // releasing the mutex.
  13491. if (socket_requests_in_flight_ > 1) {
  13492. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13493. }
  13494. socket_requests_in_flight_ += 1;
  13495. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13496. }
  13497. for (const auto &header : default_headers_) {
  13498. if (req.headers.find(header.first) == req.headers.end()) {
  13499. req.headers.insert(header);
  13500. }
  13501. }
  13502. auto ret = false;
  13503. auto close_connection = !keep_alive_;
  13504. auto se = detail::scope_exit([&]() {
  13505. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13506. std::lock_guard<std::mutex> guard(socket_mutex_);
  13507. socket_requests_in_flight_ -= 1;
  13508. if (socket_requests_in_flight_ <= 0) {
  13509. assert(socket_requests_in_flight_ == 0);
  13510. socket_requests_are_from_thread_ = std::thread::id();
  13511. }
  13512. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13513. !ret) {
  13514. disconnect(/*gracefully=*/true);
  13515. }
  13516. });
  13517. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13518. strm.set_read_interrupt([this] { return stop_requested_.load(); });
  13519. return handle_request(strm, req, res, close_connection, error);
  13520. });
  13521. if (!ret) {
  13522. if (error == Error::Success) { error = Error::Unknown; }
  13523. }
  13524. return ret;
  13525. }
  13526. inline Result ClientImpl::send(const Request &req) {
  13527. auto req2 = req;
  13528. return send_(std::move(req2));
  13529. }
  13530. inline Result ClientImpl::send_(Request &&req) {
  13531. auto res = detail::make_unique<Response>();
  13532. auto error = Error::Success;
  13533. #ifdef CPPHTTPLIB_SSL_ENABLED
  13534. // Hold the request lock until the Result has read this request's TLS error
  13535. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13536. #endif
  13537. auto ret = send(req, *res, error);
  13538. #ifdef CPPHTTPLIB_SSL_ENABLED
  13539. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13540. last_ssl_error_, last_backend_error_};
  13541. #else
  13542. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13543. #endif
  13544. }
  13545. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13546. const std::string &ct) {
  13547. (void)for_stream;
  13548. // Default headers are meant for the origin and may carry its credentials, so
  13549. // keep them off the CONNECT request the proxy reads.
  13550. if (r.method != "CONNECT") {
  13551. for (const auto &header : default_headers_) {
  13552. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13553. }
  13554. }
  13555. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13556. // prepend it rather than appending it after the caller's own fields.
  13557. if (!r.has_header("Host")) {
  13558. r.headers.emplace_front(
  13559. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13560. address_family_));
  13561. }
  13562. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13563. if (!r.content_receiver) {
  13564. if (!r.has_header("Accept-Encoding")) {
  13565. std::string accept_encoding;
  13566. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13567. accept_encoding = "br";
  13568. #endif
  13569. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13570. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13571. accept_encoding += "gzip, deflate";
  13572. #endif
  13573. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13574. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13575. accept_encoding += "zstd";
  13576. #endif
  13577. r.set_header("Accept-Encoding", accept_encoding);
  13578. }
  13579. detail::add_default_user_agent_header(r);
  13580. }
  13581. if (!r.body.empty()) {
  13582. if (!ct.empty() && !r.has_header("Content-Type")) {
  13583. r.headers.emplace("Content-Type", ct);
  13584. }
  13585. if (!r.has_header("Content-Length")) {
  13586. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13587. }
  13588. }
  13589. }
  13590. inline ClientImpl::StreamHandle
  13591. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13592. const Params &params, const Headers &headers,
  13593. const std::string &body,
  13594. const std::string &content_type) {
  13595. // Encode the target exactly like the buffered send path does, so that the
  13596. // same `path` produces the same request line through either API.
  13597. auto raw_query_path =
  13598. params.empty() ? path : append_query_params(path, params);
  13599. Request req;
  13600. req.method = method;
  13601. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13602. req.headers = headers;
  13603. req.body = body;
  13604. prepare_default_headers(req, true, content_type);
  13605. auto handle = open_stream_(req);
  13606. // Like a buffered request, a stream that fails to open is reported once
  13607. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13608. return handle;
  13609. }
  13610. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13611. StreamHandle handle;
  13612. handle.response = detail::make_unique<Response>();
  13613. handle.error = Error::Success;
  13614. handle.connection_ = detail::make_unique<ClientConnection>();
  13615. {
  13616. std::lock_guard<std::mutex> guard(socket_mutex_);
  13617. if (!socket_reusable()) {
  13618. if (!ensure_socket_connection(socket_, handle.error)) {
  13619. handle.response.reset();
  13620. return handle;
  13621. }
  13622. {
  13623. auto success = true;
  13624. auto start_time = std::chrono::steady_clock::now();
  13625. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13626. success, handle.error)) {
  13627. if (!success) { handle.response.reset(); }
  13628. return handle;
  13629. }
  13630. }
  13631. }
  13632. transfer_socket_ownership_to_handle(handle);
  13633. }
  13634. #ifdef CPPHTTPLIB_SSL_ENABLED
  13635. if (is_ssl() && handle.connection_->session) {
  13636. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13637. handle.connection_->sock, handle.connection_->session,
  13638. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13639. write_timeout_usec_);
  13640. } else {
  13641. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13642. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13643. write_timeout_sec_, write_timeout_usec_);
  13644. }
  13645. #else
  13646. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13647. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13648. write_timeout_sec_, write_timeout_usec_);
  13649. #endif
  13650. handle.stream_ = handle.socket_stream_.get();
  13651. auto &strm = *handle.stream_;
  13652. // After connecting, as for a buffered request
  13653. add_credential_headers(req);
  13654. // Build the request line and headers in memory first, like write_request()
  13655. // does, so that a rejected header leaves nothing on the wire.
  13656. {
  13657. detail::BufferStream bstrm;
  13658. // The path follows the authority in absolute-form, so one that does not
  13659. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13660. auto prefix = proxy_target_prefix();
  13661. if ((!prefix.empty() && req.path[0] != '/') ||
  13662. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  13663. handle.error = Error::Write;
  13664. handle.response.reset();
  13665. return handle;
  13666. }
  13667. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13668. handle.error)) {
  13669. handle.response.reset();
  13670. return handle;
  13671. }
  13672. const auto &data = bstrm.get_buffer();
  13673. if (!detail::write_data(strm, data.data(), data.size())) {
  13674. handle.error = Error::Write;
  13675. handle.response.reset();
  13676. return handle;
  13677. }
  13678. }
  13679. if (!req.body.empty()) {
  13680. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13681. handle.error = Error::Write;
  13682. handle.response.reset();
  13683. return handle;
  13684. }
  13685. }
  13686. if (!read_response_line(strm, req, *handle.response) ||
  13687. !detail::read_headers(strm, handle.response->headers)) {
  13688. handle.error = Error::Read;
  13689. handle.response.reset();
  13690. return handle;
  13691. }
  13692. handle.body_reader_.stream = handle.stream_;
  13693. handle.body_reader_.payload_max_length = payload_max_length_;
  13694. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13695. // header section, so none of its framing or coding headers apply.
  13696. if (req.method == "HEAD" ||
  13697. handle.response->status == StatusCode::NoContent_204 ||
  13698. handle.response->status == StatusCode::NotModified_304) {
  13699. handle.body_reader_.eof = true;
  13700. return handle;
  13701. }
  13702. // Same framing check as ClientImpl::process_request()
  13703. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13704. handle.error = Error::Read;
  13705. handle.response.reset();
  13706. return handle;
  13707. }
  13708. if (handle.response->has_header("Content-Length")) {
  13709. bool is_invalid = false;
  13710. auto content_length = detail::get_header_value_u64(
  13711. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13712. if (is_invalid) {
  13713. handle.error = Error::Read;
  13714. handle.response.reset();
  13715. return handle;
  13716. }
  13717. handle.body_reader_.has_content_length = true;
  13718. handle.body_reader_.content_length = content_length;
  13719. }
  13720. handle.body_reader_.chunked =
  13721. detail::is_chunked_transfer_encoding(handle.response->headers);
  13722. auto content_encoding = detail::get_combined_header_value(
  13723. handle.response->headers, "Content-Encoding");
  13724. if (decompress_ && !content_encoding.empty()) {
  13725. // Same policy as prepare_content_receiver(): reject a coding we know about
  13726. // but were not built with, pass an unrecognized one through as-is.
  13727. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13728. if (!handle.decompressor_) {
  13729. if (detail::is_known_content_encoding(content_encoding)) {
  13730. handle.error = Error::UnsupportedContentEncoding;
  13731. handle.response.reset();
  13732. return handle;
  13733. }
  13734. } else if (!handle.decompressor_->is_valid()) {
  13735. handle.error = Error::Compression;
  13736. handle.response.reset();
  13737. return handle;
  13738. }
  13739. }
  13740. return handle;
  13741. }
  13742. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13743. if (!is_valid() || !response) { return -1; }
  13744. auto n = decompressor_
  13745. ? read_with_decompression(buf, len)
  13746. : detail::read_body_content(stream_, body_reader_, buf, len);
  13747. if (n == 0) { parse_trailers_if_needed(); }
  13748. return n;
  13749. }
  13750. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13751. size_t len) {
  13752. if (decompress_offset_ < decompress_buffer_.size()) {
  13753. auto available = decompress_buffer_.size() - decompress_offset_;
  13754. auto to_copy = (std::min)(len, available);
  13755. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13756. decompress_offset_ += to_copy;
  13757. decompressed_bytes_read_ += to_copy;
  13758. return static_cast<ssize_t>(to_copy);
  13759. }
  13760. decompress_buffer_.clear();
  13761. decompress_offset_ = 0;
  13762. constexpr size_t kDecompressionBufferSize = 8192;
  13763. char compressed_buf[kDecompressionBufferSize];
  13764. while (true) {
  13765. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13766. sizeof(compressed_buf));
  13767. if (n <= 0) { return n; }
  13768. auto exceeded = false;
  13769. bool decompress_ok = decompressor_->decompress(
  13770. compressed_buf, static_cast<size_t>(n),
  13771. [&](const char *data, size_t data_len) {
  13772. decompress_buffer_.append(data, data_len);
  13773. auto limit = body_reader_.payload_max_length;
  13774. exceeded =
  13775. limit > 0 &&
  13776. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13777. return !exceeded;
  13778. });
  13779. if (!decompress_ok) {
  13780. body_reader_.last_error =
  13781. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13782. return -1;
  13783. }
  13784. if (!decompress_buffer_.empty()) { break; }
  13785. }
  13786. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13787. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13788. decompress_offset_ = to_copy;
  13789. decompressed_bytes_read_ += to_copy;
  13790. return static_cast<ssize_t>(to_copy);
  13791. }
  13792. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13793. // The trailers follow the last chunk, so there are none before it
  13794. auto &decoder = body_reader_.chunked_decoder;
  13795. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13796. return;
  13797. }
  13798. trailers_parsed_ = true;
  13799. decoder->parse_trailers_into(response->trailers, response->headers);
  13800. }
  13801. namespace detail {
  13802. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13803. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13804. size_t &out_chunk_offset,
  13805. size_t &out_chunk_total) {
  13806. if (finished) { return 0; }
  13807. if (chunk_remaining == 0) {
  13808. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13809. if (!lr.getline()) { return -1; }
  13810. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13811. // the line terminator is never mistaken for line content.
  13812. const char *eol = lr.ptr() + lr.size();
  13813. if (lr.end_with_crlf()) {
  13814. eol -= 2;
  13815. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13816. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13817. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13818. // has to come off here or the check below would reject the line.
  13819. eol -= 1;
  13820. }
  13821. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13822. const char *p = lr.ptr();
  13823. int v = 0;
  13824. if (p == eol || !is_hex(*p, v)) { return -1; }
  13825. size_t chunk_len = 0;
  13826. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13827. for (; p < eol && is_hex(*p, v); ++p) {
  13828. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13829. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13830. }
  13831. while (p < eol && is_space_or_tab(*p)) {
  13832. ++p;
  13833. }
  13834. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13835. // terminator, and it is built from tokens and quoted-strings, so it never
  13836. // holds a CR, LF or any other control character. getline() reads up to the
  13837. // CRLF, so a bare LF left in here would be swallowed as extension text
  13838. // while an intermediary that ends the line on it delimits the chunks
  13839. // differently, and the two disagree on where the body ends (request
  13840. // smuggling).
  13841. if (p < eol && *p != ';') { return -1; }
  13842. for (; p < eol; ++p) {
  13843. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13844. }
  13845. // The bytes around the data are no payload, so they are counted on their
  13846. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  13847. // them, which lets a stream send a byte at a time, and what goes past that
  13848. // in padding, leading zeros and extensions builds up to one header field.
  13849. overhead += lr.size() + 2;
  13850. overhead = overhead > 16 ? overhead - 16 : 0;
  13851. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  13852. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  13853. if (chunk_len == 0) {
  13854. chunk_remaining = 0;
  13855. finished = true;
  13856. out_chunk_offset = 0;
  13857. out_chunk_total = 0;
  13858. return 0;
  13859. }
  13860. chunk_remaining = chunk_len;
  13861. last_chunk_total = chunk_remaining;
  13862. last_chunk_offset = 0;
  13863. }
  13864. auto to_read = (std::min)(chunk_remaining, len);
  13865. auto n = strm.read(buf, to_read);
  13866. if (n <= 0) { return -1; }
  13867. auto offset_before = last_chunk_offset;
  13868. last_chunk_offset += static_cast<size_t>(n);
  13869. chunk_remaining -= static_cast<size_t>(n);
  13870. out_chunk_offset = offset_before;
  13871. out_chunk_total = last_chunk_total;
  13872. if (chunk_remaining == 0) {
  13873. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13874. if (!lr.getline()) { return -1; }
  13875. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13876. }
  13877. return n;
  13878. }
  13879. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13880. const Headers &src_headers) {
  13881. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13882. if (!lr.getline()) { return false; }
  13883. return parse_trailers(lr, dest, src_headers);
  13884. }
  13885. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  13886. // a redirect without a Location, is a final response.
  13887. inline bool is_redirect(const Response &res) {
  13888. switch (res.status) {
  13889. case StatusCode::MovedPermanently_301:
  13890. case StatusCode::Found_302:
  13891. case StatusCode::SeeOther_303:
  13892. case StatusCode::TemporaryRedirect_307:
  13893. case StatusCode::PermanentRedirect_308:
  13894. return !res.get_header_value("Location").empty();
  13895. default: return false;
  13896. }
  13897. }
  13898. } // namespace detail
  13899. inline void
  13900. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13901. handle.connection_->sock = socket_.sock;
  13902. #ifdef CPPHTTPLIB_SSL_ENABLED
  13903. handle.connection_->session = socket_.ssl;
  13904. socket_.ssl = nullptr;
  13905. #endif
  13906. socket_.sock = INVALID_SOCKET;
  13907. }
  13908. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  13909. inline std::string ClientImpl::proxy_target_prefix() const {
  13910. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  13911. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  13912. }
  13913. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13914. Response &res, bool close_connection,
  13915. Error &error) {
  13916. if (req.path.empty()) {
  13917. error = Error::Connection;
  13918. return false;
  13919. }
  13920. auto req_save = req;
  13921. bool ret;
  13922. auto prefix = proxy_target_prefix();
  13923. if (!prefix.empty()) {
  13924. // The path follows the authority in absolute-form, so one that does not
  13925. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13926. if (req.path[0] != '/') {
  13927. error = Error::Write;
  13928. return false;
  13929. }
  13930. auto req2 = req;
  13931. req2.path = prefix + req.path;
  13932. ret = process_request(strm, req2, res, close_connection, error);
  13933. req = std::move(req2);
  13934. req.path = req_save.path;
  13935. } else {
  13936. ret = process_request(strm, req, res, close_connection, error);
  13937. }
  13938. if (!ret) { return false; }
  13939. {
  13940. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13941. // for this to be safe.
  13942. // This is safe to call because handle_request is only called by send_
  13943. // which locks the request mutex during the process. It would be a bug
  13944. // to call it from a different thread since it's a thread-safety issue
  13945. // to do these things to the socket if another thread is using the socket.
  13946. std::lock_guard<std::mutex> guard(socket_mutex_);
  13947. // Also when the request asked for it (e.g. a body that was never sent,
  13948. // or "Connection: close"), so that a redirect or an auth retry below does
  13949. // not reuse the socket.
  13950. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13951. detail::has_header_token(res.headers, "Connection", "close") ||
  13952. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13953. disconnect(/*gracefully=*/true);
  13954. }
  13955. }
  13956. if (follow_location_ && detail::is_redirect(res)) {
  13957. req = std::move(req_save);
  13958. // The client that followed the redirect has answered any challenge it
  13959. // could. Retrying below would sign another host's challenge and send it
  13960. // here.
  13961. return redirect(req, res, error);
  13962. }
  13963. #ifdef CPPHTTPLIB_SSL_ENABLED
  13964. if ((res.status == StatusCode::Unauthorized_401 ||
  13965. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13966. req.authorization_count_ < 5) {
  13967. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13968. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13969. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13970. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13971. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13972. return ret;
  13973. }
  13974. const auto &username =
  13975. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13976. const auto &password =
  13977. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13978. if (!username.empty() && !password.empty()) {
  13979. std::map<std::string, std::string> auth;
  13980. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13981. Request new_req = req;
  13982. new_req.authorization_count_ += 1;
  13983. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13984. : "Authorization");
  13985. new_req.headers.insert(detail::make_digest_authentication_header(
  13986. req, make_request_target(req), auth, new_req.authorization_count_,
  13987. detail::random_string(10), username, password, is_proxy));
  13988. Response new_res;
  13989. ret = send(new_req, new_res, error);
  13990. if (ret) { res = std::move(new_res); }
  13991. }
  13992. }
  13993. }
  13994. #endif
  13995. return ret;
  13996. }
  13997. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13998. if (req.redirect_count_ == 0) {
  13999. error = Error::ExceedRedirectCount;
  14000. return false;
  14001. }
  14002. auto location = res.get_header_value("location");
  14003. if (location.empty()) { return false; }
  14004. detail::UrlComponents uc;
  14005. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  14006. uc)) {
  14007. return false;
  14008. }
  14009. // Only follow http/https redirects
  14010. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  14011. return false;
  14012. }
  14013. auto scheme = is_ssl() ? "https" : "http";
  14014. auto next_scheme = std::move(uc.scheme);
  14015. auto next_host = std::move(uc.host);
  14016. auto port_str = std::move(uc.port);
  14017. auto next_path = std::move(uc.path);
  14018. auto next_query = std::move(uc.query);
  14019. auto next_port = port_;
  14020. if (!port_str.empty()) {
  14021. if (!detail::parse_port(port_str, next_port)) { return false; }
  14022. } else if (!next_scheme.empty()) {
  14023. next_port = next_scheme == "https" ? 443 : 80;
  14024. }
  14025. if (next_scheme.empty()) { next_scheme = scheme; }
  14026. if (next_host.empty()) { next_host = host_; }
  14027. if (next_path.empty()) { next_path = "/"; }
  14028. // An absolute or absolute-path location can have dot segments too.
  14029. if (next_path[0] == '/') {
  14030. next_path = detail::remove_dot_segments(next_path);
  14031. }
  14032. auto path = std::move(next_path) + next_query;
  14033. // A Unix socket client sends "Host: localhost", so a Location naming
  14034. // localhost names this client too.
  14035. auto is_same_host = next_host == host_ ||
  14036. (address_family_ == AF_UNIX && next_host == "localhost");
  14037. // Same host redirect - use current client
  14038. if (next_scheme == scheme && is_same_host && next_port == port_) {
  14039. return detail::redirect(*this, req, res, path, location, error);
  14040. }
  14041. // Cross-host/scheme redirect - create new client with robust setup
  14042. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14043. path, location, error);
  14044. }
  14045. // New method for robust redirect client creation
  14046. inline bool ClientImpl::create_redirect_client(
  14047. const std::string &scheme, const std::string &host, int port, Request &req,
  14048. Response &res, const std::string &path, const std::string &location,
  14049. Error &error) {
  14050. // Determine if we need SSL
  14051. auto need_ssl = (scheme == "https");
  14052. // Clean up request headers that are host/client specific
  14053. // Remove headers that should not be carried over to new host
  14054. auto headers_to_remove = std::vector<std::string>{
  14055. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14056. for (const auto &header_name : headers_to_remove) {
  14057. auto it = req.headers.find(header_name);
  14058. while (it != req.headers.end()) {
  14059. it = req.headers.erase(it);
  14060. it = req.headers.find(header_name);
  14061. }
  14062. }
  14063. // Create appropriate client type and handle redirect
  14064. if (need_ssl) {
  14065. #ifdef CPPHTTPLIB_SSL_ENABLED
  14066. // Create SSL client for HTTPS redirect
  14067. SSLClient redirect_client(host, port);
  14068. // Setup basic client configuration first
  14069. setup_redirect_client(redirect_client);
  14070. redirect_client.enable_server_certificate_verification(
  14071. server_certificate_verification_);
  14072. redirect_client.enable_server_hostname_verification(
  14073. server_hostname_verification_);
  14074. redirect_client.system_ca_mode_ = system_ca_mode_;
  14075. // Transfer CA certificate to redirect client
  14076. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14077. if (is_ssl()) {
  14078. auto &self = static_cast<SSLClient &>(*this);
  14079. // A store given to set_ca_cert_store() lives only in this client's
  14080. // context, which then holds all that is trusted.
  14081. if (self.ca_cert_store_set_) {
  14082. std::string pem;
  14083. {
  14084. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14085. pem = detail::ca_certs_to_pem(self.ctx_);
  14086. }
  14087. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14088. redirect_client.ca_cert_store_set_ = true;
  14089. } else if (self.custom_ca_loaded_) {
  14090. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14091. ca_cert_pem_.size());
  14092. }
  14093. redirect_client.set_session_verifier(self.session_verifier_);
  14094. if (self.server_certificate_verifier_) {
  14095. redirect_client.set_server_certificate_verifier(
  14096. self.server_certificate_verifier_);
  14097. }
  14098. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14099. redirect_client.enable_windows_cert_verification_ =
  14100. self.enable_windows_cert_verification_;
  14101. #endif
  14102. }
  14103. // Client certificates are set through constructor for SSLClient
  14104. // NOTE: SSLClient constructor already takes client_cert_path and
  14105. // client_key_path so we need to create it properly if client certs are
  14106. // needed
  14107. // Execute the redirect
  14108. return detail::redirect(redirect_client, req, res, path, location, error);
  14109. #else
  14110. // SSL not supported - set appropriate error
  14111. error = Error::SSLConnection;
  14112. return false;
  14113. #endif
  14114. } else {
  14115. // HTTP redirect
  14116. ClientImpl redirect_client(host, port);
  14117. // Setup client with robust configuration
  14118. setup_redirect_client(redirect_client);
  14119. // Execute the redirect
  14120. return detail::redirect(redirect_client, req, res, path, location, error);
  14121. }
  14122. }
  14123. // New method for robust client setup (based on basic_manual_redirect.cpp
  14124. // logic)
  14125. template <typename ClientType>
  14126. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14127. // Copy basic settings first
  14128. client.set_connection_timeout(connection_timeout_sec_,
  14129. connection_timeout_usec_);
  14130. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14131. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14132. client.set_max_timeout(max_timeout_msec_);
  14133. if (has_payload_max_length_) {
  14134. client.set_payload_max_length(payload_max_length_);
  14135. }
  14136. client.set_keep_alive(keep_alive_);
  14137. client.set_follow_location(
  14138. true); // Enable redirects to handle multi-step redirects
  14139. client.set_path_encode(path_encode_);
  14140. client.set_compress(compress_);
  14141. client.set_decompress(decompress_);
  14142. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14143. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14144. // 15.4, credentials must not be forwarded when redirecting to a different
  14145. // host. This function is only called for cross-host redirects; same-host
  14146. // redirects are handled directly in ClientImpl::redirect().
  14147. // Copy the proxy configuration unconditionally; the per-target bypass is
  14148. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14149. // still use the proxy.
  14150. client.no_proxy_entries_ = no_proxy_entries_;
  14151. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14152. client.set_proxy(proxy_host_, proxy_port_);
  14153. if (!proxy_basic_auth_username_.empty() ||
  14154. !proxy_basic_auth_password_.empty()) {
  14155. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14156. proxy_basic_auth_password_);
  14157. }
  14158. if (!proxy_bearer_token_auth_token_.empty()) {
  14159. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14160. }
  14161. #ifdef CPPHTTPLIB_SSL_ENABLED
  14162. if (!proxy_digest_auth_username_.empty()) {
  14163. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14164. proxy_digest_auth_password_);
  14165. }
  14166. #endif
  14167. }
  14168. // Copy network and socket settings
  14169. client.addr_map_ = addr_map_;
  14170. client.tunnel_addr_map_ = tunnel_addr_map_;
  14171. // A Unix socket client reaches every host through its own socket, as curl's
  14172. // --unix-socket does, unless the caller mapped that host elsewhere. The
  14173. // Location's host is never taken as a socket path.
  14174. if (address_family_ == AF_UNIX) {
  14175. auto &target = client.addr_map_[client.host()];
  14176. if (target.empty()) { target = detail::addr_map_target(addr_map_, host_); }
  14177. }
  14178. client.set_address_family(address_family_);
  14179. client.set_tcp_nodelay(tcp_nodelay_);
  14180. client.set_ipv6_v6only(ipv6_v6only_);
  14181. if (socket_options_) { client.set_socket_options(socket_options_); }
  14182. if (!interface_.empty()) { client.set_interface(interface_); }
  14183. // Copy logging and headers. Not the error logger: a failure comes back to
  14184. // this client's send(), which reports it with the caller's request.
  14185. if (logger_) { client.set_logger(logger_); }
  14186. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14187. // Each new client should generate its own headers based on its target host
  14188. }
  14189. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14190. const Request &req,
  14191. Error &error) const {
  14192. auto is_shutting_down = []() { return false; };
  14193. if (req.is_chunked_content_provider_) {
  14194. auto compressor = compress_ ? detail::create_compressor().first
  14195. : std::unique_ptr<detail::compressor>();
  14196. if (!compressor) {
  14197. compressor = detail::make_unique<detail::nocompressor>();
  14198. }
  14199. return detail::write_content_chunked(strm, req.content_provider_,
  14200. is_shutting_down, *compressor, error);
  14201. } else {
  14202. return detail::write_content_with_progress(
  14203. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14204. req.upload_progress, error);
  14205. }
  14206. }
  14207. // What goes on the request line for req: its path, encoded and without the
  14208. // fragment, with `req.params` as the query when the path has none.
  14209. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14210. auto target = detail::encode_request_target(req.path, path_encode_);
  14211. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14212. target = append_query_params(target, req.params);
  14213. }
  14214. return target;
  14215. }
  14216. inline void ClientImpl::add_credential_headers(Request &req) {
  14217. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14218. // it opens is read by the origin. Each credential goes only to its own hop.
  14219. auto is_connect = req.method == "CONNECT";
  14220. if (!is_connect) {
  14221. detail::add_authorization_header(req, basic_auth_username_,
  14222. basic_auth_password_,
  14223. bearer_token_auth_token_, false);
  14224. }
  14225. // Proxy-Authorization is only sent when the proxy reads this message —
  14226. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14227. // would leak proxy credentials to the destination server.
  14228. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14229. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14230. proxy_basic_auth_password_,
  14231. proxy_bearer_token_auth_token_, true);
  14232. }
  14233. }
  14234. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14235. bool close_connection, Error &error,
  14236. bool skip_body, bool &rejected_locally) {
  14237. rejected_locally = false;
  14238. // Prepare additional headers
  14239. if (close_connection) {
  14240. if (!req.has_header("Connection")) {
  14241. req.set_header("Connection", "close");
  14242. }
  14243. }
  14244. std::string ct_for_defaults;
  14245. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14246. ct_for_defaults = "text/plain";
  14247. }
  14248. prepare_default_headers(req, false, ct_for_defaults);
  14249. if (req.body.empty()) {
  14250. if (req.content_provider_) {
  14251. if (!req.is_chunked_content_provider_) {
  14252. if (!req.has_header("Content-Length")) {
  14253. auto length = std::to_string(req.content_length_);
  14254. req.set_header("Content-Length", length);
  14255. }
  14256. }
  14257. } else {
  14258. if (req.method == "POST" || req.method == "PUT" ||
  14259. req.method == "PATCH") {
  14260. req.set_header("Content-Length", "0");
  14261. }
  14262. }
  14263. }
  14264. add_credential_headers(req);
  14265. // Request line and headers
  14266. {
  14267. detail::BufferStream bstrm;
  14268. auto path_with_query = make_request_target(req);
  14269. // The query already came in through `req.path`; still populate
  14270. // `req.params` for handlers/users who read them.
  14271. auto query_part = detail::query_of(req.path);
  14272. if (!query_part.empty()) {
  14273. detail::parse_query_text(query_part, req.params);
  14274. }
  14275. // Write request line and headers
  14276. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14277. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14278. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14279. // fail the request cleanly instead of emitting a request-line-less,
  14280. // header-injecting request.
  14281. error = Error::Write;
  14282. rejected_locally = true;
  14283. return false;
  14284. }
  14285. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14286. error)) {
  14287. rejected_locally = true;
  14288. return false;
  14289. }
  14290. // Flush buffer
  14291. auto &data = bstrm.get_buffer();
  14292. if (!detail::write_data(strm, data.data(), data.size())) {
  14293. error = Error::Write;
  14294. return false;
  14295. }
  14296. }
  14297. // After sending request line and headers, wait briefly for an early server
  14298. // response (e.g. 4xx) and avoid sending a potentially large request body
  14299. // unnecessarily. This workaround is only enabled on Windows because Unix
  14300. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14301. // buffering can accept large writes even when the peer already responded.
  14302. // Check the stream first (which covers SSL via `is_readable()`), then
  14303. // fall back to select on the socket. Only perform the wait for very large
  14304. // request bodies to avoid interfering with normal small requests and
  14305. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14306. // response. Skip this check when using Expect: 100-continue, as the protocol
  14307. // handles early responses properly.
  14308. #if defined(_WIN32)
  14309. if (!skip_body &&
  14310. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14311. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14312. auto start = std::chrono::high_resolution_clock::now();
  14313. for (;;) {
  14314. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14315. // from SSL internals. If the underlying socket is readable, assume an
  14316. // early response may be present.
  14317. auto sock = strm.socket();
  14318. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14319. return false;
  14320. }
  14321. // Fallback to stream-level check for non-socket streams or when the
  14322. // socket isn't reporting readable. Avoid using `is_readable()` for
  14323. // SSL, since `SSL_pending()` may report buffered records that do not
  14324. // indicate a complete application-level response yet.
  14325. if (!is_ssl() && strm.is_readable()) { return false; }
  14326. auto now = std::chrono::high_resolution_clock::now();
  14327. auto elapsed =
  14328. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14329. .count();
  14330. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14331. break;
  14332. }
  14333. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14334. }
  14335. }
  14336. #endif
  14337. // Body
  14338. if (skip_body) { return true; }
  14339. return write_request_body(strm, req, error);
  14340. }
  14341. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14342. Error &error) {
  14343. if (req.body.empty()) {
  14344. return write_content_with_provider(strm, req, error);
  14345. }
  14346. if (req.upload_progress) {
  14347. auto body_size = req.body.size();
  14348. size_t written = 0;
  14349. auto data = req.body.data();
  14350. while (written < body_size) {
  14351. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14352. if (!detail::write_data(strm, data + written, to_write)) {
  14353. error = Error::Write;
  14354. return false;
  14355. }
  14356. written += to_write;
  14357. if (!req.upload_progress(written, body_size)) {
  14358. error = Error::Canceled;
  14359. return false;
  14360. }
  14361. }
  14362. } else {
  14363. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14364. error = Error::Write;
  14365. return false;
  14366. }
  14367. }
  14368. return true;
  14369. }
  14370. inline std::unique_ptr<Response>
  14371. ClientImpl::send_with_content_provider_and_receiver(
  14372. Request &req, const char *body, size_t content_length,
  14373. ContentProvider content_provider,
  14374. ContentProviderWithoutLength content_provider_without_length,
  14375. const std::string &content_type, ContentReceiver content_receiver,
  14376. Error &error) {
  14377. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14378. auto enc = compress_
  14379. ? detail::create_compressor()
  14380. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14381. nullptr, nullptr);
  14382. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14383. if (enc.first && !content_provider_without_length) {
  14384. auto &compressor = enc.first;
  14385. if (content_provider) {
  14386. auto ok = true;
  14387. auto finished = false;
  14388. size_t offset = 0;
  14389. DataSink data_sink;
  14390. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14391. if (ok) {
  14392. auto last = offset + data_len == content_length;
  14393. auto ret = compressor->compress(
  14394. data, data_len, last,
  14395. [&](const char *compressed_data, size_t compressed_data_len) {
  14396. req.body.append(compressed_data, compressed_data_len);
  14397. return true;
  14398. });
  14399. if (ret) {
  14400. offset += data_len;
  14401. } else {
  14402. ok = false;
  14403. }
  14404. }
  14405. return ok;
  14406. };
  14407. // As in detail::write_content_with_progress(): the body is framed by
  14408. // content_length, so a provider that finishes early has truncated it.
  14409. // Stop and report that instead of calling the provider forever.
  14410. data_sink.done = [&]() { finished = true; };
  14411. while (ok && !finished && offset < content_length) {
  14412. if (!content_provider(offset, content_length - offset, data_sink)) {
  14413. error = Error::Canceled;
  14414. output_error_log(error, &req);
  14415. return nullptr;
  14416. }
  14417. }
  14418. // A short body here means either the provider stopped early or the
  14419. // compressor gave up. The branch below reports a failing compressor as
  14420. // Error::Compression, so keep the two distinguishable.
  14421. if (offset < content_length) {
  14422. error = ok ? Error::Write : Error::Compression;
  14423. output_error_log(error, &req);
  14424. return nullptr;
  14425. }
  14426. } else {
  14427. if (!compressor->compress(body, content_length, true,
  14428. [&](const char *data, size_t data_len) {
  14429. req.body.append(data, data_len);
  14430. return true;
  14431. })) {
  14432. error = Error::Compression;
  14433. output_error_log(error, &req);
  14434. return nullptr;
  14435. }
  14436. }
  14437. } else {
  14438. if (content_provider) {
  14439. req.content_length_ = content_length;
  14440. req.content_provider_ = std::move(content_provider);
  14441. req.is_chunked_content_provider_ = false;
  14442. } else if (content_provider_without_length) {
  14443. req.content_length_ = 0;
  14444. req.content_provider_ = detail::ContentProviderAdapter(
  14445. std::move(content_provider_without_length));
  14446. req.is_chunked_content_provider_ = true;
  14447. req.set_header("Transfer-Encoding", "chunked");
  14448. } else {
  14449. req.body.assign(body, content_length);
  14450. }
  14451. }
  14452. if (content_receiver) {
  14453. req.content_receiver =
  14454. [content_receiver](const char *data, size_t data_length,
  14455. size_t /*offset*/, size_t /*total_length*/) {
  14456. return content_receiver(data, data_length);
  14457. };
  14458. }
  14459. auto res = detail::make_unique<Response>();
  14460. return send(req, *res, error) ? std::move(res) : nullptr;
  14461. }
  14462. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14463. const std::string &method, const std::string &path, const Headers &headers,
  14464. const char *body, size_t content_length, ContentProvider content_provider,
  14465. ContentProviderWithoutLength content_provider_without_length,
  14466. const std::string &content_type, ContentReceiver content_receiver,
  14467. UploadProgress progress) {
  14468. Request req;
  14469. req.method = method;
  14470. req.headers = headers;
  14471. req.path = path;
  14472. req.upload_progress = std::move(progress);
  14473. if (max_timeout_msec_ > 0) {
  14474. req.start_time_ = std::chrono::steady_clock::now();
  14475. }
  14476. auto error = Error::Success;
  14477. #ifdef CPPHTTPLIB_SSL_ENABLED
  14478. // Hold the request lock until the Result has read this request's TLS error
  14479. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14480. #endif
  14481. auto res = send_with_content_provider_and_receiver(
  14482. req, body, content_length, std::move(content_provider),
  14483. std::move(content_provider_without_length), content_type,
  14484. std::move(content_receiver), error);
  14485. #ifdef CPPHTTPLIB_SSL_ENABLED
  14486. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14487. last_backend_error_};
  14488. #else
  14489. return Result{std::move(res), error, std::move(req.headers)};
  14490. #endif
  14491. }
  14492. inline void ClientImpl::output_log(const Request &req,
  14493. const Response &res) const {
  14494. if (logger_) {
  14495. std::lock_guard<std::mutex> guard(logger_mutex_);
  14496. logger_(req, res);
  14497. }
  14498. }
  14499. inline void ClientImpl::output_error_log(const Error &err,
  14500. const Request *req) const {
  14501. if (error_logger_) {
  14502. std::lock_guard<std::mutex> guard(logger_mutex_);
  14503. error_logger_(err, req);
  14504. }
  14505. }
  14506. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14507. Response &res, bool close_connection,
  14508. Error &error) {
  14509. // Auto-add Expect: 100-continue for large bodies
  14510. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14511. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14512. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14513. req.set_header("Expect", "100-continue");
  14514. }
  14515. }
  14516. // Check for Expect: 100-continue
  14517. auto expect_100_continue =
  14518. detail::has_header_token(req.headers, "Expect", "100-continue");
  14519. // Send request (skip body if using Expect: 100-continue)
  14520. auto rejected_locally = false;
  14521. auto write_request_success =
  14522. write_request(strm, req, close_connection, error, expect_100_continue,
  14523. rejected_locally);
  14524. // A failed write normally still reads the response below, since the server
  14525. // may have answered early (e.g. 413/414) and closed while the body was being
  14526. // sent. A request rejected before any byte reached the socket gets no such
  14527. // response, and waiting for one would block until the read timeout.
  14528. if (rejected_locally) { return false; }
  14529. #ifdef CPPHTTPLIB_SSL_ENABLED
  14530. if (is_ssl() && !expect_100_continue) {
  14531. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14532. if (!is_proxy_enabled) {
  14533. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14534. error = Error::SSLPeerCouldBeClosed_;
  14535. return false;
  14536. }
  14537. }
  14538. }
  14539. #endif
  14540. // Handle Expect: 100-continue.
  14541. //
  14542. // Wait for an interim/early response by attempting to read the status line
  14543. // under a short timeout, instead of trusting raw socket readability. Over
  14544. // TLS, post-handshake records (e.g. session tickets) make the socket
  14545. // readable without any HTTP response being available; relying on
  14546. // `select_read` there caused the body to be withheld forever and the
  14547. // request to fail with `Read` (#2458). If no status line arrives within the
  14548. // timeout, send the body anyway (matching curl's behavior).
  14549. auto status_line_read = false;
  14550. if (expect_100_continue && write_request_success) {
  14551. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14552. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14553. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14554. strm.set_read_timeout(sec, usec);
  14555. status_line_read = read_response_line(strm, req, res, false);
  14556. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14557. }
  14558. if (!status_line_read) {
  14559. // No interim response within the timeout: send the body and handle the
  14560. // response as usual.
  14561. if (!write_request_body(strm, req, error)) { return false; }
  14562. expect_100_continue = false; // Switch to normal response handling
  14563. }
  14564. }
  14565. // Receive response and headers
  14566. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14567. if ((!status_line_read &&
  14568. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14569. !detail::read_headers(strm, res.headers)) {
  14570. if (write_request_success) { error = Error::Read; }
  14571. return false;
  14572. }
  14573. if (!write_request_success) { return false; }
  14574. // Handle Expect: 100-continue response
  14575. if (expect_100_continue) {
  14576. if (res.status == StatusCode::Continue_100) {
  14577. // Server accepted, send the body
  14578. if (!write_request_body(strm, req, error)) { return false; }
  14579. // Read the actual response
  14580. res.headers.clear();
  14581. res.body.clear();
  14582. if (!read_response_line(strm, req, res) ||
  14583. !detail::read_headers(strm, res.headers)) {
  14584. error = Error::Read;
  14585. return false;
  14586. }
  14587. } else {
  14588. // A final response came first, so the body this request declared was
  14589. // never sent, and the server may still be waiting for it. The
  14590. // connection cannot carry another request.
  14591. std::lock_guard<std::mutex> guard(socket_mutex_);
  14592. socket_should_be_closed_when_request_is_done_ = true;
  14593. }
  14594. }
  14595. // Body
  14596. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14597. req.method != "CONNECT") {
  14598. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14599. // whose final transfer coding is not chunked is not ambiguous: its body
  14600. // runs until the server closes the connection, so it is not rejected.
  14601. // HEAD/204 are excluded above and a 304 carries no body.
  14602. if (res.status != StatusCode::NotModified_304) {
  14603. if (detail::has_conflicting_content_length(res.headers)) {
  14604. error = Error::Read;
  14605. return false;
  14606. }
  14607. if (detail::has_faulty_transfer_encoding(res)) {
  14608. std::lock_guard<std::mutex> guard(socket_mutex_);
  14609. socket_should_be_closed_when_request_is_done_ = true;
  14610. }
  14611. }
  14612. auto redirect = follow_location_ && detail::is_redirect(res);
  14613. if (req.response_handler && !redirect) {
  14614. if (!req.response_handler(res)) {
  14615. error = Error::Canceled;
  14616. return false;
  14617. }
  14618. }
  14619. auto out =
  14620. req.content_receiver
  14621. ? static_cast<ContentReceiverWithProgress>(
  14622. [&](const char *buf, size_t n, size_t off, size_t len) {
  14623. if (redirect) { return true; }
  14624. auto ret = req.content_receiver(buf, n, off, len);
  14625. if (!ret) { error = Error::Canceled; }
  14626. return ret;
  14627. })
  14628. : static_cast<ContentReceiverWithProgress>(
  14629. [&](const char *buf, size_t n, size_t /*off*/,
  14630. size_t /*len*/) {
  14631. assert(res.body.size() + n <= res.body.max_size());
  14632. if (payload_max_length_ > 0 &&
  14633. (res.body.size() >= payload_max_length_ ||
  14634. n > payload_max_length_ - res.body.size())) {
  14635. return false;
  14636. }
  14637. res.body.append(buf, n);
  14638. return true;
  14639. });
  14640. auto progress = [&](size_t current, size_t total) {
  14641. if (!req.download_progress || redirect) { return true; }
  14642. auto ret = req.download_progress(current, total);
  14643. if (!ret) { error = Error::Canceled; }
  14644. return ret;
  14645. };
  14646. if (res.has_header("Content-Length")) {
  14647. if (!req.content_receiver) {
  14648. auto len = res.get_header_value_u64("Content-Length");
  14649. if (len > res.body.max_size()) {
  14650. error = Error::Read;
  14651. return false;
  14652. }
  14653. // Content-Length is only the server's claim, so reserve no more than
  14654. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14655. // body has arrived. A longer body grows as it is read.
  14656. auto reserve_len =
  14657. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14658. if (payload_max_length_ > 0) {
  14659. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14660. }
  14661. res.body.reserve(reserve_len);
  14662. }
  14663. }
  14664. if (res.status != StatusCode::NotModified_304) {
  14665. auto content_status = 0;
  14666. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14667. ? (std::numeric_limits<size_t>::max)()
  14668. : payload_max_length_;
  14669. if (!detail::read_content(strm, res, max_length, content_status,
  14670. std::move(progress), std::move(out),
  14671. decompress_)) {
  14672. if (error != Error::Canceled) {
  14673. // Tell the caller apart from a plain read failure when the body was
  14674. // over the payload limit or could not be decoded because of its
  14675. // Content-Encoding.
  14676. switch (content_status) {
  14677. case StatusCode::PayloadTooLarge_413:
  14678. error = Error::ExceedMaxPayloadSize;
  14679. break;
  14680. case StatusCode::UnsupportedMediaType_415:
  14681. error = Error::UnsupportedContentEncoding;
  14682. break;
  14683. case StatusCode::InternalServerError_500:
  14684. error = Error::Compression;
  14685. break;
  14686. default: error = Error::Read; break;
  14687. }
  14688. }
  14689. return false;
  14690. }
  14691. }
  14692. }
  14693. // Log
  14694. output_log(req, res);
  14695. return true;
  14696. }
  14697. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14698. const std::string &boundary, const UploadFormDataItems &items,
  14699. const FormDataProviderItems &provider_items) const {
  14700. size_t cur_item = 0;
  14701. size_t cur_start = 0;
  14702. // cur_item and cur_start are copied to within the std::function and
  14703. // maintain state between successive calls
  14704. return [&, cur_item, cur_start](size_t offset,
  14705. DataSink &sink) mutable -> bool {
  14706. if (!offset && !items.empty()) {
  14707. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14708. return true;
  14709. } else if (cur_item < provider_items.size()) {
  14710. if (!cur_start) {
  14711. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14712. provider_items[cur_item], boundary);
  14713. offset += begin.size();
  14714. cur_start = offset;
  14715. sink.os << begin;
  14716. }
  14717. DataSink cur_sink;
  14718. auto has_data = true;
  14719. cur_sink.write = sink.write;
  14720. // Forward is_writable so a provider item asking whether it may keep
  14721. // going gets the outer sink's answer rather than the default `true`.
  14722. cur_sink.is_writable = sink.is_writable;
  14723. cur_sink.done = [&]() { has_data = false; };
  14724. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14725. return false;
  14726. }
  14727. if (!has_data) {
  14728. sink.os << detail::serialize_multipart_formdata_item_end();
  14729. cur_item++;
  14730. cur_start = 0;
  14731. }
  14732. return true;
  14733. } else {
  14734. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14735. sink.done();
  14736. return true;
  14737. }
  14738. };
  14739. }
  14740. inline bool ClientImpl::process_socket(
  14741. const Socket &socket,
  14742. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14743. std::function<bool(Stream &strm)> callback) {
  14744. return detail::process_client_socket(
  14745. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14746. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14747. }
  14748. inline bool ClientImpl::is_ssl() const { return false; }
  14749. inline Result ClientImpl::Get(const std::string &path,
  14750. DownloadProgress progress) {
  14751. return Get(path, Headers(), std::move(progress));
  14752. }
  14753. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14754. DownloadProgress progress) {
  14755. return Get(path, params, Headers(), std::move(progress));
  14756. }
  14757. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14758. const Headers &headers,
  14759. DownloadProgress progress) {
  14760. if (params.empty()) { return Get(path, headers); }
  14761. std::string path_with_query = append_query_params(path, params);
  14762. return Get(path_with_query, headers, std::move(progress));
  14763. }
  14764. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14765. DownloadProgress progress) {
  14766. Request req;
  14767. req.method = "GET";
  14768. req.path = path;
  14769. req.headers = headers;
  14770. req.download_progress = std::move(progress);
  14771. if (max_timeout_msec_ > 0) {
  14772. req.start_time_ = std::chrono::steady_clock::now();
  14773. }
  14774. return send_(std::move(req));
  14775. }
  14776. inline Result ClientImpl::Get(const std::string &path,
  14777. ContentReceiver content_receiver,
  14778. DownloadProgress progress) {
  14779. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14780. std::move(progress));
  14781. }
  14782. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14783. ContentReceiver content_receiver,
  14784. DownloadProgress progress) {
  14785. return Get(path, headers, nullptr, std::move(content_receiver),
  14786. std::move(progress));
  14787. }
  14788. inline Result ClientImpl::Get(const std::string &path,
  14789. ResponseHandler response_handler,
  14790. ContentReceiver content_receiver,
  14791. DownloadProgress progress) {
  14792. return Get(path, Headers(), std::move(response_handler),
  14793. std::move(content_receiver), std::move(progress));
  14794. }
  14795. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14796. ResponseHandler response_handler,
  14797. ContentReceiver content_receiver,
  14798. DownloadProgress progress) {
  14799. Request req;
  14800. req.method = "GET";
  14801. req.path = path;
  14802. req.headers = headers;
  14803. req.response_handler = std::move(response_handler);
  14804. req.content_receiver =
  14805. [content_receiver](const char *data, size_t data_length,
  14806. size_t /*offset*/, size_t /*total_length*/) {
  14807. return content_receiver(data, data_length);
  14808. };
  14809. req.download_progress = std::move(progress);
  14810. if (max_timeout_msec_ > 0) {
  14811. req.start_time_ = std::chrono::steady_clock::now();
  14812. }
  14813. return send_(std::move(req));
  14814. }
  14815. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14816. const Headers &headers,
  14817. ContentReceiver content_receiver,
  14818. DownloadProgress progress) {
  14819. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14820. std::move(progress));
  14821. }
  14822. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14823. const Headers &headers,
  14824. ResponseHandler response_handler,
  14825. ContentReceiver content_receiver,
  14826. DownloadProgress progress) {
  14827. if (params.empty()) {
  14828. return Get(path, headers, std::move(response_handler),
  14829. std::move(content_receiver), std::move(progress));
  14830. }
  14831. std::string path_with_query = append_query_params(path, params);
  14832. return Get(path_with_query, headers, std::move(response_handler),
  14833. std::move(content_receiver), std::move(progress));
  14834. }
  14835. inline Result ClientImpl::Head(const std::string &path) {
  14836. return Head(path, Headers());
  14837. }
  14838. inline Result ClientImpl::Head(const std::string &path,
  14839. const Headers &headers) {
  14840. Request req;
  14841. req.method = "HEAD";
  14842. req.headers = headers;
  14843. req.path = path;
  14844. if (max_timeout_msec_ > 0) {
  14845. req.start_time_ = std::chrono::steady_clock::now();
  14846. }
  14847. return send_(std::move(req));
  14848. }
  14849. inline Result ClientImpl::Post(const std::string &path) {
  14850. return Post(path, std::string(), std::string());
  14851. }
  14852. inline Result ClientImpl::Post(const std::string &path,
  14853. const Headers &headers) {
  14854. return Post(path, headers, nullptr, 0, std::string());
  14855. }
  14856. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14857. size_t content_length,
  14858. const std::string &content_type,
  14859. UploadProgress progress) {
  14860. return Post(path, Headers(), body, content_length, content_type, progress);
  14861. }
  14862. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14863. const std::string &content_type,
  14864. UploadProgress progress) {
  14865. return Post(path, Headers(), body, content_type, progress);
  14866. }
  14867. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14868. return Post(path, Headers(), params);
  14869. }
  14870. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14871. ContentProvider content_provider,
  14872. const std::string &content_type,
  14873. UploadProgress progress) {
  14874. return Post(path, Headers(), content_length, std::move(content_provider),
  14875. content_type, progress);
  14876. }
  14877. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14878. ContentProvider content_provider,
  14879. const std::string &content_type,
  14880. ContentReceiver content_receiver,
  14881. UploadProgress progress) {
  14882. return Post(path, Headers(), content_length, std::move(content_provider),
  14883. content_type, std::move(content_receiver), progress);
  14884. }
  14885. inline Result ClientImpl::Post(const std::string &path,
  14886. ContentProviderWithoutLength content_provider,
  14887. const std::string &content_type,
  14888. UploadProgress progress) {
  14889. return Post(path, Headers(), std::move(content_provider), content_type,
  14890. progress);
  14891. }
  14892. inline Result ClientImpl::Post(const std::string &path,
  14893. ContentProviderWithoutLength content_provider,
  14894. const std::string &content_type,
  14895. ContentReceiver content_receiver,
  14896. UploadProgress progress) {
  14897. return Post(path, Headers(), std::move(content_provider), content_type,
  14898. std::move(content_receiver), progress);
  14899. }
  14900. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14901. const Params &params) {
  14902. auto query = detail::params_to_query_str(params);
  14903. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14904. }
  14905. inline Result ClientImpl::Post(const std::string &path,
  14906. const UploadFormDataItems &items,
  14907. UploadProgress progress) {
  14908. return Post(path, Headers(), items, progress);
  14909. }
  14910. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14911. const UploadFormDataItems &items,
  14912. UploadProgress progress) {
  14913. const auto &boundary = detail::make_multipart_data_boundary();
  14914. const auto &content_type =
  14915. detail::serialize_multipart_formdata_get_content_type(boundary);
  14916. auto content_length = detail::get_multipart_content_length(items, boundary);
  14917. return Post(path, headers, content_length,
  14918. detail::make_multipart_content_provider(items, boundary),
  14919. content_type, progress);
  14920. }
  14921. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14922. const UploadFormDataItems &items,
  14923. const std::string &boundary,
  14924. UploadProgress progress) {
  14925. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14926. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14927. }
  14928. const auto &content_type =
  14929. detail::serialize_multipart_formdata_get_content_type(boundary);
  14930. auto content_length = detail::get_multipart_content_length(items, boundary);
  14931. return Post(path, headers, content_length,
  14932. detail::make_multipart_content_provider(items, boundary),
  14933. content_type, progress);
  14934. }
  14935. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14936. const char *body, size_t content_length,
  14937. const std::string &content_type,
  14938. UploadProgress progress) {
  14939. return send_with_content_provider_and_receiver(
  14940. "POST", path, headers, body, content_length, nullptr, nullptr,
  14941. content_type, nullptr, progress);
  14942. }
  14943. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14944. const std::string &body,
  14945. const std::string &content_type,
  14946. UploadProgress progress) {
  14947. return send_with_content_provider_and_receiver(
  14948. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14949. content_type, nullptr, progress);
  14950. }
  14951. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14952. size_t content_length,
  14953. ContentProvider content_provider,
  14954. const std::string &content_type,
  14955. UploadProgress progress) {
  14956. return send_with_content_provider_and_receiver(
  14957. "POST", path, headers, nullptr, content_length,
  14958. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14959. }
  14960. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14961. size_t content_length,
  14962. ContentProvider content_provider,
  14963. const std::string &content_type,
  14964. ContentReceiver content_receiver,
  14965. DownloadProgress progress) {
  14966. return send_with_content_provider_and_receiver(
  14967. "POST", path, headers, nullptr, content_length,
  14968. std::move(content_provider), nullptr, content_type,
  14969. std::move(content_receiver), std::move(progress));
  14970. }
  14971. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14972. ContentProviderWithoutLength content_provider,
  14973. const std::string &content_type,
  14974. UploadProgress progress) {
  14975. return send_with_content_provider_and_receiver(
  14976. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14977. content_type, nullptr, progress);
  14978. }
  14979. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14980. ContentProviderWithoutLength content_provider,
  14981. const std::string &content_type,
  14982. ContentReceiver content_receiver,
  14983. DownloadProgress progress) {
  14984. return send_with_content_provider_and_receiver(
  14985. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14986. content_type, std::move(content_receiver), std::move(progress));
  14987. }
  14988. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14989. const UploadFormDataItems &items,
  14990. const FormDataProviderItems &provider_items,
  14991. UploadProgress progress) {
  14992. const auto &boundary = detail::make_multipart_data_boundary();
  14993. const auto &content_type =
  14994. detail::serialize_multipart_formdata_get_content_type(boundary);
  14995. return send_with_content_provider_and_receiver(
  14996. "POST", path, headers, nullptr, 0, nullptr,
  14997. get_multipart_content_provider(boundary, items, provider_items),
  14998. content_type, nullptr, progress);
  14999. }
  15000. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15001. const std::string &body,
  15002. const std::string &content_type,
  15003. ContentReceiver content_receiver,
  15004. DownloadProgress progress) {
  15005. Request req;
  15006. req.method = "POST";
  15007. req.path = path;
  15008. req.headers = headers;
  15009. req.body = body;
  15010. req.content_receiver =
  15011. [content_receiver](const char *data, size_t data_length,
  15012. size_t /*offset*/, size_t /*total_length*/) {
  15013. return content_receiver(data, data_length);
  15014. };
  15015. req.download_progress = std::move(progress);
  15016. if (max_timeout_msec_ > 0) {
  15017. req.start_time_ = std::chrono::steady_clock::now();
  15018. }
  15019. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15020. return send_(std::move(req));
  15021. }
  15022. inline Result ClientImpl::Put(const std::string &path) {
  15023. return Put(path, std::string(), std::string());
  15024. }
  15025. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  15026. return Put(path, headers, nullptr, 0, std::string());
  15027. }
  15028. inline Result ClientImpl::Put(const std::string &path, const char *body,
  15029. size_t content_length,
  15030. const std::string &content_type,
  15031. UploadProgress progress) {
  15032. return Put(path, Headers(), body, content_length, content_type, progress);
  15033. }
  15034. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  15035. const std::string &content_type,
  15036. UploadProgress progress) {
  15037. return Put(path, Headers(), body, content_type, progress);
  15038. }
  15039. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  15040. return Put(path, Headers(), params);
  15041. }
  15042. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15043. ContentProvider content_provider,
  15044. const std::string &content_type,
  15045. UploadProgress progress) {
  15046. return Put(path, Headers(), content_length, std::move(content_provider),
  15047. content_type, progress);
  15048. }
  15049. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15050. ContentProvider content_provider,
  15051. const std::string &content_type,
  15052. ContentReceiver content_receiver,
  15053. UploadProgress progress) {
  15054. return Put(path, Headers(), content_length, std::move(content_provider),
  15055. content_type, std::move(content_receiver), progress);
  15056. }
  15057. inline Result ClientImpl::Put(const std::string &path,
  15058. ContentProviderWithoutLength content_provider,
  15059. const std::string &content_type,
  15060. UploadProgress progress) {
  15061. return Put(path, Headers(), std::move(content_provider), content_type,
  15062. progress);
  15063. }
  15064. inline Result ClientImpl::Put(const std::string &path,
  15065. ContentProviderWithoutLength content_provider,
  15066. const std::string &content_type,
  15067. ContentReceiver content_receiver,
  15068. UploadProgress progress) {
  15069. return Put(path, Headers(), std::move(content_provider), content_type,
  15070. std::move(content_receiver), progress);
  15071. }
  15072. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15073. const Params &params) {
  15074. auto query = detail::params_to_query_str(params);
  15075. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15076. }
  15077. inline Result ClientImpl::Put(const std::string &path,
  15078. const UploadFormDataItems &items,
  15079. UploadProgress progress) {
  15080. return Put(path, Headers(), items, progress);
  15081. }
  15082. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15083. const UploadFormDataItems &items,
  15084. UploadProgress progress) {
  15085. const auto &boundary = detail::make_multipart_data_boundary();
  15086. const auto &content_type =
  15087. detail::serialize_multipart_formdata_get_content_type(boundary);
  15088. auto content_length = detail::get_multipart_content_length(items, boundary);
  15089. return Put(path, headers, content_length,
  15090. detail::make_multipart_content_provider(items, boundary),
  15091. content_type, progress);
  15092. }
  15093. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15094. const UploadFormDataItems &items,
  15095. const std::string &boundary,
  15096. UploadProgress progress) {
  15097. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15098. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15099. }
  15100. const auto &content_type =
  15101. detail::serialize_multipart_formdata_get_content_type(boundary);
  15102. auto content_length = detail::get_multipart_content_length(items, boundary);
  15103. return Put(path, headers, content_length,
  15104. detail::make_multipart_content_provider(items, boundary),
  15105. content_type, progress);
  15106. }
  15107. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15108. const char *body, size_t content_length,
  15109. const std::string &content_type,
  15110. UploadProgress progress) {
  15111. return send_with_content_provider_and_receiver(
  15112. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15113. content_type, nullptr, progress);
  15114. }
  15115. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15116. const std::string &body,
  15117. const std::string &content_type,
  15118. UploadProgress progress) {
  15119. return send_with_content_provider_and_receiver(
  15120. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15121. content_type, nullptr, progress);
  15122. }
  15123. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15124. size_t content_length,
  15125. ContentProvider content_provider,
  15126. const std::string &content_type,
  15127. UploadProgress progress) {
  15128. return send_with_content_provider_and_receiver(
  15129. "PUT", path, headers, nullptr, content_length,
  15130. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15131. }
  15132. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15133. size_t content_length,
  15134. ContentProvider content_provider,
  15135. const std::string &content_type,
  15136. ContentReceiver content_receiver,
  15137. UploadProgress progress) {
  15138. return send_with_content_provider_and_receiver(
  15139. "PUT", path, headers, nullptr, content_length,
  15140. std::move(content_provider), nullptr, content_type,
  15141. std::move(content_receiver), progress);
  15142. }
  15143. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15144. ContentProviderWithoutLength content_provider,
  15145. const std::string &content_type,
  15146. UploadProgress progress) {
  15147. return send_with_content_provider_and_receiver(
  15148. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15149. content_type, nullptr, progress);
  15150. }
  15151. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15152. ContentProviderWithoutLength content_provider,
  15153. const std::string &content_type,
  15154. ContentReceiver content_receiver,
  15155. UploadProgress progress) {
  15156. return send_with_content_provider_and_receiver(
  15157. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15158. content_type, std::move(content_receiver), progress);
  15159. }
  15160. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15161. const UploadFormDataItems &items,
  15162. const FormDataProviderItems &provider_items,
  15163. UploadProgress progress) {
  15164. const auto &boundary = detail::make_multipart_data_boundary();
  15165. const auto &content_type =
  15166. detail::serialize_multipart_formdata_get_content_type(boundary);
  15167. return send_with_content_provider_and_receiver(
  15168. "PUT", path, headers, nullptr, 0, nullptr,
  15169. get_multipart_content_provider(boundary, items, provider_items),
  15170. content_type, nullptr, progress);
  15171. }
  15172. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15173. const std::string &body,
  15174. const std::string &content_type,
  15175. ContentReceiver content_receiver,
  15176. DownloadProgress progress) {
  15177. Request req;
  15178. req.method = "PUT";
  15179. req.path = path;
  15180. req.headers = headers;
  15181. req.body = body;
  15182. req.content_receiver =
  15183. [content_receiver](const char *data, size_t data_length,
  15184. size_t /*offset*/, size_t /*total_length*/) {
  15185. return content_receiver(data, data_length);
  15186. };
  15187. req.download_progress = std::move(progress);
  15188. if (max_timeout_msec_ > 0) {
  15189. req.start_time_ = std::chrono::steady_clock::now();
  15190. }
  15191. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15192. return send_(std::move(req));
  15193. }
  15194. inline Result ClientImpl::Patch(const std::string &path) {
  15195. return Patch(path, std::string(), std::string());
  15196. }
  15197. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15198. UploadProgress progress) {
  15199. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15200. }
  15201. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15202. size_t content_length,
  15203. const std::string &content_type,
  15204. UploadProgress progress) {
  15205. return Patch(path, Headers(), body, content_length, content_type, progress);
  15206. }
  15207. inline Result ClientImpl::Patch(const std::string &path,
  15208. const std::string &body,
  15209. const std::string &content_type,
  15210. UploadProgress progress) {
  15211. return Patch(path, Headers(), body, content_type, progress);
  15212. }
  15213. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15214. return Patch(path, Headers(), params);
  15215. }
  15216. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15217. ContentProvider content_provider,
  15218. const std::string &content_type,
  15219. UploadProgress progress) {
  15220. return Patch(path, Headers(), content_length, std::move(content_provider),
  15221. content_type, progress);
  15222. }
  15223. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15224. ContentProvider content_provider,
  15225. const std::string &content_type,
  15226. ContentReceiver content_receiver,
  15227. UploadProgress progress) {
  15228. return Patch(path, Headers(), content_length, std::move(content_provider),
  15229. content_type, std::move(content_receiver), progress);
  15230. }
  15231. inline Result ClientImpl::Patch(const std::string &path,
  15232. ContentProviderWithoutLength content_provider,
  15233. const std::string &content_type,
  15234. UploadProgress progress) {
  15235. return Patch(path, Headers(), std::move(content_provider), content_type,
  15236. progress);
  15237. }
  15238. inline Result ClientImpl::Patch(const std::string &path,
  15239. ContentProviderWithoutLength content_provider,
  15240. const std::string &content_type,
  15241. ContentReceiver content_receiver,
  15242. UploadProgress progress) {
  15243. return Patch(path, Headers(), std::move(content_provider), content_type,
  15244. std::move(content_receiver), progress);
  15245. }
  15246. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15247. const Params &params) {
  15248. auto query = detail::params_to_query_str(params);
  15249. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15250. }
  15251. inline Result ClientImpl::Patch(const std::string &path,
  15252. const UploadFormDataItems &items,
  15253. UploadProgress progress) {
  15254. return Patch(path, Headers(), items, progress);
  15255. }
  15256. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15257. const UploadFormDataItems &items,
  15258. UploadProgress progress) {
  15259. const auto &boundary = detail::make_multipart_data_boundary();
  15260. const auto &content_type =
  15261. detail::serialize_multipart_formdata_get_content_type(boundary);
  15262. auto content_length = detail::get_multipart_content_length(items, boundary);
  15263. return Patch(path, headers, content_length,
  15264. detail::make_multipart_content_provider(items, boundary),
  15265. content_type, progress);
  15266. }
  15267. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15268. const UploadFormDataItems &items,
  15269. const std::string &boundary,
  15270. UploadProgress progress) {
  15271. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15272. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15273. }
  15274. const auto &content_type =
  15275. detail::serialize_multipart_formdata_get_content_type(boundary);
  15276. auto content_length = detail::get_multipart_content_length(items, boundary);
  15277. return Patch(path, headers, content_length,
  15278. detail::make_multipart_content_provider(items, boundary),
  15279. content_type, progress);
  15280. }
  15281. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15282. const char *body, size_t content_length,
  15283. const std::string &content_type,
  15284. UploadProgress progress) {
  15285. return send_with_content_provider_and_receiver(
  15286. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15287. content_type, nullptr, progress);
  15288. }
  15289. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15290. const std::string &body,
  15291. const std::string &content_type,
  15292. UploadProgress progress) {
  15293. return send_with_content_provider_and_receiver(
  15294. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15295. content_type, nullptr, progress);
  15296. }
  15297. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15298. size_t content_length,
  15299. ContentProvider content_provider,
  15300. const std::string &content_type,
  15301. UploadProgress progress) {
  15302. return send_with_content_provider_and_receiver(
  15303. "PATCH", path, headers, nullptr, content_length,
  15304. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15305. }
  15306. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15307. size_t content_length,
  15308. ContentProvider content_provider,
  15309. const std::string &content_type,
  15310. ContentReceiver content_receiver,
  15311. UploadProgress progress) {
  15312. return send_with_content_provider_and_receiver(
  15313. "PATCH", path, headers, nullptr, content_length,
  15314. std::move(content_provider), nullptr, content_type,
  15315. std::move(content_receiver), progress);
  15316. }
  15317. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15318. ContentProviderWithoutLength content_provider,
  15319. const std::string &content_type,
  15320. UploadProgress progress) {
  15321. return send_with_content_provider_and_receiver(
  15322. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15323. content_type, nullptr, progress);
  15324. }
  15325. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15326. ContentProviderWithoutLength content_provider,
  15327. const std::string &content_type,
  15328. ContentReceiver content_receiver,
  15329. UploadProgress progress) {
  15330. return send_with_content_provider_and_receiver(
  15331. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15332. content_type, std::move(content_receiver), progress);
  15333. }
  15334. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15335. const UploadFormDataItems &items,
  15336. const FormDataProviderItems &provider_items,
  15337. UploadProgress progress) {
  15338. const auto &boundary = detail::make_multipart_data_boundary();
  15339. const auto &content_type =
  15340. detail::serialize_multipart_formdata_get_content_type(boundary);
  15341. return send_with_content_provider_and_receiver(
  15342. "PATCH", path, headers, nullptr, 0, nullptr,
  15343. get_multipart_content_provider(boundary, items, provider_items),
  15344. content_type, nullptr, progress);
  15345. }
  15346. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15347. const std::string &body,
  15348. const std::string &content_type,
  15349. ContentReceiver content_receiver,
  15350. DownloadProgress progress) {
  15351. Request req;
  15352. req.method = "PATCH";
  15353. req.path = path;
  15354. req.headers = headers;
  15355. req.body = body;
  15356. req.content_receiver =
  15357. [content_receiver](const char *data, size_t data_length,
  15358. size_t /*offset*/, size_t /*total_length*/) {
  15359. return content_receiver(data, data_length);
  15360. };
  15361. req.download_progress = std::move(progress);
  15362. if (max_timeout_msec_ > 0) {
  15363. req.start_time_ = std::chrono::steady_clock::now();
  15364. }
  15365. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15366. return send_(std::move(req));
  15367. }
  15368. inline Result ClientImpl::Delete(const std::string &path,
  15369. DownloadProgress progress) {
  15370. return Delete(path, Headers(), std::string(), std::string(), progress);
  15371. }
  15372. inline Result ClientImpl::Delete(const std::string &path,
  15373. const Headers &headers,
  15374. DownloadProgress progress) {
  15375. return Delete(path, headers, std::string(), std::string(), progress);
  15376. }
  15377. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15378. size_t content_length,
  15379. const std::string &content_type,
  15380. DownloadProgress progress) {
  15381. return Delete(path, Headers(), body, content_length, content_type, progress);
  15382. }
  15383. inline Result ClientImpl::Delete(const std::string &path,
  15384. const std::string &body,
  15385. const std::string &content_type,
  15386. DownloadProgress progress) {
  15387. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15388. progress);
  15389. }
  15390. inline Result ClientImpl::Delete(const std::string &path,
  15391. const Headers &headers,
  15392. const std::string &body,
  15393. const std::string &content_type,
  15394. DownloadProgress progress) {
  15395. return Delete(path, headers, body.data(), body.size(), content_type,
  15396. progress);
  15397. }
  15398. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15399. DownloadProgress progress) {
  15400. return Delete(path, Headers(), params, progress);
  15401. }
  15402. inline Result ClientImpl::Delete(const std::string &path,
  15403. const Headers &headers, const Params &params,
  15404. DownloadProgress progress) {
  15405. auto query = detail::params_to_query_str(params);
  15406. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15407. progress);
  15408. }
  15409. inline Result ClientImpl::Delete(const std::string &path,
  15410. const Headers &headers, const char *body,
  15411. size_t content_length,
  15412. const std::string &content_type,
  15413. DownloadProgress progress) {
  15414. Request req;
  15415. req.method = "DELETE";
  15416. req.headers = headers;
  15417. req.path = path;
  15418. req.download_progress = std::move(progress);
  15419. if (max_timeout_msec_ > 0) {
  15420. req.start_time_ = std::chrono::steady_clock::now();
  15421. }
  15422. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15423. req.body.assign(body, content_length);
  15424. return send_(std::move(req));
  15425. }
  15426. inline Result ClientImpl::Options(const std::string &path) {
  15427. return Options(path, Headers());
  15428. }
  15429. inline Result ClientImpl::Options(const std::string &path,
  15430. const Headers &headers) {
  15431. Request req;
  15432. req.method = "OPTIONS";
  15433. req.headers = headers;
  15434. req.path = path;
  15435. if (max_timeout_msec_ > 0) {
  15436. req.start_time_ = std::chrono::steady_clock::now();
  15437. }
  15438. return send_(std::move(req));
  15439. }
  15440. inline void ClientImpl::stop() {
  15441. std::lock_guard<std::mutex> guard(socket_mutex_);
  15442. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15443. // do is to shutdown_socket, so that threads using this socket suddenly
  15444. // discover they can't read/write any more and error out. Everything else
  15445. // (closing the socket, shutting ssl down) is unsafe because these actions
  15446. // are not thread-safe.
  15447. if (socket_requests_in_flight_ > 0) {
  15448. shutdown_socket(socket_);
  15449. // shutdown() does not wake a read waiting in WSAPoll on Windows, so the
  15450. // request's reads also give up once they see this flag.
  15451. stop_requested_ = true;
  15452. // Aside from that, we set a flag for the socket to be closed when we're
  15453. // done.
  15454. socket_should_be_closed_when_request_is_done_ = true;
  15455. return;
  15456. }
  15457. disconnect(/*gracefully=*/true);
  15458. }
  15459. inline std::string ClientImpl::host() const { return host_; }
  15460. inline int ClientImpl::port() const { return port_; }
  15461. inline size_t ClientImpl::is_socket_open() const {
  15462. std::lock_guard<std::mutex> guard(socket_mutex_);
  15463. return socket_.is_open();
  15464. }
  15465. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15466. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15467. connection_timeout_sec_ = sec;
  15468. connection_timeout_usec_ = usec;
  15469. }
  15470. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15471. read_timeout_sec_ = sec;
  15472. read_timeout_usec_ = usec;
  15473. }
  15474. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15475. write_timeout_sec_ = sec;
  15476. write_timeout_usec_ = usec;
  15477. }
  15478. inline void ClientImpl::set_max_timeout(time_t msec) {
  15479. max_timeout_msec_ = msec;
  15480. }
  15481. inline void ClientImpl::set_basic_auth(const std::string &username,
  15482. const std::string &password) {
  15483. basic_auth_username_ = username;
  15484. basic_auth_password_ = password;
  15485. }
  15486. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15487. bearer_token_auth_token_ = token;
  15488. }
  15489. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15490. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15491. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15492. inline void
  15493. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15494. set_direct_hostname_addr_map(std::move(addr_map));
  15495. }
  15496. inline void ClientImpl::set_direct_hostname_addr_map(
  15497. std::map<std::string, std::string> addr_map) {
  15498. addr_map_ = std::move(addr_map);
  15499. }
  15500. inline void ClientImpl::set_tunnel_hostname_addr_map(
  15501. std::map<std::string, std::string> addr_map) {
  15502. tunnel_addr_map_ = std::move(addr_map);
  15503. }
  15504. inline void ClientImpl::set_default_headers(Headers headers) {
  15505. default_headers_ = std::move(headers);
  15506. }
  15507. inline void ClientImpl::set_header_writer(
  15508. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15509. header_writer_ = writer;
  15510. }
  15511. inline void ClientImpl::set_address_family(int family) {
  15512. address_family_ = family;
  15513. }
  15514. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15515. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15516. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15517. socket_options_ = std::move(socket_options);
  15518. }
  15519. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15520. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15521. inline void ClientImpl::set_payload_max_length(size_t length) {
  15522. payload_max_length_ = length;
  15523. has_payload_max_length_ = true;
  15524. }
  15525. inline void ClientImpl::set_interface(const std::string &intf) {
  15526. interface_ = intf;
  15527. }
  15528. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15529. proxy_host_ = host;
  15530. proxy_port_ = port;
  15531. std::lock_guard<std::mutex> guard(socket_mutex_);
  15532. disconnect(/*gracefully=*/true);
  15533. }
  15534. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15535. const std::string &password) {
  15536. proxy_basic_auth_username_ = username;
  15537. proxy_basic_auth_password_ = password;
  15538. }
  15539. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15540. proxy_bearer_token_auth_token_ = token;
  15541. }
  15542. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15543. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15544. std::lock_guard<std::mutex> guard(socket_mutex_);
  15545. disconnect(/*gracefully=*/true);
  15546. }
  15547. #ifdef CPPHTTPLIB_SSL_ENABLED
  15548. inline void ClientImpl::set_digest_auth(const std::string &username,
  15549. const std::string &password) {
  15550. digest_auth_username_ = username;
  15551. digest_auth_password_ = password;
  15552. }
  15553. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15554. const std::string &ca_cert_dir_path) {
  15555. ca_cert_file_path_ = ca_cert_file_path;
  15556. ca_cert_dir_path_ = ca_cert_dir_path;
  15557. }
  15558. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15559. const std::string &password) {
  15560. proxy_digest_auth_username_ = username;
  15561. proxy_digest_auth_password_ = password;
  15562. }
  15563. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15564. if (server_certificate_verification_ == enabled) { return; }
  15565. server_certificate_verification_ = enabled;
  15566. tls_settings_changed();
  15567. }
  15568. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15569. if (server_hostname_verification_ == enabled) { return; }
  15570. server_hostname_verification_ = enabled;
  15571. tls_settings_changed();
  15572. }
  15573. inline void ClientImpl::enable_system_ca(bool enabled) {
  15574. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15575. }
  15576. #endif
  15577. inline void ClientImpl::set_logger(Logger logger) {
  15578. logger_ = std::move(logger);
  15579. }
  15580. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15581. error_logger_ = std::move(error_logger);
  15582. }
  15583. /*
  15584. * SSL/TLS Common Implementation
  15585. */
  15586. inline ClientConnection::~ClientConnection() {
  15587. #ifdef CPPHTTPLIB_SSL_ENABLED
  15588. if (session) {
  15589. tls::shutdown(session, true);
  15590. tls::free_session(session);
  15591. session = nullptr;
  15592. }
  15593. #endif
  15594. if (sock != INVALID_SOCKET) {
  15595. detail::close_socket(sock);
  15596. sock = INVALID_SOCKET;
  15597. }
  15598. }
  15599. // Universal client implementation
  15600. inline Client::Client(const std::string &scheme_host_port)
  15601. : Client(scheme_host_port, std::string(), std::string()) {}
  15602. inline Client::Client(const std::string &scheme_host_port,
  15603. const std::string &client_cert_path,
  15604. const std::string &client_key_path) {
  15605. detail::UrlComponents uc;
  15606. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15607. auto &scheme = uc.scheme;
  15608. #ifdef CPPHTTPLIB_SSL_ENABLED
  15609. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15610. #else
  15611. if (!scheme.empty() && scheme != "http") {
  15612. #endif
  15613. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15614. std::string msg = "'" + scheme + "' scheme is not supported.";
  15615. throw std::invalid_argument(msg);
  15616. #endif
  15617. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15618. return;
  15619. }
  15620. auto is_ssl = scheme == "https";
  15621. auto host = std::move(uc.host);
  15622. auto port = is_ssl ? 443 : 80;
  15623. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15624. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15625. return;
  15626. }
  15627. if (is_ssl) {
  15628. #ifdef CPPHTTPLIB_SSL_ENABLED
  15629. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15630. client_key_path);
  15631. is_ssl_ = is_ssl;
  15632. #endif
  15633. } else {
  15634. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15635. client_key_path);
  15636. }
  15637. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15638. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15639. // A URL, but not one this client can use, such as one with userinfo. A
  15640. // Unix socket path may have "//" further on.
  15641. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15642. } else {
  15643. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15644. // if port param below changes.
  15645. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15646. client_cert_path, client_key_path);
  15647. }
  15648. }
  15649. inline Client::Client(const std::string &host, int port)
  15650. : Client(host, port, std::string(), std::string()) {}
  15651. inline Client::Client(const std::string &host, int port,
  15652. const std::string &client_cert_path,
  15653. const std::string &client_key_path)
  15654. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15655. client_key_path)) {}
  15656. inline Client::~Client() = default;
  15657. inline bool Client::is_valid() const {
  15658. return cli_ != nullptr && cli_->is_valid();
  15659. }
  15660. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15661. return cli_->Get(path, std::move(progress));
  15662. }
  15663. inline Result Client::Get(const std::string &path, const Headers &headers,
  15664. DownloadProgress progress) {
  15665. return cli_->Get(path, headers, std::move(progress));
  15666. }
  15667. inline Result Client::Get(const std::string &path,
  15668. ContentReceiver content_receiver,
  15669. DownloadProgress progress) {
  15670. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15671. }
  15672. inline Result Client::Get(const std::string &path, const Headers &headers,
  15673. ContentReceiver content_receiver,
  15674. DownloadProgress progress) {
  15675. return cli_->Get(path, headers, std::move(content_receiver),
  15676. std::move(progress));
  15677. }
  15678. inline Result Client::Get(const std::string &path,
  15679. ResponseHandler response_handler,
  15680. ContentReceiver content_receiver,
  15681. DownloadProgress progress) {
  15682. return cli_->Get(path, std::move(response_handler),
  15683. std::move(content_receiver), std::move(progress));
  15684. }
  15685. inline Result Client::Get(const std::string &path, const Headers &headers,
  15686. ResponseHandler response_handler,
  15687. ContentReceiver content_receiver,
  15688. DownloadProgress progress) {
  15689. return cli_->Get(path, headers, std::move(response_handler),
  15690. std::move(content_receiver), std::move(progress));
  15691. }
  15692. inline Result Client::Get(const std::string &path, const Params &params,
  15693. DownloadProgress progress) {
  15694. return cli_->Get(path, params, std::move(progress));
  15695. }
  15696. inline Result Client::Get(const std::string &path, const Params &params,
  15697. const Headers &headers, DownloadProgress progress) {
  15698. return cli_->Get(path, params, headers, std::move(progress));
  15699. }
  15700. inline Result Client::Get(const std::string &path, const Params &params,
  15701. const Headers &headers,
  15702. ContentReceiver content_receiver,
  15703. DownloadProgress progress) {
  15704. return cli_->Get(path, params, headers, std::move(content_receiver),
  15705. std::move(progress));
  15706. }
  15707. inline Result Client::Get(const std::string &path, const Params &params,
  15708. const Headers &headers,
  15709. ResponseHandler response_handler,
  15710. ContentReceiver content_receiver,
  15711. DownloadProgress progress) {
  15712. return cli_->Get(path, params, headers, std::move(response_handler),
  15713. std::move(content_receiver), std::move(progress));
  15714. }
  15715. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15716. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15717. return cli_->Head(path, headers);
  15718. }
  15719. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15720. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15721. return cli_->Post(path, headers);
  15722. }
  15723. inline Result Client::Post(const std::string &path, const char *body,
  15724. size_t content_length,
  15725. const std::string &content_type,
  15726. UploadProgress progress) {
  15727. return cli_->Post(path, body, content_length, content_type, progress);
  15728. }
  15729. inline Result Client::Post(const std::string &path, const Headers &headers,
  15730. const char *body, size_t content_length,
  15731. const std::string &content_type,
  15732. UploadProgress progress) {
  15733. return cli_->Post(path, headers, body, content_length, content_type,
  15734. progress);
  15735. }
  15736. inline Result Client::Post(const std::string &path, const std::string &body,
  15737. const std::string &content_type,
  15738. UploadProgress progress) {
  15739. return cli_->Post(path, body, content_type, progress);
  15740. }
  15741. inline Result Client::Post(const std::string &path, const Headers &headers,
  15742. const std::string &body,
  15743. const std::string &content_type,
  15744. UploadProgress progress) {
  15745. return cli_->Post(path, headers, body, content_type, progress);
  15746. }
  15747. inline Result Client::Post(const std::string &path, size_t content_length,
  15748. ContentProvider content_provider,
  15749. const std::string &content_type,
  15750. UploadProgress progress) {
  15751. return cli_->Post(path, content_length, std::move(content_provider),
  15752. content_type, progress);
  15753. }
  15754. inline Result Client::Post(const std::string &path, size_t content_length,
  15755. ContentProvider content_provider,
  15756. const std::string &content_type,
  15757. ContentReceiver content_receiver,
  15758. UploadProgress progress) {
  15759. return cli_->Post(path, content_length, std::move(content_provider),
  15760. content_type, std::move(content_receiver), progress);
  15761. }
  15762. inline Result Client::Post(const std::string &path,
  15763. ContentProviderWithoutLength content_provider,
  15764. const std::string &content_type,
  15765. UploadProgress progress) {
  15766. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15767. }
  15768. inline Result Client::Post(const std::string &path,
  15769. ContentProviderWithoutLength content_provider,
  15770. const std::string &content_type,
  15771. ContentReceiver content_receiver,
  15772. UploadProgress progress) {
  15773. return cli_->Post(path, std::move(content_provider), content_type,
  15774. std::move(content_receiver), progress);
  15775. }
  15776. inline Result Client::Post(const std::string &path, const Headers &headers,
  15777. size_t content_length,
  15778. ContentProvider content_provider,
  15779. const std::string &content_type,
  15780. UploadProgress progress) {
  15781. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15782. content_type, progress);
  15783. }
  15784. inline Result Client::Post(const std::string &path, const Headers &headers,
  15785. size_t content_length,
  15786. ContentProvider content_provider,
  15787. const std::string &content_type,
  15788. ContentReceiver content_receiver,
  15789. DownloadProgress progress) {
  15790. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15791. content_type, std::move(content_receiver), progress);
  15792. }
  15793. inline Result Client::Post(const std::string &path, const Headers &headers,
  15794. ContentProviderWithoutLength content_provider,
  15795. const std::string &content_type,
  15796. UploadProgress progress) {
  15797. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15798. progress);
  15799. }
  15800. inline Result Client::Post(const std::string &path, const Headers &headers,
  15801. ContentProviderWithoutLength content_provider,
  15802. const std::string &content_type,
  15803. ContentReceiver content_receiver,
  15804. DownloadProgress progress) {
  15805. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15806. std::move(content_receiver), progress);
  15807. }
  15808. inline Result Client::Post(const std::string &path, const Params &params) {
  15809. return cli_->Post(path, params);
  15810. }
  15811. inline Result Client::Post(const std::string &path, const Headers &headers,
  15812. const Params &params) {
  15813. return cli_->Post(path, headers, params);
  15814. }
  15815. inline Result Client::Post(const std::string &path,
  15816. const UploadFormDataItems &items,
  15817. UploadProgress progress) {
  15818. return cli_->Post(path, items, progress);
  15819. }
  15820. inline Result Client::Post(const std::string &path, const Headers &headers,
  15821. const UploadFormDataItems &items,
  15822. UploadProgress progress) {
  15823. return cli_->Post(path, headers, items, progress);
  15824. }
  15825. inline Result Client::Post(const std::string &path, const Headers &headers,
  15826. const UploadFormDataItems &items,
  15827. const std::string &boundary,
  15828. UploadProgress progress) {
  15829. return cli_->Post(path, headers, items, boundary, progress);
  15830. }
  15831. inline Result Client::Post(const std::string &path, const Headers &headers,
  15832. const UploadFormDataItems &items,
  15833. const FormDataProviderItems &provider_items,
  15834. UploadProgress progress) {
  15835. return cli_->Post(path, headers, items, provider_items, progress);
  15836. }
  15837. inline Result Client::Post(const std::string &path, const Headers &headers,
  15838. const std::string &body,
  15839. const std::string &content_type,
  15840. ContentReceiver content_receiver,
  15841. DownloadProgress progress) {
  15842. return cli_->Post(path, headers, body, content_type,
  15843. std::move(content_receiver), progress);
  15844. }
  15845. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15846. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15847. return cli_->Put(path, headers);
  15848. }
  15849. inline Result Client::Put(const std::string &path, const char *body,
  15850. size_t content_length,
  15851. const std::string &content_type,
  15852. UploadProgress progress) {
  15853. return cli_->Put(path, body, content_length, content_type, progress);
  15854. }
  15855. inline Result Client::Put(const std::string &path, const Headers &headers,
  15856. const char *body, size_t content_length,
  15857. const std::string &content_type,
  15858. UploadProgress progress) {
  15859. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15860. }
  15861. inline Result Client::Put(const std::string &path, const std::string &body,
  15862. const std::string &content_type,
  15863. UploadProgress progress) {
  15864. return cli_->Put(path, body, content_type, progress);
  15865. }
  15866. inline Result Client::Put(const std::string &path, const Headers &headers,
  15867. const std::string &body,
  15868. const std::string &content_type,
  15869. UploadProgress progress) {
  15870. return cli_->Put(path, headers, body, content_type, progress);
  15871. }
  15872. inline Result Client::Put(const std::string &path, size_t content_length,
  15873. ContentProvider content_provider,
  15874. const std::string &content_type,
  15875. UploadProgress progress) {
  15876. return cli_->Put(path, content_length, std::move(content_provider),
  15877. content_type, progress);
  15878. }
  15879. inline Result Client::Put(const std::string &path, size_t content_length,
  15880. ContentProvider content_provider,
  15881. const std::string &content_type,
  15882. ContentReceiver content_receiver,
  15883. UploadProgress progress) {
  15884. return cli_->Put(path, content_length, std::move(content_provider),
  15885. content_type, std::move(content_receiver), progress);
  15886. }
  15887. inline Result Client::Put(const std::string &path,
  15888. ContentProviderWithoutLength content_provider,
  15889. const std::string &content_type,
  15890. UploadProgress progress) {
  15891. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15892. }
  15893. inline Result Client::Put(const std::string &path,
  15894. ContentProviderWithoutLength content_provider,
  15895. const std::string &content_type,
  15896. ContentReceiver content_receiver,
  15897. UploadProgress progress) {
  15898. return cli_->Put(path, std::move(content_provider), content_type,
  15899. std::move(content_receiver), progress);
  15900. }
  15901. inline Result Client::Put(const std::string &path, const Headers &headers,
  15902. size_t content_length,
  15903. ContentProvider content_provider,
  15904. const std::string &content_type,
  15905. UploadProgress progress) {
  15906. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15907. content_type, progress);
  15908. }
  15909. inline Result Client::Put(const std::string &path, const Headers &headers,
  15910. size_t content_length,
  15911. ContentProvider content_provider,
  15912. const std::string &content_type,
  15913. ContentReceiver content_receiver,
  15914. UploadProgress progress) {
  15915. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15916. content_type, std::move(content_receiver), progress);
  15917. }
  15918. inline Result Client::Put(const std::string &path, const Headers &headers,
  15919. ContentProviderWithoutLength content_provider,
  15920. const std::string &content_type,
  15921. UploadProgress progress) {
  15922. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15923. progress);
  15924. }
  15925. inline Result Client::Put(const std::string &path, const Headers &headers,
  15926. ContentProviderWithoutLength content_provider,
  15927. const std::string &content_type,
  15928. ContentReceiver content_receiver,
  15929. UploadProgress progress) {
  15930. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15931. std::move(content_receiver), progress);
  15932. }
  15933. inline Result Client::Put(const std::string &path, const Params &params) {
  15934. return cli_->Put(path, params);
  15935. }
  15936. inline Result Client::Put(const std::string &path, const Headers &headers,
  15937. const Params &params) {
  15938. return cli_->Put(path, headers, params);
  15939. }
  15940. inline Result Client::Put(const std::string &path,
  15941. const UploadFormDataItems &items,
  15942. UploadProgress progress) {
  15943. return cli_->Put(path, items, progress);
  15944. }
  15945. inline Result Client::Put(const std::string &path, const Headers &headers,
  15946. const UploadFormDataItems &items,
  15947. UploadProgress progress) {
  15948. return cli_->Put(path, headers, items, progress);
  15949. }
  15950. inline Result Client::Put(const std::string &path, const Headers &headers,
  15951. const UploadFormDataItems &items,
  15952. const std::string &boundary,
  15953. UploadProgress progress) {
  15954. return cli_->Put(path, headers, items, boundary, progress);
  15955. }
  15956. inline Result Client::Put(const std::string &path, const Headers &headers,
  15957. const UploadFormDataItems &items,
  15958. const FormDataProviderItems &provider_items,
  15959. UploadProgress progress) {
  15960. return cli_->Put(path, headers, items, provider_items, progress);
  15961. }
  15962. inline Result Client::Put(const std::string &path, const Headers &headers,
  15963. const std::string &body,
  15964. const std::string &content_type,
  15965. ContentReceiver content_receiver,
  15966. DownloadProgress progress) {
  15967. return cli_->Put(path, headers, body, content_type, content_receiver,
  15968. progress);
  15969. }
  15970. inline Result Client::Patch(const std::string &path) {
  15971. return cli_->Patch(path);
  15972. }
  15973. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15974. return cli_->Patch(path, headers);
  15975. }
  15976. inline Result Client::Patch(const std::string &path, const char *body,
  15977. size_t content_length,
  15978. const std::string &content_type,
  15979. UploadProgress progress) {
  15980. return cli_->Patch(path, body, content_length, content_type, progress);
  15981. }
  15982. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15983. const char *body, size_t content_length,
  15984. const std::string &content_type,
  15985. UploadProgress progress) {
  15986. return cli_->Patch(path, headers, body, content_length, content_type,
  15987. progress);
  15988. }
  15989. inline Result Client::Patch(const std::string &path, const std::string &body,
  15990. const std::string &content_type,
  15991. UploadProgress progress) {
  15992. return cli_->Patch(path, body, content_type, progress);
  15993. }
  15994. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15995. const std::string &body,
  15996. const std::string &content_type,
  15997. UploadProgress progress) {
  15998. return cli_->Patch(path, headers, body, content_type, progress);
  15999. }
  16000. inline Result Client::Patch(const std::string &path, size_t content_length,
  16001. ContentProvider content_provider,
  16002. const std::string &content_type,
  16003. UploadProgress progress) {
  16004. return cli_->Patch(path, content_length, std::move(content_provider),
  16005. content_type, progress);
  16006. }
  16007. inline Result Client::Patch(const std::string &path, size_t content_length,
  16008. ContentProvider content_provider,
  16009. const std::string &content_type,
  16010. ContentReceiver content_receiver,
  16011. UploadProgress progress) {
  16012. return cli_->Patch(path, content_length, std::move(content_provider),
  16013. content_type, std::move(content_receiver), progress);
  16014. }
  16015. inline Result Client::Patch(const std::string &path,
  16016. ContentProviderWithoutLength content_provider,
  16017. const std::string &content_type,
  16018. UploadProgress progress) {
  16019. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  16020. }
  16021. inline Result Client::Patch(const std::string &path,
  16022. ContentProviderWithoutLength content_provider,
  16023. const std::string &content_type,
  16024. ContentReceiver content_receiver,
  16025. UploadProgress progress) {
  16026. return cli_->Patch(path, std::move(content_provider), content_type,
  16027. std::move(content_receiver), progress);
  16028. }
  16029. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16030. size_t content_length,
  16031. ContentProvider content_provider,
  16032. const std::string &content_type,
  16033. UploadProgress progress) {
  16034. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16035. content_type, progress);
  16036. }
  16037. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16038. size_t content_length,
  16039. ContentProvider content_provider,
  16040. const std::string &content_type,
  16041. ContentReceiver content_receiver,
  16042. UploadProgress progress) {
  16043. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16044. content_type, std::move(content_receiver), progress);
  16045. }
  16046. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16047. ContentProviderWithoutLength content_provider,
  16048. const std::string &content_type,
  16049. UploadProgress progress) {
  16050. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16051. progress);
  16052. }
  16053. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16054. ContentProviderWithoutLength content_provider,
  16055. const std::string &content_type,
  16056. ContentReceiver content_receiver,
  16057. UploadProgress progress) {
  16058. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16059. std::move(content_receiver), progress);
  16060. }
  16061. inline Result Client::Patch(const std::string &path, const Params &params) {
  16062. return cli_->Patch(path, params);
  16063. }
  16064. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16065. const Params &params) {
  16066. return cli_->Patch(path, headers, params);
  16067. }
  16068. inline Result Client::Patch(const std::string &path,
  16069. const UploadFormDataItems &items,
  16070. UploadProgress progress) {
  16071. return cli_->Patch(path, items, progress);
  16072. }
  16073. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16074. const UploadFormDataItems &items,
  16075. UploadProgress progress) {
  16076. return cli_->Patch(path, headers, items, progress);
  16077. }
  16078. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16079. const UploadFormDataItems &items,
  16080. const std::string &boundary,
  16081. UploadProgress progress) {
  16082. return cli_->Patch(path, headers, items, boundary, progress);
  16083. }
  16084. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16085. const UploadFormDataItems &items,
  16086. const FormDataProviderItems &provider_items,
  16087. UploadProgress progress) {
  16088. return cli_->Patch(path, headers, items, provider_items, progress);
  16089. }
  16090. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16091. const std::string &body,
  16092. const std::string &content_type,
  16093. ContentReceiver content_receiver,
  16094. DownloadProgress progress) {
  16095. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16096. progress);
  16097. }
  16098. inline Result Client::Delete(const std::string &path,
  16099. DownloadProgress progress) {
  16100. return cli_->Delete(path, progress);
  16101. }
  16102. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16103. DownloadProgress progress) {
  16104. return cli_->Delete(path, headers, progress);
  16105. }
  16106. inline Result Client::Delete(const std::string &path, const char *body,
  16107. size_t content_length,
  16108. const std::string &content_type,
  16109. DownloadProgress progress) {
  16110. return cli_->Delete(path, body, content_length, content_type, progress);
  16111. }
  16112. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16113. const char *body, size_t content_length,
  16114. const std::string &content_type,
  16115. DownloadProgress progress) {
  16116. return cli_->Delete(path, headers, body, content_length, content_type,
  16117. progress);
  16118. }
  16119. inline Result Client::Delete(const std::string &path, const std::string &body,
  16120. const std::string &content_type,
  16121. DownloadProgress progress) {
  16122. return cli_->Delete(path, body, content_type, progress);
  16123. }
  16124. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16125. const std::string &body,
  16126. const std::string &content_type,
  16127. DownloadProgress progress) {
  16128. return cli_->Delete(path, headers, body, content_type, progress);
  16129. }
  16130. inline Result Client::Delete(const std::string &path, const Params &params,
  16131. DownloadProgress progress) {
  16132. return cli_->Delete(path, params, progress);
  16133. }
  16134. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16135. const Params &params, DownloadProgress progress) {
  16136. return cli_->Delete(path, headers, params, progress);
  16137. }
  16138. inline Result Client::Options(const std::string &path) {
  16139. return cli_->Options(path);
  16140. }
  16141. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16142. return cli_->Options(path, headers);
  16143. }
  16144. inline ClientImpl::StreamHandle
  16145. Client::open_stream(const std::string &method, const std::string &path,
  16146. const Params &params, const Headers &headers,
  16147. const std::string &body, const std::string &content_type) {
  16148. return cli_->open_stream(method, path, params, headers, body, content_type);
  16149. }
  16150. inline bool Client::send(Request &req, Response &res, Error &error) {
  16151. return cli_->send(req, res, error);
  16152. }
  16153. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16154. inline void Client::stop() { cli_->stop(); }
  16155. inline std::string Client::host() const { return cli_->host(); }
  16156. inline int Client::port() const { return cli_->port(); }
  16157. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16158. inline socket_t Client::socket() const { return cli_->socket(); }
  16159. inline void
  16160. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16161. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16162. }
  16163. inline void Client::set_direct_hostname_addr_map(
  16164. std::map<std::string, std::string> addr_map) {
  16165. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16166. }
  16167. inline void Client::set_tunnel_hostname_addr_map(
  16168. std::map<std::string, std::string> addr_map) {
  16169. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16170. }
  16171. inline void Client::set_default_headers(Headers headers) {
  16172. cli_->set_default_headers(std::move(headers));
  16173. }
  16174. inline void Client::set_header_writer(
  16175. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16176. cli_->set_header_writer(writer);
  16177. }
  16178. inline void Client::set_address_family(int family) {
  16179. cli_->set_address_family(family);
  16180. }
  16181. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16182. inline void Client::set_socket_options(SocketOptions socket_options) {
  16183. cli_->set_socket_options(std::move(socket_options));
  16184. }
  16185. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16186. cli_->set_connection_timeout(sec, usec);
  16187. }
  16188. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16189. cli_->set_read_timeout(sec, usec);
  16190. }
  16191. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16192. cli_->set_write_timeout(sec, usec);
  16193. }
  16194. inline void Client::set_basic_auth(const std::string &username,
  16195. const std::string &password) {
  16196. cli_->set_basic_auth(username, password);
  16197. }
  16198. inline void Client::set_bearer_token_auth(const std::string &token) {
  16199. cli_->set_bearer_token_auth(token);
  16200. }
  16201. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16202. inline void Client::set_follow_location(bool on) {
  16203. cli_->set_follow_location(on);
  16204. }
  16205. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16206. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16207. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16208. inline void Client::set_payload_max_length(size_t length) {
  16209. cli_->set_payload_max_length(length);
  16210. }
  16211. inline void Client::set_interface(const std::string &intf) {
  16212. cli_->set_interface(intf);
  16213. }
  16214. inline void Client::set_proxy(const std::string &host, int port) {
  16215. cli_->set_proxy(host, port);
  16216. }
  16217. inline void Client::set_proxy_basic_auth(const std::string &username,
  16218. const std::string &password) {
  16219. cli_->set_proxy_basic_auth(username, password);
  16220. }
  16221. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16222. cli_->set_proxy_bearer_token_auth(token);
  16223. }
  16224. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16225. cli_->set_no_proxy(patterns);
  16226. }
  16227. inline void Client::set_logger(Logger logger) {
  16228. cli_->set_logger(std::move(logger));
  16229. }
  16230. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16231. cli_->set_error_logger(std::move(error_logger));
  16232. }
  16233. /*
  16234. * Group 6: SSL Server and Client implementation
  16235. */
  16236. #ifdef CPPHTTPLIB_SSL_ENABLED
  16237. // SSL HTTP server implementation
  16238. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16239. const char *client_ca_cert_file_path,
  16240. const char *client_ca_cert_dir_path,
  16241. const char *private_key_password) {
  16242. using namespace tls;
  16243. ctx_ = create_server_context();
  16244. if (!ctx_) { return; }
  16245. // Load server certificate and private key
  16246. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16247. private_key_password)) {
  16248. last_ssl_error_ = static_cast<int>(get_error());
  16249. free_context(ctx_);
  16250. ctx_ = nullptr;
  16251. return;
  16252. }
  16253. // Load client CA certificates for client authentication
  16254. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16255. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16256. client_ca_cert_dir_path)) {
  16257. last_ssl_error_ = static_cast<int>(get_error());
  16258. free_context(ctx_);
  16259. ctx_ = nullptr;
  16260. return;
  16261. }
  16262. // Enable client certificate verification
  16263. set_verify_client(ctx_, true);
  16264. }
  16265. }
  16266. inline SSLServer::SSLServer(const PemMemory &pem) {
  16267. using namespace tls;
  16268. ctx_ = create_server_context();
  16269. if (ctx_) {
  16270. std::string cert_buf, key_buf;
  16271. if (!set_server_cert_pem(
  16272. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16273. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16274. pem.private_key_password)) {
  16275. last_ssl_error_ = static_cast<int>(get_error());
  16276. free_context(ctx_);
  16277. ctx_ = nullptr;
  16278. } else if (pem.client_ca_pem) {
  16279. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16280. : strlen(pem.client_ca_pem);
  16281. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16282. last_ssl_error_ = static_cast<int>(get_error());
  16283. free_context(ctx_);
  16284. ctx_ = nullptr;
  16285. } else {
  16286. set_verify_client(ctx_, true);
  16287. }
  16288. }
  16289. }
  16290. }
  16291. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16292. using namespace tls;
  16293. ctx_ = create_server_context();
  16294. if (ctx_) {
  16295. if (!setup_callback(ctx_)) {
  16296. free_context(ctx_);
  16297. ctx_ = nullptr;
  16298. }
  16299. }
  16300. }
  16301. inline SSLServer::~SSLServer() {
  16302. if (ctx_) { tls::free_context(ctx_); }
  16303. }
  16304. inline bool SSLServer::is_valid() const {
  16305. return ctx_ != nullptr && Server::is_valid();
  16306. }
  16307. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16308. using namespace tls;
  16309. session_t session = nullptr;
  16310. {
  16311. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16312. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16313. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16314. if (session) { handshakes_in_progress_++; }
  16315. }
  16316. if (!session) {
  16317. last_ssl_error_ = static_cast<int>(get_error());
  16318. detail::shutdown_socket(sock);
  16319. detail::close_socket(sock);
  16320. return false;
  16321. }
  16322. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16323. bool handshake_done = false;
  16324. bool ret = false;
  16325. bool websocket_upgraded = false;
  16326. auto cleanup = detail::scope_exit([&] {
  16327. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16328. free_session(session);
  16329. detail::shutdown_socket(sock);
  16330. detail::close_socket(sock);
  16331. });
  16332. // Perform TLS accept handshake with timeout
  16333. TlsError tls_err;
  16334. auto accepted = false;
  16335. {
  16336. auto handshake_left = detail::scope_exit([&] {
  16337. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16338. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16339. });
  16340. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16341. read_timeout_usec_, &tls_err);
  16342. }
  16343. if (!accepted) {
  16344. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16345. // Map TlsError to legacy ssl_error for backward compatibility
  16346. if (tls_err.code == ErrorCode::WantRead) {
  16347. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16348. } else if (tls_err.code == ErrorCode::WantWrite) {
  16349. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16350. } else {
  16351. last_ssl_error_ = SSL_ERROR_SSL;
  16352. }
  16353. #else
  16354. last_ssl_error_ = static_cast<int>(get_error());
  16355. #endif
  16356. return false;
  16357. }
  16358. handshake_done = true;
  16359. std::string remote_addr;
  16360. int remote_port = 0;
  16361. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16362. std::string local_addr;
  16363. int local_port = 0;
  16364. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16365. ret = serve_guarded([&]() {
  16366. return detail::process_server_socket_ssl(
  16367. svr_sock_, session, sock, keep_alive_max_count_,
  16368. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16369. write_timeout_sec_, write_timeout_usec_,
  16370. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16371. return process_request(
  16372. strm, remote_addr, remote_port, local_addr, local_port,
  16373. close_connection, connection_closed,
  16374. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16375. });
  16376. });
  16377. return ret;
  16378. }
  16379. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16380. const char *key_pem,
  16381. const char *client_ca_pem,
  16382. const char *password) {
  16383. if (!ctx_) { return false; }
  16384. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16385. updates_pending_++;
  16386. auto se = detail::scope_exit([&] {
  16387. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16388. });
  16389. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16390. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16391. return false;
  16392. }
  16393. if (client_ca_pem) {
  16394. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16395. // As in the constructors, a client CA makes client certificates required
  16396. tls::set_verify_client(ctx_, true);
  16397. }
  16398. return true;
  16399. }
  16400. // SSL HTTP client implementation
  16401. inline SSLClient::~SSLClient() {
  16402. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16403. // base function rather than the derived function once we get to the
  16404. // base class destructor, and won't free the SSL (causing a leak).
  16405. // This must happen before the context is freed below: some backends
  16406. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16407. // context, so freeing the context first leaves close_notify reading
  16408. // freed memory.
  16409. shutdown_ssl_impl(socket_, true);
  16410. if (ctx_) {
  16411. tls::free_context(ctx_);
  16412. ctx_ = nullptr;
  16413. }
  16414. }
  16415. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16416. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16417. shutdown_ssl_impl(socket, shutdown_gracefully);
  16418. }
  16419. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16420. bool shutdown_gracefully) {
  16421. if (socket.sock == INVALID_SOCKET) {
  16422. assert(socket.ssl == nullptr);
  16423. return;
  16424. }
  16425. if (socket.ssl) {
  16426. tls::shutdown(socket.ssl, shutdown_gracefully);
  16427. {
  16428. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16429. tls::free_session(socket.ssl);
  16430. }
  16431. socket.ssl = nullptr;
  16432. }
  16433. assert(socket.ssl == nullptr);
  16434. }
  16435. inline bool SSLClient::process_socket(
  16436. const Socket &socket,
  16437. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16438. std::function<bool(Stream &strm)> callback) {
  16439. assert(socket.ssl);
  16440. return detail::process_client_socket_ssl(
  16441. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16442. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16443. [&](detail::SSLSocketStream &strm) {
  16444. auto ret = callback(strm);
  16445. // A request that failed after the handshake reports Error::Read or
  16446. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16447. // from the server, for Result::ssl_error() and ssl_backend_error()
  16448. const auto &tls_error = strm.tls_error();
  16449. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16450. last_ssl_error_ = static_cast<int>(tls_error.code);
  16451. last_backend_error_ = tls_error.backend_code;
  16452. }
  16453. return ret;
  16454. });
  16455. }
  16456. inline bool SSLClient::is_ssl() const { return true; }
  16457. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16458. if (!is_valid()) {
  16459. error = Error::SSLConnection;
  16460. return false;
  16461. }
  16462. return ClientImpl::create_and_connect_socket(socket, error);
  16463. }
  16464. inline bool SSLClient::setup_proxy_connection(
  16465. Socket &socket,
  16466. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16467. Response &res, bool &success, Error &error) {
  16468. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16469. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16470. return false;
  16471. }
  16472. if (!initialize_ssl(socket, error)) {
  16473. success = false;
  16474. return false;
  16475. }
  16476. return true;
  16477. }
  16478. // Assumes that socket_mutex_ is locked and that there are no requests in
  16479. // flight
  16480. inline bool SSLClient::connect_with_proxy(
  16481. Socket &socket,
  16482. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16483. Response &res, bool &success, Error &error) {
  16484. success = true;
  16485. auto connect_target =
  16486. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  16487. auto retargeted = connect_target !=
  16488. detail::make_host_and_port_string_always_port(host_, port_);
  16489. Response proxy_res;
  16490. if (!detail::process_client_socket(
  16491. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16492. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16493. start_time, [&](Stream &strm) {
  16494. Request req2;
  16495. req2.method = "CONNECT";
  16496. req2.path = connect_target;
  16497. if (retargeted) { req2.set_header("Host", connect_target); }
  16498. if (max_timeout_msec_ > 0) {
  16499. req2.start_time_ = std::chrono::steady_clock::now();
  16500. }
  16501. return process_request(strm, req2, proxy_res, false, error);
  16502. })) {
  16503. // Thread-safe to close everything because we are assuming there are no
  16504. // requests in flight
  16505. shutdown_ssl(socket, true);
  16506. shutdown_socket(socket);
  16507. close_socket(socket);
  16508. success = false;
  16509. return false;
  16510. }
  16511. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16512. if (!proxy_digest_auth_username_.empty() &&
  16513. !proxy_digest_auth_password_.empty()) {
  16514. std::map<std::string, std::string> auth;
  16515. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16516. // Close the current socket and create a new one for the authenticated
  16517. // request
  16518. shutdown_ssl(socket, true);
  16519. shutdown_socket(socket);
  16520. close_socket(socket);
  16521. // Create a new socket for the authenticated CONNECT request
  16522. if (!ensure_socket_connection(socket, error)) {
  16523. success = false;
  16524. return false;
  16525. }
  16526. proxy_res = Response();
  16527. if (!detail::process_client_socket(
  16528. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16529. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16530. start_time, [&](Stream &strm) {
  16531. Request req3;
  16532. req3.method = "CONNECT";
  16533. req3.path = connect_target;
  16534. if (retargeted) { req3.set_header("Host", connect_target); }
  16535. req3.headers.insert(detail::make_digest_authentication_header(
  16536. req3, make_request_target(req3), auth, 1,
  16537. detail::random_string(10), proxy_digest_auth_username_,
  16538. proxy_digest_auth_password_, true));
  16539. if (max_timeout_msec_ > 0) {
  16540. req3.start_time_ = std::chrono::steady_clock::now();
  16541. }
  16542. return process_request(strm, req3, proxy_res, false, error);
  16543. })) {
  16544. // Thread-safe to close everything because we are assuming there are
  16545. // no requests in flight
  16546. shutdown_ssl(socket, true);
  16547. shutdown_socket(socket);
  16548. close_socket(socket);
  16549. success = false;
  16550. return false;
  16551. }
  16552. }
  16553. }
  16554. }
  16555. // If status code is not 200, proxy request is failed.
  16556. // Set error to ProxyConnection. A 407 is returned as the response of the
  16557. // request, so the caller sees the proxy asks for credentials; any other
  16558. // status would read as the answer of the origin, which it never reached.
  16559. if (proxy_res.status != StatusCode::OK_200) {
  16560. error = Error::ProxyConnection;
  16561. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16562. res = std::move(proxy_res);
  16563. } else {
  16564. success = false;
  16565. }
  16566. // Thread-safe to close everything because we are assuming there are
  16567. // no requests in flight
  16568. shutdown_ssl(socket, true);
  16569. shutdown_socket(socket);
  16570. close_socket(socket);
  16571. return false;
  16572. }
  16573. return true;
  16574. }
  16575. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16576. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16577. if (is_proxy_enabled_for_host(host_)) { return true; }
  16578. if (!initialize_ssl(socket, error)) {
  16579. shutdown_socket(socket);
  16580. close_socket(socket);
  16581. return false;
  16582. }
  16583. return true;
  16584. }
  16585. // SSL HTTP client implementation
  16586. inline SSLClient::SSLClient(const std::string &host)
  16587. : SSLClient(host, 443, std::string(), std::string()) {}
  16588. inline SSLClient::SSLClient(const std::string &host, int port)
  16589. : SSLClient(host, port, std::string(), std::string()) {}
  16590. inline void SSLClient::init_ctx() {
  16591. ctx_ = tls::create_client_context();
  16592. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16593. }
  16594. inline void SSLClient::reset_ctx_on_error() {
  16595. last_backend_error_ = tls::get_error();
  16596. tls::free_context(ctx_);
  16597. ctx_ = nullptr;
  16598. }
  16599. inline SSLClient::SSLClient(const std::string &host, int port,
  16600. const std::string &client_cert_path,
  16601. const std::string &client_key_path,
  16602. const std::string &private_key_password)
  16603. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16604. init_ctx();
  16605. if (!ctx_) { return; }
  16606. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16607. const char *password =
  16608. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16609. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16610. client_key_path.c_str(), password)) {
  16611. reset_ctx_on_error();
  16612. }
  16613. }
  16614. }
  16615. inline SSLClient::SSLClient(const std::string &host, int port,
  16616. const PemMemory &pem)
  16617. : ClientImpl(host, port) {
  16618. init_ctx();
  16619. if (!ctx_) { return; }
  16620. if (pem.cert_pem && pem.key_pem) {
  16621. std::string cert_buf, key_buf;
  16622. if (!tls::set_client_cert_pem(
  16623. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16624. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16625. pem.private_key_password)) {
  16626. reset_ctx_on_error();
  16627. }
  16628. }
  16629. }
  16630. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16631. if (ca_cert_store && ctx_) {
  16632. // set_ca_store takes ownership of ca_cert_store
  16633. tls::set_ca_store(ctx_, ca_cert_store);
  16634. ca_cert_store_set_ = true;
  16635. } else if (ca_cert_store) {
  16636. tls::free_ca_store(ca_cert_store);
  16637. }
  16638. custom_ca_loaded_ = true;
  16639. tls_settings_changed();
  16640. }
  16641. inline void
  16642. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16643. if (!ctx_) { return; }
  16644. server_certificate_verifier_ = verifier;
  16645. {
  16646. // Under the lock that creating a session from ctx_ takes
  16647. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16648. tls::set_verify_callback(ctx_, std::move(verifier));
  16649. }
  16650. tls_settings_changed();
  16651. }
  16652. inline void SSLClient::set_session_verifier(
  16653. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16654. session_verifier_ = std::move(verifier);
  16655. tls_settings_changed();
  16656. }
  16657. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16658. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16659. if (enable_windows_cert_verification_ == enabled) { return; }
  16660. enable_windows_cert_verification_ = enabled;
  16661. tls_settings_changed();
  16662. }
  16663. #endif
  16664. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16665. std::size_t size) {
  16666. if (ctx_ && ca_cert && size > 0) {
  16667. // Every PEM loaded, for redirect transfer
  16668. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16669. ca_cert_pem_ += '\n';
  16670. }
  16671. ca_cert_pem_.append(ca_cert, size);
  16672. tls::load_ca_pem(ctx_, ca_cert, size);
  16673. }
  16674. custom_ca_loaded_ = true;
  16675. tls_settings_changed();
  16676. }
  16677. inline bool SSLClient::load_certs() {
  16678. auto ret = true;
  16679. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16680. // one client is shared across concurrent requests here.
  16681. std::call_once(initialize_cert_, [&]() {
  16682. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16683. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16684. ca_cert_dir_path_, custom_ca_loaded_,
  16685. system_ca_mode_, last_backend_error_);
  16686. });
  16687. return ret;
  16688. }
  16689. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16690. // Load CA certificates if server verification is enabled
  16691. if (server_certificate_verification_) {
  16692. if (!load_certs()) {
  16693. error = Error::SSLLoadingCerts;
  16694. return false;
  16695. }
  16696. }
  16697. detail::ClientTlsSessionOptions options;
  16698. options.server_hostname_verification = server_hostname_verification_;
  16699. options.session_verifier = session_verifier_;
  16700. options.ctx_mutex = &ctx_mutex_;
  16701. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16702. // Skip Schannel when a custom CA cert is specified, as the Windows
  16703. // certificate store would not know about user-provided CA certificates.
  16704. // Also skip when system CA trust is explicitly disabled.
  16705. options.windows_cert_verification =
  16706. enable_windows_cert_verification_ &&
  16707. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16708. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16709. // Only a verifier set through set_server_certificate_verifier() is seen
  16710. // here, not one installed with tls::set_verify_callback() directly.
  16711. options.server_certificate_verifier_set =
  16712. static_cast<bool>(server_certificate_verifier_);
  16713. #endif
  16714. tls::session_t session = nullptr;
  16715. // Use scope_exit to ensure session is freed on error paths
  16716. bool success = false;
  16717. auto session_guard = detail::scope_exit([&] {
  16718. if (!success) { tls::free_session(session); }
  16719. });
  16720. detail::ClientTlsSessionError tls_error;
  16721. if (!detail::setup_client_tls_session(
  16722. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16723. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16724. options)) {
  16725. error = tls_error.error;
  16726. last_ssl_error_ = tls_error.ssl_error;
  16727. last_backend_error_ = tls_error.backend_error;
  16728. return false;
  16729. }
  16730. success = true;
  16731. socket.ssl = session;
  16732. return true;
  16733. }
  16734. inline void Client::set_digest_auth(const std::string &username,
  16735. const std::string &password) {
  16736. cli_->set_digest_auth(username, password);
  16737. }
  16738. inline void Client::set_proxy_digest_auth(const std::string &username,
  16739. const std::string &password) {
  16740. cli_->set_proxy_digest_auth(username, password);
  16741. }
  16742. inline void Client::enable_server_certificate_verification(bool enabled) {
  16743. cli_->enable_server_certificate_verification(enabled);
  16744. }
  16745. inline void Client::enable_server_hostname_verification(bool enabled) {
  16746. cli_->enable_server_hostname_verification(enabled);
  16747. }
  16748. inline void Client::enable_system_ca(bool enabled) {
  16749. cli_->enable_system_ca(enabled);
  16750. }
  16751. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16752. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16753. if (is_ssl_) {
  16754. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16755. enabled);
  16756. }
  16757. }
  16758. #endif
  16759. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16760. const std::string &ca_cert_dir_path) {
  16761. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16762. }
  16763. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16764. if (is_ssl_) {
  16765. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16766. } else if (ca_cert_store) {
  16767. tls::free_ca_store(ca_cert_store);
  16768. }
  16769. }
  16770. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16771. if (is_ssl_) {
  16772. // Use the PEM-based path so the CA data is retained for redirect transfer
  16773. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16774. }
  16775. }
  16776. inline void
  16777. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16778. if (is_ssl_) {
  16779. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16780. std::move(verifier));
  16781. }
  16782. }
  16783. inline void Client::set_session_verifier(
  16784. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16785. if (is_ssl_) {
  16786. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16787. }
  16788. }
  16789. inline tls::ctx_t Client::tls_context() const {
  16790. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16791. return nullptr;
  16792. }
  16793. #endif // CPPHTTPLIB_SSL_ENABLED
  16794. /*
  16795. * Group 7: TLS abstraction layer - Common API
  16796. */
  16797. #ifdef CPPHTTPLIB_SSL_ENABLED
  16798. namespace tls {
  16799. // Helper for PeerCert construction
  16800. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16801. return PeerCert(get_peer_cert(session));
  16802. }
  16803. namespace impl {
  16804. // set_verify_callback() can replace a callback while handshakes on other
  16805. // threads run it, so they share it, and take their reference under this lock.
  16806. inline std::mutex &verify_callback_mutex() {
  16807. static std::mutex mutex;
  16808. return mutex;
  16809. }
  16810. // The TLS libraries are C, so an exception from a verify callback must not
  16811. // unwind through them. It rejects the certificate instead.
  16812. inline bool run_verify_callback(const VerifyCallback &callback,
  16813. const VerifyContext &ctx) {
  16814. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16815. return callback(ctx);
  16816. #else
  16817. try {
  16818. return callback(ctx);
  16819. } catch (...) { return false; }
  16820. #endif
  16821. }
  16822. // Check if a string is an IPv4 address
  16823. inline bool is_ipv4_address(const std::string &str) {
  16824. int dots = 0;
  16825. for (char c : str) {
  16826. if (c == '.') {
  16827. dots++;
  16828. } else if (!detail::is_ascii_digit(c)) {
  16829. return false;
  16830. }
  16831. }
  16832. return dots == 3;
  16833. }
  16834. // Parse IPv4 address string to bytes
  16835. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16836. const char *p = str.c_str();
  16837. for (int i = 0; i < 4; i++) {
  16838. if (i > 0) {
  16839. if (*p != '.') { return false; }
  16840. p++;
  16841. }
  16842. int val = 0;
  16843. int digits = 0;
  16844. while (detail::is_ascii_digit(*p)) {
  16845. val = val * 10 + (*p - '0');
  16846. if (val > 255) { return false; }
  16847. p++;
  16848. digits++;
  16849. }
  16850. if (digits == 0) { return false; }
  16851. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16852. if (digits > 1 && *(p - digits) == '0') { return false; }
  16853. out[i] = static_cast<unsigned char>(val);
  16854. }
  16855. return *p == '\0';
  16856. }
  16857. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16858. // `out` must have room for at least 16 bytes. Returns the address length
  16859. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16860. // literal. Used to match a host against iPAddress SANs the same way the
  16861. // OpenSSL backend does via X509_check_ip.
  16862. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16863. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16864. struct in6_addr addr6 = {};
  16865. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16866. memcpy(out, &addr6, 16);
  16867. return 16;
  16868. }
  16869. return 0;
  16870. }
  16871. #ifdef _WIN32
  16872. // Enumerate Windows system certificates and call callback with DER data
  16873. template <typename Callback>
  16874. inline bool enumerate_windows_system_certs(Callback cb) {
  16875. bool loaded = false;
  16876. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16877. for (auto store_name : store_names) {
  16878. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16879. if (hStore) {
  16880. PCCERT_CONTEXT pContext = nullptr;
  16881. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16882. nullptr) {
  16883. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16884. loaded = true;
  16885. }
  16886. }
  16887. CertCloseStore(hStore, 0);
  16888. }
  16889. }
  16890. return loaded;
  16891. }
  16892. #endif
  16893. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16894. // The trust a certificate's Trust Settings give it for SSL server
  16895. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  16896. // Otherwise the first usage-constraints dictionary that applies decides: one
  16897. // naming a policy other than SSL, a host name or an application does not
  16898. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  16899. // Trust" as kSecTrustSettingsResultDeny.
  16900. inline SecTrustSettingsResult
  16901. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  16902. auto count = CFArrayGetCount(trust_settings);
  16903. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  16904. for (CFIndex i = 0; i < count; i++) {
  16905. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  16906. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  16907. auto constraint = static_cast<CFDictionaryRef>(value);
  16908. auto policy_value =
  16909. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  16910. if (policy_value) {
  16911. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  16912. auto is_ssl = false;
  16913. if (auto properties = SecPolicyCopyProperties(policy)) {
  16914. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  16915. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  16916. CFRelease(properties);
  16917. }
  16918. if (!is_ssl) { continue; }
  16919. }
  16920. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  16921. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  16922. continue;
  16923. }
  16924. auto result = kSecTrustSettingsResultTrustRoot;
  16925. auto number = static_cast<CFNumberRef>(
  16926. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  16927. if (number) {
  16928. SInt32 number_value = 0;
  16929. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  16930. continue;
  16931. }
  16932. result = static_cast<SecTrustSettingsResult>(number_value);
  16933. }
  16934. if (result == kSecTrustSettingsResultTrustRoot ||
  16935. result == kSecTrustSettingsResultTrustAsRoot ||
  16936. result == kSecTrustSettingsResultDeny) {
  16937. return result;
  16938. }
  16939. }
  16940. return kSecTrustSettingsResultUnspecified;
  16941. }
  16942. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  16943. // with DER data. A certificate with Trust Settings is not trusted just by
  16944. // having them: the settings say whether it is, and a per-user setting
  16945. // overrides the admin domain's, which overrides the system domain's (whose
  16946. // roots are all trusted). So a system root the user set to "Never Trust" is
  16947. // left out, as is one trusted only for S/MIME or code signing.
  16948. template <typename Callback>
  16949. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16950. const SecTrustSettingsDomain domains[] = {
  16951. kSecTrustSettingsDomainUser,
  16952. kSecTrustSettingsDomainAdmin,
  16953. kSecTrustSettingsDomainSystem,
  16954. };
  16955. std::set<std::string> decided;
  16956. std::vector<std::string> trusted;
  16957. for (auto domain : domains) {
  16958. CFArrayRef certs = nullptr;
  16959. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16960. if (status != errSecSuccess || !certs) {
  16961. if (certs) CFRelease(certs);
  16962. continue;
  16963. }
  16964. CFIndex count = CFArrayGetCount(certs);
  16965. for (CFIndex i = 0; i < count; i++) {
  16966. SecCertificateRef cert =
  16967. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16968. CFDataRef data = SecCertificateCopyData(cert);
  16969. if (!data) { continue; }
  16970. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  16971. static_cast<size_t>(CFDataGetLength(data)));
  16972. CFRelease(data);
  16973. // Decided by a domain that overrides this one
  16974. if (decided.find(der) != decided.end()) { continue; }
  16975. auto result = kSecTrustSettingsResultTrustRoot;
  16976. if (domain != kSecTrustSettingsDomainSystem) {
  16977. result = kSecTrustSettingsResultUnspecified;
  16978. CFArrayRef trust_settings = nullptr;
  16979. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  16980. errSecSuccess &&
  16981. trust_settings) {
  16982. result = macos_ssl_trust_settings_result(trust_settings);
  16983. }
  16984. if (trust_settings) CFRelease(trust_settings);
  16985. }
  16986. // Neither trusted nor distrusted here; a domain below may decide
  16987. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  16988. decided.insert(der);
  16989. if (result == kSecTrustSettingsResultTrustRoot ||
  16990. result == kSecTrustSettingsResultTrustAsRoot) {
  16991. trusted.push_back(std::move(der));
  16992. }
  16993. }
  16994. CFRelease(certs);
  16995. }
  16996. bool loaded = false;
  16997. for (const auto &der : trusted) {
  16998. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  16999. loaded = true;
  17000. }
  17001. }
  17002. return loaded;
  17003. }
  17004. #endif
  17005. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  17006. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  17007. // Common CA certificate file paths on Linux/Unix
  17008. inline const char **system_ca_paths() {
  17009. static const char *paths[] = {
  17010. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  17011. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  17012. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  17013. "/etc/pki/tls/cacert.pem", // OpenELEC
  17014. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  17015. nullptr};
  17016. return paths;
  17017. }
  17018. // Common CA certificate directory paths on Linux/Unix
  17019. inline const char **system_ca_dirs() {
  17020. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  17021. "/etc/pki/tls/certs", // RHEL/CentOS
  17022. "/usr/share/ca-certificates", // Other
  17023. nullptr};
  17024. return dirs;
  17025. }
  17026. #endif
  17027. } // namespace impl
  17028. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  17029. const char *ca_dir) {
  17030. if (!ctx) { return false; }
  17031. bool success = true;
  17032. if (ca_file && *ca_file) {
  17033. if (!load_ca_file(ctx, ca_file)) { success = false; }
  17034. }
  17035. if (ca_dir && *ca_dir) {
  17036. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  17037. }
  17038. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17039. // Set CA list for client certificate request (CertificateRequest message)
  17040. if (ca_file && *ca_file) {
  17041. auto list = SSL_load_client_CA_file(ca_file);
  17042. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  17043. }
  17044. #endif
  17045. return success;
  17046. }
  17047. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17048. const char *password) {
  17049. return set_client_cert_pem(ctx, cert, key, password);
  17050. }
  17051. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17052. const char *key_path, const char *password) {
  17053. return set_client_cert_file(ctx, cert_path, key_path, password);
  17054. }
  17055. // PeerCert implementation
  17056. inline PeerCert::PeerCert() = default;
  17057. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17058. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17059. other.cert_ = nullptr;
  17060. }
  17061. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17062. if (this != &other) {
  17063. if (cert_) { free_cert(cert_); }
  17064. cert_ = other.cert_;
  17065. other.cert_ = nullptr;
  17066. }
  17067. return *this;
  17068. }
  17069. inline PeerCert::~PeerCert() {
  17070. if (cert_) { free_cert(cert_); }
  17071. }
  17072. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17073. inline std::string PeerCert::subject_cn() const {
  17074. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17075. }
  17076. inline std::string PeerCert::issuer_name() const {
  17077. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17078. }
  17079. inline bool PeerCert::check_hostname(const char *hostname) const {
  17080. return cert_ ? verify_hostname(cert_, hostname) : false;
  17081. }
  17082. inline std::vector<SanEntry> PeerCert::sans() const {
  17083. std::vector<SanEntry> result;
  17084. if (cert_) { get_cert_sans(cert_, result); }
  17085. return result;
  17086. }
  17087. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17088. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17089. }
  17090. inline std::string PeerCert::serial() const {
  17091. return cert_ ? get_cert_serial(cert_) : std::string();
  17092. }
  17093. // VerifyContext method implementations
  17094. inline std::string VerifyContext::subject_cn() const {
  17095. return cert ? get_cert_subject_cn(cert) : std::string();
  17096. }
  17097. inline std::string VerifyContext::issuer_name() const {
  17098. return cert ? get_cert_issuer_name(cert) : std::string();
  17099. }
  17100. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17101. return cert ? verify_hostname(cert, hostname) : false;
  17102. }
  17103. inline std::vector<SanEntry> VerifyContext::sans() const {
  17104. std::vector<SanEntry> result;
  17105. if (cert) { get_cert_sans(cert, result); }
  17106. return result;
  17107. }
  17108. inline bool VerifyContext::validity(time_t &not_before,
  17109. time_t &not_after) const {
  17110. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17111. }
  17112. inline std::string VerifyContext::serial() const {
  17113. return cert ? get_cert_serial(cert) : std::string();
  17114. }
  17115. // TlsError static method implementation
  17116. inline std::string TlsError::verify_error_to_string(long error_code) {
  17117. return verify_error_string(error_code);
  17118. }
  17119. } // namespace tls
  17120. // Request::peer_cert() implementation
  17121. inline tls::PeerCert Request::peer_cert() const {
  17122. return tls::get_peer_cert_from_session(ssl);
  17123. }
  17124. // Request::sni() implementation
  17125. inline std::string Request::sni() const {
  17126. if (!ssl) { return std::string(); }
  17127. const char *s = tls::get_sni(ssl);
  17128. return s ? std::string(s) : std::string();
  17129. }
  17130. #endif // CPPHTTPLIB_SSL_ENABLED
  17131. /*
  17132. * Group 8: TLS abstraction layer - OpenSSL backend
  17133. */
  17134. /*
  17135. * OpenSSL Backend Implementation
  17136. */
  17137. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17138. namespace tls {
  17139. namespace impl {
  17140. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17141. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17142. switch (ssl_error) {
  17143. case SSL_ERROR_NONE: return ErrorCode::Success;
  17144. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17145. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17146. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17147. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17148. case SSL_ERROR_SSL:
  17149. default: return ErrorCode::Fatal;
  17150. }
  17151. }
  17152. // Fills in a failed SSL_connect(). One that the server certificate's
  17153. // verification stopped reports the verify result, as the other backends and
  17154. // a check after the handshake do.
  17155. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17156. auto ssl_err = SSL_get_error(ssl, ret);
  17157. auto error = ERR_get_error();
  17158. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17159. err.backend_code = error;
  17160. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17161. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17162. return;
  17163. }
  17164. // A certificate only a verify callback turned down carries no verdict of
  17165. // its own, and fails as any other handshake does
  17166. auto verify_result = SSL_get_verify_result(ssl);
  17167. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17168. return;
  17169. }
  17170. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17171. ? ErrorCode::HostnameMismatch
  17172. : ErrorCode::CertVerifyFailed;
  17173. err.backend_code = static_cast<uint64_t>(verify_result);
  17174. }
  17175. // Helper: Create client CA list from PEM string
  17176. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17177. // Caller takes ownership of returned list
  17178. inline STACK_OF(X509_NAME) *
  17179. create_client_ca_list_from_pem(const char *ca_pem) {
  17180. if (!ca_pem) { return nullptr; }
  17181. auto ca_list = sk_X509_NAME_new_null();
  17182. if (!ca_list) { return nullptr; }
  17183. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17184. if (!bio) {
  17185. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17186. return nullptr;
  17187. }
  17188. X509 *cert = nullptr;
  17189. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17190. nullptr) {
  17191. const X509_NAME *name = X509_get_subject_name(cert);
  17192. if (name) {
  17193. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17194. }
  17195. X509_free(cert);
  17196. }
  17197. BIO_free(bio);
  17198. return ca_list;
  17199. }
  17200. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17201. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17202. long /*argl*/, void * /*argp*/) {
  17203. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17204. }
  17205. // The SSL_CTX owns its verify callback, so each client or server sees only
  17206. // its own, on whichever thread runs the handshake.
  17207. inline int verify_callback_index() {
  17208. static const auto index = SSL_CTX_get_ex_new_index(
  17209. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17210. return index;
  17211. }
  17212. // OpenSSL verify callback wrapper
  17213. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17214. // Get SSL object from X509_STORE_CTX
  17215. auto ssl = static_cast<SSL *>(
  17216. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17217. if (!ssl) { return preverify_ok; }
  17218. std::shared_ptr<VerifyCallback> callback;
  17219. {
  17220. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17221. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17222. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17223. if (stored) { callback = *stored; }
  17224. }
  17225. if (!callback) { return preverify_ok; }
  17226. // Get current certificate and depth
  17227. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17228. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17229. int error = X509_STORE_CTX_get_error(ctx);
  17230. // Build context
  17231. VerifyContext verify_ctx;
  17232. verify_ctx.session = static_cast<session_t>(ssl);
  17233. verify_ctx.cert = static_cast<cert_t>(cert);
  17234. verify_ctx.depth = depth;
  17235. verify_ctx.preverify_ok = (preverify_ok != 0);
  17236. verify_ctx.error_code = error;
  17237. verify_ctx.error_string =
  17238. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17239. auto accepted = run_verify_callback(*callback, verify_ctx);
  17240. // A client verifying the server during the handshake, which is what
  17241. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17242. if (!SSL_is_server(ssl) &&
  17243. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17244. accepted = accepted && preverify_ok;
  17245. }
  17246. return accepted ? 1 : 0;
  17247. }
  17248. // Sets the verify mode from whether the peer's certificate is required and
  17249. // whether a verify callback is set.
  17250. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17251. auto has_callback =
  17252. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17253. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17254. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17255. SSL_CTX_set_verify(ssl_ctx, mode,
  17256. has_callback ? openssl_verify_callback : nullptr);
  17257. }
  17258. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17259. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17260. // that must be released with release_store_objects
  17261. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17262. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17263. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17264. #endif
  17265. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17266. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17267. return X509_STORE_get1_objects(store);
  17268. #else
  17269. return X509_STORE_get0_objects(store);
  17270. #endif
  17271. }
  17272. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17273. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17274. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17275. #else
  17276. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17277. #endif
  17278. }
  17279. } // namespace impl
  17280. inline ctx_t create_client_context() {
  17281. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17282. if (ctx) {
  17283. // Disable auto-retry to properly handle non-blocking I/O
  17284. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17285. // Set minimum TLS version
  17286. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17287. }
  17288. return static_cast<ctx_t>(ctx);
  17289. }
  17290. inline void free_context(ctx_t ctx) {
  17291. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17292. }
  17293. inline bool set_min_version(ctx_t ctx, Version version) {
  17294. if (!ctx) return false;
  17295. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17296. static_cast<uint16_t>(version)) == 1;
  17297. }
  17298. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17299. if (!ctx || !pem || len == 0) return false;
  17300. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17301. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17302. if (!store) return false;
  17303. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17304. if (!bio) return false;
  17305. bool ok = true;
  17306. X509 *cert = nullptr;
  17307. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17308. nullptr) {
  17309. if (X509_STORE_add_cert(store, cert) != 1) {
  17310. // Ignore duplicate errors
  17311. auto err = ERR_peek_last_error();
  17312. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17313. ok = false;
  17314. }
  17315. }
  17316. X509_free(cert);
  17317. if (!ok) break;
  17318. }
  17319. BIO_free(bio);
  17320. // Clear any "no more certificates" errors
  17321. ERR_clear_error();
  17322. return ok;
  17323. }
  17324. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17325. if (!ctx || !file_path) return false;
  17326. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17327. nullptr) == 1;
  17328. }
  17329. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17330. if (!ctx || !dir_path) return false;
  17331. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17332. dir_path) == 1;
  17333. }
  17334. inline bool load_system_certs(ctx_t ctx) {
  17335. if (!ctx) return false;
  17336. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17337. #ifdef _WIN32
  17338. // Windows: Load from system certificate store (ROOT and CA)
  17339. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17340. if (!store) return false;
  17341. bool loaded_any = false;
  17342. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17343. for (auto store_name : store_names) {
  17344. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17345. if (!hStore) continue;
  17346. PCCERT_CONTEXT pContext = nullptr;
  17347. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17348. nullptr) {
  17349. const unsigned char *data = pContext->pbCertEncoded;
  17350. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17351. if (x509) {
  17352. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17353. X509_free(x509);
  17354. }
  17355. }
  17356. CertCloseStore(hStore, 0);
  17357. }
  17358. return loaded_any;
  17359. #elif defined(__APPLE__)
  17360. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17361. // macOS: Load from Keychain
  17362. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17363. if (!store) return false;
  17364. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17365. [&](const unsigned char *data, size_t len) {
  17366. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17367. if (!x509) { return false; }
  17368. auto added = X509_STORE_add_cert(store, x509) == 1;
  17369. X509_free(x509);
  17370. return added;
  17371. });
  17372. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17373. #else
  17374. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17375. #endif
  17376. #else
  17377. // Other Unix: use default verify paths
  17378. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17379. #endif
  17380. }
  17381. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17382. const char *password) {
  17383. if (!ctx || !cert || !key) return false;
  17384. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17385. // Load certificate
  17386. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17387. if (!cert_bio) return false;
  17388. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17389. BIO_free(cert_bio);
  17390. if (!x509) return false;
  17391. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17392. X509_free(x509);
  17393. if (!cert_ok) return false;
  17394. // Load private key
  17395. auto key_bio = BIO_new_mem_buf(key, -1);
  17396. if (!key_bio) return false;
  17397. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17398. password ? const_cast<char *>(password)
  17399. : nullptr);
  17400. BIO_free(key_bio);
  17401. if (!pkey) return false;
  17402. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17403. EVP_PKEY_free(pkey);
  17404. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17405. }
  17406. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17407. const char *key_path, const char *password) {
  17408. if (!ctx || !cert_path || !key_path) return false;
  17409. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17410. if (password && password[0] != '\0') {
  17411. SSL_CTX_set_default_passwd_cb_userdata(
  17412. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17413. }
  17414. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17415. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17416. }
  17417. inline ctx_t create_server_context() {
  17418. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17419. if (ctx) {
  17420. // No renegotiation, as on the other backends: it would run a handshake
  17421. // that SSLServer::update_certs_pem() does not wait for
  17422. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17423. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17424. SSL_OP_NO_RENEGOTIATION);
  17425. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17426. // Without one, a client resuming its session is sent a fatal alert once
  17427. // client certificates are verified.
  17428. static const unsigned char sid_ctx[] = "cpp-httplib";
  17429. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17430. }
  17431. return static_cast<ctx_t>(ctx);
  17432. }
  17433. inline void set_verify_client(ctx_t ctx, bool require) {
  17434. if (!ctx) return;
  17435. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17436. }
  17437. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17438. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17439. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17440. SSL *ssl = SSL_new(ssl_ctx);
  17441. if (!ssl) return nullptr;
  17442. // Disable auto-retry for proper non-blocking I/O handling
  17443. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17444. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17445. if (!bio) {
  17446. SSL_free(ssl);
  17447. return nullptr;
  17448. }
  17449. SSL_set_bio(ssl, bio, bio);
  17450. return static_cast<session_t>(ssl);
  17451. }
  17452. inline void free_session(session_t session) {
  17453. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17454. }
  17455. inline bool set_sni(session_t session, const char *hostname,
  17456. bool verify_hostname) {
  17457. if (!session || !hostname) return false;
  17458. auto ssl = static_cast<SSL *>(session);
  17459. // The handshake's chain verification then checks the name as well
  17460. if (verify_hostname) {
  17461. auto param = SSL_get0_param(ssl);
  17462. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  17463. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  17464. return false;
  17465. }
  17466. }
  17467. #if defined(OPENSSL_IS_BORINGSSL)
  17468. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17469. #else
  17470. // Direct call instead of macro to suppress -Wold-style-cast warning
  17471. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17472. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17473. #endif
  17474. }
  17475. inline TlsError connect(session_t session) {
  17476. if (!session) { return TlsError(); }
  17477. auto ssl = static_cast<SSL *>(session);
  17478. auto ret = SSL_connect(ssl);
  17479. TlsError err;
  17480. if (ret == 1) {
  17481. err.code = ErrorCode::Success;
  17482. } else {
  17483. impl::fill_connect_error(ssl, ret, err);
  17484. }
  17485. return err;
  17486. }
  17487. inline TlsError accept(session_t session) {
  17488. if (!session) { return TlsError(); }
  17489. auto ssl = static_cast<SSL *>(session);
  17490. auto ret = SSL_accept(ssl);
  17491. TlsError err;
  17492. if (ret == 1) {
  17493. err.code = ErrorCode::Success;
  17494. } else {
  17495. auto ssl_err = SSL_get_error(ssl, ret);
  17496. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17497. err.backend_code = ERR_get_error();
  17498. }
  17499. return err;
  17500. }
  17501. inline bool connect_nonblocking(session_t session, socket_t sock,
  17502. time_t timeout_sec, time_t timeout_usec,
  17503. TlsError *err) {
  17504. if (!session) {
  17505. if (err) { err->code = ErrorCode::Fatal; }
  17506. return false;
  17507. }
  17508. auto ssl = static_cast<SSL *>(session);
  17509. auto bio = SSL_get_rbio(ssl);
  17510. // Set non-blocking mode for handshake
  17511. detail::set_nonblocking(sock, true);
  17512. if (bio) { BIO_set_nbio(bio, 1); }
  17513. auto cleanup = detail::scope_exit([&]() {
  17514. // Restore blocking mode after handshake
  17515. if (bio) { BIO_set_nbio(bio, 0); }
  17516. detail::set_nonblocking(sock, false);
  17517. });
  17518. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17519. auto res = 0;
  17520. while ((res = SSL_connect(ssl)) != 1) {
  17521. auto ssl_err = SSL_get_error(ssl, res);
  17522. switch (ssl_err) {
  17523. case SSL_ERROR_WANT_READ:
  17524. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17525. break;
  17526. case SSL_ERROR_WANT_WRITE:
  17527. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17528. break;
  17529. default: break;
  17530. }
  17531. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17532. return false;
  17533. }
  17534. if (err) { err->code = ErrorCode::Success; }
  17535. return true;
  17536. }
  17537. inline bool accept_nonblocking(session_t session, socket_t sock,
  17538. time_t timeout_sec, time_t timeout_usec,
  17539. TlsError *err) {
  17540. if (!session) {
  17541. if (err) { err->code = ErrorCode::Fatal; }
  17542. return false;
  17543. }
  17544. auto ssl = static_cast<SSL *>(session);
  17545. auto bio = SSL_get_rbio(ssl);
  17546. // Set non-blocking mode for handshake
  17547. detail::set_nonblocking(sock, true);
  17548. if (bio) { BIO_set_nbio(bio, 1); }
  17549. auto cleanup = detail::scope_exit([&]() {
  17550. // Restore blocking mode after handshake
  17551. if (bio) { BIO_set_nbio(bio, 0); }
  17552. detail::set_nonblocking(sock, false);
  17553. });
  17554. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17555. auto res = 0;
  17556. while ((res = SSL_accept(ssl)) != 1) {
  17557. auto ssl_err = SSL_get_error(ssl, res);
  17558. switch (ssl_err) {
  17559. case SSL_ERROR_WANT_READ:
  17560. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17561. break;
  17562. case SSL_ERROR_WANT_WRITE:
  17563. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17564. break;
  17565. default: break;
  17566. }
  17567. if (err) {
  17568. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17569. err->backend_code = ERR_get_error();
  17570. }
  17571. return false;
  17572. }
  17573. if (err) { err->code = ErrorCode::Success; }
  17574. return true;
  17575. }
  17576. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17577. if (!session || !buf) {
  17578. err.code = ErrorCode::Fatal;
  17579. return -1;
  17580. }
  17581. auto ssl = static_cast<SSL *>(session);
  17582. constexpr auto max_len =
  17583. static_cast<size_t>((std::numeric_limits<int>::max)());
  17584. if (len > max_len) { len = max_len; }
  17585. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17586. if (ret > 0) {
  17587. err.code = ErrorCode::Success;
  17588. return ret;
  17589. }
  17590. auto ssl_err = SSL_get_error(ssl, ret);
  17591. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17592. if (err.code == ErrorCode::PeerClosed) {
  17593. return 0;
  17594. } // Gracefully handle the peer closed state.
  17595. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17596. return -1;
  17597. }
  17598. inline ssize_t write(session_t session, const void *buf, size_t len,
  17599. TlsError &err) {
  17600. if (!session || !buf) {
  17601. err.code = ErrorCode::Fatal;
  17602. return -1;
  17603. }
  17604. auto ssl = static_cast<SSL *>(session);
  17605. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17606. if (ret > 0) {
  17607. err.code = ErrorCode::Success;
  17608. return ret;
  17609. }
  17610. auto ssl_err = SSL_get_error(ssl, ret);
  17611. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17612. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17613. return -1;
  17614. }
  17615. inline int pending(const_session_t session) {
  17616. if (!session) return 0;
  17617. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17618. }
  17619. inline void shutdown(session_t session, bool graceful) {
  17620. if (!session) return;
  17621. auto ssl = static_cast<SSL *>(session);
  17622. if (graceful) {
  17623. // Send close_notify without waiting for the peer's. The connection is
  17624. // closed right after this, so a unidirectional shutdown is enough, and an
  17625. // idle peer that never answers would otherwise hold this thread until the
  17626. // read timeout. The other backends do not wait either.
  17627. SSL_shutdown(ssl);
  17628. }
  17629. }
  17630. inline bool is_peer_closed(session_t session, socket_t sock) {
  17631. if (!session) return true;
  17632. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17633. detail::set_nonblocking(sock, true);
  17634. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17635. auto ssl = static_cast<SSL *>(session);
  17636. char buf;
  17637. auto ret = SSL_peek(ssl, &buf, 1);
  17638. if (ret > 0) return false;
  17639. auto err = SSL_get_error(ssl, ret);
  17640. return err == SSL_ERROR_ZERO_RETURN;
  17641. }
  17642. inline cert_t get_peer_cert(const_session_t session) {
  17643. if (!session) return nullptr;
  17644. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17645. static_cast<SSL *>(const_cast<void *>(session))));
  17646. }
  17647. inline size_t get_peer_certs(const_session_t session,
  17648. std::vector<cert_t> &certs) {
  17649. certs.clear();
  17650. if (!session) { return 0; }
  17651. auto ssl = static_cast<const SSL *>(session);
  17652. // On the server side, the chain leaves out the peer's own certificate
  17653. if (SSL_is_server(ssl)) {
  17654. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17655. }
  17656. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17657. auto count = sk_X509_num(sk);
  17658. for (decltype(count) i = 0; i < count; i++) {
  17659. auto x509 = sk_X509_value(sk, i);
  17660. X509_up_ref(x509);
  17661. certs.push_back(static_cast<cert_t>(x509));
  17662. }
  17663. }
  17664. return certs.size();
  17665. }
  17666. inline void free_cert(cert_t cert) {
  17667. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17668. }
  17669. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17670. if (!cert || !hostname) return false;
  17671. auto x509 = static_cast<X509 *>(cert);
  17672. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17673. if (detail::is_ip_address(hostname)) {
  17674. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17675. }
  17676. return X509_check_host(x509, hostname, strlen(hostname),
  17677. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  17678. }
  17679. inline uint64_t hostname_mismatch_code() {
  17680. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17681. }
  17682. inline long get_verify_result(const_session_t session) {
  17683. if (!session) return X509_V_ERR_UNSPECIFIED;
  17684. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17685. }
  17686. inline std::string get_cert_subject_cn(cert_t cert) {
  17687. if (!cert) return "";
  17688. auto x509 = static_cast<X509 *>(cert);
  17689. auto subject_name = X509_get_subject_name(x509);
  17690. if (!subject_name) return "";
  17691. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17692. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17693. if (idx < 0) return "";
  17694. auto entry = X509_NAME_get_entry(subject_name, idx);
  17695. if (!entry) return "";
  17696. auto data = X509_NAME_ENTRY_get_data(entry);
  17697. if (!data) return "";
  17698. return std::string(
  17699. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17700. static_cast<size_t>(ASN1_STRING_length(data)));
  17701. }
  17702. inline std::string get_cert_issuer_name(cert_t cert) {
  17703. if (!cert) return "";
  17704. auto x509 = static_cast<X509 *>(cert);
  17705. auto issuer_name = X509_get_issuer_name(x509);
  17706. if (!issuer_name) return "";
  17707. char buf[256];
  17708. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17709. return std::string(buf);
  17710. }
  17711. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17712. sans.clear();
  17713. if (!cert) return false;
  17714. auto x509 = static_cast<X509 *>(cert);
  17715. auto names = static_cast<GENERAL_NAMES *>(
  17716. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17717. if (!names) return true; // No SANs is valid
  17718. auto count = sk_GENERAL_NAME_num(names);
  17719. for (decltype(count) i = 0; i < count; i++) {
  17720. auto gen = sk_GENERAL_NAME_value(names, i);
  17721. if (!gen) continue;
  17722. SanEntry entry;
  17723. switch (gen->type) {
  17724. case GEN_DNS:
  17725. entry.type = SanType::DNS;
  17726. if (gen->d.dNSName) {
  17727. entry.value = std::string(
  17728. reinterpret_cast<const char *>(
  17729. ASN1_STRING_get0_data(gen->d.dNSName)),
  17730. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17731. }
  17732. break;
  17733. case GEN_IPADD:
  17734. entry.type = SanType::IP;
  17735. if (gen->d.iPAddress) {
  17736. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17737. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17738. if (len == 4) {
  17739. // IPv4
  17740. char buf[INET_ADDRSTRLEN];
  17741. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17742. entry.value = buf;
  17743. } else if (len == 16) {
  17744. // IPv6
  17745. char buf[INET6_ADDRSTRLEN];
  17746. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17747. entry.value = buf;
  17748. }
  17749. }
  17750. break;
  17751. case GEN_EMAIL:
  17752. entry.type = SanType::EMAIL;
  17753. if (gen->d.rfc822Name) {
  17754. entry.value = std::string(
  17755. reinterpret_cast<const char *>(
  17756. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17757. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17758. }
  17759. break;
  17760. case GEN_URI:
  17761. entry.type = SanType::URI;
  17762. if (gen->d.uniformResourceIdentifier) {
  17763. entry.value = std::string(
  17764. reinterpret_cast<const char *>(
  17765. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17766. static_cast<size_t>(
  17767. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17768. }
  17769. break;
  17770. default: entry.type = SanType::OTHER; break;
  17771. }
  17772. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17773. }
  17774. GENERAL_NAMES_free(names);
  17775. return true;
  17776. }
  17777. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17778. time_t &not_after) {
  17779. if (!cert) return false;
  17780. auto x509 = static_cast<X509 *>(cert);
  17781. auto nb = X509_get0_notBefore(x509);
  17782. auto na = X509_get0_notAfter(x509);
  17783. if (!nb || !na) return false;
  17784. ASN1_TIME *epoch = ASN1_TIME_new();
  17785. if (!epoch) return false;
  17786. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17787. if (!ASN1_TIME_set(epoch, 0)) return false;
  17788. int pday, psec;
  17789. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17790. not_before = 86400 * (time_t)pday + psec;
  17791. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17792. not_after = 86400 * (time_t)pday + psec;
  17793. return true;
  17794. }
  17795. inline std::string get_cert_serial(cert_t cert) {
  17796. if (!cert) return "";
  17797. auto x509 = static_cast<X509 *>(cert);
  17798. auto serial = X509_get_serialNumber(x509);
  17799. if (!serial) return "";
  17800. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17801. if (!bn) return "";
  17802. auto hex = BN_bn2hex(bn);
  17803. BN_free(bn);
  17804. if (!hex) return "";
  17805. std::string result(hex);
  17806. OPENSSL_free(hex);
  17807. return result;
  17808. }
  17809. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17810. if (!cert) return false;
  17811. auto x509 = static_cast<X509 *>(cert);
  17812. auto len = i2d_X509(x509, nullptr);
  17813. if (len < 0) return false;
  17814. der.resize(static_cast<size_t>(len));
  17815. auto p = der.data();
  17816. i2d_X509(x509, &p);
  17817. return true;
  17818. }
  17819. inline const char *get_sni(const_session_t session) {
  17820. if (!session) return nullptr;
  17821. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17822. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17823. }
  17824. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17825. inline uint64_t get_error() { return ERR_get_error(); }
  17826. inline std::string error_string(uint64_t code) {
  17827. char buf[256];
  17828. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17829. sizeof(buf));
  17830. return std::string(buf);
  17831. }
  17832. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17833. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17834. if (!mem) { return nullptr; }
  17835. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17836. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17837. if (!inf) { return nullptr; }
  17838. auto store = X509_STORE_new();
  17839. if (store) {
  17840. auto count = sk_X509_INFO_num(inf);
  17841. for (decltype(count) i = 0; i < count; i++) {
  17842. auto itmp = sk_X509_INFO_value(inf, i);
  17843. if (!itmp) { continue; }
  17844. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17845. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17846. }
  17847. }
  17848. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17849. return static_cast<ca_store_t>(store);
  17850. }
  17851. inline void free_ca_store(ca_store_t store) {
  17852. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17853. }
  17854. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17855. if (!ctx || !store) { return false; }
  17856. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17857. auto x509_store = static_cast<X509_STORE *>(store);
  17858. // Check if same store is already set
  17859. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17860. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17861. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17862. return true;
  17863. }
  17864. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17865. certs.clear();
  17866. if (!ctx) { return 0; }
  17867. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17868. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17869. if (!store) { return 0; }
  17870. auto objs = impl::get_store_objects(store);
  17871. if (!objs) { return 0; }
  17872. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17873. auto count = sk_X509_OBJECT_num(objs);
  17874. for (decltype(count) i = 0; i < count; i++) {
  17875. auto obj = sk_X509_OBJECT_value(objs, i);
  17876. if (!obj) { continue; }
  17877. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17878. auto x509 = X509_OBJECT_get0_X509(obj);
  17879. if (x509) {
  17880. // Increment reference count so caller can free it
  17881. X509_up_ref(x509);
  17882. certs.push_back(static_cast<cert_t>(x509));
  17883. }
  17884. }
  17885. }
  17886. return certs.size();
  17887. }
  17888. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17889. std::vector<std::string> names;
  17890. if (!ctx) { return names; }
  17891. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17892. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17893. if (!store) { return names; }
  17894. auto objs = impl::get_store_objects(store);
  17895. if (!objs) { return names; }
  17896. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17897. auto count = sk_X509_OBJECT_num(objs);
  17898. for (decltype(count) i = 0; i < count; i++) {
  17899. auto obj = sk_X509_OBJECT_value(objs, i);
  17900. if (!obj) { continue; }
  17901. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17902. auto x509 = X509_OBJECT_get0_X509(obj);
  17903. if (x509) {
  17904. auto subject = X509_get_subject_name(x509);
  17905. if (subject) {
  17906. char buf[512];
  17907. X509_NAME_oneline(subject, buf, sizeof(buf));
  17908. names.push_back(buf);
  17909. }
  17910. }
  17911. }
  17912. }
  17913. return names;
  17914. }
  17915. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17916. const char *key_pem, const char *password) {
  17917. if (!ctx || !cert_pem || !key_pem) { return false; }
  17918. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17919. // Load certificate from PEM
  17920. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17921. if (!cert_bio) { return false; }
  17922. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17923. BIO_free(cert_bio);
  17924. if (!cert) { return false; }
  17925. // Load private key from PEM
  17926. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17927. if (!key_bio) {
  17928. X509_free(cert);
  17929. return false;
  17930. }
  17931. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17932. password ? const_cast<char *>(password)
  17933. : nullptr);
  17934. BIO_free(key_bio);
  17935. if (!key) {
  17936. X509_free(cert);
  17937. return false;
  17938. }
  17939. // Update certificate and key
  17940. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17941. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17942. X509_free(cert);
  17943. EVP_PKEY_free(key);
  17944. return ret;
  17945. }
  17946. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17947. if (!ctx || !ca_pem) { return false; }
  17948. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17949. // Create new X509_STORE from PEM
  17950. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17951. if (!store) { return false; }
  17952. // A resumed session is not verified again, so the ticket keys from before
  17953. // go, or a client verified under the old CAs could go on resuming.
  17954. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17955. unsigned char ticket_keys[48];
  17956. #else
  17957. unsigned char ticket_keys[80];
  17958. #endif
  17959. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17960. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17961. sizeof(ticket_keys)) != 1) {
  17962. free_ca_store(store);
  17963. return false;
  17964. }
  17965. // SSL_CTX_set_cert_store takes ownership
  17966. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17967. // Set client CA list for client certificate request
  17968. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17969. if (ca_list) {
  17970. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17971. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17972. }
  17973. // The cached sessions go for the same reason.
  17974. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17975. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17976. #else
  17977. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17978. #endif
  17979. return true;
  17980. }
  17981. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17982. if (!ctx) { return false; }
  17983. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17984. auto index = impl::verify_callback_index();
  17985. if (index < 0) { return false; }
  17986. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17987. if (callback) {
  17988. stored = new std::shared_ptr<VerifyCallback>(
  17989. std::make_shared<VerifyCallback>(std::move(callback)));
  17990. }
  17991. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17992. {
  17993. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17994. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17995. SSL_CTX_get_ex_data(ssl_ctx, index));
  17996. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17997. delete stored;
  17998. return false;
  17999. }
  18000. }
  18001. // A handshake running the previous callback keeps it until it returns.
  18002. delete previous;
  18003. // A resumed handshake shows no certificate to run the callback on.
  18004. if (stored) {
  18005. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  18006. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  18007. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  18008. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  18009. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  18010. #endif
  18011. }
  18012. // Keep requiring the peer's certificate if set_verify_client() asked for it
  18013. auto require =
  18014. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  18015. impl::apply_verify_mode(ssl_ctx, require);
  18016. return true;
  18017. }
  18018. inline long get_verify_error(const_session_t session) {
  18019. if (!session) { return -1; }
  18020. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18021. return SSL_get_verify_result(ssl);
  18022. }
  18023. inline std::string verify_error_string(long error_code) {
  18024. if (error_code == X509_V_OK) { return ""; }
  18025. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  18026. return str ? str : "unknown error";
  18027. }
  18028. } // namespace tls
  18029. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  18030. /*
  18031. * Group 9: TLS abstraction layer - Mbed TLS backend
  18032. */
  18033. /*
  18034. * Mbed TLS Backend Implementation
  18035. */
  18036. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  18037. namespace tls {
  18038. namespace impl {
  18039. // Mbed TLS session wrapper
  18040. struct MbedTlsSession {
  18041. mbedtls_ssl_context ssl;
  18042. socket_t sock = INVALID_SOCKET;
  18043. std::string hostname; // For client: set via set_sni
  18044. std::string sni_hostname; // For server: received from client via SNI callback
  18045. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  18046. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  18047. // (e.g. a response that arrived while this side was still in its post-write
  18048. // check), the byte is pushed back here and served by the next read().
  18049. unsigned char peeked_byte = 0;
  18050. bool has_peeked_byte = false;
  18051. // Set by set_sni() when the caller disabled hostname verification, so the
  18052. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18053. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18054. // OpenSSL and wolfSSL keep them independent).
  18055. bool suppress_hostname_mismatch = false;
  18056. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18057. // ever runs the callback of its own context.
  18058. VerifyCallback verify_callback;
  18059. bool is_server = false;
  18060. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18061. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18062. MbedTlsSession(const MbedTlsSession &) = delete;
  18063. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18064. };
  18065. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18066. // queue)
  18067. inline int &mbedtls_last_error() {
  18068. static thread_local int err = 0;
  18069. return err;
  18070. }
  18071. // Helper to map Mbed TLS error to ErrorCode
  18072. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18073. uint32_t verify_flags) {
  18074. if (ret == 0) { return ErrorCode::Success; }
  18075. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18076. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18077. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18078. return ErrorCode::PeerClosed;
  18079. }
  18080. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18081. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18082. out_errno = errno;
  18083. return ErrorCode::SyscallError;
  18084. }
  18085. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18086. // EOF without close_notify
  18087. out_errno = 0;
  18088. return ErrorCode::SyscallError;
  18089. }
  18090. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18091. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18092. // the handshake's chain verification (see set_sni()); a mismatch there
  18093. // is reported the same way as any other verify_flags bit. Report it as
  18094. // HostnameMismatch, matching the other backends and the post-handshake
  18095. // identity check below, but only when naming is the sole problem -
  18096. // if the chain itself is also untrusted/expired/etc., that takes
  18097. // priority over the naming detail.
  18098. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18099. return ErrorCode::HostnameMismatch;
  18100. }
  18101. return ErrorCode::CertVerifyFailed;
  18102. }
  18103. return ErrorCode::Fatal;
  18104. }
  18105. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18106. // return value, including the verify-flags-dependent HostnameMismatch
  18107. // mapping; shared by connect() and connect_nonblocking() so the
  18108. // backend_code policy for that mapping only lives in one place.
  18109. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18110. int ret) {
  18111. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18112. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18113. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18114. ? static_cast<uint64_t>(verify_flags)
  18115. : static_cast<uint64_t>(-ret);
  18116. }
  18117. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18118. // non-fatal notification delivered between records, not an error and not
  18119. // application data, so I/O calls that see it should just be retried. Kept in
  18120. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18121. // splitting the closing brace across an #if.
  18122. inline bool mbedtls_is_session_ticket(int ret) {
  18123. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18124. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18125. #else
  18126. (void)ret;
  18127. return false;
  18128. #endif
  18129. }
  18130. // BIO-like send callback for Mbed TLS
  18131. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18132. size_t len) {
  18133. auto sock = *static_cast<socket_t *>(ctx);
  18134. #ifdef _WIN32
  18135. auto ret =
  18136. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18137. if (ret == SOCKET_ERROR) {
  18138. int err = WSAGetLastError();
  18139. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18140. return MBEDTLS_ERR_NET_SEND_FAILED;
  18141. }
  18142. #else
  18143. auto ret = send(sock, buf, len, 0);
  18144. if (ret < 0) {
  18145. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18146. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18147. }
  18148. return MBEDTLS_ERR_NET_SEND_FAILED;
  18149. }
  18150. #endif
  18151. return static_cast<int>(ret);
  18152. }
  18153. // BIO-like recv callback for Mbed TLS
  18154. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18155. auto sock = *static_cast<socket_t *>(ctx);
  18156. #ifdef _WIN32
  18157. auto ret =
  18158. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18159. if (ret == SOCKET_ERROR) {
  18160. int err = WSAGetLastError();
  18161. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18162. return MBEDTLS_ERR_NET_RECV_FAILED;
  18163. }
  18164. #else
  18165. auto ret = recv(sock, buf, len, 0);
  18166. if (ret < 0) {
  18167. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18168. return MBEDTLS_ERR_SSL_WANT_READ;
  18169. }
  18170. return MBEDTLS_ERR_NET_RECV_FAILED;
  18171. }
  18172. #endif
  18173. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18174. return static_cast<int>(ret);
  18175. }
  18176. // MbedTlsContext constructor/destructor implementations
  18177. inline MbedTlsContext::MbedTlsContext() {
  18178. mbedtls_ssl_config_init(&conf);
  18179. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18180. mbedtls_entropy_init(&entropy);
  18181. mbedtls_ctr_drbg_init(&ctr_drbg);
  18182. #endif
  18183. mbedtls_x509_crt_init(&ca_chain);
  18184. mbedtls_x509_crt_init(&own_cert);
  18185. mbedtls_pk_init(&own_key);
  18186. }
  18187. inline MbedTlsContext::~MbedTlsContext() {
  18188. mbedtls_pk_free(&own_key);
  18189. mbedtls_x509_crt_free(&own_cert);
  18190. mbedtls_x509_crt_free(&ca_chain);
  18191. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18192. mbedtls_ctr_drbg_free(&ctr_drbg);
  18193. mbedtls_entropy_free(&entropy);
  18194. #endif
  18195. mbedtls_ssl_config_free(&conf);
  18196. }
  18197. // Thread-local storage for SNI captured during handshake
  18198. // This is needed because the SNI callback doesn't have a way to pass
  18199. // session-specific data before the session is fully set up
  18200. inline std::string &mbedpending_sni() {
  18201. static thread_local std::string sni;
  18202. return sni;
  18203. }
  18204. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18205. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18206. const unsigned char *name, size_t name_len) {
  18207. (void)p_ctx;
  18208. (void)ssl;
  18209. // Store SNI name in thread-local storage
  18210. // It will be retrieved and stored in the session after handshake
  18211. if (name && name_len > 0) {
  18212. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18213. } else {
  18214. mbedpending_sni().clear();
  18215. }
  18216. return 0; // Accept any SNI
  18217. }
  18218. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18219. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18220. }
  18221. // MbedTLS verify callback wrapper
  18222. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18223. int cert_depth, uint32_t *flags) {
  18224. // data points to the MbedTlsSession
  18225. auto *session = static_cast<MbedTlsSession *>(data);
  18226. // set_sni() disabled hostname verification for this session: ignore the
  18227. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18228. // pass/fail decision still comes from the remaining flags (and, below, from
  18229. // the user's own verify callback).
  18230. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18231. const auto &callback = session->verify_callback;
  18232. if (!callback) { return 0; } // Continue with default verification
  18233. // Build context
  18234. VerifyContext verify_ctx;
  18235. verify_ctx.session = static_cast<session_t>(session);
  18236. verify_ctx.cert = static_cast<cert_t>(crt);
  18237. verify_ctx.depth = cert_depth;
  18238. verify_ctx.preverify_ok = (*flags == 0);
  18239. verify_ctx.error_code = static_cast<long>(*flags);
  18240. // Convert Mbed TLS flags to error string
  18241. static thread_local char error_buf[256];
  18242. if (*flags != 0) {
  18243. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18244. verify_ctx.error_string = error_buf;
  18245. } else {
  18246. verify_ctx.error_string = nullptr;
  18247. }
  18248. bool accepted = run_verify_callback(callback, verify_ctx);
  18249. if (accepted) {
  18250. // Overrides the built-in verification only on a server, as on OpenSSL and
  18251. // wolfSSL, whose clients check the verify result after the handshake
  18252. if (session->is_server) { *flags = 0; }
  18253. return 0;
  18254. }
  18255. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18256. }
  18257. // Sets the authentication mode from whether the peer's certificate is required
  18258. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18259. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18260. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18261. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18262. if (mctx.verify_client) {
  18263. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18264. } else if (mctx.verify_callback) {
  18265. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18266. }
  18267. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18268. }
  18269. } // namespace impl
  18270. inline ctx_t create_client_context() {
  18271. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18272. if (!ctx) { return nullptr; }
  18273. ctx->is_server = false;
  18274. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18275. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18276. if (!detail::ensure_mbedtls_psa_crypto()) {
  18277. delete ctx;
  18278. return nullptr;
  18279. }
  18280. int ret;
  18281. #else
  18282. // Seed the random number generator
  18283. const char *pers = "httplib_client";
  18284. int ret = mbedtls_ctr_drbg_seed(
  18285. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18286. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18287. if (ret != 0) {
  18288. impl::mbedtls_last_error() = ret;
  18289. delete ctx;
  18290. return nullptr;
  18291. }
  18292. #endif
  18293. // Set up SSL config for client
  18294. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18295. MBEDTLS_SSL_TRANSPORT_STREAM,
  18296. MBEDTLS_SSL_PRESET_DEFAULT);
  18297. if (ret != 0) {
  18298. impl::mbedtls_last_error() = ret;
  18299. delete ctx;
  18300. return nullptr;
  18301. }
  18302. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18303. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18304. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18305. #endif
  18306. // Default: verify peer certificate
  18307. ctx->verify_client = true;
  18308. impl::apply_verify_mode(*ctx);
  18309. // Set minimum TLS version to 1.2
  18310. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18311. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18312. #else
  18313. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18314. MBEDTLS_SSL_MINOR_VERSION_3);
  18315. #endif
  18316. return static_cast<ctx_t>(ctx);
  18317. }
  18318. inline ctx_t create_server_context() {
  18319. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18320. if (!ctx) { return nullptr; }
  18321. ctx->is_server = true;
  18322. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18323. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18324. if (!detail::ensure_mbedtls_psa_crypto()) {
  18325. delete ctx;
  18326. return nullptr;
  18327. }
  18328. int ret;
  18329. #else
  18330. // Seed the random number generator
  18331. const char *pers = "httplib_server";
  18332. int ret = mbedtls_ctr_drbg_seed(
  18333. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18334. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18335. if (ret != 0) {
  18336. impl::mbedtls_last_error() = ret;
  18337. delete ctx;
  18338. return nullptr;
  18339. }
  18340. #endif
  18341. // Set up SSL config for server
  18342. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18343. MBEDTLS_SSL_TRANSPORT_STREAM,
  18344. MBEDTLS_SSL_PRESET_DEFAULT);
  18345. if (ret != 0) {
  18346. impl::mbedtls_last_error() = ret;
  18347. delete ctx;
  18348. return nullptr;
  18349. }
  18350. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18351. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18352. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18353. #endif
  18354. // Default: don't verify client
  18355. impl::apply_verify_mode(*ctx);
  18356. // Set minimum TLS version to 1.2
  18357. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18358. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18359. #else
  18360. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18361. MBEDTLS_SSL_MINOR_VERSION_3);
  18362. #endif
  18363. // Set SNI callback to capture client's SNI hostname
  18364. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18365. return static_cast<ctx_t>(ctx);
  18366. }
  18367. inline void free_context(ctx_t ctx) {
  18368. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18369. }
  18370. inline bool set_min_version(ctx_t ctx, Version version) {
  18371. if (!ctx) { return false; }
  18372. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18373. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18374. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18375. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18376. if (version >= Version::TLS1_3) {
  18377. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18378. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18379. #endif
  18380. }
  18381. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18382. #else
  18383. // Mbed TLS 2.x uses major/minor version numbers
  18384. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18385. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18386. if (version >= Version::TLS1_3) {
  18387. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18388. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18389. #else
  18390. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18391. #endif
  18392. }
  18393. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18394. #endif
  18395. return true;
  18396. }
  18397. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18398. if (!ctx || !pem) { return false; }
  18399. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18400. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18401. // Add null terminator if not present
  18402. std::string pem_str(pem, len);
  18403. int ret = mbedtls_x509_crt_parse(
  18404. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18405. pem_str.size() + 1);
  18406. if (ret != 0) {
  18407. impl::mbedtls_last_error() = ret;
  18408. return false;
  18409. }
  18410. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18411. return true;
  18412. }
  18413. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18414. if (!ctx || !file_path) { return false; }
  18415. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18416. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18417. if (ret != 0) {
  18418. impl::mbedtls_last_error() = ret;
  18419. return false;
  18420. }
  18421. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18422. return true;
  18423. }
  18424. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18425. if (!ctx || !dir_path) { return false; }
  18426. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18427. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18428. if (ret < 0) { // Returns number of certs on success, negative on error
  18429. impl::mbedtls_last_error() = ret;
  18430. return false;
  18431. }
  18432. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18433. return true;
  18434. }
  18435. inline bool load_system_certs(ctx_t ctx) {
  18436. if (!ctx) { return false; }
  18437. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18438. bool loaded = false;
  18439. #ifdef _WIN32
  18440. loaded = impl::enumerate_windows_system_certs(
  18441. [&](const unsigned char *data, size_t len) {
  18442. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18443. });
  18444. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18445. loaded = impl::enumerate_macos_keychain_certs(
  18446. [&](const unsigned char *data, size_t len) {
  18447. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18448. });
  18449. #else
  18450. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18451. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18452. loaded = true;
  18453. break;
  18454. }
  18455. }
  18456. if (!loaded) {
  18457. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18458. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18459. loaded = true;
  18460. break;
  18461. }
  18462. }
  18463. }
  18464. #endif
  18465. if (loaded) {
  18466. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18467. }
  18468. return loaded;
  18469. }
  18470. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18471. const char *password) {
  18472. if (!ctx || !cert || !key) { return false; }
  18473. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18474. // Parse certificate
  18475. std::string cert_str(cert);
  18476. int ret = mbedtls_x509_crt_parse(
  18477. &mctx->own_cert,
  18478. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18479. cert_str.size() + 1);
  18480. if (ret != 0) {
  18481. impl::mbedtls_last_error() = ret;
  18482. return false;
  18483. }
  18484. // Parse private key
  18485. std::string key_str(key);
  18486. const unsigned char *pwd =
  18487. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18488. size_t pwd_len = password ? strlen(password) : 0;
  18489. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18490. ret = mbedtls_pk_parse_key(
  18491. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18492. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18493. &mctx->ctr_drbg);
  18494. #else
  18495. ret = mbedtls_pk_parse_key(
  18496. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18497. key_str.size() + 1, pwd, pwd_len);
  18498. #endif
  18499. if (ret != 0) {
  18500. impl::mbedtls_last_error() = ret;
  18501. return false;
  18502. }
  18503. // Verify that the certificate and private key match.
  18504. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18505. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18506. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18507. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18508. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18509. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18510. #else
  18511. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18512. #endif
  18513. if (ret != 0) {
  18514. impl::mbedtls_last_error() = ret;
  18515. return false;
  18516. }
  18517. #endif
  18518. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18519. if (ret != 0) {
  18520. impl::mbedtls_last_error() = ret;
  18521. return false;
  18522. }
  18523. return true;
  18524. }
  18525. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18526. const char *key_path, const char *password) {
  18527. if (!ctx || !cert_path || !key_path) { return false; }
  18528. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18529. // Parse certificate file
  18530. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18531. if (ret != 0) {
  18532. impl::mbedtls_last_error() = ret;
  18533. return false;
  18534. }
  18535. // Parse private key file
  18536. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18537. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18538. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18539. #else
  18540. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18541. #endif
  18542. if (ret != 0) {
  18543. impl::mbedtls_last_error() = ret;
  18544. return false;
  18545. }
  18546. // Verify that the certificate and private key match.
  18547. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18548. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18549. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18550. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18551. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18552. #else
  18553. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18554. #endif
  18555. if (ret != 0) {
  18556. impl::mbedtls_last_error() = ret;
  18557. return false;
  18558. }
  18559. #endif
  18560. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18561. if (ret != 0) {
  18562. impl::mbedtls_last_error() = ret;
  18563. return false;
  18564. }
  18565. return true;
  18566. }
  18567. inline void set_verify_client(ctx_t ctx, bool require) {
  18568. if (!ctx) { return; }
  18569. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18570. mctx->verify_client = require;
  18571. impl::apply_verify_mode(*mctx);
  18572. }
  18573. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18574. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18575. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18576. auto session = new (std::nothrow) impl::MbedTlsSession();
  18577. if (!session) { return nullptr; }
  18578. session->sock = sock;
  18579. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18580. if (ret != 0) {
  18581. impl::mbedtls_last_error() = ret;
  18582. delete session;
  18583. return nullptr;
  18584. }
  18585. // Explicitly opt out of in-handshake hostname verification by default;
  18586. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18587. // fails outright when no hostname was set. set_sni() installs the real
  18588. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18589. // caller verifies the certificate identity post-handshake via
  18590. // verify_hostname().
  18591. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18592. // Set BIO callbacks
  18593. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18594. impl::mbedtls_net_recv_cb, nullptr);
  18595. // Installed always, as it also masks the hostname mismatch that set_sni()
  18596. // may ask for. The session runs its own copy of the user's callback, which
  18597. // set_verify_callback() cannot replace under a handshake.
  18598. session->verify_callback = mctx->verify_callback;
  18599. session->is_server = mctx->is_server;
  18600. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18601. return static_cast<session_t>(session);
  18602. }
  18603. inline void free_session(session_t session) {
  18604. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18605. }
  18606. inline bool set_sni(session_t session, const char *hostname,
  18607. bool verify_hostname) {
  18608. if (!session || !hostname) { return false; }
  18609. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18610. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18611. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18612. // independently, so a disabled hostname check is handled below by masking
  18613. // the resulting mismatch flag instead of skipping this call.
  18614. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18615. if (ret != 0) {
  18616. impl::mbedtls_last_error() = ret;
  18617. return false;
  18618. }
  18619. msession->hostname = hostname;
  18620. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18621. return true;
  18622. }
  18623. inline TlsError connect(session_t session) {
  18624. TlsError err;
  18625. if (!session) {
  18626. err.code = ErrorCode::Fatal;
  18627. return err;
  18628. }
  18629. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18630. int ret;
  18631. do {
  18632. ret = mbedtls_ssl_handshake(&msession->ssl);
  18633. } while (impl::mbedtls_is_session_ticket(ret));
  18634. if (ret == 0) {
  18635. err.code = ErrorCode::Success;
  18636. } else {
  18637. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18638. impl::mbedtls_last_error() = ret;
  18639. }
  18640. return err;
  18641. }
  18642. inline TlsError accept(session_t session) {
  18643. // A failed handshake leaves its SNI behind, so start without it
  18644. impl::mbedpending_sni().clear();
  18645. // Same as connect for Mbed TLS - handshake works for both client and server
  18646. auto result = connect(session);
  18647. // After successful handshake, capture SNI from thread-local storage
  18648. if (result.code == ErrorCode::Success && session) {
  18649. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18650. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18651. }
  18652. return result;
  18653. }
  18654. inline bool connect_nonblocking(session_t session, socket_t sock,
  18655. time_t timeout_sec, time_t timeout_usec,
  18656. TlsError *err) {
  18657. if (!session) {
  18658. if (err) { err->code = ErrorCode::Fatal; }
  18659. return false;
  18660. }
  18661. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18662. // Set socket to non-blocking mode
  18663. detail::set_nonblocking(sock, true);
  18664. auto cleanup =
  18665. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18666. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18667. int ret;
  18668. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18669. // Non-fatal TLS 1.3 ticket; retry immediately.
  18670. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18671. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18672. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18673. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18674. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18675. }
  18676. // TlsError or timeout
  18677. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18678. impl::mbedtls_last_error() = ret;
  18679. return false;
  18680. }
  18681. if (err) { err->code = ErrorCode::Success; }
  18682. return true;
  18683. }
  18684. inline bool accept_nonblocking(session_t session, socket_t sock,
  18685. time_t timeout_sec, time_t timeout_usec,
  18686. TlsError *err) {
  18687. // A failed handshake leaves its SNI behind, so start without it
  18688. impl::mbedpending_sni().clear();
  18689. // Same implementation as connect for Mbed TLS
  18690. bool result =
  18691. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18692. // After successful handshake, capture SNI from thread-local storage
  18693. if (result && session) {
  18694. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18695. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18696. }
  18697. return result;
  18698. }
  18699. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18700. if (!session || !buf) {
  18701. err.code = ErrorCode::Fatal;
  18702. return -1;
  18703. }
  18704. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18705. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18706. if (msession->has_peeked_byte) {
  18707. if (len == 0) { return 0; }
  18708. auto p = static_cast<unsigned char *>(buf);
  18709. p[0] = msession->peeked_byte;
  18710. msession->has_peeked_byte = false;
  18711. size_t n = 1;
  18712. // Top up with any already-decrypted bytes without risking a block.
  18713. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18714. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18715. if (extra > 0) { n += static_cast<size_t>(extra); }
  18716. }
  18717. err.code = ErrorCode::Success;
  18718. return static_cast<ssize_t>(n);
  18719. }
  18720. int ret;
  18721. do {
  18722. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18723. len);
  18724. } while (impl::mbedtls_is_session_ticket(ret));
  18725. if (ret > 0) {
  18726. err.code = ErrorCode::Success;
  18727. return static_cast<ssize_t>(ret);
  18728. }
  18729. // 0 means EOF without close_notify, which is an error as on OpenSSL
  18730. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  18731. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18732. err.backend_code = static_cast<uint64_t>(-ret);
  18733. impl::mbedtls_last_error() = ret;
  18734. // mbedTLS signals a clean close_notify via a negative error code rather
  18735. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18736. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18737. return -1;
  18738. }
  18739. inline ssize_t write(session_t session, const void *buf, size_t len,
  18740. TlsError &err) {
  18741. if (!session || !buf) {
  18742. err.code = ErrorCode::Fatal;
  18743. return -1;
  18744. }
  18745. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18746. int ret;
  18747. do {
  18748. ret = mbedtls_ssl_write(&msession->ssl,
  18749. static_cast<const unsigned char *>(buf), len);
  18750. } while (impl::mbedtls_is_session_ticket(ret));
  18751. if (ret > 0) {
  18752. err.code = ErrorCode::Success;
  18753. return static_cast<ssize_t>(ret);
  18754. }
  18755. if (ret == 0) {
  18756. err.code = ErrorCode::PeerClosed;
  18757. return 0;
  18758. }
  18759. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18760. err.backend_code = static_cast<uint64_t>(-ret);
  18761. impl::mbedtls_last_error() = ret;
  18762. return -1;
  18763. }
  18764. inline int pending(const_session_t session) {
  18765. if (!session) { return 0; }
  18766. auto msession =
  18767. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18768. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18769. (msession->has_peeked_byte ? 1 : 0);
  18770. }
  18771. inline void shutdown(session_t session, bool graceful) {
  18772. if (!session) { return; }
  18773. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18774. if (graceful) {
  18775. // Try to send close_notify, but don't block forever
  18776. int ret;
  18777. int attempts = 0;
  18778. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18779. attempts < 3) {
  18780. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18781. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18782. break;
  18783. }
  18784. attempts++;
  18785. }
  18786. }
  18787. }
  18788. inline bool is_peer_closed(session_t session, socket_t sock) {
  18789. if (!session || sock == INVALID_SOCKET) { return true; }
  18790. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18791. // Check if there's already decrypted or pushed-back data available.
  18792. // If so, the connection is definitely alive.
  18793. if (msession->has_peeked_byte ||
  18794. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18795. return false;
  18796. }
  18797. // Set socket to non-blocking to avoid blocking on read
  18798. detail::set_nonblocking(sock, true);
  18799. auto cleanup =
  18800. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18801. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18802. // on application data — e.g. a response that already arrived — push the
  18803. // byte back so the next read() delivers it instead of losing it.
  18804. unsigned char buf;
  18805. int ret;
  18806. do {
  18807. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18808. } while (impl::mbedtls_is_session_ticket(ret));
  18809. // If we got data or WANT_READ (would block), connection is alive
  18810. if (ret > 0) {
  18811. msession->peeked_byte = buf;
  18812. msession->has_peeked_byte = true;
  18813. return false;
  18814. }
  18815. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18816. // If we get a peer close notify or a connection reset, the peer is closed
  18817. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18818. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18819. }
  18820. inline cert_t get_peer_cert(const_session_t session) {
  18821. if (!session) { return nullptr; }
  18822. auto msession =
  18823. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18824. // Mbed TLS returns a pointer to the internal peer cert chain.
  18825. // WARNING: This pointer is only valid while the session is active.
  18826. // Do not use the certificate after calling free_session().
  18827. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18828. return const_cast<mbedtls_x509_crt *>(cert);
  18829. }
  18830. inline size_t get_peer_certs(const_session_t session,
  18831. std::vector<cert_t> &certs) {
  18832. certs.clear();
  18833. // Mbed TLS parses the whole received chain into a list headed by the peer
  18834. // certificate, owned by the session like get_peer_cert()'s result
  18835. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18836. crt && crt->raw.len > 0; crt = crt->next) {
  18837. certs.push_back(static_cast<cert_t>(crt));
  18838. }
  18839. return certs.size();
  18840. }
  18841. inline void free_cert(cert_t cert) {
  18842. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18843. // chain, so there is nothing to free. Callers still call this for the other
  18844. // backends.
  18845. (void)cert;
  18846. }
  18847. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18848. if (!cert || !hostname) { return false; }
  18849. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18850. std::string host_str(hostname);
  18851. // Check if hostname is an IP address (IPv4 or IPv6)
  18852. unsigned char ip_bytes[16];
  18853. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18854. auto is_ip = ip_len > 0;
  18855. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18856. // in buf.tag and the raw value in buf.p / buf.len.
  18857. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18858. if (!san->buf.p || san->buf.len == 0) { continue; }
  18859. const unsigned char *p = san->buf.p;
  18860. size_t len = san->buf.len;
  18861. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18862. if (is_ip) {
  18863. // For an IP host, only a matching iPAddress SAN of the same family
  18864. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18865. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18866. memcmp(p, ip_bytes, ip_len) == 0) {
  18867. return true;
  18868. }
  18869. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18870. std::string san_name(reinterpret_cast<const char *>(p), len);
  18871. if (detail::match_hostname(san_name, host_str)) { return true; }
  18872. }
  18873. }
  18874. return false;
  18875. }
  18876. inline uint64_t hostname_mismatch_code() {
  18877. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18878. }
  18879. inline long get_verify_result(const_session_t session) {
  18880. if (!session) { return -1; }
  18881. auto msession =
  18882. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18883. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18884. // Return 0 (X509_V_OK equivalent) if verification passed
  18885. return flags == 0 ? 0 : static_cast<long>(flags);
  18886. }
  18887. inline std::string get_cert_subject_cn(cert_t cert) {
  18888. if (!cert) return "";
  18889. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18890. // Find the CN in the subject
  18891. const mbedtls_x509_name *name = &x509->subject;
  18892. while (name != nullptr) {
  18893. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18894. return std::string(reinterpret_cast<const char *>(name->val.p),
  18895. name->val.len);
  18896. }
  18897. name = name->next;
  18898. }
  18899. return "";
  18900. }
  18901. inline std::string get_cert_issuer_name(cert_t cert) {
  18902. if (!cert) return "";
  18903. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18904. // Build a human-readable issuer name string
  18905. char buf[512];
  18906. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18907. if (ret < 0) return "";
  18908. return std::string(buf);
  18909. }
  18910. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18911. sans.clear();
  18912. if (!cert) return false;
  18913. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18914. // Parse the Subject Alternative Name extension
  18915. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18916. while (cur != nullptr) {
  18917. if (cur->buf.len > 0) {
  18918. const unsigned char *p = cur->buf.p;
  18919. size_t value_len = cur->buf.len;
  18920. SanEntry entry;
  18921. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18922. case MBEDTLS_X509_SAN_DNS_NAME:
  18923. entry.type = SanType::DNS;
  18924. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18925. break;
  18926. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18927. entry.type = SanType::IP;
  18928. if (value_len == 4) {
  18929. // IPv4
  18930. char buf[16];
  18931. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18932. entry.value = buf;
  18933. } else if (value_len == 16) {
  18934. // IPv6
  18935. char buf[64];
  18936. snprintf(buf, sizeof(buf),
  18937. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18938. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18939. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18940. p[10], p[11], p[12], p[13], p[14], p[15]);
  18941. entry.value = buf;
  18942. }
  18943. break;
  18944. case MBEDTLS_X509_SAN_RFC822_NAME:
  18945. entry.type = SanType::EMAIL;
  18946. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18947. break;
  18948. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18949. entry.type = SanType::URI;
  18950. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18951. break;
  18952. default: entry.type = SanType::OTHER; break;
  18953. }
  18954. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18955. }
  18956. cur = cur->next;
  18957. }
  18958. return true;
  18959. }
  18960. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18961. time_t &not_after) {
  18962. if (!cert) return false;
  18963. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18964. // Convert mbedtls_x509_time to time_t
  18965. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18966. struct tm tm_time = {};
  18967. tm_time.tm_year = t.year - 1900;
  18968. tm_time.tm_mon = t.mon - 1;
  18969. tm_time.tm_mday = t.day;
  18970. tm_time.tm_hour = t.hour;
  18971. tm_time.tm_min = t.min;
  18972. tm_time.tm_sec = t.sec;
  18973. #ifdef _WIN32
  18974. return _mkgmtime(&tm_time);
  18975. #else
  18976. return timegm(&tm_time);
  18977. #endif
  18978. };
  18979. not_before = to_time_t(x509->valid_from);
  18980. not_after = to_time_t(x509->valid_to);
  18981. return true;
  18982. }
  18983. inline std::string get_cert_serial(cert_t cert) {
  18984. if (!cert) return "";
  18985. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18986. // Convert serial number to hex string
  18987. std::string result;
  18988. result.reserve(x509->serial.len * 2);
  18989. for (size_t i = 0; i < x509->serial.len; i++) {
  18990. char hex[3];
  18991. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18992. result += hex;
  18993. }
  18994. return result;
  18995. }
  18996. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18997. if (!cert) return false;
  18998. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18999. if (!crt->raw.p || crt->raw.len == 0) return false;
  19000. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  19001. return true;
  19002. }
  19003. inline const char *get_sni(const_session_t session) {
  19004. if (!session) return nullptr;
  19005. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  19006. // For server: return SNI received from client during handshake
  19007. if (!msession->sni_hostname.empty()) {
  19008. return msession->sni_hostname.c_str();
  19009. }
  19010. // For client: return the hostname set via set_sni
  19011. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  19012. return nullptr;
  19013. }
  19014. inline uint64_t peek_error() {
  19015. // Mbed TLS doesn't have an error queue, return the last error
  19016. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  19017. }
  19018. inline uint64_t get_error() {
  19019. // Mbed TLS doesn't have an error queue, return and clear the last error
  19020. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  19021. impl::mbedtls_last_error() = 0;
  19022. return err;
  19023. }
  19024. inline std::string error_string(uint64_t code) {
  19025. char buf[256];
  19026. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  19027. return std::string(buf);
  19028. }
  19029. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19030. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19031. // Parsing certificates needs PSA Crypto, and no context may exist yet
  19032. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  19033. #endif
  19034. if (!pem) { return nullptr; }
  19035. // mbedtls_x509_crt_parse expects null-terminated PEM
  19036. std::string pem_str(pem, len);
  19037. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  19038. if (!ca_chain) { return nullptr; }
  19039. mbedtls_x509_crt_init(ca_chain);
  19040. auto ret = mbedtls_x509_crt_parse(
  19041. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19042. pem_str.size() + 1);
  19043. if (ret != 0) {
  19044. mbedtls_x509_crt_free(ca_chain);
  19045. delete ca_chain;
  19046. return nullptr;
  19047. }
  19048. return static_cast<ca_store_t>(ca_chain);
  19049. }
  19050. inline void free_ca_store(ca_store_t store) {
  19051. if (store) {
  19052. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19053. mbedtls_x509_crt_free(ca_chain);
  19054. delete ca_chain;
  19055. }
  19056. }
  19057. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19058. if (!ctx || !store) { return false; }
  19059. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19060. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19061. // Free existing CA chain
  19062. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19063. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19064. // Copy the CA chain (deep copy)
  19065. // Parse from the raw data of the source cert
  19066. mbedtls_x509_crt *src = ca_chain;
  19067. while (src != nullptr) {
  19068. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19069. src->raw.len);
  19070. if (ret != 0) {
  19071. free_ca_store(store);
  19072. return false;
  19073. }
  19074. src = src->next;
  19075. }
  19076. // This function takes ownership of the store; the chain was deep-copied
  19077. // above, so release the source
  19078. free_ca_store(store);
  19079. // Update the SSL config to use the new CA chain
  19080. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19081. return true;
  19082. }
  19083. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19084. certs.clear();
  19085. if (!ctx) { return 0; }
  19086. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19087. // Owned by the context; see free_cert()
  19088. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19089. cert = cert->next) {
  19090. certs.push_back(static_cast<cert_t>(cert));
  19091. }
  19092. return certs.size();
  19093. }
  19094. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19095. std::vector<std::string> names;
  19096. if (!ctx) { return names; }
  19097. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19098. // Iterate through the CA chain
  19099. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19100. while (cert != nullptr && cert->raw.len > 0) {
  19101. char buf[512];
  19102. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19103. if (ret > 0) { names.push_back(buf); }
  19104. cert = cert->next;
  19105. }
  19106. return names;
  19107. }
  19108. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19109. const char *key_pem, const char *password) {
  19110. if (!ctx || !cert_pem || !key_pem) { return false; }
  19111. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19112. // Parse into new objects first, so that a bad pair leaves the old one in
  19113. // place, and swap them in after; the old ones are freed on the way out.
  19114. mbedtls_x509_crt cert;
  19115. mbedtls_pk_context key;
  19116. mbedtls_x509_crt_init(&cert);
  19117. mbedtls_pk_init(&key);
  19118. auto se = detail::scope_exit([&] {
  19119. mbedtls_x509_crt_free(&cert);
  19120. mbedtls_pk_free(&key);
  19121. });
  19122. // Parse certificate PEM
  19123. int ret = mbedtls_x509_crt_parse(
  19124. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19125. strlen(cert_pem) + 1);
  19126. if (ret != 0) {
  19127. impl::mbedtls_last_error() = ret;
  19128. return false;
  19129. }
  19130. // Parse private key PEM
  19131. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19132. ret = mbedtls_pk_parse_key(
  19133. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19134. strlen(key_pem) + 1,
  19135. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19136. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19137. &mbed_ctx->ctr_drbg);
  19138. #else
  19139. ret = mbedtls_pk_parse_key(
  19140. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19141. strlen(key_pem) + 1,
  19142. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19143. password ? strlen(password) : 0);
  19144. #endif
  19145. if (ret != 0) {
  19146. impl::mbedtls_last_error() = ret;
  19147. return false;
  19148. }
  19149. std::swap(mbed_ctx->own_cert, cert);
  19150. std::swap(mbed_ctx->own_key, key);
  19151. // Configure SSL to use the new certificate and key
  19152. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19153. &mbed_ctx->own_key);
  19154. if (ret != 0) {
  19155. impl::mbedtls_last_error() = ret;
  19156. return false;
  19157. }
  19158. return true;
  19159. }
  19160. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19161. if (!ctx || !ca_pem) { return false; }
  19162. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19163. // Parse into a new chain first, so that a bad one leaves the old in place
  19164. mbedtls_x509_crt chain;
  19165. mbedtls_x509_crt_init(&chain);
  19166. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19167. // Parse CA PEM
  19168. int ret = mbedtls_x509_crt_parse(
  19169. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19170. strlen(ca_pem) + 1);
  19171. if (ret != 0) {
  19172. impl::mbedtls_last_error() = ret;
  19173. return false;
  19174. }
  19175. std::swap(mbed_ctx->ca_chain, chain);
  19176. // Update SSL config to use new CA chain
  19177. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19178. return true;
  19179. }
  19180. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19181. if (!ctx) { return false; }
  19182. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19183. // create_session() hands each session its own copy to run.
  19184. mbed_ctx->verify_callback = std::move(callback);
  19185. impl::apply_verify_mode(*mbed_ctx);
  19186. return true;
  19187. }
  19188. inline long get_verify_error(const_session_t session) {
  19189. if (!session) { return -1; }
  19190. auto *msession =
  19191. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19192. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19193. }
  19194. inline std::string verify_error_string(long error_code) {
  19195. if (error_code == 0) { return ""; }
  19196. char buf[256];
  19197. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19198. static_cast<uint32_t>(error_code));
  19199. // Remove trailing newline if present
  19200. std::string result(buf);
  19201. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19202. result.pop_back();
  19203. }
  19204. return result;
  19205. }
  19206. } // namespace tls
  19207. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19208. /*
  19209. * Group 10: TLS abstraction layer - wolfSSL backend
  19210. */
  19211. /*
  19212. * wolfSSL Backend Implementation
  19213. */
  19214. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19215. namespace tls {
  19216. namespace impl {
  19217. // wolfSSL session wrapper
  19218. struct WolfSSLSession {
  19219. WOLFSSL *ssl = nullptr;
  19220. socket_t sock = INVALID_SOCKET;
  19221. std::string hostname; // For client: set via set_sni
  19222. std::string sni_hostname; // For server: received from client via SNI callback
  19223. WolfSSLSession() = default;
  19224. ~WolfSSLSession() {
  19225. if (ssl) { wolfSSL_free(ssl); }
  19226. }
  19227. WolfSSLSession(const WolfSSLSession &) = delete;
  19228. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19229. };
  19230. // Thread-local error code accessor for wolfSSL
  19231. inline uint64_t &wolfssl_last_error() {
  19232. static thread_local uint64_t err = 0;
  19233. return err;
  19234. }
  19235. // Helper to map wolfSSL error to ErrorCode.
  19236. // ssl_error is the value from wolfSSL_get_error().
  19237. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19238. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19239. int &out_errno) {
  19240. switch (ssl_error) {
  19241. case SSL_ERROR_NONE: return ErrorCode::Success;
  19242. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19243. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19244. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19245. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19246. // EOF without close_notify
  19247. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19248. default:
  19249. if (ssl) {
  19250. // wolfSSL stores the low-level error code as a negative value.
  19251. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19252. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19253. if (low_err == DOMAIN_NAME_MISMATCH) {
  19254. return ErrorCode::HostnameMismatch;
  19255. }
  19256. // Check verify result to distinguish cert verification from generic SSL
  19257. // errors.
  19258. long vr = wolfSSL_get_verify_result(ssl);
  19259. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19260. }
  19261. return ErrorCode::Fatal;
  19262. }
  19263. }
  19264. // WolfSSLContext constructor/destructor implementations
  19265. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19266. inline WolfSSLContext::~WolfSSLContext() {
  19267. if (ctx) { wolfSSL_CTX_free(ctx); }
  19268. }
  19269. // Thread-local storage for SNI captured during handshake
  19270. inline std::string &wolfssl_pending_sni() {
  19271. static thread_local std::string sni;
  19272. return sni;
  19273. }
  19274. // SNI callback for wolfSSL server to capture client's SNI hostname
  19275. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19276. (void)ret;
  19277. (void)exArg;
  19278. void *name_data = nullptr;
  19279. unsigned short name_len =
  19280. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19281. if (name_data && name_len > 0) {
  19282. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19283. name_len);
  19284. } else {
  19285. wolfssl_pending_sni().clear();
  19286. }
  19287. return 0; // Continue regardless
  19288. }
  19289. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19290. // runs the verify callback of its own context.
  19291. inline int context_ex_data_index() {
  19292. static const auto index =
  19293. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19294. return index;
  19295. }
  19296. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19297. // other tls:: function takes.
  19298. inline int session_ex_data_index() {
  19299. static const auto index =
  19300. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19301. return index;
  19302. }
  19303. // A resumed session skips the client's certificate, so a server that checks
  19304. // one would let in a certificate checked against another server's CA, as
  19305. // wolfSSL shares its session cache between contexts, or against a CA since
  19306. // replaced by update_server_client_ca().
  19307. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19308. if (!wctx->is_server) { return; }
  19309. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19310. #ifdef HAVE_SESSION_TICKET
  19311. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19312. #endif
  19313. }
  19314. // wolfSSL verify callback wrapper
  19315. inline int wolfssl_verify_callback(int preverify_ok,
  19316. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19317. // Get the WOLFSSL object from the X509_STORE_CTX
  19318. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19319. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19320. if (!ssl) { return preverify_ok; }
  19321. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19322. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19323. if (!wctx) { return preverify_ok; }
  19324. std::shared_ptr<VerifyCallback> callback;
  19325. {
  19326. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19327. callback = wctx->verify_callback;
  19328. }
  19329. if (!callback) { return preverify_ok; }
  19330. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19331. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19332. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19333. VerifyContext verify_ctx;
  19334. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19335. verify_ctx.cert = static_cast<cert_t>(cert);
  19336. verify_ctx.depth = depth;
  19337. verify_ctx.preverify_ok = (preverify_ok != 0);
  19338. verify_ctx.error_code = static_cast<long>(err);
  19339. if (err != 0) {
  19340. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19341. } else {
  19342. verify_ctx.error_string = nullptr;
  19343. }
  19344. auto accepted = run_verify_callback(*callback, verify_ctx);
  19345. // A client verifying the server during the handshake, which is what
  19346. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19347. if (!wolfSSL_is_server(ssl) &&
  19348. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19349. accepted = accepted && preverify_ok;
  19350. }
  19351. return accepted ? 1 : 0;
  19352. }
  19353. // Sets the verify mode from whether the peer's certificate is required and
  19354. // whether a verify callback is set.
  19355. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19356. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19357. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19358. auto mode = wctx.verify_client
  19359. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19360. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19361. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19362. has_callback ? wolfssl_verify_callback : nullptr);
  19363. }
  19364. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19365. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19366. wolfSSL_CTX_set_default_passwd_cb(
  19367. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19368. auto *pwd = static_cast<const char *>(userdata);
  19369. if (!pwd) return 0;
  19370. auto len = static_cast<int>(strlen(pwd));
  19371. if (len > size) len = size;
  19372. memcpy(buf, pwd, static_cast<size_t>(len));
  19373. return len;
  19374. });
  19375. }
  19376. } // namespace impl
  19377. inline ctx_t create_client_context() {
  19378. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19379. if (!ctx) { return nullptr; }
  19380. ctx->is_server = false;
  19381. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19382. if (!method) {
  19383. delete ctx;
  19384. return nullptr;
  19385. }
  19386. ctx->ctx = wolfSSL_CTX_new(method);
  19387. if (!ctx->ctx ||
  19388. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19389. WOLFSSL_SUCCESS) {
  19390. delete ctx;
  19391. return nullptr;
  19392. }
  19393. // Default: verify peer certificate
  19394. ctx->verify_client = true;
  19395. impl::apply_verify_mode(*ctx);
  19396. return static_cast<ctx_t>(ctx);
  19397. }
  19398. inline ctx_t create_server_context() {
  19399. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19400. if (!ctx) { return nullptr; }
  19401. ctx->is_server = true;
  19402. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19403. if (!method) {
  19404. delete ctx;
  19405. return nullptr;
  19406. }
  19407. ctx->ctx = wolfSSL_CTX_new(method);
  19408. if (!ctx->ctx ||
  19409. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19410. WOLFSSL_SUCCESS) {
  19411. delete ctx;
  19412. return nullptr;
  19413. }
  19414. // Default: don't verify client
  19415. impl::apply_verify_mode(*ctx);
  19416. // Enable SNI on server
  19417. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19418. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19419. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19420. return static_cast<ctx_t>(ctx);
  19421. }
  19422. inline void free_context(ctx_t ctx) {
  19423. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19424. }
  19425. inline bool set_min_version(ctx_t ctx, Version version) {
  19426. if (!ctx) { return false; }
  19427. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19428. int min_ver = WOLFSSL_TLSV1_2;
  19429. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19430. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19431. }
  19432. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19433. if (!ctx || !pem) { return false; }
  19434. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19435. int ret = wolfSSL_CTX_load_verify_buffer(
  19436. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19437. static_cast<long>(len), SSL_FILETYPE_PEM);
  19438. if (ret != SSL_SUCCESS) {
  19439. impl::wolfssl_last_error() =
  19440. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19441. return false;
  19442. }
  19443. wctx->ca_pem_data_.append(pem, len);
  19444. return true;
  19445. }
  19446. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19447. if (!ctx || !file_path) { return false; }
  19448. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19449. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19450. if (ret != SSL_SUCCESS) {
  19451. impl::wolfssl_last_error() =
  19452. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19453. return false;
  19454. }
  19455. return true;
  19456. }
  19457. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19458. if (!ctx || !dir_path) { return false; }
  19459. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19460. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19461. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19462. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19463. // immediately. Return true even on failure since the CA file may have
  19464. // already been loaded, matching OpenSSL's lenient behavior.
  19465. (void)ret;
  19466. return true;
  19467. }
  19468. inline bool load_system_certs(ctx_t ctx) {
  19469. if (!ctx) { return false; }
  19470. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19471. bool loaded = false;
  19472. #ifdef _WIN32
  19473. loaded = impl::enumerate_windows_system_certs(
  19474. [&](const unsigned char *data, size_t len) {
  19475. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19476. static_cast<long>(len),
  19477. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19478. });
  19479. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19480. loaded = impl::enumerate_macos_keychain_certs(
  19481. [&](const unsigned char *data, size_t len) {
  19482. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19483. static_cast<long>(len),
  19484. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19485. });
  19486. #else
  19487. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19488. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19489. SSL_SUCCESS) {
  19490. loaded = true;
  19491. break;
  19492. }
  19493. }
  19494. if (!loaded) {
  19495. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19496. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19497. SSL_SUCCESS) {
  19498. loaded = true;
  19499. break;
  19500. }
  19501. }
  19502. }
  19503. #endif
  19504. return loaded;
  19505. }
  19506. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19507. const char *password) {
  19508. if (!ctx || !cert || !key) { return false; }
  19509. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19510. // Load certificate
  19511. int ret = wolfSSL_CTX_use_certificate_buffer(
  19512. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19513. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19514. if (ret != SSL_SUCCESS) {
  19515. impl::wolfssl_last_error() =
  19516. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19517. return false;
  19518. }
  19519. // Set password callback if password is provided
  19520. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19521. // Load private key
  19522. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19523. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19524. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19525. if (ret != SSL_SUCCESS) {
  19526. impl::wolfssl_last_error() =
  19527. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19528. return false;
  19529. }
  19530. // Verify that the certificate and private key match
  19531. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19532. }
  19533. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19534. const char *key_path, const char *password) {
  19535. if (!ctx || !cert_path || !key_path) { return false; }
  19536. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19537. // Load certificate file
  19538. int ret =
  19539. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19540. if (ret != SSL_SUCCESS) {
  19541. impl::wolfssl_last_error() =
  19542. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19543. return false;
  19544. }
  19545. // Set password callback if password is provided
  19546. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19547. // Load private key file
  19548. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19549. if (ret != SSL_SUCCESS) {
  19550. impl::wolfssl_last_error() =
  19551. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19552. return false;
  19553. }
  19554. // Verify that the certificate and private key match
  19555. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19556. }
  19557. inline void set_verify_client(ctx_t ctx, bool require) {
  19558. if (!ctx) { return; }
  19559. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19560. wctx->verify_client = require;
  19561. impl::apply_verify_mode(*wctx);
  19562. }
  19563. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19564. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19565. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19566. auto session = new (std::nothrow) impl::WolfSSLSession();
  19567. if (!session) { return nullptr; }
  19568. session->sock = sock;
  19569. session->ssl = wolfSSL_new(wctx->ctx);
  19570. if (!session->ssl) {
  19571. impl::wolfssl_last_error() =
  19572. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19573. delete session;
  19574. return nullptr;
  19575. }
  19576. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19577. session) != WOLFSSL_SUCCESS) {
  19578. delete session;
  19579. return nullptr;
  19580. }
  19581. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19582. return static_cast<session_t>(session);
  19583. }
  19584. inline void free_session(session_t session) {
  19585. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19586. }
  19587. inline bool set_sni(session_t session, const char *hostname,
  19588. bool verify_hostname) {
  19589. if (!session || !hostname) { return false; }
  19590. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19591. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19592. static_cast<word16>(strlen(hostname)));
  19593. if (ret != WOLFSSL_SUCCESS) {
  19594. impl::wolfssl_last_error() =
  19595. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19596. return false;
  19597. }
  19598. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19599. // separately from the SNI extension sent above; skip it when hostname
  19600. // verification is disabled so only the chain is checked, matching OpenSSL.
  19601. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19602. wsession->hostname = hostname;
  19603. return true;
  19604. }
  19605. inline TlsError connect(session_t session) {
  19606. TlsError err;
  19607. if (!session) {
  19608. err.code = ErrorCode::Fatal;
  19609. return err;
  19610. }
  19611. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19612. int ret = wolfSSL_connect(wsession->ssl);
  19613. if (ret == SSL_SUCCESS) {
  19614. err.code = ErrorCode::Success;
  19615. } else {
  19616. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19617. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19618. err.backend_code = static_cast<uint64_t>(ssl_error);
  19619. impl::wolfssl_last_error() = err.backend_code;
  19620. }
  19621. return err;
  19622. }
  19623. inline TlsError accept(session_t session) {
  19624. TlsError err;
  19625. if (!session) {
  19626. err.code = ErrorCode::Fatal;
  19627. return err;
  19628. }
  19629. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19630. int ret = wolfSSL_accept(wsession->ssl);
  19631. if (ret == SSL_SUCCESS) {
  19632. err.code = ErrorCode::Success;
  19633. // Capture SNI from thread-local storage after successful handshake
  19634. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19635. impl::wolfssl_pending_sni().clear();
  19636. } else {
  19637. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19638. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19639. err.backend_code = static_cast<uint64_t>(ssl_error);
  19640. impl::wolfssl_last_error() = err.backend_code;
  19641. }
  19642. return err;
  19643. }
  19644. inline bool connect_nonblocking(session_t session, socket_t sock,
  19645. time_t timeout_sec, time_t timeout_usec,
  19646. TlsError *err) {
  19647. if (!session) {
  19648. if (err) { err->code = ErrorCode::Fatal; }
  19649. return false;
  19650. }
  19651. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19652. // Set socket to non-blocking mode
  19653. detail::set_nonblocking(sock, true);
  19654. auto cleanup =
  19655. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19656. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19657. int ret;
  19658. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19659. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19660. if (ssl_error == SSL_ERROR_WANT_READ) {
  19661. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19662. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19663. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19664. }
  19665. // Error or timeout
  19666. if (err) {
  19667. err->code =
  19668. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19669. err->backend_code = static_cast<uint64_t>(ssl_error);
  19670. }
  19671. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19672. return false;
  19673. }
  19674. if (err) { err->code = ErrorCode::Success; }
  19675. return true;
  19676. }
  19677. inline bool accept_nonblocking(session_t session, socket_t sock,
  19678. time_t timeout_sec, time_t timeout_usec,
  19679. TlsError *err) {
  19680. if (!session) {
  19681. if (err) { err->code = ErrorCode::Fatal; }
  19682. return false;
  19683. }
  19684. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19685. // Set socket to non-blocking mode
  19686. detail::set_nonblocking(sock, true);
  19687. auto cleanup =
  19688. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19689. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19690. int ret;
  19691. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19692. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19693. if (ssl_error == SSL_ERROR_WANT_READ) {
  19694. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19695. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19696. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19697. }
  19698. // Error or timeout
  19699. if (err) {
  19700. err->code =
  19701. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19702. err->backend_code = static_cast<uint64_t>(ssl_error);
  19703. }
  19704. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19705. return false;
  19706. }
  19707. if (err) { err->code = ErrorCode::Success; }
  19708. // Capture SNI from thread-local storage after successful handshake
  19709. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19710. impl::wolfssl_pending_sni().clear();
  19711. return true;
  19712. }
  19713. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19714. if (!session || !buf) {
  19715. err.code = ErrorCode::Fatal;
  19716. return -1;
  19717. }
  19718. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19719. constexpr auto max_len =
  19720. static_cast<size_t>((std::numeric_limits<int>::max)());
  19721. if (len > max_len) { len = max_len; }
  19722. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19723. if (ret > 0) {
  19724. err.code = ErrorCode::Success;
  19725. return static_cast<ssize_t>(ret);
  19726. }
  19727. // 0 is also returned for EOF without close_notify; get_error tells them apart
  19728. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19729. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19730. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19731. err.backend_code = static_cast<uint64_t>(ssl_error);
  19732. impl::wolfssl_last_error() = err.backend_code;
  19733. return -1;
  19734. }
  19735. inline ssize_t write(session_t session, const void *buf, size_t len,
  19736. TlsError &err) {
  19737. if (!session || !buf) {
  19738. err.code = ErrorCode::Fatal;
  19739. return -1;
  19740. }
  19741. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19742. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19743. if (ret > 0) {
  19744. err.code = ErrorCode::Success;
  19745. return static_cast<ssize_t>(ret);
  19746. }
  19747. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19748. // Treat this as an error (return -1) so callers don't spin in a
  19749. // write loop adding zero to the offset.
  19750. if (ret == 0) {
  19751. err.code = ErrorCode::PeerClosed;
  19752. return -1;
  19753. }
  19754. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19755. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19756. err.backend_code = static_cast<uint64_t>(ssl_error);
  19757. impl::wolfssl_last_error() = err.backend_code;
  19758. return -1;
  19759. }
  19760. inline int pending(const_session_t session) {
  19761. if (!session) { return 0; }
  19762. auto wsession =
  19763. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19764. return wolfSSL_pending(wsession->ssl);
  19765. }
  19766. inline void shutdown(session_t session, bool graceful) {
  19767. if (!session) { return; }
  19768. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19769. if (graceful) {
  19770. int ret;
  19771. int attempts = 0;
  19772. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19773. attempts < 3) {
  19774. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19775. if (ssl_error != SSL_ERROR_WANT_READ &&
  19776. ssl_error != SSL_ERROR_WANT_WRITE) {
  19777. break;
  19778. }
  19779. attempts++;
  19780. }
  19781. } else {
  19782. wolfSSL_shutdown(wsession->ssl);
  19783. }
  19784. }
  19785. inline bool is_peer_closed(session_t session, socket_t sock) {
  19786. if (!session || sock == INVALID_SOCKET) { return true; }
  19787. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19788. // Check if there's already decrypted data available
  19789. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19790. // Set socket to non-blocking to avoid blocking on read
  19791. detail::set_nonblocking(sock, true);
  19792. auto cleanup =
  19793. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19794. // Peek 1 byte to check connection status without consuming data
  19795. unsigned char buf;
  19796. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19797. // If we got data or WANT_READ (would block), connection is alive
  19798. if (ret > 0) { return false; }
  19799. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19800. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19801. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19802. ret == 0;
  19803. }
  19804. inline cert_t get_peer_cert(const_session_t session) {
  19805. if (!session) { return nullptr; }
  19806. auto wsession =
  19807. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19808. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19809. return static_cast<cert_t>(cert);
  19810. }
  19811. inline size_t get_peer_certs(const_session_t session,
  19812. std::vector<cert_t> &certs) {
  19813. certs.clear();
  19814. if (!session) { return 0; }
  19815. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19816. #ifdef SESSION_CERTS
  19817. auto wsession =
  19818. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19819. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19820. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19821. for (int i = 0; i < count; i++) {
  19822. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19823. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19824. }
  19825. #endif
  19826. return certs.size();
  19827. }
  19828. inline void free_cert(cert_t cert) {
  19829. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19830. }
  19831. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19832. if (!cert || !hostname) { return false; }
  19833. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19834. std::string host_str(hostname);
  19835. // Check if hostname is an IP address (IPv4 or IPv6)
  19836. unsigned char ip_bytes[16];
  19837. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19838. auto is_ip = ip_len > 0;
  19839. // Check Subject Alternative Names
  19840. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19841. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19842. if (san_names) {
  19843. int san_count = wolfSSL_sk_num(san_names);
  19844. for (int i = 0; i < san_count; i++) {
  19845. auto *names =
  19846. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19847. if (!names) continue;
  19848. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19849. // DNS name
  19850. unsigned char *dns_name = nullptr;
  19851. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19852. if (dns_name && dns_len > 0) {
  19853. std::string san_name(reinterpret_cast<char *>(dns_name),
  19854. static_cast<size_t>(dns_len));
  19855. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19856. if (detail::match_hostname(san_name, host_str)) {
  19857. wolfSSL_sk_free(san_names);
  19858. return true;
  19859. }
  19860. }
  19861. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19862. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19863. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19864. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19865. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19866. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19867. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19868. wolfSSL_sk_free(san_names);
  19869. return true;
  19870. }
  19871. }
  19872. }
  19873. wolfSSL_sk_free(san_names);
  19874. }
  19875. return false;
  19876. }
  19877. inline uint64_t hostname_mismatch_code() {
  19878. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19879. }
  19880. inline long get_verify_result(const_session_t session) {
  19881. if (!session) { return -1; }
  19882. auto wsession =
  19883. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19884. long result = wolfSSL_get_verify_result(wsession->ssl);
  19885. return result;
  19886. }
  19887. inline std::string get_cert_subject_cn(cert_t cert) {
  19888. if (!cert) return "";
  19889. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19890. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19891. if (!subject) return "";
  19892. char cn[256] = {};
  19893. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19894. sizeof(cn));
  19895. if (cn_len <= 0) return "";
  19896. return std::string(cn, static_cast<size_t>(cn_len));
  19897. }
  19898. inline std::string get_cert_issuer_name(cert_t cert) {
  19899. if (!cert) return "";
  19900. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19901. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19902. if (!issuer) return "";
  19903. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19904. if (!name_str) return "";
  19905. std::string result(name_str);
  19906. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19907. return result;
  19908. }
  19909. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19910. sans.clear();
  19911. if (!cert) return false;
  19912. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19913. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19914. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19915. if (!san_names) return true; // No SANs is not an error
  19916. int count = wolfSSL_sk_num(san_names);
  19917. for (int i = 0; i < count; i++) {
  19918. auto *name =
  19919. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19920. if (!name) continue;
  19921. SanEntry entry;
  19922. switch (name->type) {
  19923. case WOLFSSL_GEN_DNS: {
  19924. entry.type = SanType::DNS;
  19925. unsigned char *dns_name = nullptr;
  19926. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19927. if (dns_name && dns_len > 0) {
  19928. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19929. static_cast<size_t>(dns_len));
  19930. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19931. }
  19932. break;
  19933. }
  19934. case WOLFSSL_GEN_IPADD: {
  19935. entry.type = SanType::IP;
  19936. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19937. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19938. if (ip_data && ip_len == 4) {
  19939. char buf[16];
  19940. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19941. ip_data[2], ip_data[3]);
  19942. entry.value = buf;
  19943. } else if (ip_data && ip_len == 16) {
  19944. char buf[64];
  19945. snprintf(buf, sizeof(buf),
  19946. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19947. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19948. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19949. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19950. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19951. ip_data[14], ip_data[15]);
  19952. entry.value = buf;
  19953. }
  19954. break;
  19955. }
  19956. case WOLFSSL_GEN_EMAIL:
  19957. entry.type = SanType::EMAIL;
  19958. {
  19959. unsigned char *email = nullptr;
  19960. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19961. if (email && email_len > 0) {
  19962. entry.value = std::string(reinterpret_cast<char *>(email),
  19963. static_cast<size_t>(email_len));
  19964. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19965. }
  19966. }
  19967. break;
  19968. case WOLFSSL_GEN_URI:
  19969. entry.type = SanType::URI;
  19970. {
  19971. unsigned char *uri = nullptr;
  19972. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19973. &uri, name->d.uniformResourceIdentifier);
  19974. if (uri && uri_len > 0) {
  19975. entry.value = std::string(reinterpret_cast<char *>(uri),
  19976. static_cast<size_t>(uri_len));
  19977. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19978. }
  19979. }
  19980. break;
  19981. default: entry.type = SanType::OTHER; break;
  19982. }
  19983. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19984. }
  19985. wolfSSL_sk_free(san_names);
  19986. return true;
  19987. }
  19988. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19989. time_t &not_after) {
  19990. if (!cert) return false;
  19991. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19992. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19993. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19994. if (!nb || !na) return false;
  19995. // wolfSSL_ASN1_TIME_to_tm is available
  19996. struct tm tm_nb = {}, tm_na = {};
  19997. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19998. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19999. #ifdef _WIN32
  20000. not_before = _mkgmtime(&tm_nb);
  20001. not_after = _mkgmtime(&tm_na);
  20002. #else
  20003. not_before = timegm(&tm_nb);
  20004. not_after = timegm(&tm_na);
  20005. #endif
  20006. return true;
  20007. }
  20008. inline std::string get_cert_serial(cert_t cert) {
  20009. if (!cert) return "";
  20010. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20011. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  20012. if (!serial_asn1) return "";
  20013. // Get the serial number data
  20014. int len = serial_asn1->length;
  20015. unsigned char *data = serial_asn1->data;
  20016. if (!data || len <= 0) return "";
  20017. std::string result;
  20018. result.reserve(static_cast<size_t>(len) * 2);
  20019. for (int i = 0; i < len; i++) {
  20020. char hex[3];
  20021. snprintf(hex, sizeof(hex), "%02X", data[i]);
  20022. result += hex;
  20023. }
  20024. return result;
  20025. }
  20026. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20027. if (!cert) return false;
  20028. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20029. int der_len = 0;
  20030. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  20031. if (!der_data || der_len <= 0) return false;
  20032. der.assign(der_data, der_data + der_len);
  20033. return true;
  20034. }
  20035. inline const char *get_sni(const_session_t session) {
  20036. if (!session) return nullptr;
  20037. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  20038. // For server: return SNI received from client during handshake
  20039. if (!wsession->sni_hostname.empty()) {
  20040. return wsession->sni_hostname.c_str();
  20041. }
  20042. // For client: return the hostname set via set_sni
  20043. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  20044. return nullptr;
  20045. }
  20046. inline uint64_t peek_error() {
  20047. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20048. }
  20049. inline uint64_t get_error() {
  20050. uint64_t err = impl::wolfssl_last_error();
  20051. impl::wolfssl_last_error() = 0;
  20052. return err;
  20053. }
  20054. inline std::string error_string(uint64_t code) {
  20055. char buf[256];
  20056. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20057. return std::string(buf);
  20058. }
  20059. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20060. if (!pem || len == 0) { return nullptr; }
  20061. // Validate by attempting to load into a temporary ctx
  20062. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20063. if (!tmp_ctx) { return nullptr; }
  20064. int ret = wolfSSL_CTX_load_verify_buffer(
  20065. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20066. static_cast<long>(len), SSL_FILETYPE_PEM);
  20067. wolfSSL_CTX_free(tmp_ctx);
  20068. if (ret != SSL_SUCCESS) { return nullptr; }
  20069. return static_cast<ca_store_t>(
  20070. new impl::WolfSSLCAStore{std::string(pem, len)});
  20071. }
  20072. inline void free_ca_store(ca_store_t store) {
  20073. delete static_cast<impl::WolfSSLCAStore *>(store);
  20074. }
  20075. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20076. if (!ctx || !store) { return false; }
  20077. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20078. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20079. int ret = wolfSSL_CTX_load_verify_buffer(
  20080. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20081. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20082. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20083. // This function takes ownership of the store; the PEM data was copied into
  20084. // the context, so release the source
  20085. free_ca_store(store);
  20086. return ret == SSL_SUCCESS;
  20087. }
  20088. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20089. certs.clear();
  20090. if (!ctx) { return 0; }
  20091. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20092. if (wctx->ca_pem_data_.empty()) { return 0; }
  20093. const std::string &pem = wctx->ca_pem_data_;
  20094. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20095. const std::string end_marker = "-----END CERTIFICATE-----";
  20096. size_t pos = 0;
  20097. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20098. size_t end_pos = pem.find(end_marker, pos);
  20099. if (end_pos == std::string::npos) { break; }
  20100. end_pos += end_marker.size();
  20101. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20102. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20103. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20104. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20105. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20106. pos = end_pos;
  20107. }
  20108. return certs.size();
  20109. }
  20110. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20111. std::vector<std::string> names;
  20112. if (!ctx) { return names; }
  20113. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20114. if (wctx->ca_pem_data_.empty()) { return names; }
  20115. const std::string &pem = wctx->ca_pem_data_;
  20116. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20117. const std::string end_marker = "-----END CERTIFICATE-----";
  20118. size_t pos = 0;
  20119. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20120. size_t end_pos = pem.find(end_marker, pos);
  20121. if (end_pos == std::string::npos) { break; }
  20122. end_pos += end_marker.size();
  20123. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20124. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20125. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20126. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20127. if (x509) {
  20128. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20129. if (subject) {
  20130. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20131. if (name_str) {
  20132. names.push_back(name_str);
  20133. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20134. }
  20135. }
  20136. wolfSSL_X509_free(x509);
  20137. }
  20138. pos = end_pos;
  20139. }
  20140. return names;
  20141. }
  20142. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20143. const char *key_pem, const char *password) {
  20144. if (!ctx || !cert_pem || !key_pem) { return false; }
  20145. // Try the pair on a scratch context first, so that a bad one leaves the
  20146. // server's certificate and key as they were
  20147. auto tmp = create_server_context();
  20148. if (!tmp) { return false; }
  20149. auto se = detail::scope_exit([&] { free_context(tmp); });
  20150. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20151. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20152. }
  20153. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20154. if (!ctx || !ca_pem) { return false; }
  20155. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20156. // Replace the CAs rather than add to them, as the other backends do, once
  20157. // the new ones are known to load
  20158. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20159. if (!store) { return false; }
  20160. free_ca_store(store);
  20161. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20162. wctx->ca_pem_data_.clear();
  20163. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20164. }
  20165. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20166. if (!ctx) { return false; }
  20167. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20168. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20169. : nullptr;
  20170. {
  20171. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20172. // A handshake running the previous callback keeps it until it returns.
  20173. wctx->verify_callback.swap(stored);
  20174. }
  20175. impl::apply_verify_mode(*wctx);
  20176. return true;
  20177. }
  20178. inline long get_verify_error(const_session_t session) {
  20179. if (!session) { return -1; }
  20180. auto *wsession =
  20181. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20182. return wolfSSL_get_verify_result(wsession->ssl);
  20183. }
  20184. inline std::string verify_error_string(long error_code) {
  20185. if (error_code == 0) { return ""; }
  20186. const char *str =
  20187. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20188. return str ? std::string(str) : std::string();
  20189. }
  20190. } // namespace tls
  20191. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20192. // WebSocket implementation
  20193. namespace ws {
  20194. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20195. bool fin) {
  20196. std::lock_guard<std::mutex> lock(write_mutex_);
  20197. if (closed_) { return false; }
  20198. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20199. }
  20200. inline ReadResult WebSocket::read(std::string &msg) {
  20201. // Answers a control frame; any other opcode here is a protocol error.
  20202. // Returns false when the connection is done.
  20203. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20204. switch (op) {
  20205. case Opcode::Ping: {
  20206. std::lock_guard<std::mutex> lock(write_mutex_);
  20207. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20208. payload.size(), true, !is_server_);
  20209. return true;
  20210. }
  20211. case Opcode::Pong: {
  20212. std::lock_guard<std::mutex> lock(ping_mutex_);
  20213. unacked_pings_ = 0;
  20214. return true;
  20215. }
  20216. case Opcode::Close: {
  20217. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20218. // malformed, which is answered with a protocol error instead.
  20219. if (closed_.exchange(true)) { return false; }
  20220. auto reply = payload;
  20221. if (!impl::is_valid_close_payload(payload)) {
  20222. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20223. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20224. }
  20225. std::lock_guard<std::mutex> lock(write_mutex_);
  20226. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20227. reply.size(), true, !is_server_);
  20228. return false;
  20229. }
  20230. default: closed_ = true; return false;
  20231. }
  20232. };
  20233. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20234. while (!closed_) {
  20235. Opcode opcode;
  20236. std::string payload;
  20237. bool fin;
  20238. impl::FrameRead r =
  20239. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  20240. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  20241. // A timeout landed on a frame boundary of an open connection: it is
  20242. // untouched and still usable, so hand control back without closing it.
  20243. // That is only useful to a caller who asked for the timeout; the
  20244. // compile-time default is a backstop against a peer gone quiet, and
  20245. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  20246. // ends. A wait that a pong timeout cut short finds the connection closed.
  20247. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20248. return Timeout;
  20249. }
  20250. if (r != impl::FrameRead::Ok) {
  20251. closed_ = true;
  20252. return Fail;
  20253. }
  20254. switch (opcode) {
  20255. case Opcode::Text:
  20256. case Opcode::Binary: {
  20257. auto result = opcode == Opcode::Text ? Text : Binary;
  20258. msg = std::move(payload);
  20259. // Handle fragmentation
  20260. if (!fin) {
  20261. while (true) {
  20262. Opcode cont_opcode;
  20263. std::string cont_payload;
  20264. bool cont_fin;
  20265. // Only what is left of the limit, but room for a control frame,
  20266. // which may come between the fragments.
  20267. auto max_len =
  20268. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  20269. ? size_t(0)
  20270. : (std::max)(size_t(125),
  20271. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20272. msg.size());
  20273. // A timeout is not reportable here: half of a fragmented message is
  20274. // already in `msg` and read() has no way to resume it, so it is a
  20275. // failure like any other. Timeouts are only ever seen on a message
  20276. // boundary.
  20277. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  20278. cont_fin, is_server_,
  20279. max_len) != impl::FrameRead::Ok) {
  20280. closed_ = true;
  20281. return Fail;
  20282. }
  20283. // RFC 6455 5.4: the fragments are continuation frames, with only
  20284. // control frames between them.
  20285. if (cont_opcode != Opcode::Continuation) {
  20286. if (handle_control(cont_opcode, cont_payload)) { continue; }
  20287. return Fail;
  20288. }
  20289. msg += cont_payload;
  20290. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20291. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20292. closed_ = true;
  20293. return Fail;
  20294. }
  20295. if (cont_fin) { break; }
  20296. }
  20297. }
  20298. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20299. if (result == Text && !impl::is_valid_utf8(msg)) {
  20300. // close() takes the read lock to wait for the peer's Close reply, so
  20301. // it must not run while this thread still holds it.
  20302. read_lock.unlock();
  20303. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20304. return Fail;
  20305. }
  20306. return result;
  20307. }
  20308. default:
  20309. if (handle_control(opcode, payload)) { continue; }
  20310. return Fail;
  20311. }
  20312. }
  20313. return Fail;
  20314. }
  20315. inline bool WebSocket::send(const std::string &data) {
  20316. return send_frame(Opcode::Text, data.data(), data.size());
  20317. }
  20318. inline bool WebSocket::send(const char *data, size_t len) {
  20319. return send_frame(Opcode::Binary, data, len);
  20320. }
  20321. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20322. if (closed_.exchange(true)) { return; }
  20323. ping_cv_.notify_all();
  20324. std::string payload;
  20325. auto code = static_cast<uint16_t>(status);
  20326. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20327. payload.push_back(static_cast<char>(code & 0xFF));
  20328. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20329. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20330. // cut back to a whole UTF-8 character
  20331. auto short_reason = reason.substr(0, 123);
  20332. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20333. short_reason.pop_back();
  20334. }
  20335. payload += short_reason;
  20336. // A code that may not be sent, such as NoStatus, goes without a payload
  20337. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20338. {
  20339. std::lock_guard<std::mutex> lock(write_mutex_);
  20340. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20341. payload.size(), true, !is_server_);
  20342. }
  20343. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20344. // Close response before closing the TCP connection.
  20345. //
  20346. // Wait only when no other thread is parsing frames. When one is, it is the
  20347. // thread positioned to see the peer's reply, and reading here would take
  20348. // bytes out of the message it is assembling. Bailing out also leaves the
  20349. // stream, including its read timeout, entirely to that thread.
  20350. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20351. if (!read_lock.owns_lock()) { return; }
  20352. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20353. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20354. Opcode op;
  20355. std::string resp;
  20356. bool fin;
  20357. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20358. impl::FrameRead::Ok) {
  20359. if (op == Opcode::Close) { break; }
  20360. }
  20361. }
  20362. inline WebSocket::~WebSocket() {
  20363. {
  20364. std::lock_guard<std::mutex> lock(ping_mutex_);
  20365. closed_ = true;
  20366. }
  20367. ping_cv_.notify_all();
  20368. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20369. // A server's stream outlives this object
  20370. strm_.set_read_interrupt(nullptr);
  20371. }
  20372. inline void WebSocket::start_heartbeat() {
  20373. if (ping_interval_sec_ <= 0) { return; }
  20374. // A pong timeout ends a read() blocked on the silent peer
  20375. if (max_missed_pongs_ > 0) {
  20376. strm_.set_read_interrupt([this] { return pong_timed_out_.load(); });
  20377. }
  20378. ping_thread_ = std::thread([this]() {
  20379. std::unique_lock<std::mutex> lock(ping_mutex_);
  20380. // The predicate keeps a spurious wakeup from sending a ping early
  20381. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20382. [this]() { return closed_.load(); })) {
  20383. // If the peer has failed to respond to the previous pings, give up.
  20384. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20385. // opt-in liveness check controlled by max_missed_pongs_.
  20386. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20387. lock.unlock();
  20388. close(CloseStatus::GoingAway, "pong timeout");
  20389. pong_timed_out_ = true;
  20390. return;
  20391. }
  20392. lock.unlock();
  20393. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20394. lock.lock();
  20395. closed_ = true;
  20396. break;
  20397. }
  20398. lock.lock();
  20399. unacked_pings_++;
  20400. }
  20401. });
  20402. }
  20403. inline const Request &WebSocket::request() const { return req_; }
  20404. inline bool WebSocket::is_open() const { return !closed_; }
  20405. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20406. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20407. // poll(), where 0 would instead mean "return immediately", so hand it the
  20408. // negative poll uses for an unbounded wait.
  20409. if (sec == 0 && usec == 0) { sec = -1; }
  20410. strm_.set_read_timeout(sec, usec);
  20411. read_timeout_set_ = true;
  20412. }
  20413. // WebSocketClient implementation
  20414. inline WebSocketClient::WebSocketClient(
  20415. const std::string &scheme_host_port_path, const Headers &headers)
  20416. : headers_(headers) {
  20417. detail::UrlComponents uc;
  20418. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20419. !uc.host.empty() && !uc.path.empty()) {
  20420. auto &scheme = uc.scheme;
  20421. #ifdef CPPHTTPLIB_SSL_ENABLED
  20422. if (scheme != "ws" && scheme != "wss") {
  20423. #else
  20424. if (scheme != "ws") {
  20425. #endif
  20426. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20427. std::string msg = "'" + scheme + "' scheme is not supported.";
  20428. throw std::invalid_argument(msg);
  20429. #endif
  20430. return;
  20431. }
  20432. auto is_ssl = scheme == "wss";
  20433. host_ = std::move(uc.host);
  20434. port_ = is_ssl ? 443 : 80;
  20435. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20436. path_ = std::move(uc.path);
  20437. if (!uc.query.empty()) { path_ += uc.query; }
  20438. #ifdef CPPHTTPLIB_SSL_ENABLED
  20439. is_ssl_ = is_ssl;
  20440. if (is_ssl_) {
  20441. // The context lives as long as the client so that CA configuration
  20442. // survives reconnects; sessions are created per connection.
  20443. tls_ctx_ = tls::create_client_context();
  20444. if (!tls_ctx_) { return; }
  20445. }
  20446. #else
  20447. if (is_ssl) { return; }
  20448. #endif
  20449. is_valid_ = true;
  20450. }
  20451. }
  20452. #ifdef CPPHTTPLIB_SSL_ENABLED
  20453. inline WebSocketClient::WebSocketClient(
  20454. const std::string &scheme_host_port_path, const PemMemory &pem,
  20455. const Headers &headers)
  20456. : WebSocketClient(scheme_host_port_path, headers) {
  20457. // For ws:// URLs the client certificate is silently ignored, consistent
  20458. // with the TLS-only setters such as set_ca_cert_path().
  20459. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20460. std::string cert_buf, key_buf;
  20461. if (!tls::set_client_cert_pem(
  20462. tls_ctx_,
  20463. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20464. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20465. pem.private_key_password)) {
  20466. tls::free_context(tls_ctx_);
  20467. tls_ctx_ = nullptr;
  20468. is_valid_ = false;
  20469. }
  20470. }
  20471. }
  20472. #endif
  20473. inline WebSocketClient::~WebSocketClient() {
  20474. shutdown_and_close();
  20475. #ifdef CPPHTTPLIB_SSL_ENABLED
  20476. if (tls_ctx_) {
  20477. tls::free_context(tls_ctx_);
  20478. tls_ctx_ = nullptr;
  20479. }
  20480. #endif
  20481. }
  20482. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20483. inline void WebSocketClient::shutdown_and_close() {
  20484. // Send the close frame while the TLS session is still alive: ws_ holds an
  20485. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20486. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20487. if (ws_ && ws_->is_open()) { ws_->close(); }
  20488. ws_.reset();
  20489. #ifdef CPPHTTPLIB_SSL_ENABLED
  20490. if (is_ssl_) {
  20491. if (tls_session_) {
  20492. tls::shutdown(tls_session_, true);
  20493. tls::free_session(tls_session_);
  20494. tls_session_ = nullptr;
  20495. }
  20496. }
  20497. #endif
  20498. if (sock_ != INVALID_SOCKET) {
  20499. detail::shutdown_socket(sock_);
  20500. detail::close_socket(sock_);
  20501. sock_ = INVALID_SOCKET;
  20502. }
  20503. }
  20504. // The handshakes belong to establishing the connection, so an unset read
  20505. // timeout leaves them bounded by the connection timeout instead of forever.
  20506. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20507. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20508. return {connection_timeout_sec_, connection_timeout_usec_};
  20509. }
  20510. return {read_timeout_sec_, read_timeout_usec_};
  20511. }
  20512. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20513. Error &error, int &ssl_error,
  20514. uint64_t &ssl_backend_error) {
  20515. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20516. // The streams wait with poll(), where 0 instead means "return immediately",
  20517. // so they are given the negative poll uses for an unbounded wait.
  20518. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20519. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20520. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20521. #ifdef CPPHTTPLIB_SSL_ENABLED
  20522. if (is_ssl_) {
  20523. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20524. // is not safe to call concurrently on one client to begin with, since
  20525. // nothing else here is guarded either.
  20526. if (server_certificate_verification_ && !certs_loaded_) {
  20527. uint64_t backend_error = 0;
  20528. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20529. ca_cert_dir_path_, custom_ca_loaded_,
  20530. system_ca_mode_, backend_error);
  20531. certs_loaded_ = true;
  20532. }
  20533. detail::ClientTlsSessionOptions options;
  20534. options.server_hostname_verification = server_hostname_verification_;
  20535. options.session_verifier = session_verifier_;
  20536. auto timeout = handshake_timeout();
  20537. detail::ClientTlsSessionError tls_error;
  20538. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20539. server_certificate_verification_,
  20540. timeout.first, timeout.second,
  20541. &tls_error, options)) {
  20542. error = tls_error.error;
  20543. ssl_error = tls_error.ssl_error;
  20544. ssl_backend_error = tls_error.backend_error;
  20545. return false;
  20546. }
  20547. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20548. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20549. write_timeout_usec_));
  20550. return true;
  20551. }
  20552. #else
  20553. (void)error;
  20554. (void)ssl_error;
  20555. (void)ssl_backend_error;
  20556. #endif
  20557. strm = std::unique_ptr<Stream>(
  20558. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20559. write_timeout_sec_, write_timeout_usec_));
  20560. return true;
  20561. }
  20562. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20563. #ifdef CPPHTTPLIB_SSL_ENABLED
  20564. auto is_ssl = is_ssl_;
  20565. #else
  20566. auto is_ssl = false;
  20567. #endif
  20568. if (!req.has_header("Host")) {
  20569. req.headers.emplace("Host", detail::make_default_host_header_value(
  20570. host_, port_, is_ssl, address_family_));
  20571. }
  20572. detail::add_default_user_agent_header(req);
  20573. detail::add_authorization_header(req, basic_auth_username_,
  20574. basic_auth_password_,
  20575. bearer_token_auth_token_, false);
  20576. }
  20577. inline Result WebSocketClient::connect() {
  20578. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20579. shutdown_and_close();
  20580. auto error = Error::Success;
  20581. if (!create_and_connect_socket(error)) {
  20582. return Result{error, -1, Headers{}};
  20583. }
  20584. if (is_proxy_enabled()) {
  20585. Response proxy_res;
  20586. if (!connect_with_proxy(proxy_res, error)) {
  20587. shutdown_and_close();
  20588. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20589. }
  20590. }
  20591. std::unique_ptr<Stream> strm;
  20592. auto stream_error = Error::SSLConnection;
  20593. int ssl_error = 0;
  20594. uint64_t ssl_backend_error = 0;
  20595. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20596. shutdown_and_close();
  20597. #ifdef CPPHTTPLIB_SSL_ENABLED
  20598. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20599. #else
  20600. return Result{stream_error, -1, Headers{}};
  20601. #endif
  20602. }
  20603. Request req;
  20604. req.method = "GET";
  20605. req.path = path_;
  20606. req.headers = headers_;
  20607. prepare_default_headers(req);
  20608. detail::WebSocketUpgradeResponse upgrade;
  20609. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20610. shutdown_and_close();
  20611. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20612. }
  20613. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20614. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20615. websocket_ping_interval_sec_,
  20616. websocket_max_missed_pongs_));
  20617. // The stream was created with the timeout already; tell the WebSocket
  20618. // whether it came from the caller, so read() knows to report it as Timeout.
  20619. ws_->read_timeout_set_ = read_timeout_set_;
  20620. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20621. }
  20622. inline ReadResult WebSocketClient::read(std::string &msg) {
  20623. if (!ws_) { return Fail; }
  20624. return ws_->read(msg);
  20625. }
  20626. inline bool WebSocketClient::send(const std::string &data) {
  20627. if (!ws_) { return false; }
  20628. return ws_->send(data);
  20629. }
  20630. inline bool WebSocketClient::send(const char *data, size_t len) {
  20631. if (!ws_) { return false; }
  20632. return ws_->send(data, len);
  20633. }
  20634. inline void WebSocketClient::close(CloseStatus status,
  20635. const std::string &reason) {
  20636. if (ws_) { ws_->close(status, reason); }
  20637. }
  20638. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20639. inline const std::string &WebSocketClient::subprotocol() const {
  20640. return subprotocol_;
  20641. }
  20642. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20643. read_timeout_sec_ = sec;
  20644. read_timeout_usec_ = usec;
  20645. read_timeout_set_ = true;
  20646. // The members above only seed the next connect(); read() consults the
  20647. // stream, so an already-open connection has to be told directly.
  20648. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20649. }
  20650. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20651. write_timeout_sec_ = sec;
  20652. write_timeout_usec_ = usec;
  20653. }
  20654. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20655. websocket_ping_interval_sec_ = sec;
  20656. }
  20657. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20658. websocket_max_missed_pongs_ = count;
  20659. }
  20660. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20661. inline void WebSocketClient::set_address_family(int family) {
  20662. address_family_ = family;
  20663. }
  20664. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20665. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20666. socket_options_ = std::move(socket_options);
  20667. }
  20668. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20669. connection_timeout_sec_ = sec;
  20670. connection_timeout_usec_ = usec;
  20671. }
  20672. inline void WebSocketClient::set_interface(const std::string &intf) {
  20673. interface_ = intf;
  20674. }
  20675. inline void WebSocketClient::set_hostname_addr_map(
  20676. std::map<std::string, std::string> addr_map) {
  20677. set_direct_hostname_addr_map(std::move(addr_map));
  20678. }
  20679. inline void WebSocketClient::set_direct_hostname_addr_map(
  20680. std::map<std::string, std::string> addr_map) {
  20681. addr_map_ = std::move(addr_map);
  20682. }
  20683. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  20684. std::map<std::string, std::string> addr_map) {
  20685. tunnel_addr_map_ = std::move(addr_map);
  20686. }
  20687. inline bool WebSocketClient::is_proxy_enabled() const {
  20688. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20689. if (no_proxy_entries_.empty()) { return true; }
  20690. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20691. no_proxy_entries_);
  20692. }
  20693. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20694. std::string connect_host;
  20695. std::string ip;
  20696. auto port = port_;
  20697. if (is_proxy_enabled()) {
  20698. connect_host = proxy_host_;
  20699. port = proxy_port_;
  20700. } else {
  20701. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20702. }
  20703. sock_ = detail::create_client_socket(
  20704. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20705. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20706. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20707. write_timeout_usec_, interface_, error);
  20708. if (sock_ != INVALID_SOCKET) { return true; }
  20709. if (error == Error::Success) { error = Error::Connection; }
  20710. return false;
  20711. }
  20712. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20713. Response &proxy_res,
  20714. Error &error) {
  20715. auto timeout = handshake_timeout();
  20716. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20717. write_timeout_sec_, write_timeout_usec_);
  20718. if (!detail::write_request_head(strm, req, error)) { return false; }
  20719. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20720. error = Error::Read;
  20721. return false;
  20722. }
  20723. return true;
  20724. }
  20725. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20726. // forward an Upgrade request.
  20727. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20728. Error &error) {
  20729. Request req;
  20730. req.method = "CONNECT";
  20731. req.path =
  20732. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  20733. req.headers.emplace("Host", req.path);
  20734. detail::add_default_user_agent_header(req);
  20735. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20736. proxy_basic_auth_password_,
  20737. proxy_bearer_token_auth_token_, true);
  20738. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20739. #ifdef CPPHTTPLIB_SSL_ENABLED
  20740. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20741. std::map<std::string, std::string> auth;
  20742. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20743. !proxy_digest_auth_username_.empty() &&
  20744. !proxy_digest_auth_password_.empty() &&
  20745. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20746. proxy_res = Response();
  20747. shutdown_and_close();
  20748. if (!create_and_connect_socket(error)) { return false; }
  20749. req.headers.erase("Proxy-Authorization");
  20750. req.headers.insert(detail::make_digest_authentication_header(
  20751. req, req.path, auth, 1, detail::random_string(10),
  20752. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20753. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20754. }
  20755. #endif
  20756. if (proxy_res.status != StatusCode::OK_200) {
  20757. error = Error::ProxyConnection;
  20758. return false;
  20759. }
  20760. return true;
  20761. }
  20762. inline void WebSocketClient::set_basic_auth(const std::string &username,
  20763. const std::string &password) {
  20764. basic_auth_username_ = username;
  20765. basic_auth_password_ = password;
  20766. }
  20767. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  20768. bearer_token_auth_token_ = token;
  20769. }
  20770. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20771. proxy_host_ = host;
  20772. proxy_port_ = port;
  20773. }
  20774. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20775. const std::string &password) {
  20776. proxy_basic_auth_username_ = username;
  20777. proxy_basic_auth_password_ = password;
  20778. }
  20779. inline void
  20780. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20781. proxy_bearer_token_auth_token_ = token;
  20782. }
  20783. inline void
  20784. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20785. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20786. }
  20787. #ifdef CPPHTTPLIB_SSL_ENABLED
  20788. inline void
  20789. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20790. const std::string &ca_cert_dir_path) {
  20791. ca_cert_file_path_ = ca_cert_file_path;
  20792. ca_cert_dir_path_ = ca_cert_dir_path;
  20793. }
  20794. inline void
  20795. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20796. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20797. }
  20798. inline void WebSocketClient::set_session_verifier(
  20799. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20800. session_verifier_ = std::move(verifier);
  20801. }
  20802. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20803. if (store && tls_ctx_) {
  20804. // set_ca_store takes ownership of store
  20805. tls::set_ca_store(tls_ctx_, store);
  20806. } else if (store) {
  20807. tls::free_ca_store(store);
  20808. }
  20809. custom_ca_loaded_ = true;
  20810. }
  20811. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20812. std::size_t size) {
  20813. if (tls_ctx_ && ca_cert && size > 0) {
  20814. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20815. }
  20816. custom_ca_loaded_ = true;
  20817. }
  20818. inline void
  20819. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20820. server_certificate_verification_ = enabled;
  20821. }
  20822. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20823. server_hostname_verification_ = enabled;
  20824. }
  20825. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20826. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20827. }
  20828. inline void
  20829. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20830. const std::string &password) {
  20831. proxy_digest_auth_username_ = username;
  20832. proxy_digest_auth_password_ = password;
  20833. }
  20834. #endif // CPPHTTPLIB_SSL_ENABLED
  20835. } // namespace ws
  20836. // ----------------------------------------------------------------------------
  20837. } // namespace httplib
  20838. #endif // CPPHTTPLIB_HTTPLIB_H