httplib.h 850 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.67.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x004300"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. // How much of an unread request body the server skips to reuse the connection,
  113. // 0 for no limit
  114. #ifndef CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH
  115. #define CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH (256 * 1024) // 256KB
  116. #endif
  117. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  118. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  119. #endif
  120. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  121. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  124. // 1400 rather than a round number: a body that already fits in one 1500-byte
  125. // MTU gains nothing from being made smaller.
  126. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  127. #endif
  128. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  129. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  130. #endif
  131. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  132. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  133. #endif
  134. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  135. // recurses roughly once per matched character for quantified patterns such
  136. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  137. // a default ~8MB thread stack that has been observed to take on the order of
  138. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  139. // margin below that (well under the 8192-byte request URI limit) while still
  140. // fitting any realistic route segment; raise it if a route legitimately needs
  141. // longer paths. Regex routes are never applied to paths longer than this.
  142. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  143. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  144. #endif
  145. #ifndef CPPHTTPLIB_TCP_NODELAY
  146. #define CPPHTTPLIB_TCP_NODELAY false
  147. #endif
  148. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  149. #define CPPHTTPLIB_IPV6_V6ONLY false
  150. #endif
  151. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  152. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  153. #endif
  154. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  155. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  156. #endif
  157. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  158. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  159. #endif
  160. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  161. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  162. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  163. ? std::thread::hardware_concurrency() - 1 \
  164. : 0))
  165. #endif
  166. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  167. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  168. #endif
  169. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  170. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  171. #endif
  172. #ifndef CPPHTTPLIB_RECV_FLAGS
  173. #define CPPHTTPLIB_RECV_FLAGS 0
  174. #endif
  175. #ifndef CPPHTTPLIB_SEND_FLAGS
  176. #define CPPHTTPLIB_SEND_FLAGS 0
  177. #endif
  178. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  179. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  180. #endif
  181. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  182. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  183. #endif
  184. // These bound the parsing of every request, so 0 cannot lift them.
  185. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  186. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  187. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  188. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  189. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  190. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  191. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  192. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  193. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  194. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  195. #endif
  196. // One macro used to set the read timeout for both sides. They want different
  197. // defaults: a client's read timeout is the caller's own tool (it waits forever
  198. // until asked not to), while a server keeps a ceiling that reclaims a worker
  199. // from a peer that has gone quiet. The old name still works and sets both.
  200. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  201. #pragma message( \
  202. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  203. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  204. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  207. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  208. #endif
  209. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  210. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  211. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  212. #endif
  213. #endif
  214. // 0 waits forever. A read timeout is how a caller gets control back to send on
  215. // the same connection; it is not a liveness check (that is ping/pong). Only a
  216. // timeout set at runtime through set_read_timeout() is reported as
  217. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  218. // ws::Fail and closes the connection.
  219. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  220. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  221. #endif
  222. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  223. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  224. #endif
  225. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  226. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  227. #endif
  228. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  229. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  230. #endif
  231. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  232. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  233. #endif
  234. // A WebSocket connection carries small messages each way, which Nagle's
  235. // algorithm would hold back for the peer's delayed ACK (tens of milliseconds
  236. // on Linux), so it sets TCP_NODELAY unless this is false.
  237. #ifndef CPPHTTPLIB_WEBSOCKET_TCP_NODELAY
  238. #define CPPHTTPLIB_WEBSOCKET_TCP_NODELAY true
  239. #endif
  240. /*
  241. * Headers
  242. */
  243. #ifdef _WIN32
  244. #ifndef _CRT_SECURE_NO_WARNINGS
  245. #define _CRT_SECURE_NO_WARNINGS
  246. #endif //_CRT_SECURE_NO_WARNINGS
  247. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  248. #define _CRT_NONSTDC_NO_DEPRECATE
  249. #endif //_CRT_NONSTDC_NO_DEPRECATE
  250. #if defined(_MSC_VER)
  251. #if _MSC_VER < 1900
  252. #error Sorry, Visual Studio versions prior to 2015 are not supported
  253. #endif
  254. #pragma comment(lib, "ws2_32.lib")
  255. #ifndef _SSIZE_T_DEFINED
  256. using ssize_t = __int64;
  257. #define _SSIZE_T_DEFINED
  258. #endif
  259. #endif // _MSC_VER
  260. #ifndef S_ISREG
  261. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  262. #endif // S_ISREG
  263. #ifndef S_ISDIR
  264. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  265. #endif // S_ISDIR
  266. #ifndef NOMINMAX
  267. #define NOMINMAX
  268. #endif // NOMINMAX
  269. #include <io.h>
  270. #include <winsock2.h>
  271. #include <ws2tcpip.h>
  272. #if defined(__has_include)
  273. #if __has_include(<afunix.h>)
  274. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  275. #include <afunix.h>
  276. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  277. #endif
  278. #endif
  279. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  280. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  281. #endif
  282. using nfds_t = unsigned long;
  283. using socket_t = SOCKET;
  284. using socklen_t = int;
  285. #else // not _WIN32
  286. #include <arpa/inet.h>
  287. #if !defined(_AIX) && !defined(__MVS__)
  288. #include <ifaddrs.h>
  289. #endif
  290. #ifdef __MVS__
  291. #include <strings.h>
  292. #ifndef NI_MAXHOST
  293. #define NI_MAXHOST 1025
  294. #endif
  295. #endif
  296. #include <net/if.h>
  297. #include <netdb.h>
  298. #include <netinet/in.h>
  299. #ifdef __linux__
  300. #include <resolv.h>
  301. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  302. #endif
  303. #include <csignal>
  304. #include <netinet/tcp.h>
  305. #include <poll.h>
  306. #include <pthread.h>
  307. #include <sys/socket.h>
  308. #include <sys/un.h>
  309. #include <unistd.h>
  310. using socket_t = int;
  311. #ifndef INVALID_SOCKET
  312. #define INVALID_SOCKET (-1)
  313. #endif
  314. #endif //_WIN32
  315. #if defined(__APPLE__)
  316. #include <TargetConditionals.h>
  317. #endif
  318. #include <algorithm>
  319. #include <array>
  320. #include <atomic>
  321. #include <cassert>
  322. #include <chrono>
  323. #include <climits>
  324. #include <condition_variable>
  325. #include <cstdlib>
  326. #include <cstring>
  327. #include <errno.h>
  328. #include <exception>
  329. #include <fcntl.h>
  330. #include <fstream>
  331. #include <functional>
  332. #include <iomanip>
  333. #include <iostream>
  334. #include <iterator>
  335. #include <list>
  336. #include <map>
  337. #include <memory>
  338. #include <mutex>
  339. #include <random>
  340. #include <regex>
  341. #include <set>
  342. #include <sstream>
  343. #include <string>
  344. #include <sys/stat.h>
  345. #include <system_error>
  346. #include <thread>
  347. #include <type_traits>
  348. #include <unordered_map>
  349. #include <unordered_set>
  350. #include <utility>
  351. #include <vector>
  352. // On macOS with a TLS backend, enable Keychain root certificates by default
  353. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  354. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  355. // only; on those platforms the user must provide a CA bundle explicitly.
  356. #if defined(__APPLE__) && defined(__clang__) && \
  357. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  358. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  359. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  360. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  361. #if TARGET_OS_OSX
  362. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  363. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  364. #endif
  365. #endif
  366. #endif
  367. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  368. defined(__APPLE__) && !TARGET_OS_OSX
  369. #error \
  370. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  371. #endif
  372. // On Windows, enable Schannel certificate verification by default
  373. // unless the user explicitly opts out.
  374. #if defined(_WIN32) && \
  375. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  376. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  377. #endif
  378. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  379. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  380. #if TARGET_OS_MAC && defined(__clang__)
  381. #include <CFNetwork/CFHost.h>
  382. #include <CoreFoundation/CoreFoundation.h>
  383. #endif
  384. #endif
  385. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  386. #ifdef _WIN32
  387. #include <wincrypt.h>
  388. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  389. // used
  390. #undef X509_NAME
  391. #undef X509_CERT_PAIR
  392. #undef X509_EXTENSIONS
  393. #undef PKCS7_SIGNER_INFO
  394. #ifdef _MSC_VER
  395. #pragma comment(lib, "crypt32.lib")
  396. #endif
  397. #endif // _WIN32
  398. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  399. #if TARGET_OS_OSX
  400. #include <Security/Security.h>
  401. #endif
  402. #endif
  403. #include <openssl/err.h>
  404. #include <openssl/evp.h>
  405. #include <openssl/rand.h>
  406. #include <openssl/ssl.h>
  407. #include <openssl/x509v3.h>
  408. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  409. #include <openssl/applink.c>
  410. #endif
  411. #include <iostream>
  412. #include <sstream>
  413. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  414. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  415. #error Please use OpenSSL or a current version of BoringSSL
  416. #endif
  417. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  418. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  419. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  420. #endif
  421. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  422. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  423. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  424. // in with this first include group so the version gating below can use it.
  425. #include <mbedtls/error.h>
  426. #include <mbedtls/net_sockets.h>
  427. #include <mbedtls/oid.h>
  428. #include <mbedtls/pk.h>
  429. #include <mbedtls/ssl.h>
  430. #include <mbedtls/version.h>
  431. #include <mbedtls/x509_crt.h>
  432. #if MBEDTLS_VERSION_MAJOR >= 4
  433. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  434. #include <psa/crypto.h>
  435. #else
  436. #include <mbedtls/ctr_drbg.h>
  437. #include <mbedtls/entropy.h>
  438. #include <mbedtls/md5.h>
  439. #include <mbedtls/sha1.h>
  440. #include <mbedtls/sha256.h>
  441. #include <mbedtls/sha512.h>
  442. #endif
  443. #ifdef _WIN32
  444. #include <wincrypt.h>
  445. #ifdef _MSC_VER
  446. #pragma comment(lib, "crypt32.lib")
  447. #endif
  448. #endif // _WIN32
  449. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  450. #if TARGET_OS_OSX
  451. #include <Security/Security.h>
  452. #endif
  453. #endif
  454. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  455. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  456. #if MBEDTLS_VERSION_MAJOR >= 4
  457. #define CPPHTTPLIB_MBEDTLS_V4
  458. #endif
  459. #if MBEDTLS_VERSION_MAJOR >= 3
  460. #define CPPHTTPLIB_MBEDTLS_V3
  461. #endif
  462. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  463. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  464. #include <wolfssl/options.h>
  465. #include <wolfssl/openssl/x509v3.h>
  466. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  467. #ifndef WOLFSSL_GEN_EMAIL
  468. #define WOLFSSL_GEN_EMAIL 1
  469. #endif
  470. #ifndef WOLFSSL_GEN_DNS
  471. #define WOLFSSL_GEN_DNS 2
  472. #endif
  473. #ifndef WOLFSSL_GEN_URI
  474. #define WOLFSSL_GEN_URI 6
  475. #endif
  476. #ifndef WOLFSSL_GEN_IPADD
  477. #define WOLFSSL_GEN_IPADD 7
  478. #endif
  479. #include <wolfssl/ssl.h>
  480. #include <wolfssl/wolfcrypt/hash.h>
  481. #include <wolfssl/wolfcrypt/md5.h>
  482. #include <wolfssl/wolfcrypt/sha256.h>
  483. #include <wolfssl/wolfcrypt/sha512.h>
  484. #ifdef _WIN32
  485. #include <wincrypt.h>
  486. #ifdef _MSC_VER
  487. #pragma comment(lib, "crypt32.lib")
  488. #endif
  489. #endif // _WIN32
  490. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  491. #if TARGET_OS_OSX
  492. #include <Security/Security.h>
  493. #endif
  494. #endif
  495. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  496. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  497. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  498. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  499. #define CPPHTTPLIB_SSL_ENABLED
  500. #endif
  501. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  502. #include <zlib.h>
  503. #endif
  504. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  505. #include <brotli/decode.h>
  506. #include <brotli/encode.h>
  507. #endif
  508. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  509. #include <zstd.h>
  510. #endif
  511. /*
  512. * Declaration
  513. */
  514. namespace httplib {
  515. namespace ws {
  516. class WebSocket;
  517. } // namespace ws
  518. namespace sse {
  519. class SSEClient;
  520. } // namespace sse
  521. namespace detail {
  522. /*
  523. * Backport std::make_unique from C++14.
  524. *
  525. * NOTE: This code came up with the following stackoverflow post:
  526. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  527. *
  528. */
  529. template <class T, class... Args>
  530. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  531. make_unique(Args &&...args) {
  532. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  533. }
  534. template <class T>
  535. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  536. make_unique(std::size_t n) {
  537. typedef typename std::remove_extent<T>::type RT;
  538. return std::unique_ptr<T>(new RT[n]);
  539. }
  540. // Locale-independent ASCII character classification. The <cctype>
  541. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  542. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  543. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  544. // classified without regard to the locale.
  545. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  546. inline bool is_ascii_alpha(char c) {
  547. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  548. }
  549. inline bool is_ascii_alnum(char c) {
  550. return is_ascii_digit(c) || is_ascii_alpha(c);
  551. }
  552. namespace case_ignore {
  553. inline unsigned char to_lower(int c) {
  554. const static unsigned char table[256] = {
  555. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  556. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  557. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  558. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  559. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  560. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  561. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  562. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  563. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  564. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  565. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  566. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  567. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  568. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  569. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  570. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  571. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  572. 255,
  573. };
  574. return table[(unsigned char)(char)c];
  575. }
  576. inline std::string to_lower(const std::string &s) {
  577. std::string result = s;
  578. std::transform(
  579. result.begin(), result.end(), result.begin(),
  580. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  581. return result;
  582. }
  583. inline bool equal(const std::string &a, const std::string &b) {
  584. return a.size() == b.size() &&
  585. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  586. return to_lower(ca) == to_lower(cb);
  587. });
  588. }
  589. // For a literal, without building a std::string from it.
  590. template <size_t N>
  591. inline bool equal(const std::string &a, const char (&b)[N]) {
  592. return a.size() == N - 1 &&
  593. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  594. return to_lower(ca) == to_lower(cb);
  595. });
  596. }
  597. struct equal_to {
  598. bool operator()(const std::string &a, const std::string &b) const {
  599. return equal(a, b);
  600. }
  601. };
  602. struct hash {
  603. size_t operator()(const std::string &key) const {
  604. size_t h = 0;
  605. for (auto c : key) {
  606. // Unsets the 6 high bits of h, therefore no overflow happens
  607. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  608. static_cast<unsigned char>(to_lower(c));
  609. }
  610. return h;
  611. }
  612. };
  613. template <typename T>
  614. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  615. detail::case_ignore::equal_to>;
  616. } // namespace case_ignore
  617. // This is based on
  618. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  619. struct scope_exit {
  620. explicit scope_exit(std::function<void(void)> &&f)
  621. : exit_function(std::move(f)), execute_on_destruction{true} {}
  622. scope_exit(scope_exit &&rhs) noexcept
  623. : exit_function(std::move(rhs.exit_function)),
  624. execute_on_destruction{rhs.execute_on_destruction} {
  625. rhs.release();
  626. }
  627. ~scope_exit() {
  628. if (execute_on_destruction) { this->exit_function(); }
  629. }
  630. void release() { this->execute_on_destruction = false; }
  631. private:
  632. scope_exit(const scope_exit &) = delete;
  633. void operator=(const scope_exit &) = delete;
  634. scope_exit &operator=(scope_exit &&) = delete;
  635. std::function<void(void)> exit_function;
  636. bool execute_on_destruction;
  637. };
  638. // Simple from_chars implementation for integer and double types (C++17
  639. // substitute)
  640. template <typename T> struct from_chars_result {
  641. const char *ptr;
  642. std::errc ec;
  643. };
  644. template <typename T>
  645. inline from_chars_result<T> from_chars(const char *first, const char *last,
  646. T &value, int base = 10) {
  647. value = 0;
  648. const char *p = first;
  649. bool negative = false;
  650. if (p != last && *p == '-') {
  651. negative = true;
  652. ++p;
  653. }
  654. if (p == last) { return {first, std::errc::invalid_argument}; }
  655. auto radix = static_cast<T>(base);
  656. T result = 0;
  657. for (; p != last; ++p) {
  658. char c = *p;
  659. int digit = -1;
  660. if (is_ascii_digit(c)) {
  661. digit = c - '0';
  662. } else if ('a' <= c && c <= 'z') {
  663. digit = c - 'a' + 10;
  664. } else if ('A' <= c && c <= 'Z') {
  665. digit = c - 'A' + 10;
  666. } else {
  667. break;
  668. }
  669. if (digit < 0 || digit >= base) { break; }
  670. auto d = static_cast<T>(digit);
  671. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  672. return {p, std::errc::result_out_of_range};
  673. }
  674. result = result * radix + d;
  675. }
  676. if (p == first || (negative && p == first + 1)) {
  677. return {first, std::errc::invalid_argument};
  678. }
  679. value = negative ? T(0) - result : result;
  680. return {p, std::errc{}};
  681. }
  682. // from_chars for double (hand-written, locale-independent)
  683. //
  684. // The only double consumed by this library is the HTTP quality value, whose
  685. // grammar is (RFC 9110 12.4.2):
  686. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  687. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  688. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  689. // '.' always the decimal separator (std::strtod would instead read it from the
  690. // global C locale, mis-parsing q-values once an embedder calls
  691. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  692. // the result to [0, 1], so inputs outside that range need not be distinguished
  693. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  694. // cases that exponent and wide-range handling would introduce.
  695. inline from_chars_result<double> from_chars(const char *first, const char *last,
  696. double &value) {
  697. value = 0.0;
  698. const char *p = first;
  699. // Each 1eN is exactly representable, so a single final division by the
  700. // matching entry yields a correctly-rounded result.
  701. static const double powers_of_ten[] = {
  702. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  703. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  704. const int max_frac_digits =
  705. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  706. // Accumulate digits into a 64-bit integer and remember how many were
  707. // fractional. Two independent caps keep this bounded and safe:
  708. // * accumulation saturates before mantissa could overflow uint64_t, and
  709. // * frac_digits is capped at max_frac_digits so it is always a valid index
  710. // into powers_of_ten (without this an input like "0.000...0" would never
  711. // grow mantissa, so the saturation cap alone would not bound it).
  712. // Both caps only drop digits far beyond the precision a q-value needs; any
  713. // value they would change is well outside [0, 1] and rejected by the caller.
  714. uint64_t mantissa = 0;
  715. int frac_digits = 0;
  716. bool seen_digit = false;
  717. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  718. auto accumulate = [&](char c) {
  719. if (mantissa <= limit) {
  720. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  721. return true;
  722. }
  723. return false;
  724. };
  725. for (; p != last && is_ascii_digit(*p); ++p) {
  726. seen_digit = true;
  727. accumulate(*p);
  728. }
  729. if (p != last && *p == '.') {
  730. ++p;
  731. for (; p != last && is_ascii_digit(*p); ++p) {
  732. seen_digit = true;
  733. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  734. }
  735. }
  736. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  737. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  738. return {p, std::errc{}};
  739. }
  740. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  741. int &out) {
  742. int val = 0;
  743. auto r = from_chars(s, s + len, val);
  744. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  745. return false;
  746. }
  747. out = val;
  748. return true;
  749. }
  750. inline bool parse_port(const char *s, size_t len, int &port) {
  751. return parse_int_in_range(s, len, 1, 65535, port);
  752. }
  753. inline bool parse_port(const std::string &s, int &port) {
  754. return parse_port(s.data(), s.size(), port);
  755. }
  756. struct UrlComponents {
  757. std::string scheme;
  758. std::string host;
  759. std::string port;
  760. std::string path;
  761. std::string query;
  762. };
  763. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  764. uc = {};
  765. size_t pos = 0;
  766. auto sep = url.find("://");
  767. if (sep != std::string::npos) {
  768. uc.scheme = url.substr(0, sep);
  769. // Scheme must be [a-z]+ only
  770. if (uc.scheme.empty()) { return false; }
  771. for (auto c : uc.scheme) {
  772. if (c < 'a' || c > 'z') { return false; }
  773. }
  774. pos = sep + 3;
  775. } else if (url.compare(0, 2, "//") == 0) {
  776. pos = 2;
  777. }
  778. auto has_authority_prefix = pos > 0;
  779. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  780. url[0] != '?' && url[0] != '#');
  781. if (has_authority) {
  782. // userinfo is not supported, and a backslash that some parsers take for
  783. // '/' would leave them seeing another host than this one.
  784. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  785. return false;
  786. }
  787. if (pos < url.size() && url[pos] == '[') {
  788. auto close = url.find(']', pos);
  789. if (close == std::string::npos) { return false; }
  790. uc.host = url.substr(pos + 1, close - pos - 1);
  791. // IPv6 host must be [a-fA-F0-9:]+ only
  792. if (uc.host.empty()) { return false; }
  793. for (auto c : uc.host) {
  794. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  795. (c >= 'A' && c <= 'F') || c == ':')) {
  796. return false;
  797. }
  798. }
  799. pos = close + 1;
  800. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  801. // path, query or fragment delimiter (or the end of input). Otherwise the
  802. // trailing bytes would be folded into the path while the connection
  803. // still targets the bracketed address.
  804. if (pos < url.size()) {
  805. auto c = url[pos];
  806. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  807. }
  808. } else {
  809. auto end = url.find_first_of(":/?#", pos);
  810. if (end == std::string::npos) { end = url.size(); }
  811. uc.host = url.substr(pos, end - pos);
  812. pos = end;
  813. }
  814. if (pos < url.size() && url[pos] == ':') {
  815. ++pos;
  816. auto end = url.find_first_of("/?#", pos);
  817. if (end == std::string::npos) { end = url.size(); }
  818. uc.port = url.substr(pos, end - pos);
  819. pos = end;
  820. }
  821. // Without :// or //, the entire input must be consumed as host[:port].
  822. // If there is leftover (path, query, etc.), this is not a valid
  823. // host[:port] string — clear and reparse as a plain path.
  824. if (!has_authority_prefix && pos < url.size()) {
  825. uc.host.clear();
  826. uc.port.clear();
  827. pos = 0;
  828. }
  829. }
  830. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  831. auto end = url.find_first_of("?#", pos);
  832. if (end == std::string::npos) { end = url.size(); }
  833. uc.path = url.substr(pos, end - pos);
  834. pos = end;
  835. }
  836. if (pos < url.size() && url[pos] == '?') {
  837. auto end = url.find('#', pos);
  838. if (end == std::string::npos) { end = url.size(); }
  839. uc.query = url.substr(pos, end - pos);
  840. }
  841. return true;
  842. }
  843. // Removes "." and ".." segments from a path that starts with '/' (RFC 3986
  844. // section 5.2.4).
  845. inline std::string remove_dot_segments(const std::string &path) {
  846. std::string out;
  847. size_t i = 0;
  848. while (i < path.size()) {
  849. auto next = (std::min)(path.find('/', i + 1), path.size());
  850. auto segment = path.substr(i + 1, next - i - 1);
  851. auto is_last = next == path.size();
  852. if (segment == "." || segment == "..") {
  853. if (segment == "..") {
  854. out.erase((std::min)(out.rfind('/'), out.size()));
  855. }
  856. if (is_last) { out += '/'; }
  857. } else {
  858. out += '/';
  859. out += segment;
  860. }
  861. i = next;
  862. }
  863. if (out.empty()) { out = "/"; }
  864. return out;
  865. }
  866. // Resolves a relative-path or query-only Location value against the path of
  867. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  868. // references starting with '/' are returned unchanged.
  869. inline std::string resolve_relative_location(const std::string &location,
  870. const std::string &base) {
  871. if (location.empty() || location[0] == '/') { return location; }
  872. // A ':' in the first segment means the value has a scheme.
  873. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  874. // A path starting with "//" would be re-parsed as an authority. Prefix "/."
  875. // (as the URL Standard does); remove_dot_segments strips it later.
  876. auto on_this_host = [](std::string path) -> std::string {
  877. if (path.compare(0, 2, "//") == 0) { path.insert(0, "/."); }
  878. return path;
  879. };
  880. if (location[0] == '#') {
  881. return on_this_host(base.substr(0, base.find('#')) + location);
  882. }
  883. auto base_path = base.substr(0, base.find_first_of("?#"));
  884. if (location[0] == '?') { return on_this_host(base_path + location); }
  885. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  886. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  887. // Remove "." and ".." segments from the merged path.
  888. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  889. return on_this_host(remove_dot_segments(merged.substr(0, path_end)) +
  890. merged.substr(path_end));
  891. }
  892. } // namespace detail
  893. enum class SSLVerifierResponse {
  894. // no decision has been made, use the built-in certificate verifier
  895. NoDecisionMade,
  896. // connection certificate is verified and accepted
  897. CertificateAccepted,
  898. // connection certificate was processed but is rejected
  899. CertificateRejected
  900. };
  901. // System CA loading policy for SSL clients. Auto (the default) loads system
  902. // CA certs only when no custom CA is configured; enable_system_ca() switches
  903. // to an explicit policy.
  904. enum class SystemCAMode { Auto, Enabled, Disabled };
  905. enum StatusCode {
  906. // Information responses
  907. Continue_100 = 100,
  908. SwitchingProtocol_101 = 101,
  909. Processing_102 = 102,
  910. EarlyHints_103 = 103,
  911. // Successful responses
  912. OK_200 = 200,
  913. Created_201 = 201,
  914. Accepted_202 = 202,
  915. NonAuthoritativeInformation_203 = 203,
  916. NoContent_204 = 204,
  917. ResetContent_205 = 205,
  918. PartialContent_206 = 206,
  919. MultiStatus_207 = 207,
  920. AlreadyReported_208 = 208,
  921. IMUsed_226 = 226,
  922. // Redirection messages
  923. MultipleChoices_300 = 300,
  924. MovedPermanently_301 = 301,
  925. Found_302 = 302,
  926. SeeOther_303 = 303,
  927. NotModified_304 = 304,
  928. UseProxy_305 = 305,
  929. unused_306 = 306,
  930. TemporaryRedirect_307 = 307,
  931. PermanentRedirect_308 = 308,
  932. // Client error responses
  933. BadRequest_400 = 400,
  934. Unauthorized_401 = 401,
  935. PaymentRequired_402 = 402,
  936. Forbidden_403 = 403,
  937. NotFound_404 = 404,
  938. MethodNotAllowed_405 = 405,
  939. NotAcceptable_406 = 406,
  940. ProxyAuthenticationRequired_407 = 407,
  941. RequestTimeout_408 = 408,
  942. Conflict_409 = 409,
  943. Gone_410 = 410,
  944. LengthRequired_411 = 411,
  945. PreconditionFailed_412 = 412,
  946. PayloadTooLarge_413 = 413,
  947. UriTooLong_414 = 414,
  948. UnsupportedMediaType_415 = 415,
  949. RangeNotSatisfiable_416 = 416,
  950. ExpectationFailed_417 = 417,
  951. ImATeapot_418 = 418,
  952. MisdirectedRequest_421 = 421,
  953. UnprocessableContent_422 = 422,
  954. Locked_423 = 423,
  955. FailedDependency_424 = 424,
  956. TooEarly_425 = 425,
  957. UpgradeRequired_426 = 426,
  958. PreconditionRequired_428 = 428,
  959. TooManyRequests_429 = 429,
  960. RequestHeaderFieldsTooLarge_431 = 431,
  961. UnavailableForLegalReasons_451 = 451,
  962. // Server error responses
  963. InternalServerError_500 = 500,
  964. NotImplemented_501 = 501,
  965. BadGateway_502 = 502,
  966. ServiceUnavailable_503 = 503,
  967. GatewayTimeout_504 = 504,
  968. HttpVersionNotSupported_505 = 505,
  969. VariantAlsoNegotiates_506 = 506,
  970. InsufficientStorage_507 = 507,
  971. LoopDetected_508 = 508,
  972. NotExtended_510 = 510,
  973. NetworkAuthenticationRequired_511 = 511,
  974. };
  975. namespace detail {
  976. // A multimap that keeps its entries in the order they were inserted.
  977. //
  978. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  979. // fields sharing a field name significant and forbids a proxy from reordering
  980. // them, and a query string's parameters are meaningful in the order the caller
  981. // wrote them. Neither standard container expresses it: std::unordered_multimap
  982. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  983. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  984. // key, which would drop control data such as Host behind whatever else the
  985. // message carries and alphabetise a query string.
  986. //
  987. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  988. // scan, which beats hashing for the handful of entries a message carries
  989. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  990. //
  991. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  992. // Params, whose parameter names are case-sensitive, not.
  993. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  994. public:
  995. using key_type = std::string;
  996. using mapped_type = Mapped;
  997. using value_type = std::pair<std::string, Mapped>;
  998. using size_type = std::size_t;
  999. using difference_type = std::ptrdiff_t;
  1000. using reference = value_type &;
  1001. using const_reference = const value_type &;
  1002. private:
  1003. static size_type npos() { return static_cast<size_type>(-1); }
  1004. static bool keys_equal(const std::string &a, const std::string &b) {
  1005. return KeyEqual()(a, b);
  1006. }
  1007. // Iterating yields every entry in insertion order, but equal_range() and
  1008. // find() have to walk only the entries sharing one key, which are not
  1009. // adjacent. Both are the same iterator type: key_idx_ selects between the
  1010. // two traversals, and since equality compares only the position, an iterator
  1011. // restricted to one key still compares equal to end().
  1012. template <typename V> class iterator_t {
  1013. public:
  1014. using iterator_category = std::bidirectional_iterator_tag;
  1015. using value_type = insertion_ordered_multimap::value_type;
  1016. using difference_type = insertion_ordered_multimap::difference_type;
  1017. using pointer = V *;
  1018. using reference = V &;
  1019. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1020. template <typename U,
  1021. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1022. int>::type = 0>
  1023. iterator_t(const iterator_t<U> &rhs)
  1024. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1025. key_idx_(rhs.key_idx_) {}
  1026. reference operator*() const { return data_[idx_]; }
  1027. pointer operator->() const { return data_ + idx_; }
  1028. iterator_t &operator++() {
  1029. // Saturating, so that advancing past the last entry of a key stays at
  1030. // end() instead of running off the container.
  1031. if (idx_ >= size_) { return *this; }
  1032. ++idx_;
  1033. if (key_idx_ != npos()) {
  1034. while (idx_ < size_ && !matches(idx_)) {
  1035. ++idx_;
  1036. }
  1037. }
  1038. return *this;
  1039. }
  1040. iterator_t operator++(int) {
  1041. auto tmp = *this;
  1042. ++*this;
  1043. return tmp;
  1044. }
  1045. iterator_t &operator--() {
  1046. if (idx_ == 0) { return *this; }
  1047. --idx_;
  1048. if (key_idx_ != npos()) {
  1049. while (idx_ > 0 && !matches(idx_)) {
  1050. --idx_;
  1051. }
  1052. }
  1053. return *this;
  1054. }
  1055. iterator_t operator--(int) {
  1056. auto tmp = *this;
  1057. --*this;
  1058. return tmp;
  1059. }
  1060. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1061. return idx_ == rhs.idx_;
  1062. }
  1063. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1064. return idx_ != rhs.idx_;
  1065. }
  1066. private:
  1067. friend class insertion_ordered_multimap;
  1068. template <typename> friend class iterator_t;
  1069. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1070. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1071. bool matches(size_type i) const {
  1072. return keys_equal(data_[i].first, data_[key_idx_].first);
  1073. }
  1074. V *data_;
  1075. size_type idx_;
  1076. size_type size_;
  1077. size_type key_idx_;
  1078. };
  1079. public:
  1080. using iterator = iterator_t<value_type>;
  1081. using const_iterator = iterator_t<const value_type>;
  1082. insertion_ordered_multimap() = default;
  1083. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1084. : entries_(il) {}
  1085. template <typename InputIt>
  1086. insertion_ordered_multimap(InputIt first, InputIt last)
  1087. : entries_(first, last) {}
  1088. iterator begin() { return make_iter(0, npos()); }
  1089. iterator end() { return make_iter(entries_.size(), npos()); }
  1090. const_iterator begin() const { return make_citer(0, npos()); }
  1091. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1092. const_iterator cbegin() const { return begin(); }
  1093. const_iterator cend() const { return end(); }
  1094. bool empty() const { return entries_.empty(); }
  1095. size_type size() const { return entries_.size(); }
  1096. void clear() { entries_.clear(); }
  1097. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1098. iterator insert(const value_type &val) {
  1099. entries_.push_back(val);
  1100. return make_iter(entries_.size() - 1, npos());
  1101. }
  1102. iterator insert(value_type &&val) {
  1103. entries_.push_back(std::move(val));
  1104. return make_iter(entries_.size() - 1, npos());
  1105. }
  1106. template <typename... Args> iterator emplace(Args &&...args) {
  1107. entries_.emplace_back(std::forward<Args>(args)...);
  1108. return make_iter(entries_.size() - 1, npos());
  1109. }
  1110. // For entries that have to lead the message, such as the Host header field
  1111. // (RFC 9110 5.3 recommends sending control data first).
  1112. template <typename... Args> iterator emplace_front(Args &&...args) {
  1113. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1114. return make_iter(0, npos());
  1115. }
  1116. iterator find(const std::string &key) {
  1117. auto i = index_of(key);
  1118. return i == npos() ? end() : make_iter(i, i);
  1119. }
  1120. const_iterator find(const std::string &key) const {
  1121. auto i = index_of(key);
  1122. return i == npos() ? end() : make_citer(i, i);
  1123. }
  1124. size_type count(const std::string &key) const {
  1125. size_type n = 0;
  1126. for (const auto &entry : entries_) {
  1127. if (keys_equal(entry.first, key)) { n++; }
  1128. }
  1129. return n;
  1130. }
  1131. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1132. auto i = index_of(key);
  1133. return i == npos() ? std::make_pair(end(), end())
  1134. : std::make_pair(make_iter(i, i), end());
  1135. }
  1136. std::pair<const_iterator, const_iterator>
  1137. equal_range(const std::string &key) const {
  1138. auto i = index_of(key);
  1139. return i == npos() ? std::make_pair(end(), end())
  1140. : std::make_pair(make_citer(i, i), end());
  1141. }
  1142. size_type erase(const std::string &key) {
  1143. auto before = entries_.size();
  1144. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1145. [key](const value_type &entry) {
  1146. return keys_equal(entry.first, key);
  1147. }),
  1148. entries_.end());
  1149. return before - entries_.size();
  1150. }
  1151. iterator erase(const_iterator pos) {
  1152. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1153. return make_iter(pos.idx_, npos());
  1154. }
  1155. // Erases what iterating [first, last) would actually visit, so erasing an
  1156. // equal_range() removes only the entries with that key, not everything
  1157. // positioned between them.
  1158. iterator erase(const_iterator first, const_iterator last) {
  1159. auto from = first.idx_;
  1160. auto to = last.idx_;
  1161. if (from >= to) { return make_iter(from, npos()); }
  1162. auto begin_it = entries_.begin();
  1163. auto from_it = begin_it + static_cast<difference_type>(from);
  1164. auto to_it = begin_it + static_cast<difference_type>(to);
  1165. if (first.key_idx_ == npos()) {
  1166. entries_.erase(from_it, to_it);
  1167. } else {
  1168. auto key = entries_[first.key_idx_].first;
  1169. auto keep = from_it;
  1170. for (auto it = from_it; it != to_it; ++it) {
  1171. if (!keys_equal(it->first, key)) {
  1172. if (keep != it) { *keep = std::move(*it); }
  1173. ++keep;
  1174. }
  1175. }
  1176. if (keep != to_it) {
  1177. keep = std::move(to_it, entries_.end(), keep);
  1178. } else {
  1179. keep = entries_.end();
  1180. }
  1181. entries_.erase(keep, entries_.end());
  1182. }
  1183. return make_iter(from, npos());
  1184. }
  1185. friend bool operator==(const insertion_ordered_multimap &lhs,
  1186. const insertion_ordered_multimap &rhs) {
  1187. return lhs.entries_ == rhs.entries_;
  1188. }
  1189. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1190. const insertion_ordered_multimap &rhs) {
  1191. return !(lhs == rhs);
  1192. }
  1193. private:
  1194. size_type index_of(const std::string &key) const {
  1195. for (size_type i = 0; i < entries_.size(); i++) {
  1196. if (keys_equal(entries_[i].first, key)) { return i; }
  1197. }
  1198. return npos();
  1199. }
  1200. iterator make_iter(size_type idx, size_type key_idx) {
  1201. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1202. }
  1203. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1204. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1205. }
  1206. std::vector<value_type> entries_;
  1207. };
  1208. } // namespace detail
  1209. using Headers =
  1210. detail::insertion_ordered_multimap<std::string,
  1211. detail::case_ignore::equal_to>;
  1212. // Query parameter names are case-sensitive, unlike header field names.
  1213. using Params =
  1214. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1215. using Match = std::smatch;
  1216. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1217. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1218. /*
  1219. * detail: type-erased storage used by UserData.
  1220. * ABI-stable regardless of C++ standard — always uses this custom
  1221. * implementation instead of std::any.
  1222. */
  1223. namespace detail {
  1224. using any_type_id = const void *;
  1225. template <typename T> any_type_id any_typeid() noexcept {
  1226. static const char id = 0;
  1227. return &id;
  1228. }
  1229. struct any_storage {
  1230. virtual ~any_storage() = default;
  1231. virtual std::unique_ptr<any_storage> clone() const = 0;
  1232. virtual any_type_id type_id() const noexcept = 0;
  1233. };
  1234. template <typename T> struct any_value final : any_storage {
  1235. T value;
  1236. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1237. std::unique_ptr<any_storage> clone() const override {
  1238. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1239. }
  1240. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1241. };
  1242. } // namespace detail
  1243. class UserData {
  1244. public:
  1245. UserData() = default;
  1246. UserData(UserData &&) noexcept = default;
  1247. UserData &operator=(UserData &&) noexcept = default;
  1248. UserData(const UserData &o) {
  1249. for (const auto &e : o.entries_) {
  1250. if (e.second) { entries_[e.first] = e.second->clone(); }
  1251. }
  1252. }
  1253. UserData &operator=(const UserData &o) {
  1254. if (this != &o) {
  1255. entries_.clear();
  1256. for (const auto &e : o.entries_) {
  1257. if (e.second) { entries_[e.first] = e.second->clone(); }
  1258. }
  1259. }
  1260. return *this;
  1261. }
  1262. template <typename T> void set(const std::string &key, T &&value) {
  1263. using D = typename std::decay<T>::type;
  1264. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1265. }
  1266. template <typename T> T *get(const std::string &key) 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<detail::any_value<T> *>(it->second.get())->value;
  1271. }
  1272. template <typename T> const T *get(const std::string &key) const noexcept {
  1273. auto it = entries_.find(key);
  1274. if (it == entries_.end() || !it->second) { return nullptr; }
  1275. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1276. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1277. }
  1278. bool has(const std::string &key) const noexcept {
  1279. return entries_.find(key) != entries_.end();
  1280. }
  1281. void erase(const std::string &key) { entries_.erase(key); }
  1282. void clear() noexcept { entries_.clear(); }
  1283. private:
  1284. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1285. entries_;
  1286. };
  1287. struct Response;
  1288. using ResponseHandler = std::function<bool(const Response &response)>;
  1289. struct FormData {
  1290. std::string name;
  1291. std::string content;
  1292. std::string filename;
  1293. std::string content_type;
  1294. Headers headers;
  1295. };
  1296. struct FormField {
  1297. std::string name;
  1298. std::string content;
  1299. Headers headers;
  1300. };
  1301. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1302. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1303. // should see the parts as they were sent. A std::multimap sorts by field name
  1304. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1305. // than the case-insensitive predicate Headers uses.
  1306. using FormFields =
  1307. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1308. using FormFiles =
  1309. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1310. struct MultipartFormData {
  1311. FormFields fields; // Text fields from multipart
  1312. FormFiles files; // Files from multipart
  1313. // Text field access
  1314. std::string get_field(const std::string &key, size_t id = 0) const;
  1315. std::vector<std::string> get_fields(const std::string &key) const;
  1316. bool has_field(const std::string &key) const;
  1317. size_t get_field_count(const std::string &key) const;
  1318. // File access
  1319. FormData get_file(const std::string &key, size_t id = 0) const;
  1320. std::vector<FormData> get_files(const std::string &key) const;
  1321. bool has_file(const std::string &key) const;
  1322. size_t get_file_count(const std::string &key) const;
  1323. };
  1324. struct UploadFormData {
  1325. std::string name;
  1326. std::string content;
  1327. std::string filename;
  1328. std::string content_type;
  1329. };
  1330. using UploadFormDataItems = std::vector<UploadFormData>;
  1331. class DataSink {
  1332. public:
  1333. DataSink() : os(&sb_), sb_(*this) {}
  1334. DataSink(const DataSink &) = delete;
  1335. DataSink &operator=(const DataSink &) = delete;
  1336. DataSink(DataSink &&) = delete;
  1337. DataSink &operator=(DataSink &&) = delete;
  1338. std::function<bool(const char *data, size_t data_len)> write;
  1339. // Only `write` is mandatory. The rest are defaulted so that a provider
  1340. // calling one on a writer that does not set it gets sensible behaviour
  1341. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1342. // `this` is safe: DataSink is neither copyable nor movable.
  1343. std::function<bool()> is_writable = []() { return true; };
  1344. std::function<void()> done = []() {};
  1345. std::function<void(const Headers &trailer)> done_with_trailer =
  1346. [this](const Headers & /*trailer*/) { done(); };
  1347. std::ostream os;
  1348. private:
  1349. class data_sink_streambuf final : public std::streambuf {
  1350. public:
  1351. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1352. protected:
  1353. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1354. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1355. return 0;
  1356. }
  1357. private:
  1358. DataSink &sink_;
  1359. };
  1360. data_sink_streambuf sb_;
  1361. };
  1362. using ContentProvider =
  1363. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1364. using ContentProviderWithoutLength =
  1365. std::function<bool(size_t offset, DataSink &sink)>;
  1366. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1367. struct FormDataProvider {
  1368. std::string name;
  1369. ContentProviderWithoutLength provider;
  1370. std::string filename;
  1371. std::string content_type;
  1372. };
  1373. using FormDataProviderItems = std::vector<FormDataProvider>;
  1374. inline FormDataProvider
  1375. make_file_provider(const std::string &name, const std::string &filepath,
  1376. const std::string &filename = std::string(),
  1377. const std::string &content_type = std::string()) {
  1378. FormDataProvider fdp;
  1379. fdp.name = name;
  1380. fdp.filename = filename.empty() ? filepath : filename;
  1381. fdp.content_type = content_type;
  1382. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1383. std::ifstream f(filepath, std::ios::binary);
  1384. if (!f) { return false; }
  1385. if (offset > 0) {
  1386. f.seekg(static_cast<std::streamoff>(offset));
  1387. if (!f.good()) {
  1388. sink.done();
  1389. return true;
  1390. }
  1391. }
  1392. char buf[8192];
  1393. f.read(buf, sizeof(buf));
  1394. auto n = static_cast<size_t>(f.gcount());
  1395. if (n > 0) { return sink.write(buf, n); }
  1396. sink.done(); // EOF
  1397. return true;
  1398. };
  1399. return fdp;
  1400. }
  1401. inline std::pair<size_t, ContentProvider>
  1402. make_file_body(const std::string &filepath) {
  1403. size_t size = 0;
  1404. {
  1405. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1406. if (!f) { return {0, ContentProvider{}}; }
  1407. size = static_cast<size_t>(f.tellg());
  1408. }
  1409. ContentProvider provider = [filepath](size_t offset, size_t length,
  1410. DataSink &sink) -> bool {
  1411. std::ifstream f(filepath, std::ios::binary);
  1412. if (!f) { return false; }
  1413. f.seekg(static_cast<std::streamoff>(offset));
  1414. if (!f.good()) { return false; }
  1415. char buf[8192];
  1416. while (length > 0) {
  1417. auto to_read = (std::min)(sizeof(buf), length);
  1418. f.read(buf, static_cast<std::streamsize>(to_read));
  1419. auto n = static_cast<size_t>(f.gcount());
  1420. // The file is shorter than the size make_file_body() measured, which the
  1421. // caller has already committed to as Content-Length. The body cannot be
  1422. // completed, so fail as every other error here does.
  1423. if (n == 0) { return false; }
  1424. if (!sink.write(buf, n)) { return false; }
  1425. length -= n;
  1426. }
  1427. return true;
  1428. };
  1429. return {size, std::move(provider)};
  1430. }
  1431. using ContentReceiverWithProgress = std::function<bool(
  1432. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1433. using ContentReceiver =
  1434. std::function<bool(const char *data, size_t data_length)>;
  1435. using FormDataHeader = std::function<bool(const FormData &file)>;
  1436. class ContentReader {
  1437. public:
  1438. using Reader = std::function<bool(ContentReceiver receiver)>;
  1439. using FormDataReader =
  1440. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1441. ContentReader(Reader reader, FormDataReader multipart_reader)
  1442. : reader_(std::move(reader)),
  1443. formdata_reader_(std::move(multipart_reader)) {}
  1444. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1445. return formdata_reader_(std::move(header), std::move(receiver));
  1446. }
  1447. bool operator()(ContentReceiver receiver) const {
  1448. return reader_(std::move(receiver));
  1449. }
  1450. Reader reader_;
  1451. FormDataReader formdata_reader_;
  1452. };
  1453. using Range = std::pair<ssize_t, ssize_t>;
  1454. using Ranges = std::vector<Range>;
  1455. #ifdef CPPHTTPLIB_SSL_ENABLED
  1456. // TLS abstraction layer - public type definitions and API
  1457. namespace tls {
  1458. // Opaque handles (defined as void* for abstraction)
  1459. using ctx_t = void *;
  1460. using session_t = void *;
  1461. using const_session_t = const void *; // For read-only session access
  1462. using cert_t = void *;
  1463. using ca_store_t = void *;
  1464. // TLS versions
  1465. enum class Version {
  1466. TLS1_2 = 0x0303,
  1467. TLS1_3 = 0x0304,
  1468. };
  1469. // Subject Alternative Names (SAN) entry types
  1470. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1471. // SAN entry structure
  1472. struct SanEntry {
  1473. SanType type;
  1474. std::string value;
  1475. };
  1476. // Verification context for certificate verification callback
  1477. struct VerifyContext {
  1478. session_t session; // TLS session handle
  1479. cert_t cert; // Current certificate being verified
  1480. int depth; // Certificate chain depth (0 = leaf)
  1481. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1482. long error_code; // Backend-specific error code (0 = no error)
  1483. const char *error_string; // Human-readable error description
  1484. // Certificate introspection methods
  1485. std::string subject_cn() const;
  1486. std::string issuer_name() const;
  1487. bool check_hostname(const char *hostname) const;
  1488. std::vector<SanEntry> sans() const;
  1489. bool validity(time_t &not_before, time_t &not_after) const;
  1490. std::string serial() const;
  1491. };
  1492. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1493. // TlsError codes for TLS operations (backend-independent)
  1494. enum class ErrorCode : int {
  1495. Success = 0,
  1496. WantRead, // Non-blocking: need to wait for read
  1497. WantWrite, // Non-blocking: need to wait for write
  1498. PeerClosed, // Peer closed the connection
  1499. Fatal, // Unrecoverable error
  1500. SyscallError, // System call error (check sys_errno)
  1501. CertVerifyFailed, // Certificate verification failed
  1502. HostnameMismatch, // Hostname verification failed
  1503. };
  1504. // TLS error information
  1505. struct TlsError {
  1506. ErrorCode code = ErrorCode::Fatal;
  1507. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1508. int sys_errno = 0; // errno when SyscallError
  1509. // Convert verification error code to human-readable string
  1510. static std::string verify_error_to_string(long error_code);
  1511. };
  1512. // RAII wrapper for peer certificate
  1513. class PeerCert {
  1514. public:
  1515. PeerCert();
  1516. PeerCert(PeerCert &&other) noexcept;
  1517. PeerCert &operator=(PeerCert &&other) noexcept;
  1518. ~PeerCert();
  1519. PeerCert(const PeerCert &) = delete;
  1520. PeerCert &operator=(const PeerCert &) = delete;
  1521. explicit operator bool() const;
  1522. std::string subject_cn() const;
  1523. std::string issuer_name() const;
  1524. bool check_hostname(const char *hostname) const;
  1525. std::vector<SanEntry> sans() const;
  1526. bool validity(time_t &not_before, time_t &not_after) const;
  1527. std::string serial() const;
  1528. private:
  1529. explicit PeerCert(cert_t cert);
  1530. cert_t cert_ = nullptr;
  1531. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1532. };
  1533. // Callback for TLS context setup (used by SSLServer constructor)
  1534. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1535. } // namespace tls
  1536. #endif
  1537. struct Request {
  1538. std::string method;
  1539. std::string path;
  1540. std::string matched_route;
  1541. Params params;
  1542. Headers headers;
  1543. Headers trailers;
  1544. std::string body;
  1545. std::string remote_addr;
  1546. int remote_port = -1;
  1547. std::string local_addr;
  1548. int local_port = -1;
  1549. // for server
  1550. std::string version;
  1551. std::string target;
  1552. MultipartFormData form;
  1553. Ranges ranges;
  1554. Match matches;
  1555. std::unordered_map<std::string, std::string> path_params;
  1556. std::function<bool()> is_connection_closed = []() { return true; };
  1557. // for client
  1558. std::vector<std::string> accept_content_types;
  1559. ResponseHandler response_handler;
  1560. ContentReceiverWithProgress content_receiver;
  1561. DownloadProgress download_progress;
  1562. UploadProgress upload_progress;
  1563. bool has_header(const std::string &key) const;
  1564. std::string get_header_value(const std::string &key, const char *def = "",
  1565. size_t id = 0) const;
  1566. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1567. size_t id = 0) const;
  1568. size_t get_header_value_count(const std::string &key) const;
  1569. void set_header(const std::string &key, const std::string &val);
  1570. bool has_trailer(const std::string &key) const;
  1571. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1572. size_t get_trailer_value_count(const std::string &key) const;
  1573. bool has_param(const std::string &key) const;
  1574. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1575. std::vector<std::string> get_param_values(const std::string &key) const;
  1576. size_t get_param_value_count(const std::string &key) const;
  1577. bool is_multipart_form_data() const;
  1578. // private members...
  1579. bool body_read_started_ = false;
  1580. bool body_consumed_ = false;
  1581. bool expect_100_continue_pending_ = false;
  1582. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1583. size_t content_length_ = 0;
  1584. ContentProvider content_provider_;
  1585. bool is_chunked_content_provider_ = false;
  1586. size_t authorization_count_ = 0;
  1587. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1588. (std::chrono::steady_clock::time_point::min)();
  1589. #ifdef CPPHTTPLIB_SSL_ENABLED
  1590. tls::const_session_t ssl = nullptr;
  1591. tls::PeerCert peer_cert() const;
  1592. std::string sni() const;
  1593. #endif
  1594. };
  1595. namespace detail {
  1596. // Declared up here, away from the rest of the compression helpers, because
  1597. // `Response` stores one.
  1598. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1599. } // namespace detail
  1600. struct Response {
  1601. std::string version;
  1602. int status = -1;
  1603. std::string reason;
  1604. Headers headers;
  1605. Headers trailers;
  1606. std::string body;
  1607. std::string location; // Redirect location
  1608. // User-defined context — set by pre-routing/pre-request handlers and read
  1609. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1610. UserData user_data;
  1611. bool has_header(const std::string &key) const;
  1612. std::string get_header_value(const std::string &key, const char *def = "",
  1613. size_t id = 0) const;
  1614. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1615. size_t id = 0) const;
  1616. size_t get_header_value_count(const std::string &key) const;
  1617. void set_header(const std::string &key, const std::string &val);
  1618. bool has_trailer(const std::string &key) const;
  1619. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1620. size_t get_trailer_value_count(const std::string &key) const;
  1621. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1622. void set_content(const char *s, size_t n, const std::string &content_type);
  1623. void set_content(const std::string &s, const std::string &content_type);
  1624. void set_content(std::string &&s, const std::string &content_type);
  1625. void set_content_provider(
  1626. size_t length, const std::string &content_type, ContentProvider provider,
  1627. ContentProviderResourceReleaser resource_releaser = nullptr);
  1628. void set_content_provider(
  1629. const std::string &content_type, ContentProviderWithoutLength provider,
  1630. ContentProviderResourceReleaser resource_releaser = nullptr);
  1631. void set_chunked_content_provider(
  1632. const std::string &content_type, ContentProviderWithoutLength provider,
  1633. ContentProviderResourceReleaser resource_releaser = nullptr);
  1634. void set_file_content(const std::string &path,
  1635. const std::string &content_type);
  1636. void set_file_content(const std::string &path);
  1637. Response() = default;
  1638. Response(const Response &) = default;
  1639. Response &operator=(const Response &) = default;
  1640. Response(Response &&) = default;
  1641. Response &operator=(Response &&) = default;
  1642. ~Response() {
  1643. if (content_provider_resource_releaser_) {
  1644. content_provider_resource_releaser_(content_provider_success_);
  1645. }
  1646. }
  1647. // private members...
  1648. size_t content_length_ = 0;
  1649. ContentProvider content_provider_;
  1650. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1651. bool is_chunked_content_provider_ = false;
  1652. bool is_file_content_provider_ = false;
  1653. bool content_provider_success_ = false;
  1654. std::string file_content_path_;
  1655. std::string file_content_content_type_;
  1656. // Content coding chosen for the response body, decided once so that the
  1657. // headers and the body cannot disagree: where the file is opened for a
  1658. // file-backed content provider (keeping the ETag honest), and in
  1659. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1660. // for every other kind of response.
  1661. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1662. };
  1663. enum class Error {
  1664. Success = 0,
  1665. Unknown,
  1666. Connection,
  1667. BindIPAddress,
  1668. Read,
  1669. Write,
  1670. ExceedRedirectCount,
  1671. Canceled,
  1672. SSLConnection,
  1673. SSLLoadingCerts,
  1674. SSLServerVerification,
  1675. SSLServerHostnameVerification,
  1676. UnsupportedMultipartBoundaryChars,
  1677. Compression,
  1678. ConnectionTimeout,
  1679. ProxyConnection,
  1680. ConnectionClosed,
  1681. Timeout,
  1682. ResourceExhaustion,
  1683. TooManyFormDataFiles,
  1684. ExceedMaxPayloadSize,
  1685. ExceedUriMaxLength,
  1686. ExceedMaxSocketDescriptorCount,
  1687. InvalidRequestLine,
  1688. InvalidHTTPMethod,
  1689. InvalidHTTPVersion,
  1690. InvalidHeaders,
  1691. MultipartParsing,
  1692. OpenFile,
  1693. Listen,
  1694. GetSockName,
  1695. UnsupportedAddressFamily,
  1696. HTTPParsing,
  1697. InvalidRangeHeader,
  1698. UnsupportedContentEncoding,
  1699. WebSocketHandshake,
  1700. UserCallbackException,
  1701. // For internal use only
  1702. SSLPeerCouldBeClosed_,
  1703. };
  1704. std::string to_string(Error error);
  1705. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1706. class Stream {
  1707. public:
  1708. virtual ~Stream() = default;
  1709. virtual bool is_readable() const = 0;
  1710. virtual bool wait_readable() const = 0;
  1711. virtual bool wait_writable() const = 0;
  1712. virtual bool is_peer_alive() const { return wait_writable(); }
  1713. virtual ssize_t read(char *ptr, size_t size) = 0;
  1714. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1715. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1716. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1717. virtual socket_t socket() const = 0;
  1718. virtual time_t duration() const = 0;
  1719. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1720. (void)sec;
  1721. (void)usec;
  1722. }
  1723. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1724. // each one. 0 lifts the bound.
  1725. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1726. // Lets a wait for data end early once `interrupted` returns true, so that
  1727. // another thread can stop a blocked read on every platform.
  1728. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1729. (void)interrupted;
  1730. }
  1731. // Bytes already pulled off the socket and sitting in this stream's own
  1732. // buffer. Exposing them lets a line reader scan for a terminator in one
  1733. // pass instead of asking for a byte at a time. A stream that does no
  1734. // buffering of its own reports none, and readers fall back to read().
  1735. virtual const char *buffered_data(size_t &size) const {
  1736. size = 0;
  1737. return nullptr;
  1738. }
  1739. // Discards `size` bytes previously returned by buffered_data().
  1740. virtual void consume_buffered(size_t size) { (void)size; }
  1741. ssize_t write(const char *ptr);
  1742. ssize_t write(const std::string &s);
  1743. Error get_error() const { return error_; }
  1744. protected:
  1745. Error error_ = Error::Success;
  1746. };
  1747. class TaskQueue {
  1748. public:
  1749. TaskQueue() = default;
  1750. virtual ~TaskQueue() = default;
  1751. virtual bool enqueue(std::function<void()> fn) = 0;
  1752. virtual void shutdown() = 0;
  1753. virtual void on_idle() {}
  1754. };
  1755. class ThreadPool final : public TaskQueue {
  1756. public:
  1757. explicit ThreadPool(
  1758. size_t n, size_t max_n = 0, size_t mqr = 0,
  1759. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1760. ThreadPool(const ThreadPool &) = delete;
  1761. ~ThreadPool() override = default;
  1762. bool enqueue(std::function<void()> fn) override;
  1763. void shutdown() override;
  1764. private:
  1765. void worker(bool is_dynamic);
  1766. void move_to_finished(std::thread::id id);
  1767. void cleanup_finished_threads();
  1768. size_t base_thread_count_;
  1769. size_t max_thread_count_;
  1770. size_t max_queued_requests_;
  1771. time_t idle_timeout_sec_;
  1772. size_t idle_thread_count_;
  1773. bool shutdown_;
  1774. std::list<std::function<void()>> jobs_;
  1775. std::vector<std::thread> threads_; // base threads
  1776. std::list<std::thread> dynamic_threads_; // dynamic threads
  1777. std::vector<std::thread>
  1778. finished_threads_; // exited dynamic threads awaiting join
  1779. std::condition_variable cond_;
  1780. std::mutex mutex_;
  1781. };
  1782. using Logger = std::function<void(const Request &, const Response &)>;
  1783. // Forward declaration for Error type
  1784. enum class Error;
  1785. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1786. using SocketOptions = std::function<void(socket_t sock)>;
  1787. void default_socket_options(socket_t sock);
  1788. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1789. const char *status_message(int status);
  1790. std::string to_string(Error error);
  1791. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1792. std::string get_bearer_token_auth(const Request &req);
  1793. namespace detail {
  1794. class MatcherBase {
  1795. public:
  1796. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1797. virtual ~MatcherBase() = default;
  1798. const std::string &pattern() const { return pattern_; }
  1799. // Match request path and populate its matches and
  1800. virtual bool match(Request &request) const = 0;
  1801. private:
  1802. std::string pattern_;
  1803. };
  1804. /**
  1805. * Captures parameters in request path and stores them in Request::path_params
  1806. *
  1807. * Capture name is a substring of a pattern from : to /.
  1808. * The rest of the pattern is matched against the request path directly
  1809. * Parameters are captured starting from the next character after
  1810. * the end of the last matched static pattern fragment until the next /.
  1811. *
  1812. * Example pattern:
  1813. * "/path/fragments/:capture/more/fragments/:second_capture"
  1814. * Static fragments:
  1815. * "/path/fragments/", "more/fragments/"
  1816. *
  1817. * Given the following request path:
  1818. * "/path/fragments/:1/more/fragments/:2"
  1819. * the resulting capture will be
  1820. * {{"capture", "1"}, {"second_capture", "2"}}
  1821. */
  1822. class PathParamsMatcher final : public MatcherBase {
  1823. public:
  1824. PathParamsMatcher(const std::string &pattern);
  1825. bool match(Request &request) const override;
  1826. private:
  1827. // Treat segment separators as the end of path parameter capture
  1828. // Does not need to handle query parameters as they are parsed before path
  1829. // matching
  1830. static constexpr char separator = '/';
  1831. // Contains static path fragments to match against, excluding the '/' after
  1832. // path params
  1833. // Fragments are separated by path params
  1834. std::vector<std::string> static_fragments_;
  1835. // Stores the names of the path parameters to be used as keys in the
  1836. // Request::path_params map
  1837. std::vector<std::string> param_names_;
  1838. };
  1839. /**
  1840. * Performs std::regex_match on request path
  1841. * and stores the result in Request::matches
  1842. *
  1843. * Note that regex match is performed directly on the whole request.
  1844. * This means that wildcard patterns may match multiple path segments with /:
  1845. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1846. */
  1847. class RegexMatcher final : public MatcherBase {
  1848. public:
  1849. RegexMatcher(const std::string &pattern)
  1850. : MatcherBase(pattern), regex_(pattern) {}
  1851. bool match(Request &request) const override;
  1852. private:
  1853. std::regex regex_;
  1854. };
  1855. int close_socket(socket_t sock) noexcept;
  1856. bool is_accept_resource_error();
  1857. bool is_accept_transient_error();
  1858. ssize_t write_headers(Stream &strm, const Headers &headers);
  1859. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1860. time_t usec);
  1861. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1862. const std::string &boundary);
  1863. ContentProvider
  1864. make_multipart_content_provider(const UploadFormDataItems &items,
  1865. const std::string &boundary);
  1866. } // namespace detail
  1867. bool is_valid_multipart_boundary(const std::string &boundary);
  1868. // Serializer for multipart/form-data request bodies. The boundary is owned
  1869. // by the writer so that per-part framing and the final terminator always
  1870. // agree. Field names and filenames are escaped following the WHATWG HTML
  1871. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1872. // in content types.
  1873. class MultipartFormDataWriter {
  1874. public:
  1875. MultipartFormDataWriter();
  1876. // precondition: is_valid_multipart_boundary(boundary)
  1877. explicit MultipartFormDataWriter(std::string boundary);
  1878. const std::string &boundary() const;
  1879. std::string content_type() const;
  1880. // In-memory items -> whole body (known length)
  1881. std::string serialize(const UploadFormDataItems &items) const;
  1882. size_t content_length(const UploadFormDataItems &items) const;
  1883. // Per-part framing for streaming via a content provider
  1884. std::string item_begin(const UploadFormData &item) const;
  1885. static std::string item_end();
  1886. std::string finish() const;
  1887. private:
  1888. std::string boundary_;
  1889. };
  1890. class Server {
  1891. public:
  1892. using Handler = std::function<void(const Request &, Response &)>;
  1893. using ExceptionHandler =
  1894. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1895. enum class HandlerResponse {
  1896. Handled,
  1897. Unhandled,
  1898. };
  1899. using HandlerWithResponse =
  1900. std::function<HandlerResponse(const Request &, Response &)>;
  1901. using HandlerWithContentReader = std::function<void(
  1902. const Request &, Response &, const ContentReader &content_reader)>;
  1903. using Expect100ContinueHandler =
  1904. std::function<int(const Request &, Response &)>;
  1905. using StartHandler = std::function<void()>;
  1906. using WebSocketHandler =
  1907. std::function<void(const Request &, ws::WebSocket &)>;
  1908. using SubProtocolSelector =
  1909. std::function<std::string(const std::vector<std::string> &protocols)>;
  1910. Server();
  1911. virtual ~Server();
  1912. virtual bool is_valid() const;
  1913. Server &Get(const std::string &pattern, Handler handler);
  1914. Server &Post(const std::string &pattern, Handler handler);
  1915. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1916. Server &Put(const std::string &pattern, Handler handler);
  1917. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1918. Server &Patch(const std::string &pattern, Handler handler);
  1919. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1920. Server &Delete(const std::string &pattern, Handler handler);
  1921. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1922. Server &Options(const std::string &pattern, Handler handler);
  1923. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1924. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1925. // server accept it; an unregistered method is still rejected with 400.
  1926. // `method` must be a valid HTTP method token and must not be one of the
  1927. // built-in methods, which have their own registration functions above. A
  1928. // rejected registration makes is_valid() return false, so listen() fails.
  1929. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1930. Handler handler);
  1931. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1932. HandlerWithContentReader handler);
  1933. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1934. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1935. SubProtocolSelector sub_protocol_selector);
  1936. bool set_base_dir(const std::string &dir,
  1937. const std::string &mount_point = std::string());
  1938. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1939. Headers headers = Headers());
  1940. bool remove_mount_point(const std::string &mount_point);
  1941. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1942. const std::string &mime);
  1943. Server &set_default_file_mimetype(const std::string &mime);
  1944. Server &set_file_request_handler(Handler handler);
  1945. template <class ErrorHandlerFunc>
  1946. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1947. return set_error_handler_core(
  1948. std::forward<ErrorHandlerFunc>(handler),
  1949. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1950. }
  1951. Server &set_exception_handler(ExceptionHandler handler);
  1952. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1953. Server &set_post_routing_handler(Handler handler);
  1954. Server &set_pre_request_handler(HandlerWithResponse handler);
  1955. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1956. Server &set_start_handler(StartHandler handler);
  1957. Server &set_logger(Logger logger);
  1958. Server &set_pre_compression_logger(Logger logger);
  1959. Server &set_error_logger(ErrorLogger error_logger);
  1960. Server &set_address_family(int family);
  1961. Server &set_tcp_nodelay(bool on);
  1962. Server &set_ipv6_v6only(bool on);
  1963. Server &set_socket_options(SocketOptions socket_options);
  1964. Server &set_default_headers(Headers headers);
  1965. Server &
  1966. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1967. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1968. Server &set_keep_alive_max_count(size_t count);
  1969. Server &set_keep_alive_timeout(time_t sec);
  1970. template <class Rep, class Period>
  1971. Server &
  1972. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1973. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1974. template <class Rep, class Period>
  1975. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1976. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1977. template <class Rep, class Period>
  1978. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1979. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1980. template <class Rep, class Period>
  1981. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1982. Server &set_payload_max_length(size_t length);
  1983. Server &set_compress(bool on);
  1984. Server &set_static_file_compression(bool on);
  1985. Server &set_static_file_compression_min_length(size_t length);
  1986. Server &set_static_file_compression_max_length(size_t length);
  1987. Server &set_websocket_ping_interval(time_t sec);
  1988. template <class Rep, class Period>
  1989. Server &set_websocket_ping_interval(
  1990. const std::chrono::duration<Rep, Period> &duration);
  1991. Server &set_websocket_max_missed_pongs(int count);
  1992. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1993. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1994. bool listen_after_bind();
  1995. bool listen(const std::string &host, int port, int socket_flags = 0);
  1996. bool is_running() const;
  1997. void wait_until_ready() const;
  1998. void stop() noexcept;
  1999. void decommission();
  2000. std::function<TaskQueue *(void)> new_task_queue;
  2001. protected:
  2002. bool process_request(Stream &strm, const std::string &remote_addr,
  2003. int remote_port, const std::string &local_addr,
  2004. int local_port, bool close_connection,
  2005. bool &connection_closed,
  2006. const std::function<void(Request &)> &setup_request,
  2007. bool *websocket_upgraded = nullptr);
  2008. // Runs the per-connection serving loop and stops an exception thrown by a
  2009. // user callback from escaping the worker thread.
  2010. //
  2011. // process_request() wraps only routing() and the hooks before a WebSocket
  2012. // upgrade in a try/catch. Content providers, the post-routing, error,
  2013. // logging and expect-100 handlers and WebSocket handlers all run outside
  2014. // it, and the task queue calls the job without a catch, so an exception
  2015. // from any of those would terminate the process.
  2016. //
  2017. // No 500 is possible here: by the time a content provider runs, the status
  2018. // line and headers are already on the wire. Report it through the error
  2019. // logger and drop the connection, which is what the peer observes either
  2020. // way. Other connections are unaffected.
  2021. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2022. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2023. return serve();
  2024. #else
  2025. try {
  2026. return serve();
  2027. } catch (...) {
  2028. // The error logger is a user callback too, so it must not be able to
  2029. // throw the guard back open.
  2030. try {
  2031. output_error_log(Error::UserCallbackException, nullptr);
  2032. } catch (...) {}
  2033. return false;
  2034. }
  2035. #endif
  2036. }
  2037. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2038. // stop() takes the listening socket away; listen() then waits for handlers
  2039. bool is_stopping() const { return svr_sock_ == INVALID_SOCKET; }
  2040. std::vector<std::string> trusted_proxies_;
  2041. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2042. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2043. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2044. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2045. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2046. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2047. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2048. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2049. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2050. bool compress_ = true;
  2051. bool static_file_compression_ = false;
  2052. size_t static_file_compression_min_length_ =
  2053. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2054. size_t static_file_compression_max_length_ =
  2055. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2056. time_t websocket_ping_interval_sec_ =
  2057. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2058. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2059. private:
  2060. using Handlers =
  2061. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2062. using HandlersForContentReader =
  2063. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2064. HandlerWithContentReader>>;
  2065. // Both handler tables for one custom method live in a single entry, so that
  2066. // routing() needs only one map lookup per request to reach either of them.
  2067. struct CustomHandlerEntry {
  2068. Handlers handlers;
  2069. HandlersForContentReader handlers_for_content_reader;
  2070. };
  2071. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2072. static std::unique_ptr<detail::MatcherBase>
  2073. make_matcher(const std::string &pattern);
  2074. static const std::set<std::string> &builtin_methods();
  2075. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2076. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2077. template <typename H>
  2078. Server &add_handler(
  2079. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2080. const std::string &pattern, H handler) {
  2081. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2082. return *this;
  2083. }
  2084. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2085. Server &set_error_handler_core(Handler handler, std::false_type);
  2086. socket_t create_server_socket(const std::string &host, int port,
  2087. int socket_flags,
  2088. SocketOptions socket_options) const;
  2089. int bind_internal(const std::string &host, int port, int socket_flags);
  2090. bool listen_internal();
  2091. bool routing(Request &req, Response &res, Stream &strm,
  2092. bool skip_pre_routing);
  2093. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2094. bool handle_exception(Request &req, Response &res);
  2095. #endif
  2096. bool handle_file_request(Request &req, Response &res);
  2097. bool check_if_not_modified(const Request &req, Response &res,
  2098. const std::string &etag, time_t mtime) const;
  2099. bool check_if_range(Request &req, const std::string &etag,
  2100. time_t mtime) const;
  2101. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2102. Stream &strm);
  2103. bool dispatch_request_for_content_reader(
  2104. Request &req, Response &res, ContentReader content_reader,
  2105. const HandlersForContentReader &handlers) const;
  2106. bool parse_request_line(const char *s, Request &req) const;
  2107. detail::EncodingType static_file_encoding(const Request &req,
  2108. const Response &res,
  2109. const std::string &content_type,
  2110. size_t length) const;
  2111. bool apply_static_file_compression(const Request &req, Response &res) const;
  2112. void apply_ranges(const Request &req, Response &res,
  2113. std::string &content_type, std::string &boundary) const;
  2114. bool write_response(Stream &strm, bool close_connection, Request &req,
  2115. Response &res);
  2116. bool write_response_with_content(Stream &strm, bool close_connection,
  2117. const Request &req, Response &res);
  2118. bool write_response_core(Stream &strm, bool close_connection,
  2119. const Request &req, Response &res,
  2120. bool need_apply_ranges);
  2121. bool write_content_with_provider(Stream &strm, const Request &req,
  2122. Response &res, const std::string &boundary,
  2123. const std::string &content_type);
  2124. bool read_content(Stream &strm, Request &req, Response &res);
  2125. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2126. Response &res,
  2127. ContentReceiver receiver,
  2128. FormDataHeader multipart_header,
  2129. ContentReceiver multipart_receiver);
  2130. bool read_content_core(Stream &strm, Request &req, Response &res,
  2131. ContentReceiver receiver,
  2132. FormDataHeader multipart_header,
  2133. ContentReceiver multipart_receiver) const;
  2134. virtual bool process_and_close_socket(socket_t sock);
  2135. void output_log(const Request &req, const Response &res) const;
  2136. void output_pre_compression_log(const Request &req,
  2137. const Response &res) const;
  2138. void output_error_log(const Error &err, const Request *req) const;
  2139. std::atomic<bool> is_running_{false};
  2140. std::atomic<bool> is_decommissioned{false};
  2141. // Set when CustomRoute() refuses a registration. Written before listen(),
  2142. // read by is_valid() on the same thread, so it needs no synchronization.
  2143. bool has_invalid_registration_ = false;
  2144. struct MountPointEntry {
  2145. std::string mount_point;
  2146. std::string base_dir;
  2147. std::string resolved_base_dir;
  2148. Headers headers;
  2149. };
  2150. std::vector<MountPointEntry> base_dirs_;
  2151. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2152. std::string default_file_mimetype_ = "application/octet-stream";
  2153. Handler file_request_handler_;
  2154. Handlers get_handlers_;
  2155. Handlers post_handlers_;
  2156. HandlersForContentReader post_handlers_for_content_reader_;
  2157. Handlers put_handlers_;
  2158. HandlersForContentReader put_handlers_for_content_reader_;
  2159. Handlers patch_handlers_;
  2160. HandlersForContentReader patch_handlers_for_content_reader_;
  2161. Handlers delete_handlers_;
  2162. HandlersForContentReader delete_handlers_for_content_reader_;
  2163. Handlers options_handlers_;
  2164. CustomHandlers custom_handlers_;
  2165. struct WebSocketHandlerEntry {
  2166. std::unique_ptr<detail::MatcherBase> matcher;
  2167. WebSocketHandler handler;
  2168. SubProtocolSelector sub_protocol_selector;
  2169. };
  2170. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2171. WebSocketHandlers websocket_handlers_;
  2172. HandlerWithResponse error_handler_;
  2173. ExceptionHandler exception_handler_;
  2174. HandlerWithResponse pre_routing_handler_;
  2175. Handler post_routing_handler_;
  2176. HandlerWithResponse pre_request_handler_;
  2177. Expect100ContinueHandler expect_100_continue_handler_;
  2178. StartHandler start_handler_;
  2179. mutable std::mutex logger_mutex_;
  2180. Logger logger_;
  2181. Logger pre_compression_logger_;
  2182. ErrorLogger error_logger_;
  2183. int address_family_ = AF_UNSPEC;
  2184. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2185. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2186. SocketOptions socket_options_ = default_socket_options;
  2187. Headers default_headers_;
  2188. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2189. detail::write_headers;
  2190. };
  2191. class Result {
  2192. public:
  2193. Result() = default;
  2194. Result(std::unique_ptr<Response> &&res, Error err,
  2195. Headers &&request_headers = Headers{})
  2196. : res_(std::move(res)), err_(err),
  2197. request_headers_(std::move(request_headers)) {}
  2198. // Response
  2199. operator bool() const { return res_ != nullptr; }
  2200. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2201. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2202. const Response &value() const { return *res_; }
  2203. Response &value() { return *res_; }
  2204. const Response &operator*() const { return *res_; }
  2205. Response &operator*() { return *res_; }
  2206. const Response *operator->() const { return res_.get(); }
  2207. Response *operator->() { return res_.get(); }
  2208. // Error
  2209. Error error() const { return err_; }
  2210. // Request Headers
  2211. bool has_request_header(const std::string &key) const;
  2212. std::string get_request_header_value(const std::string &key,
  2213. const char *def = "",
  2214. size_t id = 0) const;
  2215. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2216. size_t id = 0) const;
  2217. size_t get_request_header_value_count(const std::string &key) const;
  2218. private:
  2219. std::unique_ptr<Response> res_;
  2220. Error err_ = Error::Unknown;
  2221. Headers request_headers_;
  2222. #ifdef CPPHTTPLIB_SSL_ENABLED
  2223. public:
  2224. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2225. int ssl_error)
  2226. : res_(std::move(res)), err_(err),
  2227. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2228. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2229. int ssl_error, uint64_t ssl_backend_error)
  2230. : res_(std::move(res)), err_(err),
  2231. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2232. ssl_backend_error_(ssl_backend_error) {}
  2233. int ssl_error() const { return ssl_error_; }
  2234. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2235. private:
  2236. int ssl_error_ = 0;
  2237. uint64_t ssl_backend_error_ = 0;
  2238. #endif
  2239. };
  2240. struct ClientConnection {
  2241. socket_t sock = INVALID_SOCKET;
  2242. bool is_open() const { return sock != INVALID_SOCKET; }
  2243. ClientConnection() = default;
  2244. ~ClientConnection();
  2245. ClientConnection(const ClientConnection &) = delete;
  2246. ClientConnection &operator=(const ClientConnection &) = delete;
  2247. ClientConnection(ClientConnection &&other) noexcept
  2248. : sock(other.sock)
  2249. #ifdef CPPHTTPLIB_SSL_ENABLED
  2250. ,
  2251. session(other.session)
  2252. #endif
  2253. {
  2254. other.sock = INVALID_SOCKET;
  2255. #ifdef CPPHTTPLIB_SSL_ENABLED
  2256. other.session = nullptr;
  2257. #endif
  2258. }
  2259. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2260. if (this != &other) {
  2261. sock = other.sock;
  2262. other.sock = INVALID_SOCKET;
  2263. #ifdef CPPHTTPLIB_SSL_ENABLED
  2264. session = other.session;
  2265. other.session = nullptr;
  2266. #endif
  2267. }
  2268. return *this;
  2269. }
  2270. #ifdef CPPHTTPLIB_SSL_ENABLED
  2271. tls::session_t session = nullptr;
  2272. #endif
  2273. };
  2274. namespace detail {
  2275. struct ChunkedDecoder;
  2276. struct BodyReader {
  2277. Stream *stream = nullptr;
  2278. bool has_content_length = false;
  2279. size_t content_length = 0;
  2280. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2281. size_t bytes_read = 0;
  2282. bool chunked = false;
  2283. bool eof = false;
  2284. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2285. Error last_error = Error::Success;
  2286. ssize_t read(char *buf, size_t len);
  2287. bool has_error() const { return last_error != Error::Success; }
  2288. };
  2289. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2290. size_t len) {
  2291. (void)stream;
  2292. return br.read(buf, len);
  2293. }
  2294. class decompressor;
  2295. enum class NoProxyKind {
  2296. Wildcard, // "*"
  2297. HostnameSuffix, // "example.com" or ".example.com"
  2298. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2299. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2300. };
  2301. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2302. // Lets one CIDR matcher cover both families.
  2303. using IPBytes = std::array<uint8_t, 16>;
  2304. struct NoProxyEntry {
  2305. NoProxyKind kind = NoProxyKind::Wildcard;
  2306. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2307. IPBytes net{};
  2308. int prefix_bits = 0;
  2309. };
  2310. struct NormalizedTarget {
  2311. std::string hostname; // lowercase; brackets and trailing dot removed
  2312. bool is_ipv4 = false;
  2313. bool is_ipv6 = false;
  2314. IPBytes ip{};
  2315. };
  2316. } // namespace detail
  2317. class ClientImpl {
  2318. public:
  2319. explicit ClientImpl(const std::string &host);
  2320. explicit ClientImpl(const std::string &host, int port);
  2321. explicit ClientImpl(const std::string &host, int port,
  2322. const std::string &client_cert_path,
  2323. const std::string &client_key_path);
  2324. virtual ~ClientImpl();
  2325. virtual bool is_valid() const;
  2326. struct StreamHandle {
  2327. std::unique_ptr<Response> response;
  2328. Error error = Error::Success;
  2329. StreamHandle() = default;
  2330. StreamHandle(const StreamHandle &) = delete;
  2331. StreamHandle &operator=(const StreamHandle &) = delete;
  2332. StreamHandle(StreamHandle &&) = default;
  2333. StreamHandle &operator=(StreamHandle &&) = default;
  2334. ~StreamHandle() = default;
  2335. bool is_valid() const {
  2336. return response != nullptr && error == Error::Success;
  2337. }
  2338. ssize_t read(char *buf, size_t len);
  2339. void parse_trailers_if_needed();
  2340. Error get_read_error() const { return body_reader_.last_error; }
  2341. bool has_read_error() const { return body_reader_.has_error(); }
  2342. bool trailers_parsed_ = false;
  2343. private:
  2344. friend class ClientImpl;
  2345. friend class sse::SSEClient;
  2346. ssize_t read_with_decompression(char *buf, size_t len);
  2347. std::unique_ptr<ClientConnection> connection_;
  2348. std::unique_ptr<Stream> socket_stream_;
  2349. Stream *stream_ = nullptr;
  2350. detail::BodyReader body_reader_;
  2351. std::unique_ptr<detail::decompressor> decompressor_;
  2352. std::string decompress_buffer_;
  2353. size_t decompress_offset_ = 0;
  2354. size_t decompressed_bytes_read_ = 0;
  2355. };
  2356. // clang-format off
  2357. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2358. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2359. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2360. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2361. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2362. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2363. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2364. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2365. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2366. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2367. Result Head(const std::string &path);
  2368. Result Head(const std::string &path, const Headers &headers);
  2369. Result Post(const std::string &path);
  2370. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2371. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2372. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2373. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2374. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2375. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2376. Result Post(const std::string &path, const Params &params);
  2377. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2378. Result Post(const std::string &path, const Headers &headers);
  2379. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2380. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2381. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2382. 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);
  2383. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2385. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2386. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2387. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2388. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2389. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2390. Result Put(const std::string &path);
  2391. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2392. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2393. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2394. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2395. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2396. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2397. Result Put(const std::string &path, const Params &params);
  2398. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2399. Result Put(const std::string &path, const Headers &headers);
  2400. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2401. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2402. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2403. 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);
  2404. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2405. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2406. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2407. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2408. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2409. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2410. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2411. Result Patch(const std::string &path);
  2412. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2413. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2414. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2415. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2416. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2417. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2418. Result Patch(const std::string &path, const Params &params);
  2419. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2420. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2421. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2422. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2423. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2424. 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);
  2425. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2426. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2427. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2428. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2429. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2430. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2431. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2432. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2433. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2434. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2435. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2436. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2437. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2438. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2439. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2440. Result Options(const std::string &path);
  2441. Result Options(const std::string &path, const Headers &headers);
  2442. // clang-format on
  2443. // Streaming API: Open a stream for reading response body incrementally
  2444. // Socket ownership is transferred to StreamHandle for true streaming
  2445. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2446. StreamHandle open_stream(const std::string &method, const std::string &path,
  2447. const Params &params = {},
  2448. const Headers &headers = {},
  2449. const std::string &body = {},
  2450. const std::string &content_type = {});
  2451. bool send(Request &req, Response &res, Error &error);
  2452. Result send(const Request &req);
  2453. void stop();
  2454. std::string host() const;
  2455. int port() const;
  2456. size_t is_socket_open() const;
  2457. socket_t socket() const;
  2458. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2459. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2460. void
  2461. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2462. void
  2463. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2464. void set_default_headers(Headers headers);
  2465. void
  2466. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2467. void set_address_family(int family);
  2468. void set_tcp_nodelay(bool on);
  2469. void set_ipv6_v6only(bool on);
  2470. void set_socket_options(SocketOptions socket_options);
  2471. void set_connection_timeout(time_t sec, time_t usec = 0);
  2472. template <class Rep, class Period>
  2473. void
  2474. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2475. void set_read_timeout(time_t sec, time_t usec = 0);
  2476. template <class Rep, class Period>
  2477. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2478. void set_write_timeout(time_t sec, time_t usec = 0);
  2479. template <class Rep, class Period>
  2480. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2481. void set_max_timeout(time_t msec);
  2482. template <class Rep, class Period>
  2483. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2484. void set_basic_auth(const std::string &username, const std::string &password);
  2485. void set_bearer_token_auth(const std::string &token);
  2486. void set_keep_alive(bool on);
  2487. void set_follow_location(bool on);
  2488. void set_path_encode(bool on);
  2489. void set_compress(bool on);
  2490. void set_decompress(bool on);
  2491. void set_payload_max_length(size_t length);
  2492. void set_interface(const std::string &intf);
  2493. void set_proxy(const std::string &host, int port);
  2494. void set_proxy_basic_auth(const std::string &username,
  2495. const std::string &password);
  2496. void set_proxy_bearer_token_auth(const std::string &token);
  2497. void set_no_proxy(const std::vector<std::string> &patterns);
  2498. void set_logger(Logger logger);
  2499. void set_error_logger(ErrorLogger error_logger);
  2500. protected:
  2501. struct Socket {
  2502. socket_t sock = INVALID_SOCKET;
  2503. // For Mbed TLS compatibility: start_time for request timeout tracking
  2504. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2505. bool is_open() const { return sock != INVALID_SOCKET; }
  2506. #ifdef CPPHTTPLIB_SSL_ENABLED
  2507. tls::session_t ssl = nullptr;
  2508. #endif
  2509. };
  2510. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2511. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2512. virtual bool setup_proxy_connection(
  2513. Socket &socket,
  2514. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2515. Response &res, bool &success, Error &error);
  2516. bool is_proxy_enabled_for_host(const std::string &host) const;
  2517. // All of:
  2518. // shutdown_ssl
  2519. // shutdown_socket
  2520. // close_socket
  2521. // disconnect
  2522. // should ONLY be called on socket_ with socket_mutex_ locked, or on a
  2523. // connection being opened, and only when no other thread is using it.
  2524. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2525. void shutdown_socket(Socket &socket) const;
  2526. void close_socket(Socket &socket);
  2527. void disconnect(bool gracefully);
  2528. // Under socket_mutex_: whether the connection kept alive can take another
  2529. // request. One with anything to read, or one set up under TLS settings
  2530. // changed since, is closed instead.
  2531. bool socket_reusable();
  2532. // Makes socket_ ready for a request, with socket_mutex_ held by guard. A new
  2533. // connection is opened without the lock, so that stop() can end it.
  2534. bool
  2535. prepare_socket(std::unique_lock<std::mutex> &guard,
  2536. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2537. Response &res, bool &success, Error &error);
  2538. // TLS settings apply as a connection is set up, so a change makes the
  2539. // connection kept alive unfit for the next request.
  2540. void tls_settings_changed() { tls_settings_version_++; }
  2541. std::string make_request_target(const Request &req) const;
  2542. bool process_request(Stream &strm, Request &req, Response &res,
  2543. bool close_connection, Error &error);
  2544. bool write_content_with_provider(Stream &strm, const Request &req,
  2545. Error &error) const;
  2546. void output_log(const Request &req, const Response &res) const;
  2547. void output_error_log(const Error &err, const Request *req) const;
  2548. // Socket endpoint information
  2549. const std::string host_;
  2550. const int port_;
  2551. // Current open socket
  2552. Socket socket_;
  2553. mutable std::mutex socket_mutex_;
  2554. std::recursive_mutex request_mutex_;
  2555. // How many send() calls are running on this client, guarded by
  2556. // request_mutex_
  2557. size_t send_depth_ = 0;
  2558. // Also guarded by request_mutex_
  2559. size_t socket_tls_settings_version_ = 0;
  2560. // These are all protected under socket_mutex
  2561. size_t socket_requests_in_flight_ = 0;
  2562. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2563. bool socket_should_be_closed_when_request_is_done_ = false;
  2564. // Set by stop(), cleared as a send() or an open_stream() starts. Its waits
  2565. // poll it: shutdown() does not reach a connection being opened, nor wake a
  2566. // read on Windows.
  2567. std::atomic<bool> stop_requested_{false};
  2568. std::function<bool()> stop_interrupt() const {
  2569. return [this] { return stop_requested_.load(); };
  2570. }
  2571. std::atomic<size_t> tls_settings_version_{0};
  2572. // Hostname to connection target map. The value is an IP literal or another
  2573. // hostname; only the connection target changes, never the identity.
  2574. std::map<std::string, std::string> addr_map_;
  2575. // Hostname to CONNECT target map, used only through a proxy.
  2576. std::map<std::string, std::string> tunnel_addr_map_;
  2577. // Default headers
  2578. Headers default_headers_;
  2579. // Header writer
  2580. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2581. detail::write_headers;
  2582. // Settings
  2583. std::string client_cert_path_;
  2584. std::string client_key_path_;
  2585. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2586. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2587. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2588. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2589. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2590. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2591. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2592. std::string basic_auth_username_;
  2593. std::string basic_auth_password_;
  2594. std::string bearer_token_auth_token_;
  2595. bool keep_alive_ = false;
  2596. bool follow_location_ = false;
  2597. bool path_encode_ = true;
  2598. int address_family_ = AF_UNSPEC;
  2599. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2600. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2601. SocketOptions socket_options_ = nullptr;
  2602. bool compress_ = false;
  2603. bool decompress_ = true;
  2604. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2605. bool has_payload_max_length_ = false;
  2606. std::string interface_;
  2607. std::string proxy_host_;
  2608. int proxy_port_ = -1;
  2609. std::string proxy_basic_auth_username_;
  2610. std::string proxy_basic_auth_password_;
  2611. std::string proxy_bearer_token_auth_token_;
  2612. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2613. mutable detail::NormalizedTarget host_normalized_;
  2614. mutable bool host_normalized_valid_ = false;
  2615. mutable std::mutex logger_mutex_;
  2616. Logger logger_;
  2617. ErrorLogger error_logger_;
  2618. private:
  2619. bool send_(Request &req, Response &res, Error &error);
  2620. Result send_(Request &&req);
  2621. socket_t create_client_socket(Error &error) const;
  2622. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2623. bool skip_100_continue = true) const;
  2624. bool write_request(Stream &strm, Request &req, bool close_connection,
  2625. Error &error, bool skip_body, bool &rejected_locally);
  2626. bool write_request_body(Stream &strm, Request &req, Error &error);
  2627. void prepare_default_headers(Request &r, bool for_stream,
  2628. const std::string &ct);
  2629. bool redirect(Request &req, Response &res, Error &error);
  2630. bool create_redirect_client(const std::string &scheme,
  2631. const std::string &host, int port, Request &req,
  2632. Response &res, const std::string &path,
  2633. const std::string &location, Error &error);
  2634. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2635. bool handle_request(Stream &strm, Request &req, Response &res,
  2636. bool close_connection, Error &error);
  2637. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2638. Request &req, const char *body, size_t content_length,
  2639. ContentProvider content_provider,
  2640. ContentProviderWithoutLength content_provider_without_length,
  2641. const std::string &content_type, ContentReceiver content_receiver,
  2642. Error &error);
  2643. Result send_with_content_provider_and_receiver(
  2644. const std::string &method, const std::string &path,
  2645. const Headers &headers, const char *body, size_t content_length,
  2646. ContentProvider content_provider,
  2647. ContentProviderWithoutLength content_provider_without_length,
  2648. const std::string &content_type, ContentReceiver content_receiver,
  2649. UploadProgress progress);
  2650. ContentProviderWithoutLength get_multipart_content_provider(
  2651. const std::string &boundary, const UploadFormDataItems &items,
  2652. const FormDataProviderItems &provider_items) const;
  2653. virtual bool
  2654. process_socket(const Socket &socket,
  2655. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2656. std::function<bool(Stream &strm)> callback);
  2657. virtual bool is_ssl() const;
  2658. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2659. StreamHandle open_stream_(Request &req);
  2660. void add_credential_headers(Request &req);
  2661. std::string proxy_target_prefix() const;
  2662. #ifdef CPPHTTPLIB_SSL_ENABLED
  2663. public:
  2664. void set_digest_auth(const std::string &username,
  2665. const std::string &password);
  2666. void set_proxy_digest_auth(const std::string &username,
  2667. const std::string &password);
  2668. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2669. const std::string &ca_cert_dir_path = std::string());
  2670. void enable_server_certificate_verification(bool enabled);
  2671. void enable_server_hostname_verification(bool enabled);
  2672. void enable_system_ca(bool enabled);
  2673. protected:
  2674. std::string digest_auth_username_;
  2675. std::string digest_auth_password_;
  2676. std::string proxy_digest_auth_username_;
  2677. std::string proxy_digest_auth_password_;
  2678. std::string ca_cert_file_path_;
  2679. std::string ca_cert_dir_path_;
  2680. bool server_certificate_verification_ = true;
  2681. bool server_hostname_verification_ = true;
  2682. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2683. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2684. int last_ssl_error_ = 0;
  2685. uint64_t last_backend_error_ = 0;
  2686. #endif
  2687. };
  2688. namespace detail {
  2689. // Stands in for a client that Client could not make from its arguments, so a
  2690. // request fails rather than going through a null pointer.
  2691. class InvalidClientImpl final : public ClientImpl {
  2692. public:
  2693. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2694. bool is_valid() const override { return false; }
  2695. private:
  2696. bool create_and_connect_socket(Socket &, Error &error) override {
  2697. error = Error::Connection;
  2698. return false;
  2699. }
  2700. };
  2701. } // namespace detail
  2702. class Client {
  2703. public:
  2704. // Universal interface
  2705. explicit Client(const std::string &scheme_host_port);
  2706. explicit Client(const std::string &scheme_host_port,
  2707. const std::string &client_cert_path,
  2708. const std::string &client_key_path);
  2709. // HTTP only interface
  2710. explicit Client(const std::string &host, int port);
  2711. explicit Client(const std::string &host, int port,
  2712. const std::string &client_cert_path,
  2713. const std::string &client_key_path);
  2714. Client(Client &&) = default;
  2715. Client &operator=(Client &&) = default;
  2716. ~Client();
  2717. bool is_valid() const;
  2718. // clang-format off
  2719. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2720. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2721. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2722. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2723. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2724. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2725. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2726. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2727. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2728. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2729. Result Head(const std::string &path);
  2730. Result Head(const std::string &path, const Headers &headers);
  2731. Result Post(const std::string &path);
  2732. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2733. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2734. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2735. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2736. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2737. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2738. Result Post(const std::string &path, const Params &params);
  2739. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2740. Result Post(const std::string &path, const Headers &headers);
  2741. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2742. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2743. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2744. 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);
  2745. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2746. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2747. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2748. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2749. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2750. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2751. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2752. Result Put(const std::string &path);
  2753. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2754. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2755. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2756. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2757. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2758. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2759. Result Put(const std::string &path, const Params &params);
  2760. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2761. Result Put(const std::string &path, const Headers &headers);
  2762. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2763. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2764. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2765. 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);
  2766. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2767. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2768. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2769. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2770. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2771. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2772. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2773. Result Patch(const std::string &path);
  2774. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2775. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2776. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2777. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2778. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2779. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2780. Result Patch(const std::string &path, const Params &params);
  2781. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2782. Result Patch(const std::string &path, const Headers &headers);
  2783. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2784. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2785. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2786. 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);
  2787. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2788. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2789. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2790. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2791. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2792. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2793. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2794. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2795. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2796. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2797. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2798. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2799. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2800. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2801. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2802. Result Options(const std::string &path);
  2803. Result Options(const std::string &path, const Headers &headers);
  2804. // clang-format on
  2805. // Streaming API: Open a stream for reading response body incrementally
  2806. // Socket ownership is transferred to StreamHandle for true streaming
  2807. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2808. ClientImpl::StreamHandle open_stream(const std::string &method,
  2809. const std::string &path,
  2810. const Params &params = {},
  2811. const Headers &headers = {},
  2812. const std::string &body = {},
  2813. const std::string &content_type = {});
  2814. bool send(Request &req, Response &res, Error &error);
  2815. Result send(const Request &req);
  2816. void stop();
  2817. std::string host() const;
  2818. int port() const;
  2819. size_t is_socket_open() const;
  2820. socket_t socket() const;
  2821. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2822. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2823. void
  2824. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2825. void
  2826. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2827. void set_default_headers(Headers headers);
  2828. void
  2829. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2830. void set_address_family(int family);
  2831. void set_tcp_nodelay(bool on);
  2832. void set_socket_options(SocketOptions socket_options);
  2833. void set_connection_timeout(time_t sec, time_t usec = 0);
  2834. template <class Rep, class Period>
  2835. void
  2836. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2837. void set_read_timeout(time_t sec, time_t usec = 0);
  2838. template <class Rep, class Period>
  2839. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2840. void set_write_timeout(time_t sec, time_t usec = 0);
  2841. template <class Rep, class Period>
  2842. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2843. void set_max_timeout(time_t msec);
  2844. template <class Rep, class Period>
  2845. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2846. void set_basic_auth(const std::string &username, const std::string &password);
  2847. void set_bearer_token_auth(const std::string &token);
  2848. void set_keep_alive(bool on);
  2849. void set_follow_location(bool on);
  2850. void set_path_encode(bool on);
  2851. void set_compress(bool on);
  2852. void set_decompress(bool on);
  2853. void set_payload_max_length(size_t length);
  2854. void set_interface(const std::string &intf);
  2855. void set_proxy(const std::string &host, int port);
  2856. void set_proxy_basic_auth(const std::string &username,
  2857. const std::string &password);
  2858. void set_proxy_bearer_token_auth(const std::string &token);
  2859. void set_no_proxy(const std::vector<std::string> &patterns);
  2860. void set_logger(Logger logger);
  2861. void set_error_logger(ErrorLogger error_logger);
  2862. private:
  2863. std::unique_ptr<ClientImpl> cli_;
  2864. #ifdef CPPHTTPLIB_SSL_ENABLED
  2865. public:
  2866. void set_digest_auth(const std::string &username,
  2867. const std::string &password);
  2868. void set_proxy_digest_auth(const std::string &username,
  2869. const std::string &password);
  2870. void enable_server_certificate_verification(bool enabled);
  2871. void enable_server_hostname_verification(bool enabled);
  2872. void enable_system_ca(bool enabled);
  2873. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2874. const std::string &ca_cert_dir_path = std::string());
  2875. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2876. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2877. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2878. void set_session_verifier(
  2879. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2880. tls::ctx_t tls_context() const;
  2881. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2882. void enable_windows_certificate_verification(bool enabled);
  2883. #endif
  2884. private:
  2885. bool is_ssl_ = false;
  2886. #endif
  2887. };
  2888. #ifdef CPPHTTPLIB_SSL_ENABLED
  2889. class SSLServer : public Server {
  2890. public:
  2891. SSLServer(const char *cert_path, const char *private_key_path,
  2892. const char *client_ca_cert_file_path = nullptr,
  2893. const char *client_ca_cert_dir_path = nullptr,
  2894. const char *private_key_password = nullptr);
  2895. struct PemMemory {
  2896. const char *cert_pem;
  2897. size_t cert_pem_len;
  2898. const char *key_pem;
  2899. size_t key_pem_len;
  2900. const char *client_ca_pem;
  2901. size_t client_ca_pem_len;
  2902. const char *private_key_password;
  2903. };
  2904. explicit SSLServer(const PemMemory &pem);
  2905. // The callback receives the ctx_t handle which can be cast to the
  2906. // appropriate backend type (SSL_CTX* for OpenSSL,
  2907. // tls::impl::MbedTlsContext* for Mbed TLS)
  2908. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2909. ~SSLServer() override;
  2910. bool is_valid() const override;
  2911. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2912. const char *client_ca_pem = nullptr,
  2913. const char *password = nullptr);
  2914. tls::ctx_t tls_context() const { return ctx_; }
  2915. int ssl_last_error() const { return last_ssl_error_; }
  2916. private:
  2917. bool process_and_close_socket(socket_t sock) override;
  2918. tls::ctx_t ctx_ = nullptr;
  2919. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2920. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2921. // bounds, and new ones wait while it is pending so that they cannot keep it
  2922. // waiting.
  2923. std::mutex ctx_mutex_;
  2924. std::condition_variable ctx_cv_;
  2925. size_t handshakes_in_progress_ = 0;
  2926. size_t updates_pending_ = 0;
  2927. int last_ssl_error_ = 0;
  2928. };
  2929. class SSLClient final : public ClientImpl {
  2930. public:
  2931. explicit SSLClient(const std::string &host);
  2932. explicit SSLClient(const std::string &host, int port);
  2933. explicit SSLClient(const std::string &host, int port,
  2934. const std::string &client_cert_path,
  2935. const std::string &client_key_path,
  2936. const std::string &private_key_password = std::string());
  2937. struct PemMemory {
  2938. const char *cert_pem;
  2939. size_t cert_pem_len;
  2940. const char *key_pem;
  2941. size_t key_pem_len;
  2942. const char *private_key_password;
  2943. };
  2944. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2945. ~SSLClient() override;
  2946. bool is_valid() const override;
  2947. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2948. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2949. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2950. // Post-handshake session verifier (backend-independent)
  2951. void set_session_verifier(
  2952. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2953. tls::ctx_t tls_context() const { return ctx_; }
  2954. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2955. void enable_windows_certificate_verification(bool enabled);
  2956. #endif
  2957. private:
  2958. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2959. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2960. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2961. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2962. bool
  2963. process_socket(const Socket &socket,
  2964. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2965. std::function<bool(Stream &strm)> callback) override;
  2966. bool is_ssl() const override;
  2967. bool setup_proxy_connection(
  2968. Socket &socket,
  2969. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2970. Response &res, bool &success, Error &error) override;
  2971. bool connect_with_proxy(
  2972. Socket &sock,
  2973. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2974. Response &res, bool &success, Error &error);
  2975. bool initialize_ssl(Socket &socket, Error &error);
  2976. void init_ctx();
  2977. void reset_ctx_on_error();
  2978. bool load_certs();
  2979. tls::ctx_t ctx_ = nullptr;
  2980. std::mutex ctx_mutex_;
  2981. std::once_flag initialize_cert_;
  2982. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2983. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2984. bool ca_cert_store_set_ = false;
  2985. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2986. // no certificate, so that a CA that failed to come through fails
  2987. // verification instead of letting the system CAs in.
  2988. bool custom_ca_loaded_ = false;
  2989. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2990. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2991. // set_server_certificate_verifier() installed there.
  2992. tls::VerifyCallback server_certificate_verifier_;
  2993. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2994. bool enable_windows_cert_verification_ = true;
  2995. #endif
  2996. friend class ClientImpl;
  2997. };
  2998. #endif // CPPHTTPLIB_SSL_ENABLED
  2999. namespace detail {
  3000. template <typename T, typename U>
  3001. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  3002. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  3003. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  3004. duration - std::chrono::seconds(sec))
  3005. .count();
  3006. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  3007. }
  3008. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  3009. return N - 1;
  3010. }
  3011. inline bool is_numeric(const std::string &str) {
  3012. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  3013. }
  3014. // std::ranges::next(first, n, last) for C++11
  3015. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  3016. for (; n > 0 && first != last; --n) {
  3017. ++first;
  3018. }
  3019. return first;
  3020. }
  3021. inline size_t get_header_value_u64(const Headers &headers,
  3022. const std::string &key, size_t def,
  3023. size_t id, bool &is_invalid_value) {
  3024. is_invalid_value = false;
  3025. auto rng = headers.equal_range(key);
  3026. auto it = bounded_next(rng.first, id, rng.second);
  3027. if (it != rng.second) {
  3028. if (is_numeric(it->second)) {
  3029. // Parse at size_t width so an out-of-range Content-Length is reported
  3030. // rather than silently saturated/truncated (a value above 2^32 would
  3031. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  3032. // and return SIZE_MAX so the existing oversized-value guards reject it.
  3033. size_t val = 0;
  3034. const auto &s = it->second;
  3035. auto r = from_chars(s.data(), s.data() + s.size(), val);
  3036. if (r.ec == std::errc::result_out_of_range) {
  3037. is_invalid_value = true;
  3038. return (std::numeric_limits<size_t>::max)();
  3039. }
  3040. return val;
  3041. } else {
  3042. is_invalid_value = true;
  3043. }
  3044. }
  3045. return def;
  3046. }
  3047. inline size_t get_header_value_u64(const Headers &headers,
  3048. const std::string &key, size_t def,
  3049. size_t id) {
  3050. auto dummy = false;
  3051. return get_header_value_u64(headers, key, def, id, dummy);
  3052. }
  3053. } // namespace detail
  3054. template <class Rep, class Period>
  3055. inline Server &
  3056. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3057. detail::duration_to_sec_and_usec(
  3058. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3059. return *this;
  3060. }
  3061. template <class Rep, class Period>
  3062. inline Server &
  3063. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3064. detail::duration_to_sec_and_usec(
  3065. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3066. return *this;
  3067. }
  3068. template <class Rep, class Period>
  3069. inline Server &
  3070. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3071. detail::duration_to_sec_and_usec(
  3072. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3073. return *this;
  3074. }
  3075. template <class Rep, class Period>
  3076. inline void ClientImpl::set_connection_timeout(
  3077. const std::chrono::duration<Rep, Period> &duration) {
  3078. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3079. set_connection_timeout(sec, usec);
  3080. });
  3081. }
  3082. template <class Rep, class Period>
  3083. inline void ClientImpl::set_read_timeout(
  3084. const std::chrono::duration<Rep, Period> &duration) {
  3085. detail::duration_to_sec_and_usec(
  3086. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3087. }
  3088. template <class Rep, class Period>
  3089. inline void ClientImpl::set_write_timeout(
  3090. const std::chrono::duration<Rep, Period> &duration) {
  3091. detail::duration_to_sec_and_usec(
  3092. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3093. }
  3094. template <class Rep, class Period>
  3095. inline void ClientImpl::set_max_timeout(
  3096. const std::chrono::duration<Rep, Period> &duration) {
  3097. auto msec =
  3098. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3099. set_max_timeout(static_cast<time_t>(msec));
  3100. }
  3101. template <class Rep, class Period>
  3102. inline void Client::set_connection_timeout(
  3103. const std::chrono::duration<Rep, Period> &duration) {
  3104. cli_->set_connection_timeout(duration);
  3105. }
  3106. template <class Rep, class Period>
  3107. inline void
  3108. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3109. cli_->set_read_timeout(duration);
  3110. }
  3111. template <class Rep, class Period>
  3112. inline void
  3113. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3114. cli_->set_write_timeout(duration);
  3115. }
  3116. inline void Client::set_max_timeout(time_t msec) {
  3117. cli_->set_max_timeout(msec);
  3118. }
  3119. template <class Rep, class Period>
  3120. inline void
  3121. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3122. cli_->set_max_timeout(duration);
  3123. }
  3124. /*
  3125. * Forward declarations and types that will be part of the .h file if split into
  3126. * .h + .cc.
  3127. */
  3128. std::string hosted_at(const std::string &hostname);
  3129. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3130. // JavaScript-style URL encoding/decoding functions
  3131. std::string encode_uri_component(const std::string &value);
  3132. std::string encode_uri(const std::string &value);
  3133. std::string decode_uri_component(const std::string &value);
  3134. std::string decode_uri(const std::string &value);
  3135. // RFC 3986 compliant URL component encoding/decoding functions
  3136. std::string encode_path_component(const std::string &component);
  3137. std::string decode_path_component(const std::string &component);
  3138. std::string encode_query_component(const std::string &component,
  3139. bool space_as_plus = true);
  3140. std::string decode_query_component(const std::string &component,
  3141. bool plus_as_space = true);
  3142. std::string sanitize_filename(const std::string &filename);
  3143. std::string append_query_params(const std::string &path, const Params &params);
  3144. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3145. std::pair<std::string, std::string>
  3146. make_basic_authentication_header(const std::string &username,
  3147. const std::string &password,
  3148. bool is_proxy = false);
  3149. namespace detail {
  3150. #if defined(_WIN32)
  3151. inline std::wstring u8string_to_wstring(const char *s) {
  3152. if (!s) { return std::wstring(); }
  3153. auto len = static_cast<int>(strlen(s));
  3154. if (!len) { return std::wstring(); }
  3155. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3156. if (!wlen) { return std::wstring(); }
  3157. std::wstring ws;
  3158. ws.resize(wlen);
  3159. wlen = ::MultiByteToWideChar(
  3160. CP_UTF8, 0, s, len,
  3161. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3162. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3163. return ws;
  3164. }
  3165. #endif
  3166. struct FileStat {
  3167. FileStat(const std::string &path);
  3168. bool is_file() const;
  3169. bool is_dir() const;
  3170. time_t mtime() const;
  3171. size_t size() const;
  3172. private:
  3173. #if defined(_WIN32)
  3174. struct _stat st_;
  3175. #else
  3176. struct stat st_;
  3177. #endif
  3178. int ret_ = -1;
  3179. };
  3180. std::string make_host_and_port_string(const std::string &host, int port,
  3181. bool is_ssl);
  3182. template <typename T>
  3183. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3184. Error &error);
  3185. bool write_data(Stream &strm, const char *d, size_t l);
  3186. std::string trim_copy(const std::string &s);
  3187. void divide(
  3188. const char *data, std::size_t size, char d,
  3189. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3190. fn);
  3191. void divide(
  3192. const std::string &str, char d,
  3193. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3194. fn);
  3195. void split(const char *b, const char *e, char d,
  3196. std::function<void(const char *, const char *)> fn);
  3197. void split(const char *b, const char *e, char d, size_t m,
  3198. std::function<void(const char *, const char *)> fn);
  3199. bool split_find(const char *b, const char *e, char d,
  3200. std::function<bool(const char *, const char *)> fn);
  3201. bool has_header_token(const Headers &headers, const std::string &key,
  3202. const std::string &token);
  3203. std::string websocket_accept_key(const std::string &client_key);
  3204. bool is_websocket_upgrade(const Request &req);
  3205. bool process_client_socket(
  3206. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3207. time_t write_timeout_sec, time_t write_timeout_usec,
  3208. time_t max_timeout_msec,
  3209. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3210. std::function<bool(Stream &)> callback);
  3211. socket_t create_client_socket(
  3212. const std::string &host, const std::string &ip, int port,
  3213. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  3214. SocketOptions socket_options, time_t connection_timeout_sec,
  3215. time_t connection_timeout_usec, time_t read_timeout_sec,
  3216. time_t read_timeout_usec, time_t write_timeout_sec,
  3217. time_t write_timeout_usec, const std::string &intf, Error &error,
  3218. const std::function<bool()> &interrupted = nullptr);
  3219. const char *get_header_value(const Headers &headers, const std::string &key,
  3220. const char *def, size_t id);
  3221. std::string get_combined_header_value(const Headers &headers,
  3222. const std::string &key);
  3223. std::string params_to_query_str(const Params &params);
  3224. void parse_query_text(const char *data, std::size_t size, Params &params);
  3225. void parse_query_text(const std::string &s, Params &params);
  3226. bool parse_multipart_boundary(const std::string &content_type,
  3227. std::string &boundary);
  3228. bool parse_range_header(const std::string &s, Ranges &ranges);
  3229. bool parse_accept_header(const std::string &s,
  3230. std::vector<std::string> &content_types);
  3231. void parse_disposition_params(const std::string &s, Params &params);
  3232. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3233. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3234. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3235. EncodingType encoding_type(const Request &req, const Response &res,
  3236. const std::string &content_type);
  3237. EncodingType encoding_type(const Request &req, const Response &res);
  3238. class BufferStream final : public Stream {
  3239. public:
  3240. BufferStream() = default;
  3241. ~BufferStream() override = default;
  3242. bool is_readable() const override;
  3243. bool wait_readable() const override;
  3244. bool wait_writable() const override;
  3245. ssize_t read(char *ptr, size_t size) override;
  3246. ssize_t write(const char *ptr, size_t size) override;
  3247. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3248. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3249. socket_t socket() const override;
  3250. time_t duration() const override;
  3251. const std::string &get_buffer() const;
  3252. private:
  3253. std::string buffer;
  3254. size_t position = 0;
  3255. };
  3256. class compressor {
  3257. public:
  3258. virtual ~compressor() = default;
  3259. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3260. virtual bool compress(const char *data, size_t data_length, bool last,
  3261. Callback callback) = 0;
  3262. };
  3263. class decompressor {
  3264. public:
  3265. virtual ~decompressor() = default;
  3266. virtual bool is_valid() const = 0;
  3267. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3268. virtual bool decompress(const char *data, size_t data_length,
  3269. Callback callback) = 0;
  3270. };
  3271. class nocompressor final : public compressor {
  3272. public:
  3273. ~nocompressor() override = default;
  3274. bool compress(const char *data, size_t data_length, bool /*last*/,
  3275. Callback callback) override;
  3276. };
  3277. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3278. class gzip_compressor final : public compressor {
  3279. public:
  3280. gzip_compressor();
  3281. ~gzip_compressor() override;
  3282. bool compress(const char *data, size_t data_length, bool last,
  3283. Callback callback) override;
  3284. private:
  3285. bool is_valid_ = false;
  3286. z_stream strm_;
  3287. };
  3288. class gzip_decompressor final : public decompressor {
  3289. public:
  3290. gzip_decompressor();
  3291. ~gzip_decompressor() override;
  3292. bool is_valid() const override;
  3293. bool decompress(const char *data, size_t data_length,
  3294. Callback callback) override;
  3295. private:
  3296. bool is_valid_ = false;
  3297. z_stream strm_;
  3298. };
  3299. #endif
  3300. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3301. class brotli_compressor final : public compressor {
  3302. public:
  3303. brotli_compressor();
  3304. ~brotli_compressor();
  3305. bool compress(const char *data, size_t data_length, bool last,
  3306. Callback callback) override;
  3307. private:
  3308. BrotliEncoderState *state_ = nullptr;
  3309. };
  3310. class brotli_decompressor final : public decompressor {
  3311. public:
  3312. brotli_decompressor();
  3313. ~brotli_decompressor();
  3314. bool is_valid() const override;
  3315. bool decompress(const char *data, size_t data_length,
  3316. Callback callback) override;
  3317. private:
  3318. BrotliDecoderResult decoder_r;
  3319. BrotliDecoderState *decoder_s = nullptr;
  3320. };
  3321. #endif
  3322. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3323. class zstd_compressor : public compressor {
  3324. public:
  3325. zstd_compressor();
  3326. ~zstd_compressor();
  3327. bool compress(const char *data, size_t data_length, bool last,
  3328. Callback callback) override;
  3329. private:
  3330. ZSTD_CCtx *ctx_ = nullptr;
  3331. };
  3332. class zstd_decompressor : public decompressor {
  3333. public:
  3334. zstd_decompressor();
  3335. ~zstd_decompressor();
  3336. bool is_valid() const override;
  3337. bool decompress(const char *data, size_t data_length,
  3338. Callback callback) override;
  3339. private:
  3340. ZSTD_DCtx *ctx_ = nullptr;
  3341. };
  3342. #endif
  3343. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3344. // to store data. The call can set memory on stack for performance.
  3345. class stream_line_reader {
  3346. public:
  3347. stream_line_reader(Stream &strm, char *fixed_buffer,
  3348. size_t fixed_buffer_size);
  3349. const char *ptr() const;
  3350. size_t size() const;
  3351. bool end_with_crlf() const;
  3352. bool getline();
  3353. private:
  3354. void append(char c);
  3355. void append(const char *data, size_t size);
  3356. Stream &strm_;
  3357. char *fixed_buffer_;
  3358. const size_t fixed_buffer_size_;
  3359. size_t fixed_buffer_used_size_ = 0;
  3360. std::string growable_buffer_;
  3361. };
  3362. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3363. const Headers &src_headers);
  3364. struct ChunkedDecoder {
  3365. Stream &strm;
  3366. size_t chunk_remaining = 0;
  3367. bool finished = false;
  3368. char line_buf[64];
  3369. size_t last_chunk_total = 0;
  3370. size_t last_chunk_offset = 0;
  3371. size_t overhead = 0;
  3372. explicit ChunkedDecoder(Stream &s);
  3373. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3374. size_t &out_chunk_total);
  3375. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3376. };
  3377. // A regular file opened to be served: mapped on Windows, read with pread()
  3378. // elsewhere.
  3379. class mmap {
  3380. public:
  3381. mmap(const char *path);
  3382. ~mmap();
  3383. bool open(const char *path);
  3384. void close();
  3385. bool is_open() const;
  3386. size_t size() const;
  3387. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3388. // down to 0, if the file has shrunk since it was opened.
  3389. size_t read(size_t offset, char *buf, size_t len) const;
  3390. private:
  3391. #if defined(_WIN32)
  3392. HANDLE hFile_ = NULL;
  3393. HANDLE hMapping_ = NULL;
  3394. void *addr_ = nullptr;
  3395. bool is_open_empty_file = false;
  3396. #else
  3397. int fd_ = -1;
  3398. #endif
  3399. size_t size_ = 0;
  3400. };
  3401. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3402. namespace fields {
  3403. bool is_token_char(char c);
  3404. bool is_token(const std::string &s);
  3405. bool is_field_name(const std::string &s);
  3406. bool is_vchar(char c);
  3407. bool is_obs_text(char c);
  3408. bool is_field_vchar(char c);
  3409. bool is_field_content(const std::string &s);
  3410. bool is_field_value(const std::string &s);
  3411. bool is_field_valid(const std::string &name, const std::string &value);
  3412. bool is_request_target(const std::string &s);
  3413. bool is_host(const std::string &s);
  3414. } // namespace fields
  3415. } // namespace detail
  3416. /*
  3417. * TLS Abstraction Layer Declarations
  3418. */
  3419. #ifdef CPPHTTPLIB_SSL_ENABLED
  3420. // TLS abstraction layer - backend-specific type declarations
  3421. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3422. namespace tls {
  3423. namespace impl {
  3424. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3425. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3426. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3427. struct MbedTlsContext {
  3428. mbedtls_ssl_config conf;
  3429. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3430. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3431. mbedtls_entropy_context entropy;
  3432. mbedtls_ctr_drbg_context ctr_drbg;
  3433. #endif
  3434. mbedtls_x509_crt ca_chain;
  3435. mbedtls_x509_crt own_cert;
  3436. mbedtls_pk_context own_key;
  3437. bool is_server = false;
  3438. // Peer certificate required (set_verify_client()); a client defaults to true
  3439. bool verify_client = false;
  3440. // Set by tls::set_verify_callback().
  3441. VerifyCallback verify_callback;
  3442. MbedTlsContext();
  3443. ~MbedTlsContext();
  3444. MbedTlsContext(const MbedTlsContext &) = delete;
  3445. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3446. };
  3447. } // namespace impl
  3448. } // namespace tls
  3449. #endif
  3450. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3451. namespace tls {
  3452. namespace impl {
  3453. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3454. // This struct is accessible via tls::impl for use in SSL context
  3455. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3456. struct WolfSSLContext {
  3457. WOLFSSL_CTX *ctx = nullptr;
  3458. bool is_server = false;
  3459. // Peer certificate required (set_verify_client()); a client defaults to true
  3460. bool verify_client = false;
  3461. // Replaced under verify_callback_mutex()
  3462. std::shared_ptr<VerifyCallback> verify_callback;
  3463. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3464. WolfSSLContext();
  3465. ~WolfSSLContext();
  3466. WolfSSLContext(const WolfSSLContext &) = delete;
  3467. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3468. };
  3469. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3470. struct WolfSSLCAStore {
  3471. std::string pem_data;
  3472. };
  3473. } // namespace impl
  3474. } // namespace tls
  3475. #endif
  3476. #endif // CPPHTTPLIB_SSL_ENABLED
  3477. namespace stream {
  3478. class Result {
  3479. public:
  3480. Result();
  3481. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3482. Result(Result &&other) noexcept;
  3483. Result &operator=(Result &&other) noexcept;
  3484. Result(const Result &) = delete;
  3485. Result &operator=(const Result &) = delete;
  3486. // Response info
  3487. bool is_valid() const;
  3488. explicit operator bool() const;
  3489. int status() const;
  3490. const Headers &headers() const;
  3491. std::string get_header_value(const std::string &key,
  3492. const char *def = "") const;
  3493. bool has_header(const std::string &key) const;
  3494. Error error() const;
  3495. Error read_error() const;
  3496. bool has_read_error() const;
  3497. // Stream reading
  3498. bool next();
  3499. const char *data() const;
  3500. size_t size() const;
  3501. std::string read_all();
  3502. private:
  3503. ClientImpl::StreamHandle handle_;
  3504. std::string buffer_;
  3505. size_t current_size_ = 0;
  3506. size_t chunk_size_;
  3507. bool finished_ = false;
  3508. };
  3509. // GET
  3510. template <typename ClientType>
  3511. inline Result Get(ClientType &cli, const std::string &path,
  3512. size_t chunk_size = 8192) {
  3513. return Result{cli.open_stream("GET", path), chunk_size};
  3514. }
  3515. template <typename ClientType>
  3516. inline Result Get(ClientType &cli, const std::string &path,
  3517. const Headers &headers, size_t chunk_size = 8192) {
  3518. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3519. }
  3520. template <typename ClientType>
  3521. inline Result Get(ClientType &cli, const std::string &path,
  3522. const Params &params, size_t chunk_size = 8192) {
  3523. return Result{cli.open_stream("GET", path, params), chunk_size};
  3524. }
  3525. template <typename ClientType>
  3526. inline Result Get(ClientType &cli, const std::string &path,
  3527. const Params &params, const Headers &headers,
  3528. size_t chunk_size = 8192) {
  3529. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3530. }
  3531. // POST
  3532. template <typename ClientType>
  3533. inline Result Post(ClientType &cli, const std::string &path,
  3534. const std::string &body, const std::string &content_type,
  3535. size_t chunk_size = 8192) {
  3536. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3537. chunk_size};
  3538. }
  3539. template <typename ClientType>
  3540. inline Result Post(ClientType &cli, const std::string &path,
  3541. const Headers &headers, const std::string &body,
  3542. const std::string &content_type, size_t chunk_size = 8192) {
  3543. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3544. chunk_size};
  3545. }
  3546. template <typename ClientType>
  3547. inline Result Post(ClientType &cli, const std::string &path,
  3548. const Params &params, const std::string &body,
  3549. const std::string &content_type, size_t chunk_size = 8192) {
  3550. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3551. chunk_size};
  3552. }
  3553. template <typename ClientType>
  3554. inline Result Post(ClientType &cli, const std::string &path,
  3555. const Params &params, const Headers &headers,
  3556. const std::string &body, const std::string &content_type,
  3557. size_t chunk_size = 8192) {
  3558. return Result{
  3559. cli.open_stream("POST", path, params, headers, body, content_type),
  3560. chunk_size};
  3561. }
  3562. // PUT
  3563. template <typename ClientType>
  3564. inline Result Put(ClientType &cli, const std::string &path,
  3565. const std::string &body, const std::string &content_type,
  3566. size_t chunk_size = 8192) {
  3567. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3568. chunk_size};
  3569. }
  3570. template <typename ClientType>
  3571. inline Result Put(ClientType &cli, const std::string &path,
  3572. const Headers &headers, const std::string &body,
  3573. const std::string &content_type, size_t chunk_size = 8192) {
  3574. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3575. chunk_size};
  3576. }
  3577. template <typename ClientType>
  3578. inline Result Put(ClientType &cli, const std::string &path,
  3579. const Params &params, const std::string &body,
  3580. const std::string &content_type, size_t chunk_size = 8192) {
  3581. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3582. chunk_size};
  3583. }
  3584. template <typename ClientType>
  3585. inline Result Put(ClientType &cli, const std::string &path,
  3586. const Params &params, const Headers &headers,
  3587. const std::string &body, const std::string &content_type,
  3588. size_t chunk_size = 8192) {
  3589. return Result{
  3590. cli.open_stream("PUT", path, params, headers, body, content_type),
  3591. chunk_size};
  3592. }
  3593. // PATCH
  3594. template <typename ClientType>
  3595. inline Result Patch(ClientType &cli, const std::string &path,
  3596. const std::string &body, const std::string &content_type,
  3597. size_t chunk_size = 8192) {
  3598. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3599. chunk_size};
  3600. }
  3601. template <typename ClientType>
  3602. inline Result Patch(ClientType &cli, const std::string &path,
  3603. const Headers &headers, const std::string &body,
  3604. const std::string &content_type, size_t chunk_size = 8192) {
  3605. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3606. chunk_size};
  3607. }
  3608. template <typename ClientType>
  3609. inline Result Patch(ClientType &cli, const std::string &path,
  3610. const Params &params, const std::string &body,
  3611. const std::string &content_type, size_t chunk_size = 8192) {
  3612. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3613. chunk_size};
  3614. }
  3615. template <typename ClientType>
  3616. inline Result Patch(ClientType &cli, const std::string &path,
  3617. const Params &params, const Headers &headers,
  3618. const std::string &body, const std::string &content_type,
  3619. size_t chunk_size = 8192) {
  3620. return Result{
  3621. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3622. chunk_size};
  3623. }
  3624. // DELETE
  3625. template <typename ClientType>
  3626. inline Result Delete(ClientType &cli, const std::string &path,
  3627. size_t chunk_size = 8192) {
  3628. return Result{cli.open_stream("DELETE", path), chunk_size};
  3629. }
  3630. template <typename ClientType>
  3631. inline Result Delete(ClientType &cli, const std::string &path,
  3632. const Headers &headers, size_t chunk_size = 8192) {
  3633. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3634. }
  3635. template <typename ClientType>
  3636. inline Result Delete(ClientType &cli, const std::string &path,
  3637. const std::string &body, const std::string &content_type,
  3638. size_t chunk_size = 8192) {
  3639. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3640. chunk_size};
  3641. }
  3642. template <typename ClientType>
  3643. inline Result Delete(ClientType &cli, const std::string &path,
  3644. const Headers &headers, const std::string &body,
  3645. const std::string &content_type,
  3646. size_t chunk_size = 8192) {
  3647. return Result{
  3648. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3649. chunk_size};
  3650. }
  3651. template <typename ClientType>
  3652. inline Result Delete(ClientType &cli, const std::string &path,
  3653. const Params &params, size_t chunk_size = 8192) {
  3654. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3655. }
  3656. template <typename ClientType>
  3657. inline Result Delete(ClientType &cli, const std::string &path,
  3658. const Params &params, const Headers &headers,
  3659. size_t chunk_size = 8192) {
  3660. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3661. }
  3662. template <typename ClientType>
  3663. inline Result Delete(ClientType &cli, const std::string &path,
  3664. const Params &params, const std::string &body,
  3665. const std::string &content_type,
  3666. size_t chunk_size = 8192) {
  3667. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3668. chunk_size};
  3669. }
  3670. template <typename ClientType>
  3671. inline Result Delete(ClientType &cli, const std::string &path,
  3672. const Params &params, const Headers &headers,
  3673. const std::string &body, const std::string &content_type,
  3674. size_t chunk_size = 8192) {
  3675. return Result{
  3676. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3677. chunk_size};
  3678. }
  3679. // HEAD
  3680. template <typename ClientType>
  3681. inline Result Head(ClientType &cli, const std::string &path,
  3682. size_t chunk_size = 8192) {
  3683. return Result{cli.open_stream("HEAD", path), chunk_size};
  3684. }
  3685. template <typename ClientType>
  3686. inline Result Head(ClientType &cli, const std::string &path,
  3687. const Headers &headers, size_t chunk_size = 8192) {
  3688. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3689. }
  3690. template <typename ClientType>
  3691. inline Result Head(ClientType &cli, const std::string &path,
  3692. const Params &params, size_t chunk_size = 8192) {
  3693. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3694. }
  3695. template <typename ClientType>
  3696. inline Result Head(ClientType &cli, const std::string &path,
  3697. const Params &params, const Headers &headers,
  3698. size_t chunk_size = 8192) {
  3699. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3700. }
  3701. // OPTIONS
  3702. template <typename ClientType>
  3703. inline Result Options(ClientType &cli, const std::string &path,
  3704. size_t chunk_size = 8192) {
  3705. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3706. }
  3707. template <typename ClientType>
  3708. inline Result Options(ClientType &cli, const std::string &path,
  3709. const Headers &headers, size_t chunk_size = 8192) {
  3710. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3711. }
  3712. template <typename ClientType>
  3713. inline Result Options(ClientType &cli, const std::string &path,
  3714. const Params &params, size_t chunk_size = 8192) {
  3715. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3716. }
  3717. template <typename ClientType>
  3718. inline Result Options(ClientType &cli, const std::string &path,
  3719. const Params &params, const Headers &headers,
  3720. size_t chunk_size = 8192) {
  3721. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3722. }
  3723. } // namespace stream
  3724. namespace sse {
  3725. struct SSEMessage {
  3726. std::string event; // Event type (default: "message")
  3727. std::string data; // Event payload
  3728. std::string id; // Event ID for Last-Event-ID header
  3729. SSEMessage();
  3730. void clear();
  3731. };
  3732. class SSEClient {
  3733. public:
  3734. using MessageHandler = std::function<void(const SSEMessage &)>;
  3735. using ErrorHandler = std::function<void(Error)>;
  3736. using OpenHandler = std::function<void()>;
  3737. SSEClient(Client &client, const std::string &path);
  3738. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3739. ~SSEClient();
  3740. SSEClient(const SSEClient &) = delete;
  3741. SSEClient &operator=(const SSEClient &) = delete;
  3742. // Event handlers
  3743. SSEClient &on_message(MessageHandler handler);
  3744. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3745. SSEClient &on_open(OpenHandler handler);
  3746. SSEClient &on_error(ErrorHandler handler);
  3747. SSEClient &set_reconnect_interval(int ms);
  3748. SSEClient &set_max_reconnect_attempts(int n);
  3749. // Update headers (thread-safe)
  3750. SSEClient &set_headers(const Headers &headers);
  3751. // State accessors
  3752. bool is_connected() const;
  3753. std::string last_event_id() const;
  3754. // Blocking start - runs event loop with auto-reconnect
  3755. void start();
  3756. // Non-blocking start - runs in background thread
  3757. void start_async();
  3758. // Stop the client (thread-safe)
  3759. void stop();
  3760. private:
  3761. void run_event_loop();
  3762. void dispatch_event(const SSEMessage &msg);
  3763. bool should_reconnect(int count) const;
  3764. void wait_for_reconnect();
  3765. // Client and path
  3766. Client &client_;
  3767. std::string path_;
  3768. Headers headers_;
  3769. mutable std::mutex headers_mutex_;
  3770. // Callbacks
  3771. MessageHandler on_message_;
  3772. std::map<std::string, MessageHandler> event_handlers_;
  3773. OpenHandler on_open_;
  3774. ErrorHandler on_error_;
  3775. // Configuration
  3776. int reconnect_interval_ms_ = 3000;
  3777. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3778. // State
  3779. std::atomic<bool> running_{false};
  3780. std::atomic<bool> connected_{false};
  3781. // Written by the event loop, which start_async() runs on its own thread
  3782. std::string last_event_id_;
  3783. mutable std::mutex last_event_id_mutex_;
  3784. // Async support
  3785. std::thread async_thread_;
  3786. };
  3787. } // namespace sse
  3788. namespace detail {
  3789. // Interprets an event stream fed in chunks of any size
  3790. class SSEParser {
  3791. public:
  3792. using EventHandler = std::function<void(const sse::SSEMessage &msg)>;
  3793. using IdHandler = std::function<void(const std::string &id)>;
  3794. using RetryHandler = std::function<void(int retry_ms)>;
  3795. SSEParser(EventHandler on_event, IdHandler on_id, RetryHandler on_retry,
  3796. size_t max_event_length = CPPHTTPLIB_SSE_MAX_EVENT_LENGTH);
  3797. // Returns false once the line and the event still waiting for their end
  3798. // exceed max_event_length. 0 means no limit.
  3799. bool parse(const char *buf, size_t n);
  3800. private:
  3801. void parse_line(const std::string &line);
  3802. EventHandler on_event_;
  3803. IdHandler on_id_;
  3804. RetryHandler on_retry_;
  3805. size_t max_event_length_;
  3806. std::string buffer_;
  3807. sse::SSEMessage msg_;
  3808. bool has_data_ = false;
  3809. bool has_id_ = false;
  3810. bool first_line_ = true;
  3811. bool after_cr_ = false;
  3812. };
  3813. } // namespace detail
  3814. namespace ws {
  3815. class WebSocketClient;
  3816. enum class Opcode : uint8_t {
  3817. Continuation = 0x0,
  3818. Text = 0x1,
  3819. Binary = 0x2,
  3820. Close = 0x8,
  3821. Ping = 0x9,
  3822. Pong = 0xA,
  3823. };
  3824. enum class CloseStatus : uint16_t {
  3825. Normal = 1000,
  3826. GoingAway = 1001,
  3827. ProtocolError = 1002,
  3828. UnsupportedData = 1003,
  3829. NoStatus = 1005,
  3830. Abnormal = 1006,
  3831. InvalidPayload = 1007,
  3832. PolicyViolation = 1008,
  3833. MessageTooBig = 1009,
  3834. MandatoryExtension = 1010,
  3835. InternalError = 1011,
  3836. };
  3837. // Timeout is returned only when a read timeout was set and it elapsed before
  3838. // any byte of a frame arrived: nothing was consumed and the connection is
  3839. // still open, so the caller can send on it and read again. `msg` is left
  3840. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3841. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3842. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3843. // upgrade handshake fully succeeded. On failure error() identifies the
  3844. // failing layer; status()/headers() expose the server's upgrade response
  3845. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3846. // CONNECT when error() is ProxyConnection.
  3847. class Result {
  3848. public:
  3849. Result() = default;
  3850. Result(Error err, int status, Headers &&headers)
  3851. : err_(err), status_(status), headers_(std::move(headers)) {}
  3852. explicit operator bool() const { return err_ == Error::Success; }
  3853. Error error() const { return err_; }
  3854. // Upgrade response info
  3855. int status() const { return status_; }
  3856. const Headers &headers() const { return headers_; }
  3857. std::string get_header_value(const std::string &key,
  3858. const char *def = "") const {
  3859. return detail::get_header_value(headers_, key, def, 0);
  3860. }
  3861. bool has_header(const std::string &key) const {
  3862. return headers_.find(key) != headers_.end();
  3863. }
  3864. #ifdef CPPHTTPLIB_SSL_ENABLED
  3865. Result(Error err, int status, Headers &&headers, int ssl_error,
  3866. uint64_t ssl_backend_error)
  3867. : err_(err), status_(status), headers_(std::move(headers)),
  3868. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3869. int ssl_error() const { return ssl_error_; }
  3870. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3871. #endif
  3872. private:
  3873. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3874. int status_ = -1;
  3875. Headers headers_;
  3876. #ifdef CPPHTTPLIB_SSL_ENABLED
  3877. int ssl_error_ = 0;
  3878. uint64_t ssl_backend_error_ = 0;
  3879. #endif
  3880. };
  3881. namespace impl {
  3882. bool is_valid_utf8(const std::string &s);
  3883. // Three states: a frame, a failure (the connection cannot be read on), or a
  3884. // timeout with the stream still usable.
  3885. enum class FrameRead { Ok, Fail, Timeout };
  3886. // A frame read in as many calls as it takes. A timeout leaves what was read
  3887. // so far in place, and the next read() goes on from there, so the stream is
  3888. // usable after a timeout wherever in a frame it lands.
  3889. class FrameReader {
  3890. public:
  3891. FrameRead read(Stream &strm, Opcode &opcode, std::string &payload, bool &fin,
  3892. bool expect_masked, size_t max_len);
  3893. // Whether part of a frame has been read and the rest is still to come
  3894. bool begun() const { return have_ > 0; }
  3895. private:
  3896. void reset();
  3897. uint8_t head_[14] = {0}; // FIN + opcode, MASK + length, its extension, key
  3898. size_t have_ = 0; // bytes of the header read so far
  3899. size_t need_ = 2; // bytes of the header, once the second is read
  3900. bool sized_ = false; // the header is whole and its length checked
  3901. size_t len_ = 0; // the payload's length, once sized_
  3902. std::string payload_;
  3903. };
  3904. // A whole frame read in one go: a timeout before any of it came is reported,
  3905. // and one that cuts it short is a failure.
  3906. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3907. std::string &payload, bool &fin,
  3908. bool expect_masked, size_t max_len);
  3909. } // namespace impl
  3910. class WebSocket {
  3911. public:
  3912. WebSocket(const WebSocket &) = delete;
  3913. WebSocket &operator=(const WebSocket &) = delete;
  3914. ~WebSocket();
  3915. ReadResult read(std::string &msg);
  3916. bool send(const std::string &data);
  3917. bool send(const char *data, size_t len);
  3918. void close(CloseStatus status = CloseStatus::Normal,
  3919. const std::string &reason = "");
  3920. const Request &request() const;
  3921. bool is_open() const;
  3922. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3923. // A server handler owns its connection's timeout this way; a client sets it
  3924. // through WebSocketClient. Safe to call while another thread is in read().
  3925. // It lands anywhere, inside a message too: what was read of it is kept,
  3926. // and the next read() goes on from there.
  3927. //
  3928. // Only a timeout set here is reported as Timeout. The compile-time default
  3929. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3930. // than a request for control, so when it elapses read() returns Fail and
  3931. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3932. void set_read_timeout(time_t sec, time_t usec = 0);
  3933. template <class Rep, class Period>
  3934. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3935. private:
  3936. friend class httplib::Server;
  3937. friend class httplib::ws::WebSocketClient;
  3938. WebSocket(
  3939. Stream &strm, const Request &req, bool is_server,
  3940. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3941. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  3942. std::function<bool()> server_stopping = nullptr)
  3943. : strm_(strm), req_(req), is_server_(is_server),
  3944. ping_interval_sec_(ping_interval_sec),
  3945. max_missed_pongs_(max_missed_pongs),
  3946. server_stopping_(std::move(server_stopping)) {
  3947. interrupt_reads();
  3948. start_heartbeat();
  3949. }
  3950. WebSocket(
  3951. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3952. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3953. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  3954. std::function<bool()> server_stopping = nullptr)
  3955. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3956. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3957. max_missed_pongs_(max_missed_pongs),
  3958. server_stopping_(std::move(server_stopping)) {
  3959. interrupt_reads();
  3960. start_heartbeat();
  3961. }
  3962. void interrupt_reads();
  3963. bool server_stopping() const {
  3964. return server_stopping_ && server_stopping_();
  3965. }
  3966. void start_heartbeat();
  3967. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3968. Stream &strm_;
  3969. std::unique_ptr<Stream> owned_strm_;
  3970. Request req_;
  3971. bool is_server_;
  3972. time_t ping_interval_sec_;
  3973. int max_missed_pongs_;
  3974. int unacked_pings_ = 0;
  3975. std::atomic<bool> closed_{false};
  3976. // Set when the peer stopped answering pings, to end a read() waiting on it
  3977. std::atomic<bool> pong_timed_out_{false};
  3978. // A server connection's view of Server::stop(), which ends its read() too
  3979. std::function<bool()> server_stopping_;
  3980. // Set once the caller has bounded read() through set_read_timeout(). Until
  3981. // then the timeout in effect is the compile-time default, and elapsing it
  3982. // is a failure that closes the connection, not a Timeout.
  3983. std::atomic<bool> read_timeout_set_{false};
  3984. std::mutex write_mutex_;
  3985. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3986. // may do so: a frame is read until it has the whole declared length,
  3987. // across several read() calls when a timeout lands inside it (frames_
  3988. // below), so a second parser stealing bytes silently corrupts the message
  3989. // the first one is assembling.
  3990. std::mutex read_mutex_;
  3991. // What read() has of the frame and the message it has not finished, kept
  3992. // across a timeout. Guarded by read_mutex_.
  3993. impl::FrameReader frames_;
  3994. std::string message_;
  3995. ReadResult message_kind_ = Fail; // Text or Binary while one is assembled
  3996. std::thread ping_thread_;
  3997. std::mutex ping_mutex_;
  3998. std::condition_variable ping_cv_;
  3999. };
  4000. class WebSocketClient {
  4001. public:
  4002. explicit WebSocketClient(const std::string &scheme_host_port_path,
  4003. const Headers &headers = {});
  4004. ~WebSocketClient();
  4005. WebSocketClient(const WebSocketClient &) = delete;
  4006. WebSocketClient &operator=(const WebSocketClient &) = delete;
  4007. bool is_valid() const;
  4008. Result connect();
  4009. ReadResult read(std::string &msg);
  4010. bool send(const std::string &data);
  4011. bool send(const char *data, size_t len);
  4012. void close(CloseStatus status = CloseStatus::Normal,
  4013. const std::string &reason = "");
  4014. bool is_open() const;
  4015. const std::string &subprotocol() const;
  4016. void set_read_timeout(time_t sec, time_t usec = 0);
  4017. template <class Rep, class Period>
  4018. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  4019. void set_write_timeout(time_t sec, time_t usec = 0);
  4020. template <class Rep, class Period>
  4021. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  4022. void set_websocket_ping_interval(time_t sec);
  4023. void set_websocket_max_missed_pongs(int count);
  4024. void set_tcp_nodelay(bool on);
  4025. void set_address_family(int family);
  4026. void set_ipv6_v6only(bool on);
  4027. void set_socket_options(SocketOptions socket_options);
  4028. void set_connection_timeout(time_t sec, time_t usec = 0);
  4029. template <class Rep, class Period>
  4030. void
  4031. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  4032. void set_interface(const std::string &intf);
  4033. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  4034. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4035. void
  4036. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4037. void
  4038. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4039. void set_basic_auth(const std::string &username, const std::string &password);
  4040. void set_bearer_token_auth(const std::string &token);
  4041. void set_proxy(const std::string &host, int port);
  4042. void set_proxy_basic_auth(const std::string &username,
  4043. const std::string &password);
  4044. void set_proxy_bearer_token_auth(const std::string &token);
  4045. void set_no_proxy(const std::vector<std::string> &patterns);
  4046. #ifdef CPPHTTPLIB_SSL_ENABLED
  4047. struct PemMemory {
  4048. const char *cert_pem;
  4049. size_t cert_pem_len;
  4050. const char *key_pem;
  4051. size_t key_pem_len;
  4052. const char *private_key_password;
  4053. };
  4054. explicit WebSocketClient(const std::string &scheme_host_port_path,
  4055. const PemMemory &pem, const Headers &headers = {});
  4056. void set_ca_cert_path(const std::string &ca_cert_file_path,
  4057. const std::string &ca_cert_dir_path = std::string());
  4058. void set_ca_cert_store(tls::ca_store_t store);
  4059. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  4060. void enable_server_certificate_verification(bool enabled);
  4061. void enable_server_hostname_verification(bool enabled);
  4062. void enable_system_ca(bool enabled);
  4063. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  4064. void set_session_verifier(
  4065. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  4066. void set_proxy_digest_auth(const std::string &username,
  4067. const std::string &password);
  4068. #endif
  4069. private:
  4070. void shutdown_and_close();
  4071. std::pair<time_t, time_t> handshake_timeout() const;
  4072. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  4073. int &ssl_error, uint64_t &ssl_backend_error);
  4074. void prepare_default_headers(Request &req);
  4075. bool is_proxy_enabled() const;
  4076. bool create_and_connect_socket(Error &error);
  4077. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  4078. bool connect_with_proxy(Response &proxy_res, Error &error);
  4079. std::string host_;
  4080. int port_;
  4081. std::string path_;
  4082. Headers headers_;
  4083. std::string subprotocol_;
  4084. bool is_valid_ = false;
  4085. socket_t sock_ = INVALID_SOCKET;
  4086. std::unique_ptr<WebSocket> ws_;
  4087. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  4088. time_t read_timeout_usec_ = 0;
  4089. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  4090. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  4091. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  4092. time_t websocket_ping_interval_sec_ =
  4093. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  4094. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  4095. int address_family_ = AF_UNSPEC;
  4096. bool tcp_nodelay_ = CPPHTTPLIB_WEBSOCKET_TCP_NODELAY;
  4097. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  4098. SocketOptions socket_options_ = nullptr;
  4099. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  4100. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  4101. std::string interface_;
  4102. // Hostname to connection target map. The value is an IP literal or another
  4103. // hostname; only the connection target changes, never the identity.
  4104. std::map<std::string, std::string> addr_map_;
  4105. // Hostname to CONNECT target map, used only through a proxy.
  4106. std::map<std::string, std::string> tunnel_addr_map_;
  4107. std::string basic_auth_username_;
  4108. std::string basic_auth_password_;
  4109. std::string bearer_token_auth_token_;
  4110. std::string proxy_host_;
  4111. int proxy_port_ = -1;
  4112. std::string proxy_basic_auth_username_;
  4113. std::string proxy_basic_auth_password_;
  4114. std::string proxy_bearer_token_auth_token_;
  4115. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  4116. #ifdef CPPHTTPLIB_SSL_ENABLED
  4117. bool is_ssl_ = false;
  4118. tls::ctx_t tls_ctx_ = nullptr;
  4119. tls::session_t tls_session_ = nullptr;
  4120. std::string ca_cert_file_path_;
  4121. std::string ca_cert_dir_path_;
  4122. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  4123. // no certificate, so that a CA that failed to come through fails
  4124. // verification instead of letting the system CAs in.
  4125. bool custom_ca_loaded_ = false;
  4126. bool certs_loaded_ = false;
  4127. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  4128. bool server_certificate_verification_ = true;
  4129. bool server_hostname_verification_ = true;
  4130. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  4131. std::string proxy_digest_auth_username_;
  4132. std::string proxy_digest_auth_password_;
  4133. #endif
  4134. };
  4135. template <class Rep, class Period>
  4136. inline void WebSocket::set_read_timeout(
  4137. const std::chrono::duration<Rep, Period> &duration) {
  4138. detail::duration_to_sec_and_usec(
  4139. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4140. }
  4141. template <class Rep, class Period>
  4142. inline void WebSocketClient::set_read_timeout(
  4143. const std::chrono::duration<Rep, Period> &duration) {
  4144. detail::duration_to_sec_and_usec(
  4145. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4146. }
  4147. template <class Rep, class Period>
  4148. inline void WebSocketClient::set_write_timeout(
  4149. const std::chrono::duration<Rep, Period> &duration) {
  4150. detail::duration_to_sec_and_usec(
  4151. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4152. }
  4153. template <class Rep, class Period>
  4154. inline void WebSocketClient::set_connection_timeout(
  4155. const std::chrono::duration<Rep, Period> &duration) {
  4156. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4157. set_connection_timeout(sec, usec);
  4158. });
  4159. }
  4160. } // namespace ws
  4161. namespace detail {
  4162. bool write_websocket_frame(Stream &strm, ws::Opcode opcode, const char *data,
  4163. size_t len, bool fin, bool mask);
  4164. } // namespace detail
  4165. // ----------------------------------------------------------------------------
  4166. /*
  4167. * Implementation that will be part of the .cc file if split into .h + .cc.
  4168. */
  4169. namespace stream {
  4170. // stream::Result implementations
  4171. inline Result::Result() : chunk_size_(8192) {}
  4172. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4173. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4174. inline Result::Result(Result &&other) noexcept
  4175. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4176. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4177. finished_(other.finished_) {
  4178. other.current_size_ = 0;
  4179. other.finished_ = true;
  4180. }
  4181. inline Result &Result::operator=(Result &&other) noexcept {
  4182. if (this != &other) {
  4183. handle_ = std::move(other.handle_);
  4184. buffer_ = std::move(other.buffer_);
  4185. current_size_ = other.current_size_;
  4186. chunk_size_ = other.chunk_size_;
  4187. finished_ = other.finished_;
  4188. other.current_size_ = 0;
  4189. other.finished_ = true;
  4190. }
  4191. return *this;
  4192. }
  4193. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4194. inline Result::operator bool() const { return is_valid(); }
  4195. inline int Result::status() const {
  4196. return handle_.response ? handle_.response->status : -1;
  4197. }
  4198. inline const Headers &Result::headers() const {
  4199. static const Headers empty_headers;
  4200. return handle_.response ? handle_.response->headers : empty_headers;
  4201. }
  4202. inline std::string Result::get_header_value(const std::string &key,
  4203. const char *def) const {
  4204. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4205. }
  4206. inline bool Result::has_header(const std::string &key) const {
  4207. return handle_.response ? handle_.response->has_header(key) : false;
  4208. }
  4209. inline Error Result::error() const { return handle_.error; }
  4210. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4211. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4212. inline bool Result::next() {
  4213. if (!handle_.is_valid() || finished_) { return false; }
  4214. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4215. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4216. if (n > 0) {
  4217. current_size_ = static_cast<size_t>(n);
  4218. return true;
  4219. }
  4220. current_size_ = 0;
  4221. finished_ = true;
  4222. return false;
  4223. }
  4224. inline const char *Result::data() const { return buffer_.data(); }
  4225. inline size_t Result::size() const { return current_size_; }
  4226. inline std::string Result::read_all() {
  4227. std::string result;
  4228. while (next()) {
  4229. result.append(data(), size());
  4230. }
  4231. return result;
  4232. }
  4233. } // namespace stream
  4234. namespace detail {
  4235. inline SSEParser::SSEParser(EventHandler on_event, IdHandler on_id,
  4236. RetryHandler on_retry, size_t max_event_length)
  4237. : on_event_(std::move(on_event)), on_id_(std::move(on_id)),
  4238. on_retry_(std::move(on_retry)), max_event_length_(max_event_length) {}
  4239. inline bool SSEParser::parse(const char *buf, size_t n) {
  4240. // What is left in the buffer has no line ending
  4241. auto search_pos = buffer_.size();
  4242. buffer_.append(buf, n);
  4243. // A line ends with \r\n, \n or \r per the SSE spec
  4244. size_t line_start = 0;
  4245. size_t eol_pos;
  4246. while ((eol_pos = buffer_.find_first_of("\r\n", search_pos)) !=
  4247. std::string::npos) {
  4248. auto line = buffer_.substr(line_start, eol_pos - line_start);
  4249. line_start = eol_pos + 1;
  4250. search_pos = line_start;
  4251. // The \n of a \r\n may arrive in a later chunk than its \r
  4252. auto is_lf_of_crlf = after_cr_ && line.empty() && buffer_[eol_pos] == '\n';
  4253. after_cr_ = buffer_[eol_pos] == '\r';
  4254. if (is_lf_of_crlf) { continue; }
  4255. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4256. if (first_line_) {
  4257. first_line_ = false;
  4258. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4259. }
  4260. parse_line(line);
  4261. }
  4262. // Keep unprocessed data in buffer
  4263. buffer_.erase(0, line_start);
  4264. return max_event_length_ == 0 ||
  4265. buffer_.size() + msg_.data.size() <= max_event_length_;
  4266. }
  4267. inline void SSEParser::parse_line(const std::string &line) {
  4268. // Blank line signals end of event
  4269. if (line.empty()) {
  4270. // The id counts for Last-Event-ID even for an event that has no data. An
  4271. // empty id clears it.
  4272. if (has_id_ && on_id_) { on_id_(msg_.id); }
  4273. // An event without a data field is not dispatched
  4274. if (has_data_ && on_event_) { on_event_(msg_); }
  4275. msg_.clear();
  4276. has_data_ = false;
  4277. has_id_ = false;
  4278. return;
  4279. }
  4280. // Lines starting with ':' are comments (ignored)
  4281. if (line[0] == ':') { return; }
  4282. // Find the colon separator
  4283. auto colon_pos = line.find(':');
  4284. auto field = line.substr(0, colon_pos);
  4285. std::string value;
  4286. // Value starts after colon, skip optional single space
  4287. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4288. auto value_start = colon_pos + 1;
  4289. if (line[value_start] == ' ') { value_start++; }
  4290. value = line.substr(value_start);
  4291. }
  4292. // Handle known fields
  4293. if (field == "event") {
  4294. // An empty event type is dispatched as "message" per the SSE spec
  4295. msg_.event = value.empty() ? std::string("message") : std::move(value);
  4296. } else if (field == "data") {
  4297. // Multiple data lines are concatenated with newlines
  4298. if (has_data_) { msg_.data += "\n"; }
  4299. msg_.data += value;
  4300. has_data_ = true;
  4301. } else if (field == "id") {
  4302. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4303. // valid (clears the last event ID)
  4304. if (fields::is_field_value(value)) {
  4305. msg_.id = value;
  4306. has_id_ = true;
  4307. }
  4308. } else if (field == "retry") {
  4309. // Parse retry interval in milliseconds
  4310. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4311. if (is_numeric(value)) {
  4312. int v = 0;
  4313. auto res = from_chars(value.data(), value.data() + value.size(), v);
  4314. if (res.ec == std::errc{} && on_retry_) { on_retry_(v); }
  4315. }
  4316. }
  4317. // Unknown fields are ignored per SSE spec
  4318. }
  4319. } // namespace detail
  4320. namespace sse {
  4321. // SSEMessage implementations
  4322. inline SSEMessage::SSEMessage() : event("message") {}
  4323. inline void SSEMessage::clear() {
  4324. event = "message";
  4325. data.clear();
  4326. id.clear();
  4327. }
  4328. // SSEClient implementations
  4329. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4330. : client_(client), path_(path) {}
  4331. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4332. const Headers &headers)
  4333. : client_(client), path_(path), headers_(headers) {}
  4334. inline SSEClient::~SSEClient() { stop(); }
  4335. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4336. on_message_ = std::move(handler);
  4337. return *this;
  4338. }
  4339. inline SSEClient &SSEClient::on_event(const std::string &type,
  4340. MessageHandler handler) {
  4341. event_handlers_[type] = std::move(handler);
  4342. return *this;
  4343. }
  4344. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4345. on_open_ = std::move(handler);
  4346. return *this;
  4347. }
  4348. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4349. on_error_ = std::move(handler);
  4350. return *this;
  4351. }
  4352. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4353. reconnect_interval_ms_ = ms;
  4354. return *this;
  4355. }
  4356. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4357. max_reconnect_attempts_ = n;
  4358. return *this;
  4359. }
  4360. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4361. std::lock_guard<std::mutex> lock(headers_mutex_);
  4362. headers_ = headers;
  4363. return *this;
  4364. }
  4365. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4366. inline std::string SSEClient::last_event_id() const {
  4367. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4368. return last_event_id_;
  4369. }
  4370. inline void SSEClient::start() {
  4371. running_.store(true);
  4372. run_event_loop();
  4373. }
  4374. inline void SSEClient::start_async() {
  4375. running_.store(true);
  4376. async_thread_ = std::thread([this]() { run_event_loop(); });
  4377. }
  4378. inline void SSEClient::stop() {
  4379. running_.store(false);
  4380. client_.stop(); // Cancel any pending operations
  4381. if (async_thread_.joinable()) { async_thread_.join(); }
  4382. }
  4383. inline void SSEClient::run_event_loop() {
  4384. auto reconnect_count = 0;
  4385. while (running_.load()) {
  4386. // Build headers, including Last-Event-ID if we have one
  4387. Headers request_headers;
  4388. {
  4389. std::lock_guard<std::mutex> lock(headers_mutex_);
  4390. request_headers = headers_;
  4391. }
  4392. if (!last_event_id_.empty()) {
  4393. request_headers.emplace("Last-Event-ID", last_event_id_);
  4394. }
  4395. // Open streaming connection. An event stream has no end, so each event is
  4396. // bounded instead of the whole body.
  4397. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4398. handle.body_reader_.payload_max_length = 0;
  4399. // stop() ends a read that is waiting for the next event
  4400. if (handle.stream_) {
  4401. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4402. }
  4403. stream::Result result{std::move(handle)};
  4404. // Connection error handling
  4405. if (!result) {
  4406. connected_.store(false);
  4407. if (on_error_) { on_error_(result.error()); }
  4408. if (!should_reconnect(reconnect_count)) { break; }
  4409. wait_for_reconnect();
  4410. reconnect_count++;
  4411. continue;
  4412. }
  4413. if (result.status() != StatusCode::OK_200) {
  4414. connected_.store(false);
  4415. if (on_error_) { on_error_(Error::Connection); }
  4416. // For certain errors, don't reconnect.
  4417. // Note: 401 is intentionally absent so that handlers can refresh
  4418. // credentials via set_headers() and let the client reconnect.
  4419. if (result.status() == StatusCode::NoContent_204 ||
  4420. result.status() == StatusCode::NotFound_404 ||
  4421. result.status() == StatusCode::Forbidden_403) {
  4422. break;
  4423. }
  4424. if (!should_reconnect(reconnect_count)) { break; }
  4425. wait_for_reconnect();
  4426. reconnect_count++;
  4427. continue;
  4428. }
  4429. // Connection successful
  4430. connected_.store(true);
  4431. reconnect_count = 0;
  4432. if (on_open_) { on_open_(); }
  4433. // Event receiving loop
  4434. detail::SSEParser parser(
  4435. [this](const SSEMessage &msg) { dispatch_event(msg); },
  4436. [this](const std::string &id) {
  4437. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4438. last_event_id_ = id;
  4439. },
  4440. [this](int retry_ms) { reconnect_interval_ms_ = retry_ms; });
  4441. auto event_too_long = false;
  4442. while (running_.load() && result.next()) {
  4443. if (!parser.parse(result.data(), result.size())) {
  4444. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4445. event_too_long = true;
  4446. break;
  4447. }
  4448. }
  4449. // Connection ended
  4450. connected_.store(false);
  4451. // Reconnecting would only get the same event again
  4452. if (!running_.load() || event_too_long) { break; }
  4453. // Check for read errors
  4454. if (result.has_read_error()) {
  4455. if (on_error_) { on_error_(result.read_error()); }
  4456. }
  4457. if (!should_reconnect(reconnect_count)) { break; }
  4458. wait_for_reconnect();
  4459. reconnect_count++;
  4460. }
  4461. connected_.store(false);
  4462. }
  4463. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4464. // Check for specific event type handler first
  4465. auto it = event_handlers_.find(msg.event);
  4466. if (it != event_handlers_.end()) {
  4467. it->second(msg);
  4468. return;
  4469. }
  4470. // Fall back to generic message handler
  4471. if (on_message_) { on_message_(msg); }
  4472. }
  4473. inline bool SSEClient::should_reconnect(int count) const {
  4474. if (!running_.load()) { return false; }
  4475. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4476. return count < max_reconnect_attempts_;
  4477. }
  4478. inline void SSEClient::wait_for_reconnect() {
  4479. // Use small increments to check running_ flag frequently.
  4480. // Always wait at least one increment, so that a zero interval (e.g.
  4481. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4482. const auto step_ms = 100;
  4483. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4484. auto waited = 0;
  4485. while (running_.load() && waited < interval_ms) {
  4486. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4487. waited += step_ms;
  4488. }
  4489. }
  4490. } // namespace sse
  4491. #ifdef CPPHTTPLIB_SSL_ENABLED
  4492. /*
  4493. * TLS abstraction layer - internal function declarations
  4494. * These are implementation details and not part of the public API.
  4495. */
  4496. namespace tls {
  4497. // Client context
  4498. ctx_t create_client_context();
  4499. void free_context(ctx_t ctx);
  4500. bool set_min_version(ctx_t ctx, Version version);
  4501. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4502. bool load_ca_file(ctx_t ctx, const char *file_path);
  4503. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4504. bool load_system_certs(ctx_t ctx);
  4505. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4506. const char *password);
  4507. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4508. const char *key_path, const char *password);
  4509. // Server context
  4510. ctx_t create_server_context();
  4511. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4512. const char *password);
  4513. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4514. const char *key_path, const char *password);
  4515. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4516. void set_verify_client(ctx_t ctx, bool require);
  4517. // Session management
  4518. session_t create_session(ctx_t ctx, socket_t sock);
  4519. void free_session(session_t session);
  4520. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4521. // Handshake (non-blocking capable)
  4522. TlsError connect(session_t session);
  4523. TlsError accept(session_t session);
  4524. // Handshake with timeout (blocking until timeout, or until interrupted)
  4525. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4526. time_t timeout_usec, TlsError *err,
  4527. const std::function<bool()> &interrupted = nullptr);
  4528. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4529. time_t timeout_usec, TlsError *err);
  4530. // I/O (non-blocking capable)
  4531. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4532. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4533. int pending(const_session_t session);
  4534. void shutdown(session_t session, bool graceful);
  4535. // Connection state
  4536. bool is_peer_closed(session_t session, socket_t sock);
  4537. // Certificate verification
  4538. cert_t get_peer_cert(const_session_t session);
  4539. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4540. // do not use them after free_session(), as with get_peer_cert().
  4541. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4542. void free_cert(cert_t cert);
  4543. // Matches the host against the subjectAltName entries only, never the Common
  4544. // Name (RFC 9525).
  4545. bool verify_hostname(cert_t cert, const char *hostname);
  4546. uint64_t hostname_mismatch_code();
  4547. long get_verify_result(const_session_t session);
  4548. // Certificate introspection
  4549. std::string get_cert_subject_cn(cert_t cert);
  4550. std::string get_cert_issuer_name(cert_t cert);
  4551. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4552. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4553. std::string get_cert_serial(cert_t cert);
  4554. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4555. const char *get_sni(const_session_t session);
  4556. // CA store management
  4557. ca_store_t create_ca_store(const char *pem, size_t len);
  4558. void free_ca_store(ca_store_t store);
  4559. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4560. // Free each with free_cert(), and do not use them once the context's CA
  4561. // certificates change.
  4562. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4563. std::vector<std::string> get_ca_names(ctx_t ctx);
  4564. // Dynamic certificate update (for servers)
  4565. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4566. const char *password);
  4567. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4568. // Certificate verification callback
  4569. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4570. long get_verify_error(const_session_t session);
  4571. std::string verify_error_string(long error_code);
  4572. // TlsError information
  4573. uint64_t peek_error();
  4574. uint64_t get_error();
  4575. std::string error_string(uint64_t code);
  4576. } // namespace tls
  4577. #endif // CPPHTTPLIB_SSL_ENABLED
  4578. /*
  4579. * Group 1: detail namespace - Non-SSL utilities
  4580. */
  4581. namespace detail {
  4582. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4583. const void *optval, socklen_t optlen) {
  4584. return setsockopt(sock, level, optname,
  4585. #ifdef _WIN32
  4586. reinterpret_cast<const char *>(optval),
  4587. #else
  4588. optval,
  4589. #endif
  4590. optlen) == 0;
  4591. }
  4592. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4593. time_t sec, time_t usec) {
  4594. #ifdef _WIN32
  4595. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4596. #else
  4597. timeval timeout;
  4598. timeout.tv_sec = static_cast<long>(sec);
  4599. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4600. #endif
  4601. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4602. }
  4603. inline bool is_hex(char c, int &v) {
  4604. if (is_ascii_digit(c)) {
  4605. v = c - '0';
  4606. return true;
  4607. } else if ('A' <= c && c <= 'F') {
  4608. v = c - 'A' + 10;
  4609. return true;
  4610. } else if ('a' <= c && c <= 'f') {
  4611. v = c - 'a' + 10;
  4612. return true;
  4613. }
  4614. return false;
  4615. }
  4616. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4617. int &val) {
  4618. if (i >= s.size()) { return false; }
  4619. val = 0;
  4620. for (; cnt; i++, cnt--) {
  4621. if (!s[i]) { return false; }
  4622. auto v = 0;
  4623. if (is_hex(s[i], v)) {
  4624. val = val * 16 + v;
  4625. } else {
  4626. return false;
  4627. }
  4628. }
  4629. return true;
  4630. }
  4631. inline std::string from_i_to_hex(size_t n) {
  4632. static const auto charset = "0123456789abcdef";
  4633. std::string ret;
  4634. do {
  4635. ret = charset[n & 15] + ret;
  4636. n >>= 4;
  4637. } while (n > 0);
  4638. return ret;
  4639. }
  4640. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4641. // builds and trips -Wtautological-type-limit-compare.
  4642. inline bool fits_in_size_t(uint64_t n) {
  4643. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4644. }
  4645. inline std::string compute_etag(const FileStat &fs,
  4646. const std::string &suffix = std::string()) {
  4647. if (!fs.is_file()) { return std::string(); }
  4648. // If mtime cannot be determined (negative value indicates an error
  4649. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4650. // value like 0 could collide with a real file that legitimately has
  4651. // mtime == 0 (epoch) and lead to misleading validators.
  4652. auto mtime_raw = fs.mtime();
  4653. if (mtime_raw < 0) { return std::string(); }
  4654. auto mtime = static_cast<size_t>(mtime_raw);
  4655. auto size = fs.size();
  4656. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4657. from_i_to_hex(size) + suffix + "\"";
  4658. }
  4659. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4660. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4661. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4662. inline std::string file_mtime_to_http_date(time_t mtime) {
  4663. if (mtime < 0) { return std::string(); }
  4664. struct tm tm_buf;
  4665. #ifdef _WIN32
  4666. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4667. #else
  4668. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4669. #endif
  4670. char buf[64];
  4671. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4672. return std::string();
  4673. }
  4674. return std::string(buf);
  4675. }
  4676. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4677. inline time_t parse_http_date(const std::string &date_str) {
  4678. struct tm tm_buf;
  4679. // Create a classic locale object once for all parsing attempts
  4680. const std::locale classic_locale = std::locale::classic();
  4681. // Try to parse using std::get_time (C++11, cross-platform)
  4682. auto try_parse = [&](const char *fmt) -> bool {
  4683. std::istringstream ss(date_str);
  4684. ss.imbue(classic_locale);
  4685. memset(&tm_buf, 0, sizeof(tm_buf));
  4686. ss >> std::get_time(&tm_buf, fmt);
  4687. return !ss.fail();
  4688. };
  4689. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4690. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4691. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4692. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4693. // asctime format: "Sun Nov 6 08:49:37 1994"
  4694. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4695. return static_cast<time_t>(-1);
  4696. }
  4697. }
  4698. }
  4699. #ifdef _WIN32
  4700. return _mkgmtime(&tm_buf);
  4701. #elif defined _AIX
  4702. return mktime(&tm_buf);
  4703. #else
  4704. return timegm(&tm_buf);
  4705. #endif
  4706. }
  4707. inline bool is_weak_etag(const std::string &s) {
  4708. // Check if the string is a weak ETag (starts with 'W/"')
  4709. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4710. }
  4711. inline bool is_strong_etag(const std::string &s) {
  4712. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4713. // chars)
  4714. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4715. }
  4716. inline size_t to_utf8(int code, char *buff) {
  4717. if (code < 0x0080) {
  4718. buff[0] = static_cast<char>(code & 0x7F);
  4719. return 1;
  4720. } else if (code < 0x0800) {
  4721. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4722. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4723. return 2;
  4724. } else if (code < 0xD800) {
  4725. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4726. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4727. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4728. return 3;
  4729. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4730. return 0;
  4731. } else if (code < 0x10000) {
  4732. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4733. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4734. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4735. return 3;
  4736. } else if (code < 0x110000) {
  4737. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4738. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4739. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4740. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4741. return 4;
  4742. }
  4743. // NOTREACHED
  4744. return 0;
  4745. }
  4746. } // namespace detail
  4747. namespace ws {
  4748. namespace impl {
  4749. inline bool is_valid_utf8(const std::string &s) {
  4750. size_t i = 0;
  4751. auto n = s.size();
  4752. while (i < n) {
  4753. auto c = static_cast<unsigned char>(s[i]);
  4754. size_t len;
  4755. uint32_t cp;
  4756. if (c < 0x80) {
  4757. i++;
  4758. continue;
  4759. } else if ((c & 0xE0) == 0xC0) {
  4760. len = 2;
  4761. cp = c & 0x1F;
  4762. } else if ((c & 0xF0) == 0xE0) {
  4763. len = 3;
  4764. cp = c & 0x0F;
  4765. } else if ((c & 0xF8) == 0xF0) {
  4766. len = 4;
  4767. cp = c & 0x07;
  4768. } else {
  4769. return false;
  4770. }
  4771. if (i + len > n) { return false; }
  4772. for (size_t j = 1; j < len; j++) {
  4773. auto b = static_cast<unsigned char>(s[i + j]);
  4774. if ((b & 0xC0) != 0x80) { return false; }
  4775. cp = (cp << 6) | (b & 0x3F);
  4776. }
  4777. // Overlong encoding check
  4778. if (len == 2 && cp < 0x80) { return false; }
  4779. if (len == 3 && cp < 0x800) { return false; }
  4780. if (len == 4 && cp < 0x10000) { return false; }
  4781. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4782. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4783. if (cp > 0x10FFFF) { return false; }
  4784. i += len;
  4785. }
  4786. return true;
  4787. }
  4788. } // namespace impl
  4789. } // namespace ws
  4790. namespace detail {
  4791. // NOTE: This code came up with the following stackoverflow post:
  4792. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4793. inline std::string base64_encode(const std::string &in) {
  4794. static const auto lookup =
  4795. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4796. std::string out;
  4797. out.reserve(in.size());
  4798. // Unsigned: the accumulator is never masked, so with a signed int the
  4799. // `val << 8` below overflows once enough bytes are folded in (undefined
  4800. // behaviour before C++20). Only the low bits are ever emitted, so the
  4801. // wrap-around of an unsigned accumulator does not affect the output.
  4802. uint32_t val = 0;
  4803. auto valb = -6;
  4804. for (auto c : in) {
  4805. val = (val << 8) + static_cast<uint8_t>(c);
  4806. valb += 8;
  4807. while (valb >= 0) {
  4808. out.push_back(lookup[(val >> valb) & 0x3F]);
  4809. valb -= 6;
  4810. }
  4811. }
  4812. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4813. while (out.size() % 4) {
  4814. out.push_back('=');
  4815. }
  4816. return out;
  4817. }
  4818. inline std::string sha1(const std::string &input) {
  4819. // RFC 3174 SHA-1 implementation
  4820. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4821. return (x << n) | (x >> (32 - n));
  4822. };
  4823. uint32_t h0 = 0x67452301;
  4824. uint32_t h1 = 0xEFCDAB89;
  4825. uint32_t h2 = 0x98BADCFE;
  4826. uint32_t h3 = 0x10325476;
  4827. uint32_t h4 = 0xC3D2E1F0;
  4828. // Pre-processing: adding padding bits
  4829. std::string msg = input;
  4830. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4831. msg.push_back(static_cast<char>(0x80u));
  4832. while (msg.size() % 64 != 56) {
  4833. msg.push_back(0);
  4834. }
  4835. // Append original length in bits as 64-bit big-endian
  4836. for (int i = 56; i >= 0; i -= 8) {
  4837. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4838. }
  4839. // Process each 512-bit chunk
  4840. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4841. uint32_t w[80];
  4842. for (size_t i = 0; i < 16; i++) {
  4843. w[i] =
  4844. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4845. << 24) |
  4846. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4847. << 16) |
  4848. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4849. << 8) |
  4850. (static_cast<uint32_t>(
  4851. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4852. }
  4853. for (int i = 16; i < 80; i++) {
  4854. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4855. }
  4856. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4857. for (int i = 0; i < 80; i++) {
  4858. uint32_t f, k;
  4859. if (i < 20) {
  4860. f = (b & c) | ((~b) & d);
  4861. k = 0x5A827999;
  4862. } else if (i < 40) {
  4863. f = b ^ c ^ d;
  4864. k = 0x6ED9EBA1;
  4865. } else if (i < 60) {
  4866. f = (b & c) | (b & d) | (c & d);
  4867. k = 0x8F1BBCDC;
  4868. } else {
  4869. f = b ^ c ^ d;
  4870. k = 0xCA62C1D6;
  4871. }
  4872. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4873. e = d;
  4874. d = c;
  4875. c = left_rotate(b, 30);
  4876. b = a;
  4877. a = temp;
  4878. }
  4879. h0 += a;
  4880. h1 += b;
  4881. h2 += c;
  4882. h3 += d;
  4883. h4 += e;
  4884. }
  4885. // Produce the final hash as a 20-byte binary string
  4886. std::string hash(20, '\0');
  4887. for (size_t i = 0; i < 4; i++) {
  4888. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4889. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4890. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4891. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4892. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4893. }
  4894. return hash;
  4895. }
  4896. inline std::string websocket_accept_key(const std::string &client_key) {
  4897. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4898. return base64_encode(sha1(client_key + magic));
  4899. }
  4900. inline bool is_websocket_upgrade(const Request &req) {
  4901. if (req.method != "GET") { return false; }
  4902. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4903. // list of protocols and asks recipients to match each name
  4904. // case-insensitively, so look for the token rather than compare the whole
  4905. // field value.
  4906. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4907. // Check Connection: Upgrade
  4908. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4909. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4910. // RFC 6455 Section 4.2.1
  4911. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4912. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4913. return false;
  4914. }
  4915. static const std::string b64chars =
  4916. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4917. for (size_t i = 0; i < 22; i++) {
  4918. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4919. }
  4920. // Check Sec-WebSocket-Version: 13
  4921. auto version = req.get_header_value("Sec-WebSocket-Version");
  4922. if (version != "13") { return false; }
  4923. return true;
  4924. }
  4925. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4926. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4927. thread_local std::random_device rd;
  4928. size_t filled = 0;
  4929. while (filled < n) {
  4930. auto v = rd();
  4931. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4932. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4933. }
  4934. }
  4935. }
  4936. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4937. const char *data, size_t len, bool fin,
  4938. bool mask) {
  4939. // The header (FIN + opcode, MASK + length, the extended length, the mask
  4940. // key: 14 bytes at most) goes out in one write with the payload's first
  4941. // chunk, so that under TCP_NODELAY a small frame is one segment, not three.
  4942. uint8_t header[14];
  4943. size_t header_len = 0;
  4944. header[header_len++] = static_cast<uint8_t>(
  4945. (fin ? 0x80 : 0x00) | (static_cast<uint8_t>(opcode) & 0x0F));
  4946. uint8_t mask_bit = mask ? 0x80 : 0x00;
  4947. if (len < 126) {
  4948. header[header_len++] = static_cast<uint8_t>(len) | mask_bit;
  4949. } else if (len <= 0xFFFF) {
  4950. header[header_len++] = 126 | mask_bit;
  4951. header[header_len++] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4952. header[header_len++] = static_cast<uint8_t>(len & 0xFF);
  4953. } else {
  4954. header[header_len++] = 127 | mask_bit;
  4955. for (int i = 7; i >= 0; i--) {
  4956. header[header_len++] =
  4957. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4958. }
  4959. }
  4960. uint8_t mask_key[4] = {0};
  4961. if (mask) {
  4962. fill_random_bytes(mask_key, sizeof(mask_key));
  4963. std::copy(mask_key, mask_key + 4, header + header_len);
  4964. header_len += 4;
  4965. }
  4966. // `n` bytes of the payload from `offset`, masked if they are to be, at `out`
  4967. auto put = [&](char *out, size_t offset, size_t n) {
  4968. for (size_t i = 0; i < n; i++) {
  4969. out[i] = mask ? data[offset + i] ^
  4970. static_cast<char>(mask_key[(offset + i) % 4])
  4971. : data[offset + i];
  4972. }
  4973. };
  4974. const size_t chunk_size = 4096;
  4975. size_t first = (std::min)(len, chunk_size);
  4976. std::vector<char> buf(header_len + first);
  4977. std::copy(header, header + header_len, buf.begin());
  4978. put(buf.data() + header_len, 0, first);
  4979. if (!write_data(strm, buf.data(), buf.size())) { return false; }
  4980. // The rest, masked a chunk at a time, or else as it is
  4981. if (!mask) {
  4982. return first == len || write_data(strm, data + first, len - first);
  4983. }
  4984. for (size_t offset = first; offset < len; offset += chunk_size) {
  4985. size_t n = (std::min)(chunk_size, len - offset);
  4986. put(buf.data(), offset, n);
  4987. if (!write_data(strm, buf.data(), n)) { return false; }
  4988. }
  4989. return true;
  4990. }
  4991. } // namespace detail
  4992. namespace ws {
  4993. namespace impl {
  4994. inline void FrameReader::reset() {
  4995. have_ = 0;
  4996. need_ = 2;
  4997. sized_ = false;
  4998. len_ = 0;
  4999. payload_.clear();
  5000. }
  5001. // Stream::read may return less than asked for -- it hands back whatever its
  5002. // buffer already holds -- so each part of the frame is read in a loop, a byte
  5003. // at a time if that is how it comes. (When read() fails it always records why,
  5004. // so the error belongs to this call and not to an earlier one.)
  5005. inline FrameRead FrameReader::read(Stream &strm, Opcode &opcode,
  5006. std::string &payload, bool &fin,
  5007. bool expect_masked, size_t max_len) {
  5008. // A timeout keeps what was read; anything else ends the frame
  5009. auto stopped = [&]() {
  5010. if (strm.get_error() == Error::Timeout) { return FrameRead::Timeout; }
  5011. reset();
  5012. return FrameRead::Fail;
  5013. };
  5014. auto fail = [&]() {
  5015. reset();
  5016. return FrameRead::Fail;
  5017. };
  5018. while (have_ < need_) {
  5019. auto n = strm.read(reinterpret_cast<char *>(head_) + have_, need_ - have_);
  5020. if (n <= 0) { return stopped(); }
  5021. have_ += static_cast<size_t>(n);
  5022. if (have_ < 2 || need_ > 2) { continue; }
  5023. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  5024. if (head_[0] & 0x70) { return fail(); }
  5025. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  5026. // MUST have a payload length of 125 bytes or less
  5027. auto len7 = head_[1] & 0x7F;
  5028. if ((head_[0] & 0x08) && (!(head_[0] & 0x80) || len7 > 125)) {
  5029. return fail();
  5030. }
  5031. auto masked = (head_[1] & 0x80) != 0;
  5032. if (masked != expect_masked) { return fail(); }
  5033. // The extended length and the mask key follow
  5034. need_ = 2 + (len7 == 126 ? 2 : len7 == 127 ? 8 : 0) + (masked ? 4 : 0);
  5035. }
  5036. if (!sized_) {
  5037. uint64_t len = head_[1] & 0x7F;
  5038. if (len == 126) {
  5039. len = (static_cast<uint64_t>(head_[2]) << 8) | head_[3];
  5040. } else if (len == 127) {
  5041. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  5042. if (head_[2] & 0x80) { return fail(); }
  5043. len = 0;
  5044. for (size_t i = 2; i < 10; i++) {
  5045. len = (len << 8) | head_[i];
  5046. }
  5047. }
  5048. // A max_len of 0 means no limit, as payload_max_length does, and a length
  5049. // size_t cannot hold (32-bit builds) is refused either way.
  5050. if ((max_len > 0 && len > max_len) || !detail::fits_in_size_t(len)) {
  5051. return fail();
  5052. }
  5053. len_ = static_cast<size_t>(len);
  5054. sized_ = true;
  5055. }
  5056. // Grow the payload only as it arrives, since a header alone can announce
  5057. // max_len bytes that never come.
  5058. while (payload_.size() < len_) {
  5059. auto offset = payload_.size();
  5060. auto n = (std::min)(len_ - offset, CPPHTTPLIB_RECV_BUFSIZ);
  5061. payload_.resize(offset + n);
  5062. auto got = strm.read(&payload_[offset], n);
  5063. if (got <= 0) {
  5064. payload_.resize(offset);
  5065. return stopped();
  5066. }
  5067. payload_.resize(offset + static_cast<size_t>(got));
  5068. }
  5069. if (head_[1] & 0x80) {
  5070. const auto *mask_key = head_ + need_ - 4;
  5071. for (size_t i = 0; i < payload_.size(); i++) {
  5072. payload_[i] ^= static_cast<char>(mask_key[i % 4]);
  5073. }
  5074. }
  5075. fin = (head_[0] & 0x80) != 0;
  5076. opcode = static_cast<Opcode>(head_[0] & 0x0F);
  5077. payload = std::move(payload_);
  5078. reset();
  5079. return FrameRead::Ok;
  5080. }
  5081. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  5082. std::string &payload, bool &fin,
  5083. bool expect_masked, size_t max_len) {
  5084. FrameReader reader;
  5085. auto r = reader.read(strm, opcode, payload, fin, expect_masked, max_len);
  5086. return r == FrameRead::Timeout && reader.begun() ? FrameRead::Fail : r;
  5087. }
  5088. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  5089. // be sent followed by a UTF-8 reason.
  5090. inline bool is_valid_close_payload(const std::string &payload) {
  5091. if (payload.empty()) { return true; }
  5092. if (payload.size() < 2) { return false; }
  5093. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  5094. static_cast<uint8_t>(payload[1]);
  5095. auto may_be_sent = (1000 <= code && code <= 1003) ||
  5096. (1007 <= code && code <= 1014) ||
  5097. (3000 <= code && code <= 4999);
  5098. return may_be_sent && is_valid_utf8(payload.substr(2));
  5099. }
  5100. } // namespace impl
  5101. } // namespace ws
  5102. namespace detail {
  5103. // A path a mount point serves: absolute, with no empty segment except a
  5104. // trailing '/', no segment ending in '.' or a space (which covers "." and
  5105. // ".." and names Windows trims into another file's name) and, on Windows, no
  5106. // ':' (which names an NTFS stream, so "a.txt::$DATA" is a.txt), so the file
  5107. // served is the one that req.path names to the handlers that ran before it.
  5108. inline bool is_valid_path(const std::string &path) {
  5109. if (path.empty() || path[0] != '/') { return false; }
  5110. auto beg = size_t{1};
  5111. for (auto i = beg; i <= path.size(); i++) {
  5112. if (i < path.size() && path[i] != '/') {
  5113. if (path[i] == '\0' || path[i] == '\\') { return false; }
  5114. #ifdef _WIN32
  5115. if (path[i] == ':') { return false; }
  5116. #endif
  5117. continue;
  5118. }
  5119. auto len = i - beg;
  5120. if ((len == 0 && i < path.size()) ||
  5121. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5122. return false;
  5123. }
  5124. beg = i + 1;
  5125. }
  5126. return true;
  5127. }
  5128. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5129. #if defined(_WIN32)
  5130. // Resolve junctions and symlinks, as realpath() does
  5131. auto wpath = u8string_to_wstring(path);
  5132. if (wpath.empty()) { return false; }
  5133. CREATEFILE2_EXTENDED_PARAMETERS params{};
  5134. params.dwSize = sizeof(params);
  5135. params.dwFileFlags = FILE_FLAG_BACKUP_SEMANTICS; // Needed to open a directory
  5136. auto h = ::CreateFile2(wpath.c_str(), 0,
  5137. FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
  5138. OPEN_EXISTING, &params);
  5139. if (h == INVALID_HANDLE_VALUE) { return false; }
  5140. auto guard = scope_exit([&]() { ::CloseHandle(h); });
  5141. std::wstring wbuf(MAX_PATH, L'\0');
  5142. auto len = ::GetFinalPathNameByHandleW(
  5143. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5144. if (len >= wbuf.size()) {
  5145. wbuf.resize(len);
  5146. len = ::GetFinalPathNameByHandleW(
  5147. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5148. }
  5149. if (len == 0 || len >= wbuf.size()) { return false; }
  5150. auto n = ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5151. nullptr, 0, nullptr, nullptr);
  5152. if (n <= 0) { return false; }
  5153. resolved.assign(static_cast<size_t>(n), '\0');
  5154. ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5155. &resolved[0], n, nullptr, nullptr);
  5156. #elif defined(PATH_MAX)
  5157. char buf[PATH_MAX];
  5158. if (realpath(path, buf) == nullptr) { return false; }
  5159. resolved = buf;
  5160. #else
  5161. auto buf = realpath(path, nullptr);
  5162. auto guard = scope_exit([&]() { std::free(buf); });
  5163. if (buf == nullptr) { return false; }
  5164. resolved = buf;
  5165. #endif
  5166. return true;
  5167. }
  5168. inline bool is_path_within_base(const std::string &resolved_path,
  5169. const std::string &resolved_base) {
  5170. #if defined(_WIN32)
  5171. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5172. resolved_base.size()) == 0;
  5173. #else
  5174. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5175. resolved_base.size()) == 0;
  5176. #endif
  5177. }
  5178. inline FileStat::FileStat(const std::string &path) {
  5179. #if defined(_WIN32)
  5180. auto wpath = u8string_to_wstring(path.c_str());
  5181. ret_ = _wstat(wpath.c_str(), &st_);
  5182. #else
  5183. ret_ = stat(path.c_str(), &st_);
  5184. #endif
  5185. }
  5186. inline bool FileStat::is_file() const {
  5187. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5188. }
  5189. inline bool FileStat::is_dir() const {
  5190. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5191. }
  5192. inline time_t FileStat::mtime() const {
  5193. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5194. : static_cast<time_t>(-1);
  5195. }
  5196. inline size_t FileStat::size() const {
  5197. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5198. }
  5199. inline std::string encode_path(const std::string &s) {
  5200. std::string result;
  5201. result.reserve(s.size());
  5202. for (size_t i = 0; s[i]; i++) {
  5203. switch (s[i]) {
  5204. case ' ': result += "%20"; break;
  5205. case '+': result += "%2B"; break;
  5206. case '\'': result += "%27"; break;
  5207. case ',': result += "%2C"; break;
  5208. // case ':': result += "%3A"; break; // ok? probably...
  5209. case ';': result += "%3B"; break;
  5210. default:
  5211. auto c = static_cast<uint8_t>(s[i]);
  5212. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5213. // in a request-target as-is.
  5214. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5215. result += '%';
  5216. char hex[4];
  5217. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5218. assert(len == 2);
  5219. result.append(hex, static_cast<size_t>(len));
  5220. } else {
  5221. result += s[i];
  5222. }
  5223. break;
  5224. }
  5225. }
  5226. return result;
  5227. }
  5228. inline std::string file_extension(const std::string &path) {
  5229. auto i = path.size();
  5230. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5231. i--;
  5232. }
  5233. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5234. return std::string();
  5235. }
  5236. return path.substr(i);
  5237. }
  5238. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5239. template <typename T>
  5240. inline bool parse_header(const char *beg, const char *end, T fn);
  5241. template <typename T>
  5242. inline bool parse_header(const char *beg, const char *end, T fn) {
  5243. // Skip trailing spaces and tabs.
  5244. while (beg < end && is_space_or_tab(end[-1])) {
  5245. end--;
  5246. }
  5247. auto p = beg;
  5248. while (p < end && *p != ':') {
  5249. p++;
  5250. }
  5251. auto name = std::string(beg, p);
  5252. if (!detail::fields::is_field_name(name)) { return false; }
  5253. if (p == end) { return false; }
  5254. auto key_end = p;
  5255. if (*p++ != ':') { return false; }
  5256. while (p < end && is_space_or_tab(*p)) {
  5257. p++;
  5258. }
  5259. if (p <= end) {
  5260. auto key_len = key_end - beg;
  5261. if (!key_len) { return false; }
  5262. auto key = std::string(beg, key_end);
  5263. auto val = std::string(p, end);
  5264. if (!detail::fields::is_field_value(val)) { return false; }
  5265. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5266. // percent-decoded by the recipient. Applications that need to interpret a
  5267. // value as a URI component should call httplib::decode_uri_component()
  5268. // (or decode_path_component()) explicitly.
  5269. fn(key, val);
  5270. return true;
  5271. }
  5272. return false;
  5273. }
  5274. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5275. const Headers &src_headers) {
  5276. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5277. // transfer coding is complete when a chunk with a chunk-size of zero is
  5278. // received, possibly followed by a trailer section, and finally terminated by
  5279. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5280. //
  5281. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5282. // doesn't care for the existence of the final CRLF. In other words, it seems
  5283. // to be ok whether the final CRLF exists or not in the chunked data.
  5284. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5285. //
  5286. // According to the reference code in RFC 9112, cpp-httplib now allows
  5287. // chunked transfer coding data without the final CRLF.
  5288. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5289. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5290. "transfer-encoding",
  5291. "content-length",
  5292. "host",
  5293. "authorization",
  5294. "www-authenticate",
  5295. "proxy-authenticate",
  5296. "proxy-authorization",
  5297. "cookie",
  5298. "set-cookie",
  5299. "cache-control",
  5300. "expect",
  5301. "max-forwards",
  5302. "pragma",
  5303. "range",
  5304. "te",
  5305. "age",
  5306. "expires",
  5307. "date",
  5308. "location",
  5309. "retry-after",
  5310. "vary",
  5311. "warning",
  5312. "content-encoding",
  5313. "content-type",
  5314. "content-range",
  5315. "trailer"};
  5316. case_ignore::unordered_set<std::string> declared_trailers;
  5317. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5318. if (!trailer_header.empty()) {
  5319. // split() trims each token and skips empty ones, so the name arrives ready
  5320. // to look up.
  5321. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5322. ',', [&](const char *b, const char *e) {
  5323. // A legitimate message declares only a handful of trailers. Cap the
  5324. // set so a peer cannot grow it without bound: an oversized set only
  5325. // arises from an attempt to force many colliding names into
  5326. // quadratic lookups (case_ignore::hash is unkeyed).
  5327. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5328. return;
  5329. }
  5330. std::string key(b, e);
  5331. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5332. declared_trailers.insert(key);
  5333. }
  5334. });
  5335. }
  5336. size_t trailer_header_count = 0;
  5337. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5338. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5339. // Count every received trailer field, not only the declared ones stored in
  5340. // dest, so undeclared fields cannot keep this loop running past the limit.
  5341. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5342. constexpr auto line_terminator_len = 2;
  5343. auto line_beg = line_reader.ptr();
  5344. auto line_end =
  5345. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5346. if (!parse_header(line_beg, line_end,
  5347. [&](const std::string &key, const std::string &val) {
  5348. if (declared_trailers.find(key) !=
  5349. declared_trailers.end()) {
  5350. dest.emplace(key, val);
  5351. }
  5352. })) {
  5353. return false;
  5354. }
  5355. trailer_header_count++;
  5356. if (!line_reader.getline()) { return false; }
  5357. }
  5358. return true;
  5359. }
  5360. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5361. size_t right) {
  5362. while (b + left < e && is_space_or_tab(b[left])) {
  5363. left++;
  5364. }
  5365. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5366. right--;
  5367. }
  5368. return std::make_pair(left, right);
  5369. }
  5370. inline std::string trim_copy(const std::string &s) {
  5371. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5372. return s.substr(r.first, r.second - r.first);
  5373. }
  5374. inline std::string trim_double_quotes_copy(const std::string &s) {
  5375. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5376. return s.substr(1, s.size() - 2);
  5377. }
  5378. return s;
  5379. }
  5380. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5381. // here, as browsers send any other backslash, such as one in a Windows path,
  5382. // as it is.
  5383. inline std::string unquote_param(const std::string &s) {
  5384. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5385. std::string out;
  5386. for (size_t i = 1; i + 1 < s.size(); i++) {
  5387. if (s[i] == '\\' && i + 2 < s.size() &&
  5388. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5389. i++;
  5390. }
  5391. out += s[i];
  5392. }
  5393. return out;
  5394. }
  5395. inline void
  5396. divide(const char *data, std::size_t size, char d,
  5397. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5398. fn) {
  5399. const auto it = std::find(data, data + size, d);
  5400. const auto found = static_cast<std::size_t>(it != data + size);
  5401. const auto lhs_data = data;
  5402. const auto lhs_size = static_cast<std::size_t>(it - data);
  5403. const auto rhs_data = it + found;
  5404. const auto rhs_size = size - lhs_size - found;
  5405. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5406. }
  5407. inline void
  5408. divide(const std::string &str, char d,
  5409. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5410. fn) {
  5411. divide(str.data(), str.size(), d, std::move(fn));
  5412. }
  5413. inline void split(const char *b, const char *e, char d,
  5414. std::function<void(const char *, const char *)> fn) {
  5415. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5416. }
  5417. inline void split(const char *b, const char *e, char d, size_t m,
  5418. std::function<void(const char *, const char *)> fn) {
  5419. size_t i = 0;
  5420. size_t beg = 0;
  5421. size_t count = 1;
  5422. while (e ? (b + i < e) : (b[i] != '\0')) {
  5423. if (b[i] == d && count < m) {
  5424. auto r = trim(b, e, beg, i);
  5425. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5426. beg = i + 1;
  5427. count++;
  5428. }
  5429. i++;
  5430. }
  5431. if (i) {
  5432. auto r = trim(b, e, beg, i);
  5433. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5434. }
  5435. }
  5436. // Same contract as split(), except that a delimiter inside a quoted-string is
  5437. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5438. // quoted-string, and ';' and '=' are legal characters inside one.
  5439. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5440. std::function<void(const char *, const char *)> fn) {
  5441. size_t i = 0;
  5442. size_t beg = 0;
  5443. size_t count = 1;
  5444. auto in_quotes = false;
  5445. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5446. while (has(i)) {
  5447. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5448. // A quoted-pair, whose second character does not end the string.
  5449. i++;
  5450. } else if (b[i] == '"') {
  5451. in_quotes = !in_quotes;
  5452. } else if (b[i] == d && !in_quotes && count < m) {
  5453. auto r = trim(b, e, beg, i);
  5454. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5455. beg = i + 1;
  5456. count++;
  5457. }
  5458. i++;
  5459. }
  5460. if (i) {
  5461. auto r = trim(b, e, beg, i);
  5462. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5463. }
  5464. }
  5465. inline void split_unquoted(const char *b, const char *e, char d,
  5466. std::function<void(const char *, const char *)> fn) {
  5467. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5468. std::move(fn));
  5469. }
  5470. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5471. // key a token, so the first '=' is the separator even when the value is a
  5472. // quoted-string carrying more of them.
  5473. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5474. std::string &val) {
  5475. divide(
  5476. b, static_cast<std::size_t>(e - b), '=',
  5477. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5478. const auto kr = trim(kb, kb + klen, 0, klen);
  5479. key.assign(kb + kr.first, kb + kr.second);
  5480. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5481. val.assign(vb + vr.first, vb + vr.second);
  5482. });
  5483. }
  5484. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5485. std::function<bool(const char *, const char *)> fn) {
  5486. size_t i = 0;
  5487. size_t beg = 0;
  5488. size_t count = 1;
  5489. while (e ? (b + i < e) : (b[i] != '\0')) {
  5490. if (b[i] == d && count < m) {
  5491. auto r = trim(b, e, beg, i);
  5492. if (r.first < r.second) {
  5493. auto found = fn(&b[r.first], &b[r.second]);
  5494. if (found) { return true; }
  5495. }
  5496. beg = i + 1;
  5497. count++;
  5498. }
  5499. i++;
  5500. }
  5501. if (i) {
  5502. auto r = trim(b, e, beg, i);
  5503. if (r.first < r.second) {
  5504. auto found = fn(&b[r.first], &b[r.second]);
  5505. if (found) { return true; }
  5506. }
  5507. }
  5508. return false;
  5509. }
  5510. inline bool split_find(const char *b, const char *e, char d,
  5511. std::function<bool(const char *, const char *)> fn) {
  5512. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5513. std::move(fn));
  5514. }
  5515. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5516. size_t fixed_buffer_size)
  5517. : strm_(strm), fixed_buffer_(fixed_buffer),
  5518. fixed_buffer_size_(fixed_buffer_size) {}
  5519. inline const char *stream_line_reader::ptr() const {
  5520. if (growable_buffer_.empty()) {
  5521. return fixed_buffer_;
  5522. } else {
  5523. return growable_buffer_.data();
  5524. }
  5525. }
  5526. inline size_t stream_line_reader::size() const {
  5527. if (growable_buffer_.empty()) {
  5528. return fixed_buffer_used_size_;
  5529. } else {
  5530. return growable_buffer_.size();
  5531. }
  5532. }
  5533. inline bool stream_line_reader::end_with_crlf() const {
  5534. auto end = ptr() + size();
  5535. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5536. }
  5537. inline bool stream_line_reader::getline() {
  5538. fixed_buffer_used_size_ = 0;
  5539. growable_buffer_.clear();
  5540. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5541. char prev_byte = 0;
  5542. #endif
  5543. for (size_t i = 0;; i++) {
  5544. // Fast path: whatever the stream has already buffered can be scanned for
  5545. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5546. // call, a bounds check and a one-byte copy per character of the request.
  5547. size_t buffered_size = 0;
  5548. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5549. auto take = buffered_size;
  5550. auto terminated = false;
  5551. for (size_t at = 0; at < buffered_size;) {
  5552. auto nl = static_cast<const char *>(
  5553. memchr(buffered + at, '\n', buffered_size - at));
  5554. if (!nl) { break; }
  5555. auto pos = static_cast<size_t>(nl - buffered);
  5556. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5557. take = pos + 1;
  5558. terminated = true;
  5559. break;
  5560. #else
  5561. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5562. // be the last byte of an earlier chunk, hence prev_byte.
  5563. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5564. take = pos + 1;
  5565. terminated = true;
  5566. break;
  5567. }
  5568. at = pos + 1;
  5569. #endif
  5570. }
  5571. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5572. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5573. prev_byte = buffered[take - 1];
  5574. #endif
  5575. append(buffered, take);
  5576. strm_.consume_buffered(take);
  5577. i += take;
  5578. if (terminated) { return true; }
  5579. continue;
  5580. }
  5581. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5582. // Treat exceptionally long lines as an error to
  5583. // prevent infinite loops/memory exhaustion
  5584. return false;
  5585. }
  5586. char byte;
  5587. auto n = strm_.read(&byte, 1);
  5588. if (n < 0) {
  5589. return false;
  5590. } else if (n == 0) {
  5591. if (i == 0) {
  5592. return false;
  5593. } else {
  5594. break;
  5595. }
  5596. }
  5597. append(byte);
  5598. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5599. if (byte == '\n') { break; }
  5600. #else
  5601. if (prev_byte == '\r' && byte == '\n') { break; }
  5602. prev_byte = byte;
  5603. #endif
  5604. }
  5605. return true;
  5606. }
  5607. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5608. inline void stream_line_reader::append(const char *data, size_t size) {
  5609. // Once the line has outgrown the fixed buffer everything must keep going to
  5610. // the growable one, even if a later chunk would have fit. Without the
  5611. // emptiness check a short append after a long one would land in the fixed
  5612. // buffer, which ptr() and size() no longer look at, and be lost.
  5613. if (growable_buffer_.empty() &&
  5614. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5615. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5616. fixed_buffer_used_size_ += size;
  5617. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5618. } else {
  5619. // Unlike the per-character overload, this can be the very first append of
  5620. // the line, so the fixed buffer may hold nothing and carry no terminator
  5621. // yet. assign() takes an explicit length and does not need one.
  5622. if (growable_buffer_.empty()) {
  5623. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5624. }
  5625. growable_buffer_.append(data, size);
  5626. }
  5627. }
  5628. inline mmap::mmap(const char *path) { open(path); }
  5629. inline mmap::~mmap() { close(); }
  5630. inline bool mmap::open(const char *path) {
  5631. close();
  5632. #if defined(_WIN32)
  5633. auto wpath = u8string_to_wstring(path);
  5634. if (wpath.empty()) { return false; }
  5635. hFile_ =
  5636. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5637. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5638. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5639. LARGE_INTEGER size{};
  5640. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5641. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5642. // See:
  5643. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5644. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5645. size_ = static_cast<size_t>(size.QuadPart);
  5646. hMapping_ =
  5647. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5648. // Special treatment for an empty file...
  5649. if (hMapping_ == NULL && size_ == 0) {
  5650. close();
  5651. is_open_empty_file = true;
  5652. return true;
  5653. }
  5654. if (hMapping_ == NULL) {
  5655. close();
  5656. return false;
  5657. }
  5658. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5659. if (addr_ == nullptr) {
  5660. close();
  5661. return false;
  5662. }
  5663. #else
  5664. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5665. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5666. if (fd_ == -1) { return false; }
  5667. // Only a regular file has a size to serve, unlike a directory or a device.
  5668. struct stat sb;
  5669. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5670. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5671. close();
  5672. return false;
  5673. }
  5674. size_ = static_cast<size_t>(sb.st_size);
  5675. #endif
  5676. return true;
  5677. }
  5678. inline bool mmap::is_open() const {
  5679. #if defined(_WIN32)
  5680. return is_open_empty_file ? true : addr_ != nullptr;
  5681. #else
  5682. return fd_ != -1;
  5683. #endif
  5684. }
  5685. inline size_t mmap::size() const { return size_; }
  5686. inline void mmap::close() {
  5687. #if defined(_WIN32)
  5688. if (addr_) {
  5689. ::UnmapViewOfFile(addr_);
  5690. addr_ = nullptr;
  5691. }
  5692. if (hMapping_) {
  5693. ::CloseHandle(hMapping_);
  5694. hMapping_ = NULL;
  5695. }
  5696. if (hFile_ != INVALID_HANDLE_VALUE) {
  5697. ::CloseHandle(hFile_);
  5698. hFile_ = INVALID_HANDLE_VALUE;
  5699. }
  5700. is_open_empty_file = false;
  5701. #else
  5702. if (fd_ != -1) {
  5703. ::close(fd_);
  5704. fd_ = -1;
  5705. }
  5706. #endif
  5707. size_ = 0;
  5708. }
  5709. inline int close_socket(socket_t sock) noexcept {
  5710. #ifdef _WIN32
  5711. return closesocket(sock);
  5712. #else
  5713. return close(sock);
  5714. #endif
  5715. }
  5716. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5717. ssize_t res = 0;
  5718. while (true) {
  5719. res = fn();
  5720. if (res < 0 && errno == EINTR) {
  5721. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5722. continue;
  5723. }
  5724. break;
  5725. }
  5726. return res;
  5727. }
  5728. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5729. if (offset >= size_) { return 0; }
  5730. len = (std::min)(len, size_ - offset);
  5731. #if defined(_WIN32)
  5732. // Windows does not let a mapped file be truncated.
  5733. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5734. return len;
  5735. #else
  5736. auto n = handle_EINTR(
  5737. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5738. return n > 0 ? static_cast<size_t>(n) : 0;
  5739. #endif
  5740. }
  5741. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5742. return handle_EINTR([&]() {
  5743. return recv(sock,
  5744. #ifdef _WIN32
  5745. static_cast<char *>(ptr), static_cast<int>(size),
  5746. #else
  5747. ptr, size,
  5748. #endif
  5749. flags);
  5750. });
  5751. }
  5752. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5753. int flags) {
  5754. return handle_EINTR([&]() {
  5755. return send(sock,
  5756. #ifdef _WIN32
  5757. static_cast<const char *>(ptr), static_cast<int>(size),
  5758. #else
  5759. ptr, size,
  5760. #endif
  5761. flags);
  5762. });
  5763. }
  5764. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5765. #ifdef _WIN32
  5766. return ::WSAPoll(fds, nfds, timeout);
  5767. #else
  5768. return ::poll(fds, nfds, timeout);
  5769. #endif
  5770. }
  5771. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5772. time_t usec) {
  5773. struct pollfd pfd;
  5774. pfd.fd = sock;
  5775. pfd.events = events;
  5776. pfd.revents = 0;
  5777. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5778. // "return immediately", which callers here rely on to probe a socket.
  5779. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5780. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5781. }
  5782. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5783. return select_impl(sock, POLLIN, sec, usec);
  5784. }
  5785. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5786. return select_impl(sock, POLLOUT, sec, usec);
  5787. }
  5788. // The point sec and usec from now, for select_until(). A negative sec, or one
  5789. // past what the clock reaches, never comes.
  5790. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5791. time_t usec) {
  5792. auto now = std::chrono::steady_clock::now();
  5793. auto never = (std::chrono::steady_clock::time_point::max)();
  5794. if (sec < 0 ||
  5795. sec >= std::chrono::duration_cast<std::chrono::seconds>(never - now)
  5796. .count()) {
  5797. return never;
  5798. }
  5799. return now + std::chrono::seconds(sec) + std::chrono::microseconds(usec);
  5800. }
  5801. // Waits only for the time left until deadline, so that all the waits of one
  5802. // TLS handshake come out of a single timeout. With interrupted, it waits in
  5803. // slices and gives up once interrupted() returns true, as a local shutdown()
  5804. // would not wake the wait on Windows.
  5805. inline ssize_t
  5806. select_until(socket_t sock, short events,
  5807. std::chrono::steady_clock::time_point deadline,
  5808. const std::function<bool()> &interrupted = nullptr) {
  5809. if (!interrupted) {
  5810. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5811. return select_impl(sock, events, -1, 0);
  5812. }
  5813. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5814. deadline - std::chrono::steady_clock::now())
  5815. .count();
  5816. if (left <= 0) { return 0; }
  5817. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5818. static_cast<time_t>(left % 1000000));
  5819. }
  5820. const auto slice = std::chrono::microseconds(100000);
  5821. while (!interrupted()) {
  5822. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5823. deadline - std::chrono::steady_clock::now());
  5824. auto last = left < slice;
  5825. // poll() takes whole milliseconds, so round the last wait up to keep it
  5826. // from ending before the deadline.
  5827. auto wait_usec = last ? (std::max)((left.count() + 999) / 1000 * 1000,
  5828. static_cast<decltype(left.count())>(0))
  5829. : slice.count();
  5830. auto ret = select_impl(sock, events, 0, static_cast<time_t>(wait_usec));
  5831. if (ret != 0 || last) { return ret; }
  5832. }
  5833. return 0;
  5834. }
  5835. // select_impl(), but waits in slices and gives up once interrupted() returns
  5836. // true
  5837. inline ssize_t select_interruptible(socket_t sock, short events, time_t sec,
  5838. time_t usec,
  5839. const std::function<bool()> &interrupted) {
  5840. if (!interrupted) { return select_impl(sock, events, sec, usec); }
  5841. return select_until(sock, events, deadline_after(sec, usec), interrupted);
  5842. }
  5843. inline ssize_t
  5844. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5845. const std::function<bool()> &interrupted) {
  5846. return select_interruptible(sock, POLLIN, sec, usec, interrupted);
  5847. }
  5848. // Waits for a connect in progress, which ends as Error::Canceled once
  5849. // interrupted() returns true
  5850. inline Error
  5851. wait_until_socket_is_ready(socket_t sock, time_t sec, time_t usec,
  5852. const std::function<bool()> &interrupted = nullptr) {
  5853. auto ret =
  5854. select_interruptible(sock, POLLIN | POLLOUT, sec, usec, interrupted);
  5855. if (ret == 0) {
  5856. return interrupted && interrupted() ? Error::Canceled
  5857. : Error::ConnectionTimeout;
  5858. }
  5859. if (ret < 0) { return Error::Connection; }
  5860. // A failed connect reports its error here, whatever events poll() returned
  5861. auto error = 0;
  5862. socklen_t len = sizeof(error);
  5863. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5864. reinterpret_cast<char *>(&error), &len);
  5865. return res >= 0 && !error ? Error::Success : Error::Connection;
  5866. }
  5867. inline bool is_socket_alive(socket_t sock) {
  5868. const auto val = detail::select_read(sock, 0, 0);
  5869. if (val == 0) {
  5870. return true;
  5871. } else if (val < 0 && errno == EBADF) {
  5872. return false;
  5873. }
  5874. char buf[1];
  5875. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5876. }
  5877. class SocketStream final : public Stream {
  5878. public:
  5879. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5880. time_t write_timeout_sec, time_t write_timeout_usec,
  5881. time_t max_timeout_msec = 0,
  5882. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5883. (std::chrono::steady_clock::time_point::min)());
  5884. ~SocketStream() override;
  5885. bool is_readable() const override;
  5886. bool wait_readable() const override;
  5887. bool wait_writable() const override;
  5888. bool is_peer_alive() const override;
  5889. ssize_t read(char *ptr, size_t size) override;
  5890. ssize_t write(const char *ptr, size_t size) override;
  5891. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5892. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5893. socket_t socket() const override;
  5894. time_t duration() const override;
  5895. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5896. void set_max_timeout(time_t msec) override;
  5897. void set_read_interrupt(std::function<bool()> interrupted) override;
  5898. const char *buffered_data(size_t &size) const override;
  5899. void consume_buffered(size_t size) override;
  5900. // The caller has just seen this socket become readable. Lets the next read
  5901. // skip its own readiness wait, which would otherwise ask the kernel a
  5902. // question that was answered a moment ago. Consumed by that read.
  5903. void set_readable_hint() { readable_hint_ = true; }
  5904. private:
  5905. bool ensure_readable();
  5906. socket_t sock_;
  5907. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5908. // thread while a read is in flight -- that is the point of it, for a caller
  5909. // holding one connection and wanting control back to send on it.
  5910. std::atomic<time_t> read_timeout_sec_;
  5911. std::atomic<time_t> read_timeout_usec_;
  5912. time_t write_timeout_sec_;
  5913. time_t write_timeout_usec_;
  5914. time_t max_timeout_msec_;
  5915. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5916. std::function<bool()> read_interrupted_;
  5917. std::vector<char> read_buff_;
  5918. size_t read_buff_off_ = 0;
  5919. size_t read_buff_content_size_ = 0;
  5920. bool readable_hint_ = false;
  5921. static const size_t read_buff_size_ = 1024l * 4;
  5922. };
  5923. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5924. time_t keep_alive_timeout_sec) {
  5925. using namespace std::chrono;
  5926. const auto interval_usec =
  5927. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5928. // Avoid expensive `steady_clock::now()` call for the first time
  5929. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5930. const auto start = steady_clock::now() - microseconds{interval_usec};
  5931. const auto timeout = seconds{keep_alive_timeout_sec};
  5932. while (true) {
  5933. if (svr_sock == INVALID_SOCKET) {
  5934. break; // Server socket is closed
  5935. }
  5936. auto val = select_read(sock, 0, interval_usec);
  5937. if (val < 0) {
  5938. break; // Ssocket error
  5939. } else if (val == 0) {
  5940. if (steady_clock::now() - start > timeout) {
  5941. break; // Timeout
  5942. }
  5943. } else {
  5944. return true; // Ready for read
  5945. }
  5946. }
  5947. return false;
  5948. }
  5949. // `has_buffered_request` reports whether the connection's stream already holds
  5950. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5951. // 9.3.2), so reading one request can pull the start of the next one into the
  5952. // stream's buffer; that request must be served without waiting for the socket
  5953. // to become readable again, since its bytes are no longer on the socket.
  5954. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5955. template <typename P, typename T>
  5956. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5957. socket_t sock,
  5958. size_t keep_alive_max_count,
  5959. time_t keep_alive_timeout_sec,
  5960. P has_buffered_request, T callback) {
  5961. auto ret = false;
  5962. // A keep_alive_max_count of 0 sets no limit.
  5963. for (size_t served = 0;
  5964. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5965. auto socket_readable = false;
  5966. if (!has_buffered_request()) {
  5967. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5968. socket_readable = true;
  5969. }
  5970. auto close_connection = served + 1 == keep_alive_max_count;
  5971. auto connection_closed = false;
  5972. ret = callback(socket_readable, close_connection, connection_closed);
  5973. if (!ret || connection_closed) { break; }
  5974. }
  5975. return ret;
  5976. }
  5977. template <typename T>
  5978. inline bool
  5979. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5980. size_t keep_alive_max_count,
  5981. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5982. time_t read_timeout_usec, time_t write_timeout_sec,
  5983. time_t write_timeout_usec, T callback) {
  5984. // One stream per connection: its read buffer can already hold the start of
  5985. // the next, pipelined request.
  5986. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5987. write_timeout_sec, write_timeout_usec);
  5988. return process_server_socket_core(
  5989. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5990. [&]() { return strm.is_readable(); },
  5991. [&](bool socket_readable, bool close_connection,
  5992. bool &connection_closed) {
  5993. if (socket_readable) { strm.set_readable_hint(); }
  5994. return callback(strm, close_connection, connection_closed);
  5995. });
  5996. }
  5997. inline bool process_client_socket(
  5998. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5999. time_t write_timeout_sec, time_t write_timeout_usec,
  6000. time_t max_timeout_msec,
  6001. std::chrono::time_point<std::chrono::steady_clock> start_time,
  6002. std::function<bool(Stream &)> callback) {
  6003. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  6004. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  6005. start_time);
  6006. return callback(strm);
  6007. }
  6008. inline int shutdown_socket(socket_t sock) noexcept {
  6009. #ifdef _WIN32
  6010. return shutdown(sock, SD_BOTH);
  6011. #else
  6012. return shutdown(sock, SHUT_RDWR);
  6013. #endif
  6014. }
  6015. // Half-closes the write side and drains any in-flight/queued bytes before
  6016. // the final shutdown+close. Closing with unread data in the receive queue
  6017. // (or bytes arriving after the receive side is closed) makes the stack send
  6018. // an abortive RST instead of a graceful FIN, which can make the peer see the
  6019. // response as a failed read even though it was fully written.
  6020. inline void drain_and_close_socket(socket_t sock) noexcept {
  6021. #ifdef _WIN32
  6022. shutdown(sock, SD_SEND);
  6023. #else
  6024. shutdown(sock, SHUT_WR);
  6025. #endif
  6026. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6027. size_t total = 0;
  6028. const auto deadline = std::chrono::steady_clock::now() +
  6029. std::chrono::milliseconds(100); // bound #1
  6030. while (total < size_t(1024u * 1024u)) { // bound #2
  6031. const auto remaining =
  6032. std::chrono::duration_cast<std::chrono::microseconds>(
  6033. deadline - std::chrono::steady_clock::now())
  6034. .count();
  6035. if (remaining <= 0) { break; }
  6036. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  6037. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  6038. if (n <= 0) { break; }
  6039. total += static_cast<size_t>(n);
  6040. }
  6041. shutdown_socket(sock);
  6042. close_socket(sock);
  6043. }
  6044. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  6045. if (s.size() > 1 && s[0] == '\0') {
  6046. auto ret = s;
  6047. ret[0] = '@';
  6048. return ret;
  6049. }
  6050. return s;
  6051. }
  6052. inline std::string
  6053. unescape_abstract_namespace_unix_domain(const std::string &s) {
  6054. if (s.size() > 1 && s[0] == '@') {
  6055. auto ret = s;
  6056. ret[0] = '\0';
  6057. return ret;
  6058. }
  6059. return s;
  6060. }
  6061. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  6062. const struct addrinfo *hints,
  6063. struct addrinfo **res, time_t timeout_sec) {
  6064. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  6065. if (timeout_sec <= 0) {
  6066. // No timeout specified, use standard getaddrinfo
  6067. return getaddrinfo(node, service, hints, res);
  6068. }
  6069. #ifdef _WIN32
  6070. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  6071. OVERLAPPED overlapped = {};
  6072. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  6073. if (!event) { return EAI_FAIL; }
  6074. overlapped.hEvent = event;
  6075. PADDRINFOEXW result_addrinfo = nullptr;
  6076. HANDLE cancel_handle = nullptr;
  6077. ADDRINFOEXW hints_ex = {};
  6078. if (hints) {
  6079. hints_ex.ai_flags = hints->ai_flags;
  6080. hints_ex.ai_family = hints->ai_family;
  6081. hints_ex.ai_socktype = hints->ai_socktype;
  6082. hints_ex.ai_protocol = hints->ai_protocol;
  6083. }
  6084. auto wnode = u8string_to_wstring(node);
  6085. auto wservice = u8string_to_wstring(service);
  6086. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  6087. hints ? &hints_ex : nullptr, &result_addrinfo,
  6088. nullptr, &overlapped, nullptr, &cancel_handle);
  6089. if (ret == WSA_IO_PENDING) {
  6090. auto wait_result =
  6091. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  6092. if (wait_result == WAIT_TIMEOUT) {
  6093. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  6094. ::CloseHandle(event);
  6095. return EAI_AGAIN;
  6096. }
  6097. DWORD bytes_returned;
  6098. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  6099. &bytes_returned, FALSE)) {
  6100. ::CloseHandle(event);
  6101. return ::WSAGetLastError();
  6102. }
  6103. }
  6104. ::CloseHandle(event);
  6105. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  6106. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  6107. return 0;
  6108. }
  6109. return ret;
  6110. #elif TARGET_OS_MAC && defined(__clang__)
  6111. if (!node) { return EAI_NONAME; }
  6112. // macOS implementation using CFHost API for asynchronous DNS resolution
  6113. CFStringRef hostname_ref = CFStringCreateWithCString(
  6114. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  6115. if (!hostname_ref) { return EAI_MEMORY; }
  6116. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  6117. CFRelease(hostname_ref);
  6118. if (!host_ref) { return EAI_MEMORY; }
  6119. // Set up context for callback
  6120. struct CFHostContext {
  6121. bool completed = false;
  6122. bool success = false;
  6123. CFArrayRef addresses = nullptr;
  6124. std::mutex mutex;
  6125. std::condition_variable cv;
  6126. } context;
  6127. CFHostClientContext client_context;
  6128. memset(&client_context, 0, sizeof(client_context));
  6129. client_context.info = &context;
  6130. // Set callback
  6131. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  6132. const CFStreamError *error, void *info) {
  6133. auto ctx = static_cast<CFHostContext *>(info);
  6134. std::lock_guard<std::mutex> lock(ctx->mutex);
  6135. if (error && error->error != 0) {
  6136. ctx->success = false;
  6137. } else {
  6138. Boolean hasBeenResolved;
  6139. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6140. if (ctx->addresses && hasBeenResolved) {
  6141. CFRetain(ctx->addresses);
  6142. ctx->success = true;
  6143. } else {
  6144. ctx->success = false;
  6145. }
  6146. }
  6147. ctx->completed = true;
  6148. ctx->cv.notify_one();
  6149. };
  6150. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6151. CFRelease(host_ref);
  6152. return EAI_SYSTEM;
  6153. }
  6154. // Schedule on run loop
  6155. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6156. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6157. // Start resolution
  6158. CFStreamError stream_error;
  6159. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6160. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6161. CFRelease(host_ref);
  6162. return EAI_FAIL;
  6163. }
  6164. // Wait for completion with timeout
  6165. auto timeout_time =
  6166. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6167. bool timed_out = false;
  6168. {
  6169. std::unique_lock<std::mutex> lock(context.mutex);
  6170. while (!context.completed) {
  6171. auto now = std::chrono::steady_clock::now();
  6172. if (now >= timeout_time) {
  6173. timed_out = true;
  6174. break;
  6175. }
  6176. // Run the runloop for a short time
  6177. lock.unlock();
  6178. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6179. lock.lock();
  6180. }
  6181. }
  6182. // Clean up
  6183. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6184. CFHostSetClient(host_ref, nullptr, nullptr);
  6185. if (timed_out || !context.completed) {
  6186. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6187. CFRelease(host_ref);
  6188. return EAI_AGAIN;
  6189. }
  6190. if (!context.success || !context.addresses) {
  6191. CFRelease(host_ref);
  6192. return EAI_NODATA;
  6193. }
  6194. // Convert CFArray to addrinfo
  6195. CFIndex count = CFArrayGetCount(context.addresses);
  6196. if (count == 0) {
  6197. CFRelease(context.addresses);
  6198. CFRelease(host_ref);
  6199. return EAI_NODATA;
  6200. }
  6201. struct addrinfo *result_addrinfo = nullptr;
  6202. struct addrinfo **current = &result_addrinfo;
  6203. for (CFIndex i = 0; i < count; i++) {
  6204. CFDataRef addr_data =
  6205. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6206. if (!addr_data) continue;
  6207. const struct sockaddr *sockaddr_ptr =
  6208. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6209. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6210. // Allocate addrinfo structure
  6211. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6212. if (!*current) {
  6213. freeaddrinfo(result_addrinfo);
  6214. CFRelease(context.addresses);
  6215. CFRelease(host_ref);
  6216. return EAI_MEMORY;
  6217. }
  6218. memset(*current, 0, sizeof(struct addrinfo));
  6219. // Set up addrinfo fields
  6220. (*current)->ai_family = sockaddr_ptr->sa_family;
  6221. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6222. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6223. (*current)->ai_addrlen = sockaddr_len;
  6224. // Copy sockaddr
  6225. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6226. if (!(*current)->ai_addr) {
  6227. freeaddrinfo(result_addrinfo);
  6228. CFRelease(context.addresses);
  6229. CFRelease(host_ref);
  6230. return EAI_MEMORY;
  6231. }
  6232. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6233. // Set port if service is specified
  6234. if (service && *service) {
  6235. int port = 0;
  6236. if (parse_port(service, strlen(service), port)) {
  6237. if (sockaddr_ptr->sa_family == AF_INET) {
  6238. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6239. ->sin_port = htons(static_cast<uint16_t>(port));
  6240. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6241. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6242. ->sin6_port = htons(static_cast<uint16_t>(port));
  6243. }
  6244. }
  6245. }
  6246. current = &((*current)->ai_next);
  6247. }
  6248. CFRelease(context.addresses);
  6249. CFRelease(host_ref);
  6250. *res = result_addrinfo;
  6251. return 0;
  6252. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6253. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6254. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6255. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6256. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6257. // the resolver worker still references the stack-local gaicb. The cancel
  6258. // path therefore waits (gai_suspend with no timeout) for the worker to
  6259. // actually finish before letting the stack frame go. The trade-off is that
  6260. // a wedged DNS server can hold this thread for the system resolver timeout
  6261. // (~30s by default) past the caller's connection timeout.
  6262. struct gaicb request{};
  6263. struct gaicb *requests[1] = {&request};
  6264. struct sigevent sevp{};
  6265. struct timespec timeout{timeout_sec, 0};
  6266. request.ar_name = node;
  6267. request.ar_service = service;
  6268. request.ar_request = hints;
  6269. sevp.sigev_notify = SIGEV_NONE;
  6270. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6271. if (rc != 0) { return rc; }
  6272. auto cleanup = scope_exit([&] {
  6273. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6274. });
  6275. int wait_result = gai_suspend(requests, 1, &timeout);
  6276. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6277. int gai_result = gai_error(&request);
  6278. if (gai_result == 0) {
  6279. *res = request.ar_result;
  6280. request.ar_result = nullptr;
  6281. return 0;
  6282. }
  6283. return gai_result;
  6284. }
  6285. gai_cancel(&request);
  6286. while (gai_error(&request) == EAI_INPROGRESS) {
  6287. gai_suspend(requests, 1, nullptr);
  6288. }
  6289. return wait_result;
  6290. #else
  6291. // Fallback implementation using thread-based timeout for other Unix systems.
  6292. struct GetAddrInfoState {
  6293. ~GetAddrInfoState() {
  6294. if (info) { freeaddrinfo(info); }
  6295. }
  6296. std::mutex mutex;
  6297. std::condition_variable result_cv;
  6298. bool completed = false;
  6299. int result = EAI_SYSTEM;
  6300. std::string node;
  6301. std::string service;
  6302. struct addrinfo hints;
  6303. struct addrinfo *info = nullptr;
  6304. };
  6305. // Allocate on the heap, so the resolver thread can keep using the data.
  6306. auto state = std::make_shared<GetAddrInfoState>();
  6307. if (node) { state->node = node; }
  6308. state->service = service;
  6309. state->hints = *hints;
  6310. std::thread resolve_thread([state]() {
  6311. auto thread_result =
  6312. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6313. &state->info);
  6314. std::lock_guard<std::mutex> lock(state->mutex);
  6315. state->result = thread_result;
  6316. state->completed = true;
  6317. state->result_cv.notify_one();
  6318. });
  6319. // Wait for completion or timeout
  6320. std::unique_lock<std::mutex> lock(state->mutex);
  6321. auto finished =
  6322. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6323. [&] { return state->completed; });
  6324. if (finished) {
  6325. // Operation completed within timeout
  6326. resolve_thread.join();
  6327. *res = state->info;
  6328. state->info = nullptr; // Pass ownership to caller
  6329. return state->result;
  6330. } else {
  6331. // Timeout occurred
  6332. resolve_thread.detach(); // Let the thread finish in background
  6333. return EAI_AGAIN; // Return timeout error
  6334. }
  6335. #endif
  6336. #else
  6337. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6338. return getaddrinfo(node, service, hints, res);
  6339. #endif
  6340. }
  6341. template <typename BindOrConnect>
  6342. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6343. int address_family, int socket_flags, bool tcp_nodelay,
  6344. bool ipv6_v6only, SocketOptions socket_options,
  6345. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6346. // Get address info
  6347. const char *node = nullptr;
  6348. struct addrinfo hints;
  6349. struct addrinfo *result;
  6350. memset(&hints, 0, sizeof(struct addrinfo));
  6351. hints.ai_socktype = SOCK_STREAM;
  6352. hints.ai_protocol = IPPROTO_IP;
  6353. if (!ip.empty()) {
  6354. node = ip.c_str();
  6355. // Ask getaddrinfo to convert IP in c-string to address
  6356. hints.ai_family = AF_UNSPEC;
  6357. hints.ai_flags = AI_NUMERICHOST;
  6358. } else {
  6359. if (!host.empty()) { node = host.c_str(); }
  6360. hints.ai_family = address_family;
  6361. hints.ai_flags = socket_flags;
  6362. }
  6363. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6364. if (hints.ai_family == AF_UNIX) {
  6365. const auto addrlen = host.length();
  6366. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6367. #ifdef SOCK_CLOEXEC
  6368. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6369. hints.ai_protocol);
  6370. #else
  6371. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6372. #endif
  6373. if (sock != INVALID_SOCKET) {
  6374. sockaddr_un addr{};
  6375. addr.sun_family = AF_UNIX;
  6376. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6377. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6378. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6379. hints.ai_addrlen = static_cast<socklen_t>(
  6380. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6381. #ifndef SOCK_CLOEXEC
  6382. #ifndef _WIN32
  6383. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6384. #endif
  6385. #endif
  6386. if (socket_options) { socket_options(sock); }
  6387. #ifdef _WIN32
  6388. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6389. // remove the option.
  6390. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6391. #endif
  6392. bool dummy;
  6393. if (!bind_or_connect(sock, hints, dummy)) {
  6394. close_socket(sock);
  6395. sock = INVALID_SOCKET;
  6396. }
  6397. }
  6398. return sock;
  6399. }
  6400. #endif
  6401. auto service = std::to_string(port);
  6402. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6403. timeout_sec)) {
  6404. #if defined __linux__ && !defined __ANDROID__
  6405. res_init();
  6406. #endif
  6407. return INVALID_SOCKET;
  6408. }
  6409. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6410. for (auto rp = result; rp; rp = rp->ai_next) {
  6411. // Create a socket
  6412. #ifdef _WIN32
  6413. auto sock =
  6414. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6415. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6416. /**
  6417. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6418. * and above the socket creation fails on older Windows Systems.
  6419. *
  6420. * Let's try to create a socket the old way in this case.
  6421. *
  6422. * Reference:
  6423. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6424. *
  6425. * WSA_FLAG_NO_HANDLE_INHERIT:
  6426. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6427. * SP1, and later
  6428. *
  6429. */
  6430. if (sock == INVALID_SOCKET) {
  6431. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6432. }
  6433. #else
  6434. #ifdef SOCK_CLOEXEC
  6435. auto sock =
  6436. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6437. #else
  6438. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6439. #endif
  6440. #endif
  6441. if (sock == INVALID_SOCKET) { continue; }
  6442. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6443. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6444. close_socket(sock);
  6445. continue;
  6446. }
  6447. #endif
  6448. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6449. if (rp->ai_family == AF_INET6) {
  6450. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6451. }
  6452. if (socket_options) { socket_options(sock); }
  6453. // bind or connect
  6454. auto quit = false;
  6455. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6456. close_socket(sock);
  6457. if (quit) { break; }
  6458. }
  6459. return INVALID_SOCKET;
  6460. }
  6461. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6462. #ifdef _WIN32
  6463. auto flags = nonblocking ? 1UL : 0UL;
  6464. ioctlsocket(sock, FIONBIO, &flags);
  6465. #else
  6466. auto flags = fcntl(sock, F_GETFL, 0);
  6467. fcntl(sock, F_SETFL,
  6468. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6469. #endif
  6470. }
  6471. inline bool is_connection_error() {
  6472. #ifdef _WIN32
  6473. return WSAGetLastError() != WSAEWOULDBLOCK;
  6474. #else
  6475. return errno != EINPROGRESS;
  6476. #endif
  6477. }
  6478. // accept() failed because the process or the network stack is temporarily out
  6479. // of resources. The listening socket is still usable, so back off briefly and
  6480. // try again.
  6481. inline bool is_accept_resource_error() {
  6482. #ifdef _WIN32
  6483. auto err = WSAGetLastError();
  6484. return err == WSAEMFILE || err == WSAENOBUFS;
  6485. #else
  6486. auto err = errno;
  6487. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6488. #endif
  6489. }
  6490. // accept() failed for a reason that says nothing about the listening socket:
  6491. // the pending connection went away before it could be accepted, or the call
  6492. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6493. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6494. // connection that way.
  6495. inline bool is_accept_transient_error() {
  6496. #ifdef _WIN32
  6497. auto err = WSAGetLastError();
  6498. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6499. err == WSAECONNABORTED;
  6500. #else
  6501. auto err = errno;
  6502. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6503. err == ECONNABORTED;
  6504. #endif
  6505. }
  6506. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6507. struct addrinfo hints;
  6508. struct addrinfo *result;
  6509. memset(&hints, 0, sizeof(struct addrinfo));
  6510. hints.ai_family = AF_UNSPEC;
  6511. hints.ai_socktype = SOCK_STREAM;
  6512. hints.ai_protocol = 0;
  6513. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6514. return false;
  6515. }
  6516. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6517. auto ret = false;
  6518. for (auto rp = result; rp; rp = rp->ai_next) {
  6519. const auto &ai = *rp;
  6520. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6521. ret = true;
  6522. break;
  6523. }
  6524. }
  6525. return ret;
  6526. }
  6527. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6528. #define USE_IF2IP
  6529. #endif
  6530. #ifdef USE_IF2IP
  6531. inline std::string if2ip(int address_family, const std::string &ifn) {
  6532. struct ifaddrs *ifap;
  6533. getifaddrs(&ifap);
  6534. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6535. std::string addr_candidate;
  6536. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6537. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6538. (AF_UNSPEC == address_family ||
  6539. ifa->ifa_addr->sa_family == address_family)) {
  6540. if (ifa->ifa_addr->sa_family == AF_INET) {
  6541. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6542. char buf[INET_ADDRSTRLEN];
  6543. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6544. return std::string(buf, INET_ADDRSTRLEN);
  6545. }
  6546. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6547. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6548. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6549. char buf[INET6_ADDRSTRLEN] = {};
  6550. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6551. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6552. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6553. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6554. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6555. } else {
  6556. return std::string(buf, INET6_ADDRSTRLEN);
  6557. }
  6558. }
  6559. }
  6560. }
  6561. }
  6562. }
  6563. return addr_candidate;
  6564. }
  6565. #endif
  6566. inline socket_t
  6567. create_client_socket(const std::string &host, const std::string &ip, int port,
  6568. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6569. SocketOptions socket_options,
  6570. time_t connection_timeout_sec,
  6571. time_t connection_timeout_usec, time_t read_timeout_sec,
  6572. time_t read_timeout_usec, time_t write_timeout_sec,
  6573. time_t write_timeout_usec, const std::string &intf,
  6574. Error &error, const std::function<bool()> &interrupted) {
  6575. auto sock = create_socket(
  6576. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6577. std::move(socket_options),
  6578. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6579. if (!intf.empty()) {
  6580. #ifdef USE_IF2IP
  6581. auto ip_from_if = if2ip(address_family, intf);
  6582. if (ip_from_if.empty()) { ip_from_if = intf; }
  6583. if (!bind_ip_address(sock2, ip_from_if)) {
  6584. error = Error::BindIPAddress;
  6585. return false;
  6586. }
  6587. #endif
  6588. }
  6589. set_nonblocking(sock2, true);
  6590. auto ret =
  6591. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6592. if (ret < 0) {
  6593. if (is_connection_error()) {
  6594. error = Error::Connection;
  6595. return false;
  6596. }
  6597. error =
  6598. wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6599. connection_timeout_usec, interrupted);
  6600. if (error != Error::Success) {
  6601. if (error == Error::ConnectionTimeout || error == Error::Canceled) {
  6602. quit = true;
  6603. }
  6604. return false;
  6605. }
  6606. }
  6607. set_nonblocking(sock2, false);
  6608. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6609. read_timeout_usec);
  6610. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6611. write_timeout_usec);
  6612. error = Error::Success;
  6613. return true;
  6614. },
  6615. connection_timeout_sec); // Pass DNS timeout
  6616. if (sock != INVALID_SOCKET) {
  6617. error = Error::Success;
  6618. } else {
  6619. if (error == Error::Success) { error = Error::Connection; }
  6620. }
  6621. return sock;
  6622. }
  6623. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6624. socklen_t addr_len, std::string &ip, int &port) {
  6625. if (addr.ss_family == AF_INET) {
  6626. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6627. } else if (addr.ss_family == AF_INET6) {
  6628. port =
  6629. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6630. } else {
  6631. return false;
  6632. }
  6633. std::array<char, NI_MAXHOST> ipstr{};
  6634. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6635. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6636. 0, NI_NUMERICHOST)) {
  6637. return false;
  6638. }
  6639. ip = ipstr.data();
  6640. return true;
  6641. }
  6642. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6643. struct sockaddr_storage addr;
  6644. socklen_t addr_len = sizeof(addr);
  6645. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6646. &addr_len)) {
  6647. get_ip_and_port(addr, addr_len, ip, port);
  6648. }
  6649. }
  6650. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6651. struct sockaddr_storage addr;
  6652. socklen_t addr_len = sizeof(addr);
  6653. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6654. &addr_len)) {
  6655. #ifndef _WIN32
  6656. if (addr.ss_family == AF_UNIX) {
  6657. #if defined(__linux__)
  6658. struct ucred ucred;
  6659. socklen_t len = sizeof(ucred);
  6660. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6661. port = ucred.pid;
  6662. }
  6663. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6664. pid_t pid;
  6665. socklen_t len = sizeof(pid);
  6666. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6667. port = pid;
  6668. }
  6669. #endif
  6670. return;
  6671. }
  6672. #endif
  6673. get_ip_and_port(addr, addr_len, ip, port);
  6674. }
  6675. }
  6676. inline std::string
  6677. find_content_type(const std::string &path,
  6678. const std::map<std::string, std::string> &user_data,
  6679. const std::string &default_content_type) {
  6680. // Extensions are matched regardless of case, as web servers do
  6681. auto ext = case_ignore::to_lower(file_extension(path));
  6682. auto it = user_data.find(ext);
  6683. if (it != user_data.end()) { return it->second; }
  6684. static const struct {
  6685. const char *ext;
  6686. const char *type;
  6687. } types[] = {
  6688. {"css", "text/css"},
  6689. {"csv", "text/csv"},
  6690. {"htm", "text/html"},
  6691. {"html", "text/html"},
  6692. {"js", "text/javascript"},
  6693. {"mjs", "text/javascript"},
  6694. {"txt", "text/plain"},
  6695. {"vtt", "text/vtt"},
  6696. {"apng", "image/apng"},
  6697. {"avif", "image/avif"},
  6698. {"bmp", "image/bmp"},
  6699. {"gif", "image/gif"},
  6700. {"png", "image/png"},
  6701. {"svg", "image/svg+xml"},
  6702. {"webp", "image/webp"},
  6703. {"ico", "image/x-icon"},
  6704. {"tif", "image/tiff"},
  6705. {"tiff", "image/tiff"},
  6706. {"jpg", "image/jpeg"},
  6707. {"jpeg", "image/jpeg"},
  6708. {"mp4", "video/mp4"},
  6709. {"mpeg", "video/mpeg"},
  6710. {"webm", "video/webm"},
  6711. {"mp3", "audio/mp3"},
  6712. {"mpga", "audio/mpeg"},
  6713. {"weba", "audio/webm"},
  6714. {"wav", "audio/wave"},
  6715. {"otf", "font/otf"},
  6716. {"ttf", "font/ttf"},
  6717. {"woff", "font/woff"},
  6718. {"woff2", "font/woff2"},
  6719. {"7z", "application/x-7z-compressed"},
  6720. {"atom", "application/atom+xml"},
  6721. {"pdf", "application/pdf"},
  6722. {"json", "application/json"},
  6723. {"rss", "application/rss+xml"},
  6724. {"tar", "application/x-tar"},
  6725. {"xht", "application/xhtml+xml"},
  6726. {"xhtml", "application/xhtml+xml"},
  6727. {"xslt", "application/xslt+xml"},
  6728. {"xml", "application/xml"},
  6729. {"gz", "application/gzip"},
  6730. {"zip", "application/zip"},
  6731. {"wasm", "application/wasm"},
  6732. };
  6733. for (const auto &t : types) {
  6734. if (ext == t.ext) { return t.type; }
  6735. }
  6736. return default_content_type;
  6737. }
  6738. inline std::string
  6739. extract_media_type(const std::string &content_type,
  6740. std::map<std::string, std::string> *params = nullptr) {
  6741. // Extract type/subtype from Content-Type value (RFC 2045)
  6742. // e.g. "application/json; charset=utf-8" -> "application/json"
  6743. auto media_type = content_type;
  6744. auto semicolon_pos = media_type.find(';');
  6745. if (semicolon_pos != std::string::npos) {
  6746. auto param_str = media_type.substr(semicolon_pos + 1);
  6747. media_type = media_type.substr(0, semicolon_pos);
  6748. if (params) {
  6749. // Parse parameters: key=value pairs separated by ';'
  6750. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6751. [&](const char *b, const char *e) {
  6752. std::string key;
  6753. std::string val;
  6754. divide_param_pair(b, e, key, val);
  6755. // Parameter names are case-insensitive (RFC 9110
  6756. // §5.6.6)
  6757. if (!key.empty()) {
  6758. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6759. unquote_param(val));
  6760. }
  6761. });
  6762. }
  6763. }
  6764. // Trim whitespace from media type
  6765. return trim_copy(media_type);
  6766. }
  6767. inline bool can_compress_content_type(const std::string &content_type) {
  6768. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6769. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6770. static const char *const compressible[] = {
  6771. "image/svg+xml",
  6772. "application/javascript",
  6773. "application/x-javascript",
  6774. "application/json",
  6775. "application/ld+json",
  6776. "application/xml",
  6777. "application/xhtml+xml",
  6778. "application/rss+xml",
  6779. "application/atom+xml",
  6780. "application/xslt+xml",
  6781. "application/protobuf",
  6782. };
  6783. for (auto type : compressible) {
  6784. if (mime_type == type) { return true; }
  6785. }
  6786. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6787. }
  6788. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6789. double &quality) {
  6790. quality = 1.0;
  6791. token.clear();
  6792. // Split on first ';': left = token name, right = parameters
  6793. const char *params_b = nullptr;
  6794. std::size_t params_len = 0;
  6795. divide(
  6796. b, static_cast<std::size_t>(e - b), ';',
  6797. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6798. auto r = trim(lb, lb + llen, 0, llen);
  6799. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6800. params_b = rb;
  6801. params_len = rlen;
  6802. });
  6803. if (token.empty()) { return false; }
  6804. if (params_len == 0) { return true; }
  6805. // Scan parameters for q= (stops on first match)
  6806. bool invalid = false;
  6807. split_find(params_b, params_b + params_len, ';',
  6808. (std::numeric_limits<size_t>::max)(),
  6809. [&](const char *pb, const char *pe) -> bool {
  6810. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6811. auto len = static_cast<size_t>(pe - pb);
  6812. if (len < 2) { return false; }
  6813. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6814. return false;
  6815. }
  6816. // Trim the value portion
  6817. auto r = trim(pb, pe, 2, len);
  6818. if (r.first >= r.second) {
  6819. invalid = true;
  6820. return true;
  6821. }
  6822. double v = 0.0;
  6823. auto res = from_chars(pb + r.first, pb + r.second, v);
  6824. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6825. v < 0.0 || v > 1.0) {
  6826. invalid = true;
  6827. return true;
  6828. }
  6829. quality = v;
  6830. return true;
  6831. });
  6832. return !invalid;
  6833. }
  6834. inline EncodingType encoding_type(const Request &req,
  6835. const std::string &content_type) {
  6836. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6837. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6838. if (s.empty()) { return EncodingType::None; }
  6839. // Single-pass: iterate tokens and track the best supported encoding.
  6840. // Server preference breaks ties (br > gzip > zstd).
  6841. EncodingType best = EncodingType::None;
  6842. double best_q = 0.0; // q=0 means "not acceptable"
  6843. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6844. auto priority = [](EncodingType t) -> int {
  6845. switch (t) {
  6846. case EncodingType::Brotli: return 0;
  6847. case EncodingType::Gzip: return 1;
  6848. case EncodingType::Zstd: return 2;
  6849. default: return 3;
  6850. }
  6851. };
  6852. std::string name;
  6853. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6854. double quality = 1.0;
  6855. if (!parse_quality(b, e, name, quality)) { return; }
  6856. if (quality <= 0.0) { return; }
  6857. EncodingType type = EncodingType::None;
  6858. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6859. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6860. #endif
  6861. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6862. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6863. type = EncodingType::Gzip;
  6864. }
  6865. #endif
  6866. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6867. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6868. type = EncodingType::Zstd;
  6869. }
  6870. #endif
  6871. if (type == EncodingType::None) { return; }
  6872. // Higher q-value wins; for equal q, server preference breaks ties
  6873. if (quality > best_q ||
  6874. (quality == best_q && priority(type) < priority(best))) {
  6875. best_q = quality;
  6876. best = type;
  6877. }
  6878. });
  6879. return best;
  6880. }
  6881. // `content_type` is taken separately because a file-backed response has not
  6882. // been given one yet when its coding has to be decided.
  6883. inline EncodingType encoding_type(const Request &req, const Response &res,
  6884. const std::string &content_type) {
  6885. // The response already names a content coding of its own: a handler serving
  6886. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6887. // point whose headers name the coding its files are stored in. Applying one
  6888. // on top of that would double-encode the body and append a second
  6889. // `Content-Encoding` field line.
  6890. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6891. return encoding_type(req, content_type);
  6892. }
  6893. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6894. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6895. }
  6896. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6897. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6898. if (type == EncodingType::Gzip) {
  6899. return detail::make_unique<gzip_compressor>();
  6900. }
  6901. #endif
  6902. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6903. if (type == EncodingType::Brotli) {
  6904. return detail::make_unique<brotli_compressor>();
  6905. }
  6906. #endif
  6907. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6908. if (type == EncodingType::Zstd) {
  6909. return detail::make_unique<zstd_compressor>();
  6910. }
  6911. #endif
  6912. (void)type;
  6913. return nullptr;
  6914. }
  6915. inline const char *encoding_name(EncodingType type) {
  6916. switch (type) {
  6917. case EncodingType::Gzip: return "gzip";
  6918. case EncodingType::Brotli: return "br";
  6919. case EncodingType::Zstd: return "zstd";
  6920. default: return "";
  6921. }
  6922. }
  6923. inline bool nocompressor::compress(const char *data, size_t data_length,
  6924. bool /*last*/, Callback callback) {
  6925. if (!data_length) { return true; }
  6926. return callback(data, data_length);
  6927. }
  6928. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6929. inline gzip_compressor::gzip_compressor() {
  6930. std::memset(&strm_, 0, sizeof(strm_));
  6931. strm_.zalloc = Z_NULL;
  6932. strm_.zfree = Z_NULL;
  6933. strm_.opaque = Z_NULL;
  6934. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6935. Z_DEFAULT_STRATEGY) == Z_OK;
  6936. }
  6937. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6938. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6939. bool last, Callback callback) {
  6940. assert(is_valid_);
  6941. do {
  6942. constexpr size_t max_avail_in =
  6943. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6944. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6945. (std::min)(data_length, max_avail_in));
  6946. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6947. data_length -= strm_.avail_in;
  6948. data += strm_.avail_in;
  6949. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6950. auto ret = Z_OK;
  6951. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6952. do {
  6953. strm_.avail_out = static_cast<uInt>(buff.size());
  6954. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6955. ret = deflate(&strm_, flush);
  6956. if (ret == Z_STREAM_ERROR) { return false; }
  6957. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6958. return false;
  6959. }
  6960. } while (strm_.avail_out == 0);
  6961. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6962. (flush == Z_NO_FLUSH && ret == Z_OK));
  6963. assert(strm_.avail_in == 0);
  6964. } while (data_length > 0);
  6965. return true;
  6966. }
  6967. inline gzip_decompressor::gzip_decompressor() {
  6968. std::memset(&strm_, 0, sizeof(strm_));
  6969. strm_.zalloc = Z_NULL;
  6970. strm_.zfree = Z_NULL;
  6971. strm_.opaque = Z_NULL;
  6972. // 15 is the value of wbits, which should be at the maximum possible value
  6973. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6974. // that the stream type should be automatically detected either gzip or
  6975. // deflate.
  6976. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6977. }
  6978. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6979. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6980. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6981. Callback callback) {
  6982. assert(is_valid_);
  6983. auto ret = Z_OK;
  6984. do {
  6985. constexpr size_t max_avail_in =
  6986. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6987. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6988. (std::min)(data_length, max_avail_in));
  6989. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6990. data_length -= strm_.avail_in;
  6991. data += strm_.avail_in;
  6992. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6993. while (strm_.avail_in > 0 && ret == Z_OK) {
  6994. strm_.avail_out = static_cast<uInt>(buff.size());
  6995. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6996. ret = inflate(&strm_, Z_NO_FLUSH);
  6997. assert(ret != Z_STREAM_ERROR);
  6998. switch (ret) {
  6999. case Z_NEED_DICT:
  7000. case Z_DATA_ERROR:
  7001. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  7002. }
  7003. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  7004. return false;
  7005. }
  7006. }
  7007. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  7008. } while (data_length > 0);
  7009. return true;
  7010. }
  7011. #endif
  7012. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7013. inline brotli_compressor::brotli_compressor() {
  7014. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  7015. }
  7016. inline brotli_compressor::~brotli_compressor() {
  7017. BrotliEncoderDestroyInstance(state_);
  7018. }
  7019. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  7020. bool last, Callback callback) {
  7021. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7022. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  7023. auto available_in = data_length;
  7024. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7025. for (;;) {
  7026. if (last) {
  7027. if (BrotliEncoderIsFinished(state_)) { break; }
  7028. } else {
  7029. if (!available_in) { break; }
  7030. }
  7031. auto available_out = buff.size();
  7032. auto next_out = buff.data();
  7033. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  7034. &available_out, &next_out, nullptr)) {
  7035. return false;
  7036. }
  7037. auto output_bytes = buff.size() - available_out;
  7038. if (output_bytes) {
  7039. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  7040. }
  7041. }
  7042. return true;
  7043. }
  7044. inline brotli_decompressor::brotli_decompressor() {
  7045. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  7046. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  7047. : BROTLI_DECODER_RESULT_ERROR;
  7048. }
  7049. inline brotli_decompressor::~brotli_decompressor() {
  7050. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  7051. }
  7052. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  7053. inline bool brotli_decompressor::decompress(const char *data,
  7054. size_t data_length,
  7055. Callback callback) {
  7056. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7057. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  7058. return 0;
  7059. }
  7060. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7061. size_t avail_in = data_length;
  7062. size_t total_out;
  7063. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  7064. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7065. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  7066. char *next_out = buff.data();
  7067. size_t avail_out = buff.size();
  7068. decoder_r = BrotliDecoderDecompressStream(
  7069. decoder_s, &avail_in, &next_in, &avail_out,
  7070. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  7071. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  7072. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  7073. }
  7074. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7075. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  7076. }
  7077. #endif
  7078. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7079. inline zstd_compressor::zstd_compressor() {
  7080. ctx_ = ZSTD_createCCtx();
  7081. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  7082. }
  7083. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  7084. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  7085. bool last, Callback callback) {
  7086. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7087. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  7088. ZSTD_inBuffer input = {data, data_length, 0};
  7089. bool finished;
  7090. do {
  7091. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7092. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  7093. if (ZSTD_isError(remaining)) { return false; }
  7094. if (!callback(buff.data(), output.pos)) { return false; }
  7095. finished = last ? (remaining == 0) : (input.pos == input.size);
  7096. } while (!finished);
  7097. return true;
  7098. }
  7099. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  7100. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  7101. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  7102. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  7103. Callback callback) {
  7104. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7105. ZSTD_inBuffer input = {data, data_length, 0};
  7106. while (input.pos < input.size) {
  7107. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7108. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  7109. if (ZSTD_isError(remaining)) { return false; }
  7110. if (!callback(buff.data(), output.pos)) { return false; }
  7111. }
  7112. return true;
  7113. }
  7114. #endif
  7115. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  7116. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  7117. // unknown coding, and its payload would be handed back still compressed.
  7118. inline bool is_zlib_encoding(const std::string &encoding) {
  7119. return case_ignore::equal(encoding, "gzip") ||
  7120. case_ignore::equal(encoding, "deflate");
  7121. }
  7122. inline bool is_brotli_encoding(const std::string &encoding) {
  7123. return case_ignore::equal(encoding, "br");
  7124. }
  7125. inline bool is_zstd_encoding(const std::string &encoding) {
  7126. return case_ignore::equal(encoding, "zstd");
  7127. }
  7128. // Returns true if the content coding is one cpp-httplib is able to decompress
  7129. // when the corresponding support is compiled in.
  7130. inline bool is_known_content_encoding(const std::string &encoding) {
  7131. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  7132. is_zstd_encoding(encoding);
  7133. }
  7134. inline std::unique_ptr<decompressor>
  7135. create_decompressor(const std::string &encoding) {
  7136. std::unique_ptr<decompressor> decompressor;
  7137. if (is_zlib_encoding(encoding)) {
  7138. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7139. decompressor = detail::make_unique<gzip_decompressor>();
  7140. #endif
  7141. } else if (is_brotli_encoding(encoding)) {
  7142. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7143. decompressor = detail::make_unique<brotli_decompressor>();
  7144. #endif
  7145. } else if (is_zstd_encoding(encoding)) {
  7146. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7147. decompressor = detail::make_unique<zstd_decompressor>();
  7148. #endif
  7149. }
  7150. return decompressor;
  7151. }
  7152. // Returns the best available compressor and its Content-Encoding name.
  7153. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7154. inline std::pair<std::unique_ptr<compressor>, const char *>
  7155. create_compressor() {
  7156. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7157. return {detail::make_unique<brotli_compressor>(), "br"};
  7158. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7159. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7160. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7161. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7162. #else
  7163. return {nullptr, nullptr};
  7164. #endif
  7165. }
  7166. inline bool is_prohibited_header_name(const std::string &name) {
  7167. // Field names are case-insensitive (RFC 9110 §5.1)
  7168. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7169. case_ignore::equal(name, "REMOTE_PORT") ||
  7170. case_ignore::equal(name, "LOCAL_ADDR") ||
  7171. case_ignore::equal(name, "LOCAL_PORT");
  7172. }
  7173. inline bool has_header(const Headers &headers, const std::string &key) {
  7174. if (is_prohibited_header_name(key)) { return false; }
  7175. return headers.find(key) != headers.end();
  7176. }
  7177. inline const char *get_header_value(const Headers &headers,
  7178. const std::string &key, const char *def,
  7179. size_t id) {
  7180. if (is_prohibited_header_name(key)) {
  7181. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7182. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7183. throw std::invalid_argument(msg);
  7184. #else
  7185. return "";
  7186. #endif
  7187. }
  7188. auto rng = headers.equal_range(key);
  7189. auto it = bounded_next(rng.first, id, rng.second);
  7190. if (it != rng.second) { return it->second.c_str(); }
  7191. return def;
  7192. }
  7193. inline size_t get_header_value_count(const Headers &headers,
  7194. const std::string &key) {
  7195. return headers.count(key);
  7196. }
  7197. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7198. // list may be sent as several field lines, and the combined field value is
  7199. // those values joined by commas in the order they were received. Callers that
  7200. // parse such a list must work on the combined value; reading only the first
  7201. // occurrence silently drops whatever the later field lines carry.
  7202. inline std::string get_combined_header_value(const Headers &headers,
  7203. const std::string &key) {
  7204. std::string combined;
  7205. auto rng = headers.equal_range(key);
  7206. for (auto it = rng.first; it != rng.second; ++it) {
  7207. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7208. // elements, so an empty field line must not contribute a bare comma to the
  7209. // combined value.
  7210. if (it->second.empty()) { continue; }
  7211. if (!combined.empty()) { combined += ", "; }
  7212. combined += it->second;
  7213. }
  7214. return combined;
  7215. }
  7216. inline bool has_header_token(const Headers &headers, const std::string &key,
  7217. const std::string &token) {
  7218. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7219. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7220. // several lines. Match complete tokens rather than searching the raw value,
  7221. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7222. auto rng = headers.equal_range(key);
  7223. for (auto it = rng.first; it != rng.second; ++it) {
  7224. const auto &value = it->second;
  7225. if (split_find(value.data(), value.data() + value.size(), ',',
  7226. [&](const char *b, const char *e) {
  7227. return case_ignore::equal(std::string(b, e), token);
  7228. })) {
  7229. return true;
  7230. }
  7231. }
  7232. return false;
  7233. }
  7234. template <typename Map>
  7235. inline typename Map::mapped_type
  7236. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7237. auto rng = m.equal_range(key);
  7238. auto it = bounded_next(rng.first, id, rng.second);
  7239. if (it != rng.second) { return it->second; }
  7240. return typename Map::mapped_type();
  7241. }
  7242. inline void set_header(Headers &headers, const std::string &key,
  7243. const std::string &val) {
  7244. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7245. }
  7246. // Drops the fields set_header() would refuse, from headers an application can
  7247. // fill directly: CR/LF in one would split the message.
  7248. inline void erase_invalid_fields(Headers &headers) {
  7249. for (auto it = headers.begin(); it != headers.end();) {
  7250. if (fields::is_field_valid(it->first, it->second)) {
  7251. ++it;
  7252. } else {
  7253. it = headers.erase(it);
  7254. }
  7255. }
  7256. }
  7257. inline bool read_headers(Stream &strm, Headers &headers) {
  7258. const auto bufsiz = 2048;
  7259. char buf[bufsiz];
  7260. stream_line_reader line_reader(strm, buf, bufsiz);
  7261. size_t header_count = 0;
  7262. for (;;) {
  7263. if (!line_reader.getline()) { return false; }
  7264. // Check if the line ends with CRLF.
  7265. auto line_terminator_len = 2;
  7266. if (line_reader.end_with_crlf()) {
  7267. // Blank line indicates end of headers.
  7268. if (line_reader.size() == 2) { break; }
  7269. } else {
  7270. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7271. // Blank line indicates end of headers.
  7272. if (line_reader.size() == 1) { break; }
  7273. line_terminator_len = 1;
  7274. #else
  7275. continue; // Skip invalid line.
  7276. #endif
  7277. }
  7278. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7279. // Check header count limit
  7280. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7281. // Exclude line terminator
  7282. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7283. if (!parse_header(line_reader.ptr(), end,
  7284. [&](const std::string &key, const std::string &val) {
  7285. headers.emplace(key, val);
  7286. })) {
  7287. return false;
  7288. }
  7289. header_count++;
  7290. }
  7291. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7292. // headers that have different values to prevent request smuggling.
  7293. auto cl_range = headers.equal_range("Content-Length");
  7294. if (cl_range.first != cl_range.second) {
  7295. const auto &first_val = cl_range.first->second;
  7296. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7297. if (it->second != first_val) { return false; }
  7298. }
  7299. }
  7300. return true;
  7301. }
  7302. // Parsed by hand: std::regex_match recurses once per character of the reason
  7303. // phrase, which a server can make as long as a whole line.
  7304. inline bool parse_status_line(const char *line, std::string &version,
  7305. int &status, std::string &reason) {
  7306. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7307. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7308. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7309. !is_ascii_digit(line[11])) {
  7310. return false;
  7311. }
  7312. auto p = line + 12;
  7313. auto reason_begin = p;
  7314. if (*p == ' ') {
  7315. reason_begin = ++p;
  7316. p += std::strcspn(p, "\r\n");
  7317. }
  7318. auto reason_end = p;
  7319. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7320. if (*p == '\r') { p++; }
  7321. #else
  7322. if (*p++ != '\r') { return false; }
  7323. #endif
  7324. if (*p++ != '\n' || *p != '\0') { return false; }
  7325. version.assign(line, 8);
  7326. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7327. reason.assign(reason_begin, reason_end);
  7328. return true;
  7329. }
  7330. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7331. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7332. struct WebSocketUpgradeResponse {
  7333. Error error = Error::Success;
  7334. int status = -1;
  7335. Headers headers;
  7336. std::string selected_subprotocol;
  7337. };
  7338. // Reads a response's status line and headers, leaving any body unread. An
  7339. // unparsable status line is no stream error; it just leaves `status` as is.
  7340. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7341. const auto bufsiz = 2048;
  7342. char buf[bufsiz];
  7343. stream_line_reader line_reader(strm, buf, bufsiz);
  7344. if (!line_reader.getline()) { return false; }
  7345. std::string version;
  7346. std::string reason;
  7347. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7348. return true;
  7349. }
  7350. return read_headers(strm, headers);
  7351. }
  7352. inline bool
  7353. read_websocket_upgrade_response(Stream &strm,
  7354. const std::string &expected_accept,
  7355. const std::string &offered_subprotocols,
  7356. WebSocketUpgradeResponse &upgrade) {
  7357. // The headers of a rejection are kept so the caller can see why the server
  7358. // refused the upgrade.
  7359. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7360. upgrade.error = Error::Read;
  7361. return false;
  7362. }
  7363. const auto &headers = upgrade.headers;
  7364. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7365. upgrade.error = Error::WebSocketHandshake;
  7366. return false;
  7367. }
  7368. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7369. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7370. upgrade.error = Error::WebSocketHandshake;
  7371. return false;
  7372. }
  7373. // Verify Connection: Upgrade
  7374. if (!has_header_token(headers, "Connection", "upgrade")) {
  7375. upgrade.error = Error::WebSocketHandshake;
  7376. return false;
  7377. }
  7378. // Verify Sec-WebSocket-Accept header value
  7379. auto it = headers.find("Sec-WebSocket-Accept");
  7380. if (it == headers.end() || it->second != expected_accept) {
  7381. upgrade.error = Error::WebSocketHandshake;
  7382. return false;
  7383. }
  7384. // Extract negotiated subprotocol
  7385. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7386. if (proto_it != headers.end()) {
  7387. upgrade.selected_subprotocol = proto_it->second;
  7388. }
  7389. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7390. if (!upgrade.selected_subprotocol.empty()) {
  7391. auto was_offered = false;
  7392. split(offered_subprotocols.data(),
  7393. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7394. [&](const char *b, const char *e) {
  7395. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7396. was_offered = true;
  7397. }
  7398. });
  7399. if (!was_offered) {
  7400. upgrade.error = Error::WebSocketHandshake;
  7401. return false;
  7402. }
  7403. }
  7404. return true;
  7405. }
  7406. enum class ReadContentResult {
  7407. Success, // Successfully read the content
  7408. PayloadTooLarge, // The content exceeds the specified payload limit
  7409. Error // An error occurred while reading the content
  7410. };
  7411. inline ReadContentResult read_content_with_length(
  7412. Stream &strm, size_t len, DownloadProgress progress,
  7413. ContentReceiverWithProgress out,
  7414. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7415. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7416. detail::BodyReader br;
  7417. br.stream = &strm;
  7418. br.has_content_length = true;
  7419. br.content_length = len;
  7420. br.payload_max_length = payload_max_length;
  7421. br.chunked = false;
  7422. br.bytes_read = 0;
  7423. br.last_error = Error::Success;
  7424. size_t r = 0;
  7425. while (r < len) {
  7426. auto read_len = static_cast<size_t>(len - r);
  7427. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7428. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7429. if (n <= 0) {
  7430. // Check if it was a payload size error
  7431. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7432. return ReadContentResult::PayloadTooLarge;
  7433. }
  7434. return ReadContentResult::Error;
  7435. }
  7436. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7437. return ReadContentResult::Error;
  7438. }
  7439. r += static_cast<size_t>(n);
  7440. if (progress) {
  7441. if (!progress(r, len)) { return ReadContentResult::Error; }
  7442. }
  7443. }
  7444. return ReadContentResult::Success;
  7445. }
  7446. inline ReadContentResult
  7447. read_content_without_length(Stream &strm, size_t payload_max_length,
  7448. ContentReceiverWithProgress out) {
  7449. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7450. size_t r = 0;
  7451. for (;;) {
  7452. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7453. if (n == 0) { return ReadContentResult::Success; }
  7454. if (n < 0) { return ReadContentResult::Error; }
  7455. // Check if adding this data would exceed the payload limit
  7456. if (payload_max_length > 0 &&
  7457. (r > payload_max_length ||
  7458. payload_max_length - r < static_cast<size_t>(n))) {
  7459. return ReadContentResult::PayloadTooLarge;
  7460. }
  7461. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7462. return ReadContentResult::Error;
  7463. }
  7464. r += static_cast<size_t>(n);
  7465. }
  7466. return ReadContentResult::Success;
  7467. }
  7468. template <typename T>
  7469. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7470. size_t payload_max_length,
  7471. ContentReceiverWithProgress out) {
  7472. detail::ChunkedDecoder dec(strm);
  7473. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7474. size_t total_len = 0;
  7475. for (;;) {
  7476. size_t chunk_offset = 0;
  7477. size_t chunk_total = 0;
  7478. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7479. if (n < 0) { return ReadContentResult::Error; }
  7480. if (n == 0) {
  7481. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7482. return ReadContentResult::Error;
  7483. }
  7484. return ReadContentResult::Success;
  7485. }
  7486. if (payload_max_length > 0 &&
  7487. (total_len > payload_max_length ||
  7488. payload_max_length - total_len < static_cast<size_t>(n))) {
  7489. return ReadContentResult::PayloadTooLarge;
  7490. }
  7491. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7492. return ReadContentResult::Error;
  7493. }
  7494. total_len += static_cast<size_t>(n);
  7495. }
  7496. }
  7497. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7498. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7499. // is the final transfer coding. A single field value may list several
  7500. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7501. // several Transfer-Encoding lines, which combine into one comma-separated
  7502. // list in the order the lines were received. Headers preserves that order,
  7503. // so the final coding is the last token of the last line. Match it
  7504. // case-insensitively rather than comparing the whole value against
  7505. // "chunked".
  7506. //
  7507. // Security: reading a chunked message as unframed leaves its body in the
  7508. // socket, where a keep-alive connection parses it as a smuggled request.
  7509. // Server::process_request() answers 400 and closes when the final coding is
  7510. // not chunked, so a request whose framing cannot be determined never
  7511. // reaches the "no body" path.
  7512. auto rng = headers.equal_range("Transfer-Encoding");
  7513. if (rng.first == rng.second) { return false; }
  7514. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7515. // combined list ending in nothing rather than inheriting the line before it.
  7516. std::string last_coding;
  7517. for (auto it = rng.first; it != rng.second; ++it) {
  7518. const auto &value = it->second;
  7519. last_coding.clear();
  7520. split(value.data(), value.data() + value.size(), ',',
  7521. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7522. }
  7523. return case_ignore::equal(last_coding, "chunked");
  7524. }
  7525. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7526. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7527. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7528. return msg.has_header("Transfer-Encoding") &&
  7529. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7530. }
  7531. inline bool has_conflicting_content_length(const Headers &headers) {
  7532. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7533. // Content-Length is framed ambiguously. The body readers here delimit it by
  7534. // the transfer coding and drop Content-Length, while an intermediary may do
  7535. // the reverse, so the two disagree on where the body ends and a reused
  7536. // connection is desynchronised (request/response smuggling). Content-Length:
  7537. // 0 is tolerated for compatibility with existing peers.
  7538. return has_header(headers, "Transfer-Encoding") &&
  7539. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7540. }
  7541. template <typename T, typename U>
  7542. bool prepare_content_receiver(T &x, int &status,
  7543. ContentReceiverWithProgress receiver,
  7544. bool decompress, size_t payload_max_length,
  7545. bool &exceed_payload_max_length, U callback) {
  7546. if (decompress) {
  7547. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7548. std::unique_ptr<decompressor> decompressor;
  7549. if (!encoding.empty()) {
  7550. // A coding we know about but were not built with is an error. An
  7551. // unrecognized coding (including "identity") is left alone and the
  7552. // payload is passed through as-is, since some servers misuse the header,
  7553. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7554. decompressor = detail::create_decompressor(encoding);
  7555. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7556. status = StatusCode::UnsupportedMediaType_415;
  7557. return false;
  7558. }
  7559. }
  7560. if (decompressor) {
  7561. if (decompressor->is_valid()) {
  7562. size_t decompressed_size = 0;
  7563. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7564. size_t off, size_t len) {
  7565. return decompressor->decompress(
  7566. buf, n, [&](const char *buf2, size_t n2) {
  7567. // Guard against zip-bomb: check
  7568. // decompressed size against limit.
  7569. if (payload_max_length > 0 &&
  7570. (decompressed_size >= payload_max_length ||
  7571. n2 > payload_max_length - decompressed_size)) {
  7572. exceed_payload_max_length = true;
  7573. return false;
  7574. }
  7575. decompressed_size += n2;
  7576. return receiver(buf2, n2, off, len);
  7577. });
  7578. };
  7579. return callback(std::move(out));
  7580. } else {
  7581. status = StatusCode::InternalServerError_500;
  7582. return false;
  7583. }
  7584. }
  7585. }
  7586. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7587. size_t len) {
  7588. return receiver(buf, n, off, len);
  7589. };
  7590. return callback(std::move(out));
  7591. }
  7592. template <typename T>
  7593. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7594. DownloadProgress progress,
  7595. ContentReceiverWithProgress receiver, bool decompress) {
  7596. bool exceed_payload_max_length = false;
  7597. return prepare_content_receiver(
  7598. x, status, std::move(receiver), decompress, payload_max_length,
  7599. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7600. auto ret = true;
  7601. // Note: exceed_payload_max_length may also be set by the decompressor
  7602. // wrapper in prepare_content_receiver when the decompressed payload
  7603. // size exceeds the limit.
  7604. if (is_chunked_transfer_encoding(x.headers)) {
  7605. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7606. if (result == ReadContentResult::Success) {
  7607. ret = true;
  7608. } else if (result == ReadContentResult::PayloadTooLarge) {
  7609. exceed_payload_max_length = true;
  7610. ret = false;
  7611. } else {
  7612. ret = false;
  7613. }
  7614. } else if (!has_header(x.headers, "Content-Length")) {
  7615. auto result =
  7616. read_content_without_length(strm, payload_max_length, out);
  7617. if (result == ReadContentResult::Success) {
  7618. ret = true;
  7619. } else if (result == ReadContentResult::PayloadTooLarge) {
  7620. exceed_payload_max_length = true;
  7621. ret = false;
  7622. } else {
  7623. ret = false;
  7624. }
  7625. } else {
  7626. auto is_invalid_value = false;
  7627. auto len = get_header_value_u64(x.headers, "Content-Length",
  7628. (std::numeric_limits<size_t>::max)(),
  7629. 0, is_invalid_value);
  7630. if (is_invalid_value) {
  7631. ret = false;
  7632. } else if (len > 0) {
  7633. auto result = read_content_with_length(
  7634. strm, len, std::move(progress), out, payload_max_length);
  7635. ret = (result == ReadContentResult::Success);
  7636. if (result == ReadContentResult::PayloadTooLarge) {
  7637. exceed_payload_max_length = true;
  7638. }
  7639. }
  7640. }
  7641. if (!ret) {
  7642. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7643. : StatusCode::BadRequest_400;
  7644. }
  7645. return ret;
  7646. });
  7647. }
  7648. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7649. const std::string &path) {
  7650. // Neither the method nor the request target may carry CR/LF, SP or other
  7651. // control octets; otherwise a value smuggled into either splits the request
  7652. // line and injects headers or a whole request.
  7653. if (!fields::is_token(method)) { return -1; }
  7654. if (!fields::is_request_target(path)) { return -1; }
  7655. std::string s = method;
  7656. s += ' ';
  7657. s += path;
  7658. s += " HTTP/1.1\r\n";
  7659. return strm.write(s.data(), s.size());
  7660. }
  7661. inline ssize_t write_response_line(Stream &strm, int status) {
  7662. std::string s = "HTTP/1.1 ";
  7663. s += std::to_string(status);
  7664. s += ' ';
  7665. s += httplib::status_message(status);
  7666. s += "\r\n";
  7667. return strm.write(s.data(), s.size());
  7668. }
  7669. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7670. ssize_t write_len = 0;
  7671. for (const auto &x : headers) {
  7672. std::string s;
  7673. s = x.first;
  7674. s += ": ";
  7675. s += x.second;
  7676. s += "\r\n";
  7677. auto len = strm.write(s.data(), s.size());
  7678. if (len < 0) { return len; }
  7679. write_len += len;
  7680. }
  7681. auto len = strm.write("\r\n");
  7682. if (len < 0) { return len; }
  7683. write_len += len;
  7684. return write_len;
  7685. }
  7686. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7687. size_t offset = 0;
  7688. while (offset < l) {
  7689. auto length = strm.write(d + offset, l - offset);
  7690. if (length < 0) { return false; }
  7691. offset += static_cast<size_t>(length);
  7692. }
  7693. return true;
  7694. }
  7695. template <typename T>
  7696. inline bool write_content_with_progress(Stream &strm,
  7697. const ContentProvider &content_provider,
  7698. size_t offset, size_t length,
  7699. T is_shutting_down,
  7700. const UploadProgress &upload_progress,
  7701. Error &error) {
  7702. size_t end_offset = offset + length;
  7703. size_t start_offset = offset;
  7704. auto ok = true;
  7705. auto finished = false;
  7706. DataSink data_sink;
  7707. data_sink.write = [&](const char *d, size_t l) -> bool {
  7708. if (ok) {
  7709. // Bytes past `length` would follow the framed body, where the peer reads
  7710. // them as the next message. Write only what fits and fail the rest.
  7711. if (l > end_offset - offset) {
  7712. l = end_offset - offset;
  7713. ok = false;
  7714. }
  7715. if (write_data(strm, d, l)) {
  7716. offset += l;
  7717. if (upload_progress && length > 0) {
  7718. size_t current_written = offset - start_offset;
  7719. if (!upload_progress(current_written, length)) {
  7720. ok = false;
  7721. return false;
  7722. }
  7723. }
  7724. } else {
  7725. ok = false;
  7726. }
  7727. }
  7728. return ok;
  7729. };
  7730. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7731. // The body is framed by `length`, so a provider that reports itself done
  7732. // early has truncated it. Record that and let the short-body check below
  7733. // fail the write, rather than calling the provider again forever.
  7734. data_sink.done = [&]() { finished = true; };
  7735. while (offset < end_offset && !finished && !is_shutting_down()) {
  7736. auto last_offset = offset;
  7737. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7738. error = Error::Write;
  7739. return false;
  7740. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7741. error = Error::Canceled;
  7742. return false;
  7743. } else if (!ok) {
  7744. error = Error::Write;
  7745. return false;
  7746. }
  7747. // A provider that reports success without writing anything and without
  7748. // reporting itself done gets handed the same offset and length again on
  7749. // the next pass, so it would spin here for as long as the peer stays
  7750. // connected. Treat making no progress as a short body, like done() early.
  7751. if (!finished && offset == last_offset) {
  7752. error = Error::Write;
  7753. return false;
  7754. }
  7755. }
  7756. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7757. error = Error::Write;
  7758. return false;
  7759. }
  7760. error = Error::Success;
  7761. return true;
  7762. }
  7763. template <typename T>
  7764. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7765. size_t offset, size_t length, T is_shutting_down,
  7766. Error &error) {
  7767. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7768. is_shutting_down, nullptr, error);
  7769. }
  7770. template <typename T>
  7771. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7772. size_t offset, size_t length,
  7773. const T &is_shutting_down) {
  7774. auto error = Error::Success;
  7775. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7776. error);
  7777. }
  7778. template <typename T>
  7779. inline bool
  7780. write_content_without_length(Stream &strm,
  7781. const ContentProvider &content_provider,
  7782. const T &is_shutting_down) {
  7783. size_t offset = 0;
  7784. auto data_available = true;
  7785. auto ok = true;
  7786. DataSink data_sink;
  7787. data_sink.write = [&](const char *d, size_t l) -> bool {
  7788. if (ok) {
  7789. offset += l;
  7790. if (!write_data(strm, d, l)) { ok = false; }
  7791. }
  7792. return ok;
  7793. };
  7794. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7795. data_sink.done = [&](void) { data_available = false; };
  7796. while (data_available && !is_shutting_down()) {
  7797. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7798. return false;
  7799. } else if (!content_provider(offset, 0, data_sink)) {
  7800. return false;
  7801. } else if (!ok) {
  7802. return false;
  7803. }
  7804. }
  7805. return !data_available; // true only if done() was called, false if shutting
  7806. // down
  7807. }
  7808. // Runs a known-length content provider to completion and compresses what it
  7809. // writes into `out`, chunk by chunk, without holding the identity form.
  7810. inline bool compress_content_provider(const ContentProvider &content_provider,
  7811. size_t length, compressor &cmp,
  7812. std::string &out) {
  7813. size_t offset = 0;
  7814. auto ok = true;
  7815. auto finished = false;
  7816. DataSink data_sink;
  7817. auto append = [&](const char *data, size_t data_len) {
  7818. out.append(data, data_len);
  7819. return true;
  7820. };
  7821. data_sink.write = [&](const char *d, size_t l) -> bool {
  7822. if (!ok) { return false; }
  7823. offset += l;
  7824. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7825. return ok;
  7826. };
  7827. // The body is framed by `length`, so a provider that reports itself done
  7828. // early has truncated it; the short-body check below turns that into a
  7829. // failure rather than calling the provider again forever.
  7830. data_sink.done = [&]() { finished = true; };
  7831. while (offset < length && !finished) {
  7832. auto prev_offset = offset;
  7833. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7834. return false;
  7835. }
  7836. // No Stream to block on here, so a provider that keeps returning true
  7837. // without writing would spin. Treat a pass that made no progress as a
  7838. // failure.
  7839. if (offset == prev_offset) { return false; }
  7840. }
  7841. if (offset != length) { return false; }
  7842. return cmp.compress(nullptr, 0, true, append);
  7843. }
  7844. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7845. // and the file flag, so recording them has to come after; keeping all of it
  7846. // here means a third file-serving path cannot get that order wrong.
  7847. inline void set_file_content_provider(Response &res,
  7848. const std::shared_ptr<mmap> &m,
  7849. const std::string &content_type,
  7850. EncodingType encoding) {
  7851. // One read and one write move up to this much of the file at a time.
  7852. auto buf = std::make_shared<std::vector<char>>(
  7853. (std::min)(m->size(), size_t(256 * 1024)));
  7854. res.set_content_provider(
  7855. m->size(), content_type,
  7856. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7857. // Never read past the file, which ends the response early if it has
  7858. // shrunk since it was opened.
  7859. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7860. if (n == 0) { return false; }
  7861. sink.write(buf->data(), n);
  7862. return true;
  7863. });
  7864. res.is_file_content_provider_ = true;
  7865. res.content_coding_ = encoding;
  7866. }
  7867. template <typename T, typename U>
  7868. inline bool
  7869. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7870. const T &is_shutting_down, U &compressor, Error &error) {
  7871. size_t offset = 0;
  7872. auto data_available = true;
  7873. auto ok = true;
  7874. DataSink data_sink;
  7875. data_sink.write = [&](const char *d, size_t l) -> bool {
  7876. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7877. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7878. // zero-length chunk is the terminator, so it must not be emitted here.
  7879. if (ok && l > 0) {
  7880. offset += l;
  7881. std::string payload;
  7882. if (compressor.compress(d, l, false,
  7883. [&](const char *data, size_t data_len) {
  7884. payload.append(data, data_len);
  7885. return true;
  7886. })) {
  7887. if (!payload.empty()) {
  7888. // Emit chunked response header and footer for each chunk
  7889. auto chunk =
  7890. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7891. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7892. }
  7893. } else {
  7894. ok = false;
  7895. }
  7896. }
  7897. return ok;
  7898. };
  7899. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7900. auto done_with_trailer = [&](const Headers *trailer) {
  7901. if (!ok) { return; }
  7902. data_available = false;
  7903. std::string payload;
  7904. if (!compressor.compress(nullptr, 0, true,
  7905. [&](const char *data, size_t data_len) {
  7906. payload.append(data, data_len);
  7907. return true;
  7908. })) {
  7909. ok = false;
  7910. return;
  7911. }
  7912. if (!payload.empty()) {
  7913. // Emit chunked response header and footer for each chunk
  7914. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7915. if (!write_data(strm, chunk.data(), chunk.size())) {
  7916. ok = false;
  7917. return;
  7918. }
  7919. }
  7920. constexpr const char done_marker[] = "0\r\n";
  7921. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7922. // Trailer
  7923. if (trailer) {
  7924. for (const auto &kv : *trailer) {
  7925. // Skip fields with invalid names or values to prevent response
  7926. // splitting via CR/LF injection, matching set_header().
  7927. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7928. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7929. if (!write_data(strm, field_line.data(), field_line.size())) {
  7930. ok = false;
  7931. }
  7932. }
  7933. }
  7934. constexpr const char crlf[] = "\r\n";
  7935. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7936. };
  7937. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7938. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7939. done_with_trailer(&trailer);
  7940. };
  7941. while (data_available && !is_shutting_down()) {
  7942. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7943. error = Error::Write;
  7944. return false;
  7945. } else if (!content_provider(offset, 0, data_sink)) {
  7946. error = Error::Canceled;
  7947. return false;
  7948. } else if (!ok) {
  7949. error = Error::Write;
  7950. return false;
  7951. }
  7952. }
  7953. if (data_available) { // exited due to is_shutting_down(), not done()
  7954. error = Error::Write;
  7955. return false;
  7956. }
  7957. error = Error::Success;
  7958. return true;
  7959. }
  7960. template <typename T, typename U>
  7961. inline bool write_content_chunked(Stream &strm,
  7962. const ContentProvider &content_provider,
  7963. const T &is_shutting_down, U &compressor) {
  7964. auto error = Error::Success;
  7965. return write_content_chunked(strm, content_provider, is_shutting_down,
  7966. compressor, error);
  7967. }
  7968. template <typename T>
  7969. inline bool redirect(T &cli, Request &req, Response &res,
  7970. const std::string &path, const std::string &location,
  7971. Error &error) {
  7972. Request new_req = req;
  7973. new_req.path = path;
  7974. new_req.params.clear();
  7975. new_req.redirect_count_ -= 1;
  7976. if (res.status == StatusCode::SeeOther_303 &&
  7977. (req.method != "GET" && req.method != "HEAD")) {
  7978. new_req.method = "GET";
  7979. new_req.body.clear();
  7980. new_req.headers.clear();
  7981. new_req.content_length_ = 0;
  7982. new_req.content_provider_ = nullptr;
  7983. new_req.is_chunked_content_provider_ = false;
  7984. }
  7985. Response new_res;
  7986. auto ret = cli.send(new_req, new_res, error);
  7987. if (ret) {
  7988. req = std::move(new_req);
  7989. res = std::move(new_res);
  7990. if (res.location.empty()) { res.location = location; }
  7991. }
  7992. return ret;
  7993. }
  7994. inline std::string params_to_query_str(const Params &params) {
  7995. std::string query;
  7996. for (auto it = params.begin(); it != params.end(); ++it) {
  7997. if (it != params.begin()) { query += '&'; }
  7998. query += encode_query_component(it->first);
  7999. query += '=';
  8000. query += encode_query_component(it->second);
  8001. }
  8002. return query;
  8003. }
  8004. // Splits one "key=value" span of a query string at its first '='. A span with
  8005. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  8006. // "?flag" keeps its name.
  8007. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  8008. std::string &val) {
  8009. divide(b, static_cast<std::size_t>(e - b), '=',
  8010. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  8011. std::size_t rhs_size) {
  8012. key.assign(lhs_data, lhs_size);
  8013. val.assign(rhs_data, rhs_size);
  8014. });
  8015. }
  8016. inline void parse_query_text(const char *data, std::size_t size,
  8017. Params &params) {
  8018. std::set<std::string> cache;
  8019. split(data, data + size, '&', [&](const char *b, const char *e) {
  8020. std::string kv(b, e);
  8021. if (cache.find(kv) != cache.end()) { return; }
  8022. cache.insert(std::move(kv));
  8023. std::string key;
  8024. std::string val;
  8025. divide_query_pair(b, e, key, val);
  8026. if (!key.empty()) {
  8027. params.emplace(decode_query_component(key), decode_query_component(val));
  8028. }
  8029. });
  8030. }
  8031. inline void parse_query_text(const std::string &s, Params &params) {
  8032. parse_query_text(s.data(), s.size(), params);
  8033. }
  8034. // Normalize a query string by decoding and re-encoding each key/value pair
  8035. // while preserving the original parameter order. This avoids double-encoding
  8036. // and ensures consistent encoding. It works on the raw string rather than
  8037. // parsing into Params and re-serializing, because that round trip cannot
  8038. // reproduce the input: params_to_query_str() always emits '=', so a bare
  8039. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  8040. // duplicated pairs.
  8041. inline std::string normalize_query_string(const std::string &query) {
  8042. std::string result;
  8043. split(query.data(), query.data() + query.size(), '&',
  8044. [&](const char *b, const char *e) {
  8045. std::string key;
  8046. std::string val;
  8047. divide_query_pair(b, e, key, val);
  8048. if (!key.empty()) {
  8049. auto dec_key = decode_query_component(key);
  8050. auto dec_val = decode_query_component(val);
  8051. if (!result.empty()) { result += '&'; }
  8052. result += encode_query_component(dec_key);
  8053. if (!val.empty() || std::find(b, e, '=') != e) {
  8054. result += '=';
  8055. result += encode_query_component(dec_val);
  8056. }
  8057. }
  8058. });
  8059. return result;
  8060. }
  8061. // The query of a client's path: what follows '?', up to the fragment.
  8062. inline std::string query_of(const std::string &path) {
  8063. auto fragment_pos = path.find('#');
  8064. auto query_pos = path.find('?');
  8065. return query_pos < fragment_pos
  8066. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  8067. : std::string();
  8068. }
  8069. // Build the request target that goes on the wire from a caller-supplied path.
  8070. // Shared by the buffered send path and the streaming API so that both put the
  8071. // same bytes in the request line for the same input.
  8072. inline std::string encode_request_target(const std::string &uri,
  8073. bool path_encode) {
  8074. // The fragment stays with the client (RFC 9110 §7.1).
  8075. auto target = uri.substr(0, uri.find('#'));
  8076. // `substr(0, npos)` yields the whole string, which is what the no-query
  8077. // case needs.
  8078. auto query_pos = target.find('?');
  8079. auto path_part = target.substr(0, query_pos);
  8080. std::string query_part;
  8081. if (query_pos != std::string::npos) {
  8082. query_part = target.substr(query_pos + 1);
  8083. }
  8084. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  8085. if (!query_part.empty()) {
  8086. // When path encoding is disabled the caller has supplied an already-encoded
  8087. // target and expects the exact bytes to be sent on the wire, so skip
  8088. // normalization for the query too. Normalizing would decode-then-re-encode
  8089. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  8090. // which a strict RFC 3986 server decodes back as `+`, not a space).
  8091. if (path_encode) {
  8092. auto normalized = normalize_query_string(query_part);
  8093. if (!normalized.empty()) {
  8094. result += '?';
  8095. result += normalized;
  8096. }
  8097. } else {
  8098. result += '?';
  8099. result += query_part;
  8100. }
  8101. }
  8102. return result;
  8103. }
  8104. inline bool parse_multipart_boundary(const std::string &content_type,
  8105. std::string &boundary) {
  8106. std::map<std::string, std::string> params;
  8107. extract_media_type(content_type, &params);
  8108. auto it = params.find("boundary");
  8109. if (it == params.end()) { return false; }
  8110. boundary = it->second;
  8111. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  8112. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  8113. // bytes costs a nearly full comparison at nearly every position: the
  8114. // boundary's length multiplies the worst-case cost of scanning a body.
  8115. return !boundary.empty() && boundary.size() <= 70;
  8116. }
  8117. inline void parse_disposition_params(const std::string &s, Params &params) {
  8118. std::set<std::string> cache;
  8119. split_unquoted(
  8120. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  8121. std::string kv(b, e);
  8122. if (cache.find(kv) != cache.end()) { return; }
  8123. cache.insert(kv);
  8124. std::string key;
  8125. std::string val;
  8126. divide_param_pair(b, e, key, val);
  8127. if (!key.empty()) {
  8128. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  8129. }
  8130. });
  8131. }
  8132. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8133. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  8134. #else
  8135. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  8136. #endif
  8137. auto is_valid = [](const std::string &str) {
  8138. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  8139. };
  8140. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8141. const auto pos = static_cast<size_t>(6);
  8142. const auto len = static_cast<size_t>(s.size() - 6);
  8143. auto all_valid_ranges = true;
  8144. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8145. if (!all_valid_ranges) { return; }
  8146. const auto it = std::find(b, e, '-');
  8147. if (it == e) {
  8148. all_valid_ranges = false;
  8149. return;
  8150. }
  8151. const auto lhs = std::string(b, it);
  8152. const auto rhs = std::string(it + 1, e);
  8153. if (!is_valid(lhs) || !is_valid(rhs)) {
  8154. all_valid_ranges = false;
  8155. return;
  8156. }
  8157. ssize_t first = -1;
  8158. if (!lhs.empty()) {
  8159. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8160. // would turn the range into a suffix range.
  8161. auto res =
  8162. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8163. if (res.ec != std::errc{}) {
  8164. all_valid_ranges = false;
  8165. return;
  8166. }
  8167. }
  8168. ssize_t last = -1;
  8169. if (!rhs.empty()) {
  8170. // An overflowing last-byte-pos is past any content length, so keeping
  8171. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8172. ssize_t v;
  8173. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8174. if (res.ec == std::errc{}) { last = v; }
  8175. }
  8176. if ((first == -1 && last == -1) ||
  8177. (first != -1 && last != -1 && first > last)) {
  8178. all_valid_ranges = false;
  8179. return;
  8180. }
  8181. ranges.emplace_back(first, last);
  8182. });
  8183. return all_valid_ranges && !ranges.empty();
  8184. }
  8185. return false;
  8186. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8187. }
  8188. #else
  8189. } catch (...) { return false; }
  8190. #endif
  8191. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8192. inline std::string remove_quoted_strings(const std::string &s) {
  8193. std::string out;
  8194. auto in_quotes = false;
  8195. for (size_t i = 0; i < s.size(); i++) {
  8196. if (s[i] == '"') {
  8197. in_quotes = !in_quotes;
  8198. } else if (!in_quotes) {
  8199. out += s[i];
  8200. } else if (s[i] == '\\') {
  8201. i++;
  8202. }
  8203. }
  8204. return out;
  8205. }
  8206. inline bool parse_accept_header(const std::string &s,
  8207. std::vector<std::string> &content_types) {
  8208. // Parameter values are not used here, so a quoted-string is dropped rather
  8209. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8210. if (s.find('"') != std::string::npos) {
  8211. return parse_accept_header(remove_quoted_strings(s), content_types);
  8212. }
  8213. content_types.clear();
  8214. // Empty string is considered valid (no preference)
  8215. if (s.empty()) { return true; }
  8216. struct AcceptEntry {
  8217. std::string media_type;
  8218. double quality;
  8219. int order;
  8220. };
  8221. std::vector<AcceptEntry> entries;
  8222. int order = 0;
  8223. bool has_invalid_entry = false;
  8224. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8225. // has to parse and ignore empty list elements, so a leading, trailing or
  8226. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8227. // split() skips them, and the header length limit bounds how many a sender
  8228. // can send, so ignoring all of them cannot be used as a denial-of-service
  8229. // vector.
  8230. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8231. std::string entry(b, e);
  8232. entry = trim_copy(entry);
  8233. AcceptEntry accept_entry;
  8234. accept_entry.order = order++;
  8235. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8236. accept_entry.media_type, accept_entry.quality)) {
  8237. has_invalid_entry = true;
  8238. return;
  8239. }
  8240. // Remove additional parameters from media type
  8241. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8242. // Basic validation of media type format
  8243. if (accept_entry.media_type.empty()) {
  8244. has_invalid_entry = true;
  8245. return;
  8246. }
  8247. // Check for basic media type format (should contain '/' or be '*')
  8248. if (accept_entry.media_type != "*" &&
  8249. accept_entry.media_type.find('/') == std::string::npos) {
  8250. has_invalid_entry = true;
  8251. return;
  8252. }
  8253. entries.push_back(std::move(accept_entry));
  8254. });
  8255. // Return false if any invalid entry was found
  8256. if (has_invalid_entry) { return false; }
  8257. // Sort by quality (descending), then by original order (ascending)
  8258. std::sort(entries.begin(), entries.end(),
  8259. [](const AcceptEntry &a, const AcceptEntry &b) {
  8260. if (a.quality != b.quality) {
  8261. return a.quality > b.quality; // Higher quality first
  8262. }
  8263. return a.order < b.order; // Earlier order first for same quality
  8264. });
  8265. // Extract sorted media types
  8266. content_types.reserve(entries.size());
  8267. for (auto &entry : entries) {
  8268. content_types.push_back(std::move(entry.media_type));
  8269. }
  8270. return true;
  8271. }
  8272. class FormDataParser {
  8273. public:
  8274. FormDataParser() = default;
  8275. void set_boundary(std::string &&boundary) {
  8276. boundary_ = std::move(boundary);
  8277. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8278. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8279. }
  8280. bool is_valid() const { return is_valid_; }
  8281. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8282. const ContentReceiver &content_callback) {
  8283. // Once the close delimiter has been seen the rest of the body is epilogue
  8284. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8285. // spread across reads is not copied in only to be erased right away.
  8286. if (state_ == 5) { return true; }
  8287. buf_append(buf, n);
  8288. while (buf_size() > 0) {
  8289. switch (state_) {
  8290. case 0: { // Initial boundary
  8291. auto pos = buf_find(dash_boundary_crlf_);
  8292. if (pos == buf_size()) {
  8293. // Not found yet: keep only a possible partial boundary at the tail so
  8294. // that a body which never contains the boundary cannot grow the
  8295. // buffer (and get rescanned from the start) without bound.
  8296. auto keep = dash_boundary_crlf_.size() - 1;
  8297. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8298. return true;
  8299. }
  8300. buf_erase(pos + dash_boundary_crlf_.size());
  8301. state_ = 1;
  8302. break;
  8303. }
  8304. case 1: { // New entry
  8305. clear_file_info();
  8306. header_searched_ = 0;
  8307. state_ = 2;
  8308. break;
  8309. }
  8310. case 2: { // Headers
  8311. // Resume where the last call stopped looking, so that a line arriving
  8312. // a few bytes at a time is not searched from its start each time.
  8313. auto pos = buf_find(crlf_, header_searched_);
  8314. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8315. while (pos < buf_size()) {
  8316. // Empty line
  8317. if (pos == 0) {
  8318. if (!header_callback(file_)) {
  8319. is_valid_ = false;
  8320. return false;
  8321. }
  8322. buf_erase(crlf_.size());
  8323. state_ = 3;
  8324. break;
  8325. }
  8326. // Check header count limit
  8327. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8328. is_valid_ = false;
  8329. return false;
  8330. }
  8331. header_count_++;
  8332. const auto header = buf_head(pos);
  8333. if (!parse_header(header.data(), header.data() + header.size(),
  8334. [&](const std::string &, const std::string &) {})) {
  8335. is_valid_ = false;
  8336. return false;
  8337. }
  8338. // Parse and emplace space trimmed headers into a map
  8339. if (!parse_header(
  8340. header.data(), header.data() + header.size(),
  8341. [&](const std::string &key, const std::string &val) {
  8342. file_.headers.emplace(key, val);
  8343. })) {
  8344. is_valid_ = false;
  8345. return false;
  8346. }
  8347. constexpr const char header_content_type[] = "Content-Type:";
  8348. if (start_with_case_ignore(header, header_content_type)) {
  8349. file_.content_type =
  8350. trim_copy(header.substr(str_len(header_content_type)));
  8351. } else {
  8352. std::string disposition_params;
  8353. if (parse_content_disposition(header, disposition_params)) {
  8354. Params params;
  8355. parse_disposition_params(disposition_params, params);
  8356. auto it = params.find("name");
  8357. if (it != params.end()) {
  8358. file_.name = it->second;
  8359. } else {
  8360. is_valid_ = false;
  8361. return false;
  8362. }
  8363. it = params.find("filename");
  8364. if (it != params.end()) { file_.filename = it->second; }
  8365. it = params.find("filename*");
  8366. if (it != params.end()) {
  8367. // RFC 5987: only UTF-8 encoding is allowed
  8368. const auto &val = it->second;
  8369. constexpr const char utf8_prefix[] = "UTF-8''";
  8370. constexpr size_t prefix_len = str_len(utf8_prefix);
  8371. if (val.size() > prefix_len &&
  8372. start_with_case_ignore(val, utf8_prefix)) {
  8373. file_.filename = decode_path_component(
  8374. val.substr(prefix_len)); // override...
  8375. } else {
  8376. is_valid_ = false;
  8377. return false;
  8378. }
  8379. }
  8380. }
  8381. }
  8382. buf_erase(pos + crlf_.size());
  8383. pos = buf_find(crlf_);
  8384. }
  8385. if (state_ != 3) {
  8386. // The CR of the CRLF may be the last byte so far.
  8387. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8388. return true;
  8389. }
  8390. break;
  8391. }
  8392. case 3: { // Body
  8393. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8394. auto pos = buf_find(crlf_dash_boundary_);
  8395. if (pos < buf_size()) {
  8396. if (!content_callback(buf_data(), pos)) {
  8397. is_valid_ = false;
  8398. return false;
  8399. }
  8400. buf_erase(pos + crlf_dash_boundary_.size());
  8401. state_ = 4;
  8402. } else {
  8403. auto len = buf_size() - crlf_dash_boundary_.size();
  8404. if (len > 0) {
  8405. if (!content_callback(buf_data(), len)) {
  8406. is_valid_ = false;
  8407. return false;
  8408. }
  8409. buf_erase(len);
  8410. }
  8411. return true;
  8412. }
  8413. break;
  8414. }
  8415. case 4: { // Boundary
  8416. if (crlf_.size() > buf_size()) { return true; }
  8417. if (buf_start_with(crlf_)) {
  8418. buf_erase(crlf_.size());
  8419. state_ = 1;
  8420. } else if (buf_start_with(dash_)) {
  8421. buf_erase(dash_.size());
  8422. is_valid_ = true;
  8423. state_ = 5;
  8424. } else {
  8425. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8426. // accepted after a boundary; RFC 2046 allows transport-padding in
  8427. // between, but this parser has never supported it. Either way the
  8428. // body is already destined to be rejected, so fail now instead of
  8429. // buffering the rest of it. Both are two bytes, so the check above
  8430. // already guarantees enough buffered data to decide.
  8431. is_valid_ = false;
  8432. return false;
  8433. }
  8434. break;
  8435. }
  8436. case 5: { // Epilogue
  8437. buf_erase(buf_size());
  8438. break;
  8439. }
  8440. }
  8441. }
  8442. return true;
  8443. }
  8444. private:
  8445. void clear_file_info() {
  8446. file_.name.clear();
  8447. file_.filename.clear();
  8448. file_.content_type.clear();
  8449. file_.headers.clear();
  8450. header_count_ = 0;
  8451. }
  8452. bool start_with_case_ignore(const std::string &a, const char *b,
  8453. size_t offset = 0) const {
  8454. const auto b_len = strlen(b);
  8455. if (a.size() < offset + b_len) { return false; }
  8456. for (size_t i = 0; i < b_len; i++) {
  8457. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8458. return false;
  8459. }
  8460. }
  8461. return true;
  8462. }
  8463. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8464. // Returns true if header matches, with the params portion in `params_out`.
  8465. bool parse_content_disposition(const std::string &header,
  8466. std::string &params_out) const {
  8467. constexpr const char prefix[] = "Content-Disposition:";
  8468. constexpr size_t prefix_len = str_len(prefix);
  8469. if (!start_with_case_ignore(header, prefix)) { return false; }
  8470. // Skip whitespace after "Content-Disposition:"
  8471. auto pos = prefix_len;
  8472. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8473. pos++;
  8474. }
  8475. // Match "form-data;" (case-insensitive)
  8476. constexpr const char form_data[] = "form-data;";
  8477. constexpr size_t form_data_len = str_len(form_data);
  8478. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8479. pos += form_data_len;
  8480. // Skip whitespace after "form-data;"
  8481. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8482. pos++;
  8483. }
  8484. params_out = header.substr(pos);
  8485. return true;
  8486. }
  8487. const std::string dash_ = "--";
  8488. const std::string crlf_ = "\r\n";
  8489. std::string boundary_;
  8490. std::string dash_boundary_crlf_;
  8491. std::string crlf_dash_boundary_;
  8492. size_t state_ = 0;
  8493. bool is_valid_ = false;
  8494. FormData file_;
  8495. size_t header_count_ = 0;
  8496. size_t header_searched_ = 0;
  8497. // Buffer
  8498. bool start_with(const std::string &a, size_t spos, size_t epos,
  8499. const std::string &b) const {
  8500. if (epos - spos < b.size()) { return false; }
  8501. for (size_t i = 0; i < b.size(); i++) {
  8502. if (a[i + spos] != b[i]) { return false; }
  8503. }
  8504. return true;
  8505. }
  8506. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8507. const char *buf_data() const { return &buf_[buf_spos_]; }
  8508. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8509. bool buf_start_with(const std::string &s) const {
  8510. return start_with(buf_, buf_spos_, buf_epos_, s);
  8511. }
  8512. size_t buf_find(const std::string &s, size_t from = 0) const {
  8513. auto c = s.front();
  8514. size_t off = buf_spos_ + from;
  8515. while (off < buf_epos_) {
  8516. auto pos = off;
  8517. while (true) {
  8518. if (pos == buf_epos_) { return buf_size(); }
  8519. if (buf_[pos] == c) { break; }
  8520. pos++;
  8521. }
  8522. auto remaining_size = buf_epos_ - pos;
  8523. if (s.size() > remaining_size) { return buf_size(); }
  8524. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8525. off = pos + 1;
  8526. }
  8527. return buf_size();
  8528. }
  8529. void buf_append(const char *data, size_t n) {
  8530. auto remaining_size = buf_size();
  8531. if (remaining_size > 0 && buf_spos_ > 0) {
  8532. for (size_t i = 0; i < remaining_size; i++) {
  8533. buf_[i] = buf_[buf_spos_ + i];
  8534. }
  8535. }
  8536. buf_spos_ = 0;
  8537. buf_epos_ = remaining_size;
  8538. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8539. for (size_t i = 0; i < n; i++) {
  8540. buf_[buf_epos_ + i] = data[i];
  8541. }
  8542. buf_epos_ += n;
  8543. }
  8544. void buf_erase(size_t size) { buf_spos_ += size; }
  8545. std::string buf_;
  8546. size_t buf_spos_ = 0;
  8547. size_t buf_epos_ = 0;
  8548. };
  8549. inline std::string random_string(size_t length) {
  8550. constexpr const char data[] =
  8551. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8552. std::string result(length, '\0');
  8553. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8554. for (auto &c : result) {
  8555. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8556. }
  8557. return result;
  8558. }
  8559. inline std::string make_multipart_data_boundary() {
  8560. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8561. }
  8562. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8563. auto valid = true;
  8564. for (size_t i = 0; i < boundary.size(); i++) {
  8565. auto c = boundary[i];
  8566. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8567. valid = false;
  8568. break;
  8569. }
  8570. }
  8571. return valid;
  8572. }
  8573. // Escape a multipart field name/filename following the WHATWG HTML standard
  8574. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8575. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8576. // With quoted = false, only CR and LF are escaped; this is for header values
  8577. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8578. inline std::string escape_multipart_field(const std::string &s,
  8579. bool quoted = true) {
  8580. std::string result;
  8581. result.reserve(s.size());
  8582. for (auto c : s) {
  8583. switch (c) {
  8584. case '"':
  8585. if (quoted) {
  8586. result += "%22";
  8587. } else {
  8588. result += c;
  8589. }
  8590. break;
  8591. case '\\':
  8592. // A lone backslash would escape the character after it (RFC 9110
  8593. // 5.6.4).
  8594. if (quoted) { result += '\\'; }
  8595. result += c;
  8596. break;
  8597. case '\r': result += "%0D"; break;
  8598. case '\n': result += "%0A"; break;
  8599. default: result += c; break;
  8600. }
  8601. }
  8602. return result;
  8603. }
  8604. template <typename T>
  8605. inline std::string
  8606. serialize_multipart_formdata_item_begin(const T &item,
  8607. const std::string &boundary) {
  8608. std::string body = "--" + boundary + "\r\n";
  8609. body += "Content-Disposition: form-data; name=\"" +
  8610. escape_multipart_field(item.name) + "\"";
  8611. if (!item.filename.empty()) {
  8612. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8613. }
  8614. body += "\r\n";
  8615. if (!item.content_type.empty()) {
  8616. body +=
  8617. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8618. "\r\n";
  8619. }
  8620. body += "\r\n";
  8621. return body;
  8622. }
  8623. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8624. inline std::string
  8625. serialize_multipart_formdata_finish(const std::string &boundary) {
  8626. return "--" + boundary + "--\r\n";
  8627. }
  8628. inline std::string
  8629. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8630. return "multipart/form-data; boundary=" + boundary;
  8631. }
  8632. inline std::string
  8633. serialize_multipart_formdata(const UploadFormDataItems &items,
  8634. const std::string &boundary, bool finish = true) {
  8635. std::string body;
  8636. for (const auto &item : items) {
  8637. body += serialize_multipart_formdata_item_begin(item, boundary);
  8638. body += item.content + serialize_multipart_formdata_item_end();
  8639. }
  8640. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8641. return body;
  8642. }
  8643. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8644. const std::string &boundary) {
  8645. size_t total = 0;
  8646. for (const auto &item : items) {
  8647. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8648. total += item.content.size();
  8649. total += serialize_multipart_formdata_item_end().size();
  8650. }
  8651. total += serialize_multipart_formdata_finish(boundary).size();
  8652. return total;
  8653. }
  8654. struct MultipartSegment {
  8655. const char *data;
  8656. size_t size;
  8657. };
  8658. // NOTE: items must outlive the returned ContentProvider
  8659. // (safe for synchronous use inside Post/Put/Patch)
  8660. inline ContentProvider
  8661. make_multipart_content_provider(const UploadFormDataItems &items,
  8662. const std::string &boundary) {
  8663. // Own the per-item header strings and the finish string
  8664. std::vector<std::string> owned;
  8665. owned.reserve(items.size() + 1);
  8666. for (const auto &item : items)
  8667. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8668. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8669. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8670. std::vector<MultipartSegment> segs;
  8671. segs.reserve(items.size() * 3 + 1);
  8672. static const char crlf[] = "\r\n";
  8673. for (size_t i = 0; i < items.size(); i++) {
  8674. segs.push_back({owned[i].data(), owned[i].size()});
  8675. segs.push_back({items[i].content.data(), items[i].content.size()});
  8676. segs.push_back({crlf, 2});
  8677. }
  8678. segs.push_back({owned.back().data(), owned.back().size()});
  8679. struct MultipartState {
  8680. std::vector<std::string> owned;
  8681. std::vector<MultipartSegment> segs;
  8682. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8683. };
  8684. auto state = std::make_shared<MultipartState>();
  8685. state->owned = std::move(owned);
  8686. // `segs` holds raw pointers into owned strings; std::string move preserves
  8687. // the data pointer, so these pointers remain valid after the move above.
  8688. state->segs = std::move(segs);
  8689. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8690. // Buffer multiple small segments into fewer, larger writes to avoid
  8691. // excessive TCP packets when there are many form data items (#2410)
  8692. auto &buf = state->buf;
  8693. auto buf_size = buf.size();
  8694. size_t buf_len = 0;
  8695. size_t remaining = length;
  8696. // Find the first segment containing 'offset'
  8697. size_t pos = 0;
  8698. size_t seg_idx = 0;
  8699. for (; seg_idx < state->segs.size(); seg_idx++) {
  8700. const auto &seg = state->segs[seg_idx];
  8701. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8702. pos += seg.size;
  8703. }
  8704. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8705. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8706. const auto &seg = state->segs[seg_idx];
  8707. size_t available = seg.size - seg_offset;
  8708. size_t to_copy = (std::min)(available, remaining);
  8709. const char *src = seg.data + seg_offset;
  8710. seg_offset = 0; // only the first segment has a non-zero offset
  8711. while (to_copy > 0) {
  8712. size_t space = buf_size - buf_len;
  8713. size_t chunk = (std::min)(to_copy, space);
  8714. std::memcpy(buf.data() + buf_len, src, chunk);
  8715. buf_len += chunk;
  8716. src += chunk;
  8717. to_copy -= chunk;
  8718. remaining -= chunk;
  8719. if (buf_len == buf_size) {
  8720. if (!sink.write(buf.data(), buf_len)) { return false; }
  8721. buf_len = 0;
  8722. }
  8723. }
  8724. }
  8725. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8726. return true;
  8727. };
  8728. }
  8729. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8730. if (ranges.size() <= 1) return;
  8731. // Sort ranges by start position
  8732. std::sort(ranges.begin(), ranges.end(),
  8733. [](const Range &a, const Range &b) { return a.first < b.first; });
  8734. Ranges coalesced;
  8735. coalesced.reserve(ranges.size());
  8736. for (auto &r : ranges) {
  8737. auto first_pos = r.first;
  8738. auto last_pos = r.second;
  8739. // Handle special cases like in range_error
  8740. if (first_pos == -1 && last_pos == -1) {
  8741. first_pos = 0;
  8742. last_pos = static_cast<ssize_t>(content_length);
  8743. }
  8744. if (first_pos == -1) {
  8745. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8746. last_pos = static_cast<ssize_t>(content_length) - 1;
  8747. }
  8748. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8749. last_pos = static_cast<ssize_t>(content_length) - 1;
  8750. }
  8751. // Skip invalid ranges
  8752. if (!(0 <= first_pos && first_pos <= last_pos &&
  8753. last_pos < static_cast<ssize_t>(content_length))) {
  8754. continue;
  8755. }
  8756. // Coalesce with previous range if overlapping or adjacent (but not
  8757. // identical)
  8758. if (!coalesced.empty()) {
  8759. auto &prev = coalesced.back();
  8760. // Check if current range overlaps or is adjacent to previous range
  8761. // but don't coalesce identical ranges (allow duplicates)
  8762. if (first_pos <= prev.second + 1 &&
  8763. !(first_pos == prev.first && last_pos == prev.second)) {
  8764. // Extend the previous range
  8765. prev.second = (std::max)(prev.second, last_pos);
  8766. continue;
  8767. }
  8768. }
  8769. // Add new range
  8770. coalesced.emplace_back(first_pos, last_pos);
  8771. }
  8772. ranges = std::move(coalesced);
  8773. }
  8774. inline bool range_error(Request &req, Response &res) {
  8775. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8776. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8777. req.ranges.clear();
  8778. if (res.status == StatusCode::PartialContent_206) {
  8779. res.status = StatusCode::OK_200;
  8780. }
  8781. return false;
  8782. }
  8783. ssize_t content_len = static_cast<ssize_t>(
  8784. res.content_length_ ? res.content_length_ : res.body.size());
  8785. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8786. size_t overwrapping_count = 0;
  8787. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8788. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8789. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8790. // Too many ranges
  8791. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8792. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8793. return true;
  8794. }
  8795. for (auto &r : req.ranges) {
  8796. auto &first_pos = r.first;
  8797. auto &last_pos = r.second;
  8798. if (first_pos == -1 && last_pos == -1) {
  8799. first_pos = 0;
  8800. last_pos = content_len;
  8801. }
  8802. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8803. // selects the entire representation.
  8804. if (first_pos == -1) {
  8805. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8806. last_pos = content_len - 1;
  8807. }
  8808. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8809. // A client can limit the number of bytes requested without knowing the
  8810. // size of the selected representation. If the last-pos value is absent,
  8811. // or if the value is greater than or equal to the current length of the
  8812. // representation data, the byte range is interpreted as the remainder of
  8813. // the representation (i.e., the server replaces the value of last-pos
  8814. // with a value that is one less than the current length of the selected
  8815. // representation).
  8816. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8817. if (last_pos == -1 || last_pos >= content_len) {
  8818. last_pos = content_len - 1;
  8819. }
  8820. // Range must be within content length
  8821. if (!(0 <= first_pos && first_pos <= last_pos &&
  8822. last_pos <= content_len - 1)) {
  8823. return true;
  8824. }
  8825. // Request must not have more than two overlapping ranges
  8826. for (const auto &processed_range : processed_ranges) {
  8827. if (!(last_pos < processed_range.first ||
  8828. first_pos > processed_range.second)) {
  8829. overwrapping_count++;
  8830. if (overwrapping_count > 2) { return true; }
  8831. break; // Only count once per range
  8832. }
  8833. }
  8834. processed_ranges.emplace_back(first_pos, last_pos);
  8835. }
  8836. // After validation, coalesce overlapping ranges as per RFC 9110
  8837. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8838. }
  8839. return false;
  8840. }
  8841. inline std::pair<size_t, size_t>
  8842. get_range_offset_and_length(Range r, size_t content_length) {
  8843. assert(r.first != -1 && r.second != -1);
  8844. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8845. assert(r.first <= r.second &&
  8846. r.second < static_cast<ssize_t>(content_length));
  8847. (void)(content_length);
  8848. return std::make_pair(static_cast<size_t>(r.first),
  8849. static_cast<size_t>(r.second - r.first) + 1);
  8850. }
  8851. inline std::string make_content_range_header_field(
  8852. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8853. auto st = offset_and_length.first;
  8854. auto ed = st + offset_and_length.second - 1;
  8855. std::string field = "bytes ";
  8856. field += std::to_string(st);
  8857. field += '-';
  8858. field += std::to_string(ed);
  8859. field += '/';
  8860. field += std::to_string(content_length);
  8861. return field;
  8862. }
  8863. template <typename SToken, typename CToken, typename Content>
  8864. bool process_multipart_ranges_data(const Request &req,
  8865. const std::string &boundary,
  8866. const std::string &content_type,
  8867. size_t content_length, SToken stoken,
  8868. CToken ctoken, Content content) {
  8869. for (size_t i = 0; i < req.ranges.size(); i++) {
  8870. ctoken("--");
  8871. stoken(boundary);
  8872. ctoken("\r\n");
  8873. if (!content_type.empty()) {
  8874. ctoken("Content-Type: ");
  8875. stoken(content_type);
  8876. ctoken("\r\n");
  8877. }
  8878. auto offset_and_length =
  8879. get_range_offset_and_length(req.ranges[i], content_length);
  8880. ctoken("Content-Range: ");
  8881. stoken(make_content_range_header_field(offset_and_length, content_length));
  8882. ctoken("\r\n");
  8883. ctoken("\r\n");
  8884. if (!content(offset_and_length.first, offset_and_length.second)) {
  8885. return false;
  8886. }
  8887. ctoken("\r\n");
  8888. }
  8889. ctoken("--");
  8890. stoken(boundary);
  8891. ctoken("--");
  8892. return true;
  8893. }
  8894. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8895. const std::string &boundary,
  8896. const std::string &content_type,
  8897. size_t content_length,
  8898. std::string &data) {
  8899. process_multipart_ranges_data(
  8900. req, boundary, content_type, content_length,
  8901. [&](const std::string &token) { data += token; },
  8902. [&](const std::string &token) { data += token; },
  8903. [&](size_t offset, size_t length) {
  8904. assert(offset + length <= content_length);
  8905. data += res.body.substr(offset, length);
  8906. return true;
  8907. });
  8908. }
  8909. inline size_t get_multipart_ranges_data_length(const Request &req,
  8910. const std::string &boundary,
  8911. const std::string &content_type,
  8912. size_t content_length) {
  8913. size_t data_length = 0;
  8914. process_multipart_ranges_data(
  8915. req, boundary, content_type, content_length,
  8916. [&](const std::string &token) { data_length += token.size(); },
  8917. [&](const std::string &token) { data_length += token.size(); },
  8918. [&](size_t /*offset*/, size_t length) {
  8919. data_length += length;
  8920. return true;
  8921. });
  8922. return data_length;
  8923. }
  8924. template <typename T>
  8925. inline bool
  8926. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8927. const std::string &boundary,
  8928. const std::string &content_type,
  8929. size_t content_length, const T &is_shutting_down) {
  8930. return process_multipart_ranges_data(
  8931. req, boundary, content_type, content_length,
  8932. [&](const std::string &token) { strm.write(token); },
  8933. [&](const std::string &token) { strm.write(token); },
  8934. [&](size_t offset, size_t length) {
  8935. return write_content(strm, res.content_provider_, offset, length,
  8936. is_shutting_down);
  8937. });
  8938. }
  8939. inline bool has_framed_body(const Request &req) {
  8940. return is_chunked_transfer_encoding(req.headers) ||
  8941. req.get_header_value_u64("Content-Length") > 0;
  8942. }
  8943. inline bool expect_content(const Request &req) {
  8944. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8945. req.method == "DELETE") {
  8946. return true;
  8947. }
  8948. return has_framed_body(req);
  8949. }
  8950. #ifdef _WIN32
  8951. class WSInit {
  8952. public:
  8953. WSInit() {
  8954. WSADATA wsaData;
  8955. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8956. }
  8957. ~WSInit() {
  8958. if (is_valid_) WSACleanup();
  8959. }
  8960. bool is_valid_ = false;
  8961. };
  8962. static WSInit wsinit_;
  8963. #endif
  8964. inline std::string unescape_quoted_pairs(const std::string &s) {
  8965. std::string out;
  8966. out.reserve(s.size());
  8967. for (size_t i = 0; i < s.size(); i++) {
  8968. if (s[i] == '\\' && i + 1 < s.size()) {
  8969. out += s[++i];
  8970. } else {
  8971. out += s[i];
  8972. }
  8973. }
  8974. return out;
  8975. }
  8976. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8977. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8978. // quoted-pair, so the recipient recovers the original value.
  8979. inline std::string escape_quoted_pairs(const std::string &s) {
  8980. std::string out;
  8981. out.reserve(s.size());
  8982. for (auto c : s) {
  8983. if (c == '\\' || c == '"') { out += '\\'; }
  8984. out += c;
  8985. }
  8986. return out;
  8987. }
  8988. // RFC 9110 Section 11.6.1 defines a challenge list as
  8989. // WWW-Authenticate = #challenge
  8990. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8991. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8992. // so a server may offer several schemes, each with its own comma-separated
  8993. // auth-param list, in either order and either as separate field lines or
  8994. // packed into one. Splitting on every comma would break apart a challenge's
  8995. // own param list; splitting only on the first space would miss a Digest
  8996. // challenge that isn't first. Split on commas that aren't inside a
  8997. // quoted-string instead (split_unquoted), then track which scheme each
  8998. // resulting segment belongs to: a segment whose text before "=" contains
  8999. // whitespace (or that has no "=" at all) starts a new challenge named by its
  9000. // leading token.
  9001. inline bool parse_www_authenticate(const Response &res,
  9002. std::map<std::string, std::string> &auth,
  9003. bool is_proxy) {
  9004. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  9005. auto combined = get_combined_header_value(res.headers, auth_key);
  9006. if (combined.empty()) { return false; }
  9007. auto found_digest = false;
  9008. auto in_digest_challenge = false;
  9009. split_unquoted(
  9010. combined.data(), combined.data() + combined.size(), ',',
  9011. [&](const char *b, const char *e) {
  9012. std::string segment(b, e);
  9013. auto eq_pos = segment.find('=');
  9014. // BWS is allowed on both sides of "=", so the text naming the key (or,
  9015. // for the first segment of a challenge, "<scheme> <key>") must be
  9016. // trimmed before its boundaries are inspected.
  9017. auto key_part = trim_copy(
  9018. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  9019. auto space_pos = key_part.find_last_of(" \t");
  9020. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  9021. // "<scheme>[ <key>]" starts a new challenge.
  9022. auto scheme_end =
  9023. space_pos == std::string::npos ? key_part.size() : space_pos;
  9024. // RFC 7616 Section 3.7: a server may offer more than one Digest
  9025. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  9026. // from one challenge is never paired with another's algorithm.
  9027. in_digest_challenge =
  9028. !found_digest &&
  9029. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  9030. if (in_digest_challenge) { found_digest = true; }
  9031. if (space_pos == std::string::npos) {
  9032. // Bare scheme (or a token68), no auth-param on this segment.
  9033. return;
  9034. }
  9035. key_part = key_part.substr(space_pos + 1);
  9036. }
  9037. if (!in_digest_challenge) { return; }
  9038. auto val = trim_copy(segment.substr(eq_pos + 1));
  9039. auto unquoted = trim_double_quotes_copy(val);
  9040. if (unquoted.size() != val.size()) {
  9041. unquoted = unescape_quoted_pairs(unquoted);
  9042. }
  9043. auth[std::move(key_part)] = std::move(unquoted);
  9044. });
  9045. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  9046. // make_digest_authentication_header() dereferences both unconditionally, so
  9047. // a challenge missing either can't produce a usable Authorization header.
  9048. // Treat it the same as no Digest challenge at all.
  9049. return found_digest && auth.find("realm") != auth.end() &&
  9050. auth.find("nonce") != auth.end();
  9051. }
  9052. class ContentProviderAdapter {
  9053. public:
  9054. explicit ContentProviderAdapter(
  9055. ContentProviderWithoutLength &&content_provider)
  9056. : content_provider_(std::move(content_provider)) {}
  9057. bool operator()(size_t offset, size_t, DataSink &sink) {
  9058. return content_provider_(offset, sink);
  9059. }
  9060. private:
  9061. ContentProviderWithoutLength content_provider_;
  9062. };
  9063. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  9064. namespace fields {
  9065. inline bool is_token_char(char c) {
  9066. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  9067. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  9068. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  9069. }
  9070. inline bool is_token(const std::string &s) {
  9071. if (s.empty()) { return false; }
  9072. for (auto c : s) {
  9073. if (!is_token_char(c)) { return false; }
  9074. }
  9075. return true;
  9076. }
  9077. inline bool is_field_name(const std::string &s) { return is_token(s); }
  9078. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  9079. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  9080. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  9081. inline bool is_field_content(const std::string &s) {
  9082. if (s.empty()) { return true; }
  9083. if (s.size() == 1) {
  9084. return is_field_vchar(s[0]);
  9085. } else if (s.size() == 2) {
  9086. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  9087. } else {
  9088. size_t i = 0;
  9089. if (!is_field_vchar(s[i])) { return false; }
  9090. i++;
  9091. while (i < s.size() - 1) {
  9092. auto c = s[i++];
  9093. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  9094. } else {
  9095. return false;
  9096. }
  9097. }
  9098. return is_field_vchar(s[i]);
  9099. }
  9100. }
  9101. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  9102. inline bool is_field_valid(const std::string &name, const std::string &value) {
  9103. return is_field_name(name) && is_field_value(value);
  9104. }
  9105. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  9106. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  9107. inline bool is_request_target(const std::string &s) {
  9108. return std::all_of(s.begin(), s.end(), is_field_vchar);
  9109. }
  9110. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  9111. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  9112. inline bool is_host(const std::string &s) {
  9113. return std::all_of(s.begin(), s.end(), [](char c) {
  9114. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  9115. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9116. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9117. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  9118. });
  9119. }
  9120. } // namespace fields
  9121. // Built in memory first, like ClientImpl::write_request, so a rejected header
  9122. // never leaves a partial request on the wire.
  9123. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  9124. BufferStream bstrm;
  9125. if (write_request_line(bstrm, req.method, req.path) < 0) {
  9126. error = Error::Write;
  9127. return false;
  9128. }
  9129. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  9130. return false;
  9131. }
  9132. const auto &data = bstrm.get_buffer();
  9133. if (!write_data(strm, data.data(), data.size())) {
  9134. error = Error::Write;
  9135. return false;
  9136. }
  9137. return true;
  9138. }
  9139. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9140. WebSocketUpgradeResponse &upgrade) {
  9141. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9142. std::string key_bytes(16, '\0');
  9143. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9144. key_bytes.size());
  9145. auto client_key = base64_encode(key_bytes);
  9146. req.headers.erase("Upgrade");
  9147. req.headers.erase("Connection");
  9148. req.headers.erase("Sec-WebSocket-Key");
  9149. req.headers.erase("Sec-WebSocket-Version");
  9150. req.headers.emplace("Upgrade", "websocket");
  9151. req.headers.emplace("Connection", "Upgrade");
  9152. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9153. req.headers.emplace("Sec-WebSocket-Version", "13");
  9154. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9155. // Verify 101 response and Sec-WebSocket-Accept header
  9156. auto expected_accept = websocket_accept_key(client_key);
  9157. auto offered_subprotocols =
  9158. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9159. return read_websocket_upgrade_response(strm, expected_accept,
  9160. offered_subprotocols, upgrade);
  9161. }
  9162. inline bool is_ip_address(const std::string &host) {
  9163. struct in_addr addr4;
  9164. struct in6_addr addr6;
  9165. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9166. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9167. }
  9168. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9169. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9170. // else, including an address with a zone ID, is returned as it is.
  9171. inline std::string canonical_ip(const std::string &addr) {
  9172. struct in6_addr addr6;
  9173. if (addr.find('%') != std::string::npos ||
  9174. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9175. return addr;
  9176. }
  9177. char buf[INET6_ADDRSTRLEN];
  9178. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9179. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9180. : addr;
  9181. }
  9182. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9183. }
  9184. // `trusted_proxies` holds canonical_ip() spellings.
  9185. inline bool is_trusted_proxy(const std::string &addr,
  9186. const std::vector<std::string> &trusted_proxies) {
  9187. if (trusted_proxies.empty()) { return false; }
  9188. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9189. canonical_ip(addr)) != trusted_proxies.end();
  9190. }
  9191. // Resolve where a client should connect for `host`, honoring a user-supplied
  9192. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9193. // supplying the Host header and SNI; only the connection target changes.
  9194. //
  9195. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9196. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9197. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9198. // absent or empty mapping leaves `host` as the connection target; without the
  9199. // empty check the value would reach getaddrinfo as a null node and silently
  9200. // resolve to loopback.
  9201. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9202. const std::string &host, std::string &connect_host,
  9203. std::string &ip) {
  9204. connect_host = host;
  9205. ip.clear();
  9206. auto it = addr_map.find(host);
  9207. if (it == addr_map.end() || it->second.empty()) { return; }
  9208. if (is_ip_address(it->second)) {
  9209. ip = it->second;
  9210. } else {
  9211. connect_host = it->second;
  9212. }
  9213. }
  9214. } // namespace detail
  9215. /*
  9216. * Group 2: detail namespace - SSL common utilities
  9217. */
  9218. #ifdef CPPHTTPLIB_SSL_ENABLED
  9219. namespace detail {
  9220. class SSLSocketStream final : public Stream {
  9221. public:
  9222. SSLSocketStream(
  9223. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9224. time_t read_timeout_usec, time_t write_timeout_sec,
  9225. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9226. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9227. (std::chrono::steady_clock::time_point::min)());
  9228. ~SSLSocketStream() override;
  9229. bool is_readable() const override;
  9230. bool wait_readable() const override;
  9231. bool wait_writable() const override;
  9232. bool is_peer_alive() const override;
  9233. ssize_t read(char *ptr, size_t size) override;
  9234. ssize_t write(const char *ptr, size_t size) override;
  9235. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9236. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9237. socket_t socket() const override;
  9238. time_t duration() const override;
  9239. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9240. void set_max_timeout(time_t msec) override;
  9241. void set_read_interrupt(std::function<bool()> interrupted) override;
  9242. // See SocketStream::set_readable_hint().
  9243. void set_readable_hint() { readable_hint_ = true; }
  9244. // The error from the last read() or write() that failed in the TLS layer,
  9245. // with code Success if none did
  9246. const tls::TlsError &tls_error() const { return tls_error_; }
  9247. private:
  9248. bool ensure_readable();
  9249. socket_t sock_;
  9250. tls::session_t session_;
  9251. time_t read_timeout_sec_;
  9252. time_t read_timeout_usec_;
  9253. time_t write_timeout_sec_;
  9254. time_t write_timeout_usec_;
  9255. time_t max_timeout_msec_;
  9256. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9257. std::function<bool()> read_interrupted_;
  9258. bool readable_hint_ = false;
  9259. tls::TlsError tls_error_;
  9260. };
  9261. // A TLS stream for WebSocket connections, where the receive path and the
  9262. // send path (application send() plus the heartbeat ping thread) run on
  9263. // different threads. A single TLS session must never be entered
  9264. // concurrently, so every call into the session is serialized by one mutex.
  9265. //
  9266. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9267. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9268. // call under the lock, then waits for readiness with select() outside the
  9269. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9270. // blocked waiting for data never stalls a concurrent sender.
  9271. //
  9272. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9273. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9274. class WebSocketSSLStream final : public Stream {
  9275. public:
  9276. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9277. time_t read_timeout_sec, time_t read_timeout_usec,
  9278. time_t write_timeout_sec, time_t write_timeout_usec);
  9279. ~WebSocketSSLStream() override;
  9280. bool is_readable() const override;
  9281. bool wait_readable() const override;
  9282. bool wait_writable() const override;
  9283. ssize_t read(char *ptr, size_t size) override;
  9284. ssize_t write(const char *ptr, size_t size) override;
  9285. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9286. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9287. socket_t socket() const override;
  9288. time_t duration() const override;
  9289. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9290. void set_max_timeout(time_t msec) override;
  9291. void set_read_interrupt(std::function<bool()> interrupted) override;
  9292. private:
  9293. mutable std::mutex session_mutex_;
  9294. socket_t sock_;
  9295. tls::session_t session_;
  9296. // May change while another thread is in wait_readable(); write timeouts don't
  9297. std::atomic<time_t> read_timeout_sec_;
  9298. std::atomic<time_t> read_timeout_usec_;
  9299. time_t write_timeout_sec_;
  9300. time_t write_timeout_usec_;
  9301. std::atomic<time_t> max_timeout_msec_{0};
  9302. std::atomic<std::chrono::steady_clock::rep> start_time_;
  9303. std::function<bool()> read_interrupted_;
  9304. };
  9305. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9306. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9307. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9308. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9309. unsigned int hash_length = 0;
  9310. unsigned char hash[EVP_MAX_MD_SIZE];
  9311. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9312. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9313. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9314. std::stringstream ss;
  9315. for (auto i = 0u; i < hash_length; ++i) {
  9316. ss << std::hex << std::setw(2) << std::setfill('0')
  9317. << static_cast<unsigned int>(hash[i]);
  9318. }
  9319. return ss.str();
  9320. }
  9321. inline std::string MD5(const std::string &s) {
  9322. return message_digest(s, EVP_md5());
  9323. }
  9324. inline std::string SHA_256(const std::string &s) {
  9325. return message_digest(s, EVP_sha256());
  9326. }
  9327. inline std::string SHA_512(const std::string &s) {
  9328. return message_digest(s, EVP_sha512());
  9329. }
  9330. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9331. namespace {
  9332. template <size_t N>
  9333. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9334. std::stringstream ss;
  9335. for (size_t i = 0; i < N; ++i) {
  9336. ss << std::hex << std::setw(2) << std::setfill('0')
  9337. << static_cast<unsigned int>(hash[i]);
  9338. }
  9339. return ss.str();
  9340. }
  9341. } // namespace
  9342. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9343. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9344. // initialized once. PSA state is process-global; do not free it.
  9345. inline bool ensure_mbedtls_psa_crypto() {
  9346. static std::once_flag once;
  9347. static bool ok = false;
  9348. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9349. return ok;
  9350. }
  9351. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9352. unsigned char *out, size_t out_size) {
  9353. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9354. size_t olen = 0;
  9355. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9356. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9357. olen == out_size;
  9358. }
  9359. #endif
  9360. inline std::string MD5(const std::string &s) {
  9361. unsigned char hash[16];
  9362. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9363. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9364. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9365. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9366. hash);
  9367. #else
  9368. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9369. hash);
  9370. #endif
  9371. return hash_to_hex(hash);
  9372. }
  9373. inline std::string SHA_256(const std::string &s) {
  9374. unsigned char hash[32];
  9375. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9376. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9377. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9378. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9379. hash, 0);
  9380. #else
  9381. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9382. s.size(), hash, 0);
  9383. #endif
  9384. return hash_to_hex(hash);
  9385. }
  9386. inline std::string SHA_512(const std::string &s) {
  9387. unsigned char hash[64];
  9388. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9389. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9390. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9391. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9392. hash, 0);
  9393. #else
  9394. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9395. s.size(), hash, 0);
  9396. #endif
  9397. return hash_to_hex(hash);
  9398. }
  9399. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9400. namespace {
  9401. template <size_t N>
  9402. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9403. std::stringstream ss;
  9404. for (size_t i = 0; i < N; ++i) {
  9405. ss << std::hex << std::setw(2) << std::setfill('0')
  9406. << static_cast<unsigned int>(hash[i]);
  9407. }
  9408. return ss.str();
  9409. }
  9410. } // namespace
  9411. inline std::string MD5(const std::string &s) {
  9412. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9413. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9414. static_cast<word32>(s.size()), hash);
  9415. return hash_to_hex(hash);
  9416. }
  9417. inline std::string SHA_256(const std::string &s) {
  9418. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9419. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9420. static_cast<word32>(s.size()), hash);
  9421. return hash_to_hex(hash);
  9422. }
  9423. inline std::string SHA_512(const std::string &s) {
  9424. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9425. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9426. static_cast<word32>(s.size()), hash);
  9427. return hash_to_hex(hash);
  9428. }
  9429. #endif
  9430. template <typename T>
  9431. inline bool process_server_socket_ssl(
  9432. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9433. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9434. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9435. time_t write_timeout_usec, T callback) {
  9436. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9437. // of a pipelined request, which keep_alive() cannot see on the socket.
  9438. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9439. write_timeout_sec, write_timeout_usec);
  9440. return process_server_socket_core(
  9441. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9442. [&]() { return strm.is_readable(); },
  9443. [&](bool socket_readable, bool close_connection,
  9444. bool &connection_closed) {
  9445. if (socket_readable) { strm.set_readable_hint(); }
  9446. return callback(strm, close_connection, connection_closed);
  9447. });
  9448. }
  9449. template <typename T>
  9450. inline bool process_client_socket_ssl(
  9451. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9452. time_t read_timeout_usec, time_t write_timeout_sec,
  9453. time_t write_timeout_usec, time_t max_timeout_msec,
  9454. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9455. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9456. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9457. start_time);
  9458. return callback(strm);
  9459. }
  9460. // `uri` is req's request-target in origin form, as curl sends it, also when
  9461. // the request line carries the absolute form for a proxy.
  9462. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9463. const Request &req, const std::string &uri,
  9464. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9465. const std::string &cnonce, const std::string &username,
  9466. const std::string &password, bool is_proxy = false) {
  9467. std::string nc;
  9468. {
  9469. std::stringstream ss;
  9470. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9471. nc = ss.str();
  9472. }
  9473. std::string qop;
  9474. if (auth.find("qop") != auth.end()) {
  9475. qop = auth.at("qop");
  9476. if (qop.find("auth-int") != std::string::npos) {
  9477. qop = "auth-int";
  9478. } else if (qop.find("auth") != std::string::npos) {
  9479. qop = "auth";
  9480. } else {
  9481. qop.clear();
  9482. }
  9483. }
  9484. std::string algo = "MD5";
  9485. if (auth.find("algorithm") != auth.end()) {
  9486. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9487. // not a token would otherwise be emitted verbatim and could carry commas
  9488. // or quotes that inject further auth-params into the header below.
  9489. const auto &a = auth.at("algorithm");
  9490. if (fields::is_token(a)) { algo = a; }
  9491. }
  9492. std::string response;
  9493. {
  9494. auto H = algo == "SHA-256" ? detail::SHA_256
  9495. : algo == "SHA-512" ? detail::SHA_512
  9496. : detail::MD5;
  9497. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9498. auto A2 = req.method + ":" + uri;
  9499. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9500. if (qop.empty()) {
  9501. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9502. } else {
  9503. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9504. ":" + qop + ":" + H(A2));
  9505. }
  9506. }
  9507. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9508. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9509. // close the string early. realm, nonce and opaque come straight from the
  9510. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9511. // without this a crafted challenge injects extra auth-params into the header.
  9512. auto field =
  9513. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9514. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9515. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9516. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9517. "\", algorithm=" + algo +
  9518. (qop.empty() ? ", response=\""
  9519. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9520. "\", response=\"") +
  9521. response + "\"" +
  9522. (opaque.empty()
  9523. ? ""
  9524. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9525. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9526. return std::make_pair(key, field);
  9527. }
  9528. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9529. // backend accepts the same names.
  9530. inline bool match_hostname(const std::string &pattern,
  9531. const std::string &hostname) {
  9532. // A trailing dot on the host is ignored
  9533. auto host = hostname;
  9534. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9535. // Exact match (case-insensitive)
  9536. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9537. // Split both pattern and hostname into components by '.', keeping any empty
  9538. // one, which no name may have
  9539. auto labels = [](const std::string &s) {
  9540. std::vector<std::string> v;
  9541. size_t b = 0;
  9542. while (true) {
  9543. auto e = s.find('.', b);
  9544. v.push_back(s.substr(b, e - b));
  9545. if (e == std::string::npos) { return v; }
  9546. b = e + 1;
  9547. }
  9548. };
  9549. auto pattern_components = labels(pattern);
  9550. auto host_components = labels(host);
  9551. auto has_empty_label = [](const std::vector<std::string> &v) {
  9552. return std::any_of(v.begin(), v.end(),
  9553. [](const std::string &l) { return l.empty(); });
  9554. };
  9555. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9556. return false;
  9557. }
  9558. // Component count must match
  9559. if (host_components.size() != pattern_components.size()) { return false; }
  9560. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9561. // and an IDNA label may not have one
  9562. const auto &leftmost = pattern_components.front();
  9563. if (leftmost.find('*') != std::string::npos &&
  9564. (pattern_components.size() < 3 ||
  9565. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9566. return false;
  9567. }
  9568. // Compare each component with wildcard support
  9569. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9570. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9571. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9572. auto itr = pattern_components.begin();
  9573. for (const auto &h : host_components) {
  9574. auto &p = *itr;
  9575. auto is_leftmost = itr == pattern_components.begin();
  9576. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9577. bool partial_match = false;
  9578. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9579. const auto prefix_length = p.size() - 1;
  9580. if (prefix_length == 0) {
  9581. partial_match = true;
  9582. } else if (h.size() >= prefix_length) {
  9583. partial_match =
  9584. std::equal(p.begin(),
  9585. p.begin() + static_cast<std::string::difference_type>(
  9586. prefix_length),
  9587. h.begin(), [](const char ca, const char cb) {
  9588. return detail::case_ignore::to_lower(ca) ==
  9589. detail::case_ignore::to_lower(cb);
  9590. });
  9591. }
  9592. }
  9593. if (!partial_match) { return false; }
  9594. }
  9595. ++itr;
  9596. }
  9597. return true;
  9598. }
  9599. #ifdef _WIN32
  9600. // Verify certificate using Windows CertGetCertificateChain API.
  9601. // This provides real-time certificate validation with Windows Update
  9602. // integration, independent of the TLS backend.
  9603. inline bool verify_cert_with_windows_schannel(
  9604. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9605. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9606. if (der_cert.empty()) { return false; }
  9607. out_error = 0;
  9608. // Create Windows certificate context from DER data
  9609. auto cert_context = CertCreateCertificateContext(
  9610. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9611. static_cast<DWORD>(der_cert.size()));
  9612. if (!cert_context) {
  9613. out_error = GetLastError();
  9614. return false;
  9615. }
  9616. auto cert_guard =
  9617. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9618. // Give CryptoAPI the certificates the server sent. Without them it follows
  9619. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9620. std::vector<tls::cert_t> peer_certs;
  9621. tls::get_peer_certs(session, peer_certs);
  9622. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9623. auto store_guard = scope_exit([&] {
  9624. for (auto cert : peer_certs) {
  9625. tls::free_cert(cert);
  9626. }
  9627. if (store) { CertCloseStore(store, 0); }
  9628. });
  9629. for (auto cert : peer_certs) {
  9630. std::vector<unsigned char> der;
  9631. if (store && tls::get_cert_der(cert, der)) {
  9632. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9633. static_cast<DWORD>(der.size()),
  9634. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9635. }
  9636. }
  9637. // Setup chain parameters
  9638. CERT_CHAIN_PARA chain_para = {};
  9639. chain_para.cbSize = sizeof(chain_para);
  9640. // Require the server authentication usage along the chain, which also
  9641. // rejects roots that Windows trusts only for other purposes.
  9642. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9643. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9644. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9645. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9646. // Build certificate chain with revocation checking
  9647. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9648. auto chain_result = CertGetCertificateChain(
  9649. nullptr, cert_context, nullptr, store, &chain_para,
  9650. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9651. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9652. nullptr, &chain_context);
  9653. if (!chain_result || !chain_context) {
  9654. out_error = GetLastError();
  9655. return false;
  9656. }
  9657. auto chain_guard =
  9658. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9659. // Verify SSL policy
  9660. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9661. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9662. #ifdef AUTHTYPE_SERVER
  9663. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9664. #endif
  9665. std::wstring whost;
  9666. if (verify_hostname) {
  9667. whost = u8string_to_wstring(hostname.c_str());
  9668. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9669. }
  9670. CERT_CHAIN_POLICY_PARA policy_para = {};
  9671. policy_para.cbSize = sizeof(policy_para);
  9672. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9673. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9674. #else
  9675. policy_para.dwFlags = 0;
  9676. #endif
  9677. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9678. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9679. policy_status.cbSize = sizeof(policy_status);
  9680. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9681. &policy_para, &policy_status)) {
  9682. out_error = GetLastError();
  9683. return false;
  9684. }
  9685. if (policy_status.dwError != 0) {
  9686. out_error = policy_status.dwError;
  9687. return false;
  9688. }
  9689. return true;
  9690. }
  9691. #endif // _WIN32
  9692. // Loads CA file/dir configuration and applies the system CA policy to a
  9693. // client TLS context. PEM data and native stores are applied to the context
  9694. // directly at set time; has_custom_store reflects them for the Auto policy
  9695. // decision.
  9696. inline bool load_client_ca_config(tls::ctx_t ctx,
  9697. const std::string &ca_cert_file_path,
  9698. const std::string &ca_cert_dir_path,
  9699. bool has_custom_store, SystemCAMode mode,
  9700. uint64_t &backend_error) {
  9701. auto ret = true;
  9702. if (!ca_cert_file_path.empty()) {
  9703. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9704. backend_error = tls::get_error();
  9705. ret = false;
  9706. }
  9707. } else if (!ca_cert_dir_path.empty()) {
  9708. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9709. backend_error = tls::get_error();
  9710. ret = false;
  9711. }
  9712. }
  9713. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9714. !ca_cert_dir_path.empty() || has_custom_store;
  9715. if (mode == SystemCAMode::Enabled ||
  9716. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9717. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9718. }
  9719. return ret;
  9720. }
  9721. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9722. // loaded into another context.
  9723. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9724. std::string pem;
  9725. std::vector<tls::cert_t> certs;
  9726. tls::get_ca_certs(ctx, certs);
  9727. for (auto cert : certs) {
  9728. std::vector<unsigned char> der;
  9729. if (tls::get_cert_der(cert, der)) {
  9730. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9731. pem += "-----BEGIN CERTIFICATE-----\n";
  9732. for (size_t i = 0; i < b64.size(); i += 64) {
  9733. pem += b64.substr(i, 64);
  9734. pem += '\n';
  9735. }
  9736. pem += "-----END CERTIFICATE-----\n";
  9737. }
  9738. tls::free_cert(cert);
  9739. }
  9740. return pem;
  9741. }
  9742. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9743. // copied to buf, or pem itself when len is 0.
  9744. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9745. if (!pem || len == 0) { return pem; }
  9746. buf.assign(pem, len);
  9747. return buf.c_str();
  9748. }
  9749. // The parts of session setup that only SSLClient needs, plus the handful
  9750. // WebSocketClient also exposes; everything else takes the defaults, which is
  9751. // what keeps the two clients on one implementation.
  9752. struct ClientTlsSessionOptions {
  9753. // Both SSLClient and WebSocketClient expose this independently of
  9754. // certificate verification.
  9755. bool server_hostname_verification = true;
  9756. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9757. // When set, ends the handshake as a timeout does once it returns true
  9758. std::function<bool()> interrupted;
  9759. // When non-null, guards session creation against concurrent use of the
  9760. // context. A WebSocketClient is not safe to use from several threads to
  9761. // begin with, so it passes nothing.
  9762. std::mutex *ctx_mutex = nullptr;
  9763. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9764. // The caller decides whether Schannel has anything to say about this
  9765. // connection; see SSLClient::initialize_ssl().
  9766. bool windows_cert_verification = false;
  9767. // A server certificate verifier works on the backend's chain verification,
  9768. // so the backend keeps deciding and Schannel only adds its own check.
  9769. bool server_certificate_verifier_set = false;
  9770. #endif
  9771. };
  9772. // Filled in on failure for callers that report error details.
  9773. struct ClientTlsSessionError {
  9774. Error error = Error::Success;
  9775. int ssl_error = 0;
  9776. uint64_t backend_error = 0;
  9777. };
  9778. // Establishes a client TLS session on an already connected socket. On failure
  9779. // the session is left for the caller to free: SSLClient frees it right away,
  9780. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9781. inline bool setup_client_tls_session(
  9782. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9783. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9784. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9785. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9786. using namespace tls;
  9787. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9788. if (out_error) {
  9789. out_error->error = error;
  9790. out_error->ssl_error = ssl_error;
  9791. out_error->backend_error = backend_error;
  9792. }
  9793. return false;
  9794. };
  9795. // A TLS failure, whose verification codes name the Error too
  9796. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9797. auto error = Error::SSLConnection;
  9798. if (code == ErrorCode::CertVerifyFailed) {
  9799. error = Error::SSLServerVerification;
  9800. } else if (code == ErrorCode::HostnameMismatch) {
  9801. error = Error::SSLServerHostnameVerification;
  9802. }
  9803. return fail(error, static_cast<int>(code), backend_error);
  9804. };
  9805. if (!ctx) {
  9806. session = nullptr;
  9807. return fail(Error::SSLConnection, 0, 0);
  9808. }
  9809. // With Windows verification on and no server certificate verifier set,
  9810. // Schannel is the only chain verifier. The backend's trust store is a
  9811. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9812. // demand, so the backend's verdict is not used.
  9813. auto windows_verifies_chain = false;
  9814. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9815. windows_verifies_chain = options.windows_cert_verification &&
  9816. !options.server_certificate_verifier_set;
  9817. #endif
  9818. // The chain, and a host name, are verified during the handshake, so that a
  9819. // server failing them never gets to see a client certificate. Unless
  9820. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9821. // identity is checked after the handshake by verify_hostname().
  9822. auto verify_in_handshake =
  9823. server_certificate_verification && !windows_verifies_chain;
  9824. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9825. // A session verifier may accept a certificate the built-in check rejects,
  9826. // and runs only after the handshake
  9827. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9828. #endif
  9829. {
  9830. std::unique_lock<std::mutex> guard;
  9831. if (options.ctx_mutex) {
  9832. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9833. }
  9834. // The mode is set on the context, so under the same lock
  9835. set_verify_client(ctx, verify_in_handshake);
  9836. session = create_session(ctx, sock);
  9837. }
  9838. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9839. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9840. // their identity is checked post-handshake below instead.
  9841. if (!is_ip_address(host)) {
  9842. if (!set_sni(session, host.c_str(),
  9843. verify_in_handshake && options.server_hostname_verification)) {
  9844. return fail(Error::SSLConnection, 0, get_error());
  9845. }
  9846. }
  9847. TlsError tls_err;
  9848. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec, &tls_err,
  9849. options.interrupted)) {
  9850. return fail_tls(tls_err.code, tls_err.backend_code);
  9851. }
  9852. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9853. if (options.session_verifier) {
  9854. verification_status = options.session_verifier(session);
  9855. }
  9856. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9857. return fail(Error::SSLServerVerification, 0, get_error());
  9858. }
  9859. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9860. server_certificate_verification) {
  9861. if (!windows_verifies_chain) {
  9862. auto verify_result = get_verify_result(session);
  9863. if (verify_result != 0) {
  9864. return fail_tls(ErrorCode::CertVerifyFailed,
  9865. static_cast<uint64_t>(verify_result));
  9866. }
  9867. }
  9868. auto server_cert = get_peer_cert(session);
  9869. if (!server_cert) {
  9870. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9871. }
  9872. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9873. // Identity check against the peer certificate, post-handshake for all
  9874. // backends. For IP hosts this is the only identity verification, since no
  9875. // hostname is bound during the handshake.
  9876. if (options.server_hostname_verification) {
  9877. if (!verify_hostname(server_cert, host.c_str())) {
  9878. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9879. }
  9880. }
  9881. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9882. // Windows Schannel verification, which lets Windows fetch missing roots
  9883. // and intermediates on demand. It must not be skipped: unless a server
  9884. // certificate verifier is set, it is the only chain check.
  9885. if (options.windows_cert_verification) {
  9886. std::vector<unsigned char> der;
  9887. uint64_t wincrypt_error = 0;
  9888. if (!get_cert_der(server_cert, der) ||
  9889. !verify_cert_with_windows_schannel(
  9890. der, host, options.server_hostname_verification, wincrypt_error,
  9891. session)) {
  9892. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9893. }
  9894. }
  9895. #endif
  9896. }
  9897. return true;
  9898. }
  9899. } // namespace detail
  9900. #endif // CPPHTTPLIB_SSL_ENABLED
  9901. /*
  9902. * Group 3: httplib namespace - Non-SSL public API implementations
  9903. */
  9904. inline void default_socket_options(socket_t sock) {
  9905. set_socket_opt(sock, SOL_SOCKET,
  9906. #ifdef SO_REUSEPORT
  9907. SO_REUSEPORT,
  9908. #else
  9909. SO_REUSEADDR,
  9910. #endif
  9911. 1);
  9912. }
  9913. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9914. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9915. sizeof(optval));
  9916. }
  9917. inline std::string get_bearer_token_auth(const Request &req) {
  9918. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9919. // than the prefix carries no token.
  9920. constexpr const char bearer_prefix[] = "Bearer ";
  9921. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9922. auto value = req.get_header_value("Authorization");
  9923. if (value.size() >= bearer_prefix_len &&
  9924. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9925. bearer_prefix)) {
  9926. return value.substr(bearer_prefix_len);
  9927. }
  9928. return "";
  9929. }
  9930. inline const char *status_message(int status) {
  9931. switch (status) {
  9932. case StatusCode::Continue_100: return "Continue";
  9933. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9934. case StatusCode::Processing_102: return "Processing";
  9935. case StatusCode::EarlyHints_103: return "Early Hints";
  9936. case StatusCode::OK_200: return "OK";
  9937. case StatusCode::Created_201: return "Created";
  9938. case StatusCode::Accepted_202: return "Accepted";
  9939. case StatusCode::NonAuthoritativeInformation_203:
  9940. return "Non-Authoritative Information";
  9941. case StatusCode::NoContent_204: return "No Content";
  9942. case StatusCode::ResetContent_205: return "Reset Content";
  9943. case StatusCode::PartialContent_206: return "Partial Content";
  9944. case StatusCode::MultiStatus_207: return "Multi-Status";
  9945. case StatusCode::AlreadyReported_208: return "Already Reported";
  9946. case StatusCode::IMUsed_226: return "IM Used";
  9947. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9948. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9949. case StatusCode::Found_302: return "Found";
  9950. case StatusCode::SeeOther_303: return "See Other";
  9951. case StatusCode::NotModified_304: return "Not Modified";
  9952. case StatusCode::UseProxy_305: return "Use Proxy";
  9953. case StatusCode::unused_306: return "unused";
  9954. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9955. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9956. case StatusCode::BadRequest_400: return "Bad Request";
  9957. case StatusCode::Unauthorized_401: return "Unauthorized";
  9958. case StatusCode::PaymentRequired_402: return "Payment Required";
  9959. case StatusCode::Forbidden_403: return "Forbidden";
  9960. case StatusCode::NotFound_404: return "Not Found";
  9961. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9962. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9963. case StatusCode::ProxyAuthenticationRequired_407:
  9964. return "Proxy Authentication Required";
  9965. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9966. case StatusCode::Conflict_409: return "Conflict";
  9967. case StatusCode::Gone_410: return "Gone";
  9968. case StatusCode::LengthRequired_411: return "Length Required";
  9969. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9970. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9971. case StatusCode::UriTooLong_414: return "URI Too Long";
  9972. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9973. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9974. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9975. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9976. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9977. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9978. case StatusCode::Locked_423: return "Locked";
  9979. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9980. case StatusCode::TooEarly_425: return "Too Early";
  9981. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9982. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9983. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9984. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9985. return "Request Header Fields Too Large";
  9986. case StatusCode::UnavailableForLegalReasons_451:
  9987. return "Unavailable For Legal Reasons";
  9988. case StatusCode::NotImplemented_501: return "Not Implemented";
  9989. case StatusCode::BadGateway_502: return "Bad Gateway";
  9990. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9991. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9992. case StatusCode::HttpVersionNotSupported_505:
  9993. return "HTTP Version Not Supported";
  9994. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9995. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9996. case StatusCode::LoopDetected_508: return "Loop Detected";
  9997. case StatusCode::NotExtended_510: return "Not Extended";
  9998. case StatusCode::NetworkAuthenticationRequired_511:
  9999. return "Network Authentication Required";
  10000. default:
  10001. case StatusCode::InternalServerError_500: return "Internal Server Error";
  10002. }
  10003. }
  10004. inline std::string to_string(const Error error) {
  10005. switch (error) {
  10006. case Error::Success: return "Success (no error)";
  10007. case Error::Unknown: return "Unknown";
  10008. case Error::Connection: return "Could not establish connection";
  10009. case Error::BindIPAddress: return "Failed to bind IP address";
  10010. case Error::Read: return "Failed to read connection";
  10011. case Error::Write: return "Failed to write connection";
  10012. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  10013. case Error::Canceled: return "Connection handling canceled";
  10014. case Error::SSLConnection: return "SSL connection failed";
  10015. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  10016. case Error::SSLServerVerification: return "SSL server verification failed";
  10017. case Error::SSLServerHostnameVerification:
  10018. return "SSL server hostname verification failed";
  10019. case Error::UnsupportedMultipartBoundaryChars:
  10020. return "Unsupported HTTP multipart boundary characters";
  10021. case Error::Compression: return "Compression failed";
  10022. case Error::ConnectionTimeout: return "Connection timed out";
  10023. case Error::ProxyConnection: return "Proxy connection failed";
  10024. case Error::ConnectionClosed: return "Connection closed by server";
  10025. case Error::Timeout: return "Read timeout";
  10026. case Error::ResourceExhaustion: return "Resource exhaustion";
  10027. case Error::TooManyFormDataFiles: return "Too many form data files";
  10028. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  10029. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  10030. case Error::ExceedMaxSocketDescriptorCount:
  10031. return "Exceeded maximum socket descriptor count";
  10032. case Error::InvalidRequestLine: return "Invalid request line";
  10033. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  10034. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  10035. case Error::InvalidHeaders: return "Invalid headers";
  10036. case Error::MultipartParsing: return "Multipart parsing failed";
  10037. case Error::OpenFile: return "Failed to open file";
  10038. case Error::Listen: return "Failed to listen on socket";
  10039. case Error::GetSockName: return "Failed to get socket name";
  10040. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  10041. case Error::HTTPParsing: return "HTTP parsing failed";
  10042. case Error::InvalidRangeHeader: return "Invalid Range header";
  10043. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  10044. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  10045. case Error::UserCallbackException: return "User callback threw an exception";
  10046. default: break;
  10047. }
  10048. return "Invalid";
  10049. }
  10050. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  10051. os << to_string(obj);
  10052. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  10053. return os;
  10054. }
  10055. inline std::string hosted_at(const std::string &hostname) {
  10056. std::vector<std::string> addrs;
  10057. hosted_at(hostname, addrs);
  10058. if (addrs.empty()) { return std::string(); }
  10059. return addrs[0];
  10060. }
  10061. inline void hosted_at(const std::string &hostname,
  10062. std::vector<std::string> &addrs) {
  10063. struct addrinfo hints;
  10064. struct addrinfo *result;
  10065. memset(&hints, 0, sizeof(struct addrinfo));
  10066. hints.ai_family = AF_UNSPEC;
  10067. hints.ai_socktype = SOCK_STREAM;
  10068. hints.ai_protocol = 0;
  10069. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  10070. &result, 0)) {
  10071. #if defined __linux__ && !defined __ANDROID__
  10072. res_init();
  10073. #endif
  10074. return;
  10075. }
  10076. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  10077. for (auto rp = result; rp; rp = rp->ai_next) {
  10078. const auto &addr =
  10079. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  10080. std::string ip;
  10081. auto dummy = -1;
  10082. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  10083. dummy)) {
  10084. addrs.emplace_back(std::move(ip));
  10085. }
  10086. }
  10087. }
  10088. inline std::string encode_uri_component(const std::string &value) {
  10089. std::ostringstream escaped;
  10090. escaped.fill('0');
  10091. escaped << std::hex;
  10092. for (auto c : value) {
  10093. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10094. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  10095. escaped << c;
  10096. } else {
  10097. escaped << std::uppercase;
  10098. escaped << '%' << std::setw(2)
  10099. << static_cast<int>(static_cast<unsigned char>(c));
  10100. escaped << std::nouppercase;
  10101. }
  10102. }
  10103. return escaped.str();
  10104. }
  10105. inline std::string encode_uri(const std::string &value) {
  10106. std::ostringstream escaped;
  10107. escaped.fill('0');
  10108. escaped << std::hex;
  10109. for (auto c : value) {
  10110. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10111. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  10112. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  10113. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  10114. escaped << c;
  10115. } else {
  10116. escaped << std::uppercase;
  10117. escaped << '%' << std::setw(2)
  10118. << static_cast<int>(static_cast<unsigned char>(c));
  10119. escaped << std::nouppercase;
  10120. }
  10121. }
  10122. return escaped.str();
  10123. }
  10124. inline std::string decode_uri_component(const std::string &value) {
  10125. std::string result;
  10126. for (size_t i = 0; i < value.size(); i++) {
  10127. if (value[i] == '%' && i + 2 < value.size()) {
  10128. auto val = 0;
  10129. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10130. result += static_cast<char>(val);
  10131. i += 2;
  10132. } else {
  10133. result += value[i];
  10134. }
  10135. } else {
  10136. result += value[i];
  10137. }
  10138. }
  10139. return result;
  10140. }
  10141. inline std::string decode_uri(const std::string &value) {
  10142. std::string result;
  10143. for (size_t i = 0; i < value.size(); i++) {
  10144. if (value[i] == '%' && i + 2 < value.size()) {
  10145. auto val = 0;
  10146. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10147. auto c = static_cast<char>(val);
  10148. // Keep escapes of the reserved characters that encode_uri leaves
  10149. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10150. // delimiter is not promoted into a real one (as with JS decodeURI).
  10151. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10152. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10153. c == '#') {
  10154. result += value[i];
  10155. result += value[i + 1];
  10156. result += value[i + 2];
  10157. } else {
  10158. result += c;
  10159. }
  10160. i += 2;
  10161. } else {
  10162. result += value[i];
  10163. }
  10164. } else {
  10165. result += value[i];
  10166. }
  10167. }
  10168. return result;
  10169. }
  10170. inline std::string encode_path_component(const std::string &component) {
  10171. std::string result;
  10172. result.reserve(component.size() * 3);
  10173. for (size_t i = 0; i < component.size(); i++) {
  10174. auto c = static_cast<unsigned char>(component[i]);
  10175. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10176. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10177. c == '_' || c == '~') {
  10178. result += static_cast<char>(c);
  10179. }
  10180. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10181. // "," / ";" / "="
  10182. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10183. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10184. c == '=') {
  10185. result += static_cast<char>(c);
  10186. }
  10187. // Colon is allowed in path segments except first segment
  10188. else if (c == ':') {
  10189. result += static_cast<char>(c);
  10190. }
  10191. // @ is allowed in path
  10192. else if (c == '@') {
  10193. result += static_cast<char>(c);
  10194. } else {
  10195. result += '%';
  10196. char hex[3];
  10197. snprintf(hex, sizeof(hex), "%02X", c);
  10198. result.append(hex, 2);
  10199. }
  10200. }
  10201. return result;
  10202. }
  10203. inline std::string decode_path_component(const std::string &component) {
  10204. std::string result;
  10205. result.reserve(component.size());
  10206. for (size_t i = 0; i < component.size(); i++) {
  10207. if (component[i] == '%' && i + 1 < component.size()) {
  10208. if (component[i + 1] == 'u') {
  10209. // Unicode %uXXXX encoding
  10210. auto val = 0;
  10211. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10212. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10213. char buff[4];
  10214. size_t len = 0;
  10215. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10216. (len = detail::to_utf8(val, buff)) > 0) {
  10217. result.append(buff, len);
  10218. i += 5; // 'u0000'
  10219. } else {
  10220. // Not 4 hex digits, or a surrogate, which is no character: the
  10221. // escape is kept as it is rather than joining its neighbours
  10222. result += component[i];
  10223. }
  10224. } else {
  10225. // Standard %XX encoding
  10226. auto val = 0;
  10227. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10228. // 2 digits hex codes
  10229. result += static_cast<char>(val);
  10230. i += 2; // 'XX'
  10231. } else {
  10232. result += component[i];
  10233. }
  10234. }
  10235. } else {
  10236. result += component[i];
  10237. }
  10238. }
  10239. return result;
  10240. }
  10241. inline std::string encode_query_component(const std::string &component,
  10242. bool space_as_plus) {
  10243. std::string result;
  10244. result.reserve(component.size() * 3);
  10245. for (size_t i = 0; i < component.size(); i++) {
  10246. auto c = static_cast<unsigned char>(component[i]);
  10247. // Unreserved characters per RFC 3986
  10248. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10249. c == '_' || c == '~') {
  10250. result += static_cast<char>(c);
  10251. }
  10252. // Space handling
  10253. else if (c == ' ') {
  10254. if (space_as_plus) {
  10255. result += '+';
  10256. } else {
  10257. result += "%20";
  10258. }
  10259. }
  10260. // Plus sign handling
  10261. else if (c == '+') {
  10262. if (space_as_plus) {
  10263. result += "%2B";
  10264. } else {
  10265. result += static_cast<char>(c);
  10266. }
  10267. }
  10268. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10269. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10270. c == '*' || c == ',' || c == ';') {
  10271. result += static_cast<char>(c);
  10272. }
  10273. // Colon and @ are allowed in query
  10274. else if (c == ':' || c == '@') {
  10275. result += static_cast<char>(c);
  10276. }
  10277. // Forward slash is allowed in query values
  10278. else if (c == '/') {
  10279. result += static_cast<char>(c);
  10280. }
  10281. // Question mark is allowed in query values (after first ?)
  10282. else if (c == '?') {
  10283. result += static_cast<char>(c);
  10284. } else {
  10285. result += '%';
  10286. char hex[3];
  10287. snprintf(hex, sizeof(hex), "%02X", c);
  10288. result.append(hex, 2);
  10289. }
  10290. }
  10291. return result;
  10292. }
  10293. inline std::string decode_query_component(const std::string &component,
  10294. bool plus_as_space) {
  10295. std::string result;
  10296. result.reserve(component.size());
  10297. for (size_t i = 0; i < component.size(); i++) {
  10298. if (component[i] == '%' && i + 2 < component.size()) {
  10299. auto val = 0;
  10300. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10301. result += static_cast<char>(val);
  10302. i += 2;
  10303. } else {
  10304. result += component[i];
  10305. }
  10306. } else if (component[i] == '+' && plus_as_space) {
  10307. result += ' '; // + becomes space in form-urlencoded
  10308. } else {
  10309. result += component[i];
  10310. }
  10311. }
  10312. return result;
  10313. }
  10314. inline std::string sanitize_filename(const std::string &filename) {
  10315. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10316. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10317. #ifdef _WIN32
  10318. auto pos = filename.find_last_of("/\\:");
  10319. #else
  10320. auto pos = filename.find_last_of("/\\");
  10321. #endif
  10322. auto result =
  10323. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10324. // Strip null bytes
  10325. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10326. // Trim whitespace
  10327. {
  10328. auto start = result.find_first_not_of(" \t");
  10329. auto end = result.find_last_not_of(" \t");
  10330. result = (start == std::string::npos)
  10331. ? ""
  10332. : result.substr(start, end - start + 1);
  10333. }
  10334. // Reject . and ..
  10335. if (result == "." || result == "..") { return ""; }
  10336. return result;
  10337. }
  10338. inline std::string append_query_params(const std::string &path,
  10339. const Params &params) {
  10340. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10341. auto fragment_pos = path.find('#');
  10342. auto path_with_query = path.substr(0, fragment_pos);
  10343. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10344. path_with_query += detail::params_to_query_str(params);
  10345. if (fragment_pos != std::string::npos) {
  10346. path_with_query.append(path, fragment_pos, std::string::npos);
  10347. }
  10348. return path_with_query;
  10349. }
  10350. // Header utilities
  10351. inline std::pair<std::string, std::string>
  10352. make_range_header(const Ranges &ranges) {
  10353. std::string field = "bytes=";
  10354. auto i = 0;
  10355. for (const auto &r : ranges) {
  10356. if (i != 0) { field += ", "; }
  10357. if (r.first != -1) { field += std::to_string(r.first); }
  10358. field += '-';
  10359. if (r.second != -1) { field += std::to_string(r.second); }
  10360. i++;
  10361. }
  10362. return std::make_pair("Range", std::move(field));
  10363. }
  10364. inline std::pair<std::string, std::string>
  10365. make_basic_authentication_header(const std::string &username,
  10366. const std::string &password, bool is_proxy) {
  10367. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10368. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10369. return std::make_pair(key, std::move(field));
  10370. }
  10371. inline std::pair<std::string, std::string>
  10372. make_bearer_token_authentication_header(const std::string &token,
  10373. bool is_proxy = false) {
  10374. auto field = "Bearer " + token;
  10375. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10376. return std::make_pair(key, std::move(field));
  10377. }
  10378. namespace detail {
  10379. // Basic auth when a username or password is set, otherwise a bearer token,
  10380. // unless the request already carries the header.
  10381. inline void add_authorization_header(Request &req, const std::string &username,
  10382. const std::string &password,
  10383. const std::string &token, bool is_proxy) {
  10384. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10385. return;
  10386. }
  10387. if (!username.empty() || !password.empty()) {
  10388. req.headers.insert(
  10389. make_basic_authentication_header(username, password, is_proxy));
  10390. } else if (!token.empty()) {
  10391. req.headers.insert(
  10392. make_bearer_token_authentication_header(token, is_proxy));
  10393. }
  10394. }
  10395. } // namespace detail
  10396. // Request implementation
  10397. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10398. size_t id) const {
  10399. return detail::get_header_value_u64(headers, key, def, id);
  10400. }
  10401. inline bool Request::has_header(const std::string &key) const {
  10402. return detail::has_header(headers, key);
  10403. }
  10404. inline std::string Request::get_header_value(const std::string &key,
  10405. const char *def, size_t id) const {
  10406. return detail::get_header_value(headers, key, def, id);
  10407. }
  10408. inline size_t Request::get_header_value_count(const std::string &key) const {
  10409. return detail::get_header_value_count(headers, key);
  10410. }
  10411. inline void Request::set_header(const std::string &key,
  10412. const std::string &val) {
  10413. detail::set_header(headers, key, val);
  10414. }
  10415. inline bool Request::has_trailer(const std::string &key) const {
  10416. return trailers.find(key) != trailers.end();
  10417. }
  10418. inline std::string Request::get_trailer_value(const std::string &key,
  10419. size_t id) const {
  10420. return detail::get_multimap_value(trailers, key, id);
  10421. }
  10422. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10423. return trailers.count(key);
  10424. }
  10425. inline bool Request::has_param(const std::string &key) const {
  10426. return params.find(key) != params.end();
  10427. }
  10428. inline std::string Request::get_param_value(const std::string &key,
  10429. size_t id) const {
  10430. return detail::get_multimap_value(params, key, id);
  10431. }
  10432. inline std::vector<std::string>
  10433. Request::get_param_values(const std::string &key) const {
  10434. auto rng = params.equal_range(key);
  10435. std::vector<std::string> values;
  10436. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10437. for (auto it = rng.first; it != rng.second; ++it) {
  10438. values.push_back(it->second);
  10439. }
  10440. return values;
  10441. }
  10442. inline size_t Request::get_param_value_count(const std::string &key) const {
  10443. return params.count(key);
  10444. }
  10445. inline bool Request::is_multipart_form_data() const {
  10446. const auto &content_type = get_header_value("Content-Type");
  10447. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10448. "multipart/form-data");
  10449. }
  10450. // Multipart FormData implementation
  10451. inline std::string MultipartFormData::get_field(const std::string &key,
  10452. size_t id) const {
  10453. auto rng = fields.equal_range(key);
  10454. auto it = detail::bounded_next(rng.first, id, rng.second);
  10455. if (it != rng.second) { return it->second.content; }
  10456. return std::string();
  10457. }
  10458. inline std::vector<std::string>
  10459. MultipartFormData::get_fields(const std::string &key) const {
  10460. std::vector<std::string> values;
  10461. auto rng = fields.equal_range(key);
  10462. for (auto it = rng.first; it != rng.second; it++) {
  10463. values.push_back(it->second.content);
  10464. }
  10465. return values;
  10466. }
  10467. inline bool MultipartFormData::has_field(const std::string &key) const {
  10468. return fields.find(key) != fields.end();
  10469. }
  10470. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10471. return fields.count(key);
  10472. }
  10473. inline FormData MultipartFormData::get_file(const std::string &key,
  10474. size_t id) const {
  10475. return detail::get_multimap_value(files, key, id);
  10476. }
  10477. inline std::vector<FormData>
  10478. MultipartFormData::get_files(const std::string &key) const {
  10479. std::vector<FormData> values;
  10480. auto rng = files.equal_range(key);
  10481. for (auto it = rng.first; it != rng.second; it++) {
  10482. values.push_back(it->second);
  10483. }
  10484. return values;
  10485. }
  10486. inline bool MultipartFormData::has_file(const std::string &key) const {
  10487. return files.find(key) != files.end();
  10488. }
  10489. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10490. return files.count(key);
  10491. }
  10492. // Multipart FormData writer implementation
  10493. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10494. return detail::is_multipart_boundary_chars_valid(boundary);
  10495. }
  10496. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10497. : boundary_(detail::make_multipart_data_boundary()) {}
  10498. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10499. : boundary_(std::move(boundary)) {}
  10500. inline const std::string &MultipartFormDataWriter::boundary() const {
  10501. return boundary_;
  10502. }
  10503. inline std::string MultipartFormDataWriter::content_type() const {
  10504. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10505. }
  10506. inline std::string
  10507. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10508. return detail::serialize_multipart_formdata(items, boundary_);
  10509. }
  10510. inline size_t MultipartFormDataWriter::content_length(
  10511. const UploadFormDataItems &items) const {
  10512. return detail::get_multipart_content_length(items, boundary_);
  10513. }
  10514. inline std::string
  10515. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10516. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10517. }
  10518. inline std::string MultipartFormDataWriter::item_end() {
  10519. return detail::serialize_multipart_formdata_item_end();
  10520. }
  10521. inline std::string MultipartFormDataWriter::finish() const {
  10522. return detail::serialize_multipart_formdata_finish(boundary_);
  10523. }
  10524. // Response implementation
  10525. namespace detail {
  10526. // A response has one content source: `body`, a content provider, or a file.
  10527. // Each content setter calls this so that the one called last wins.
  10528. inline void clear_content_provider(Response &res) {
  10529. auto releaser = std::move(res.content_provider_resource_releaser_);
  10530. auto success = res.content_provider_success_;
  10531. res.content_length_ = 0;
  10532. res.content_provider_ = nullptr;
  10533. res.content_provider_resource_releaser_ = nullptr;
  10534. res.is_chunked_content_provider_ = false;
  10535. res.is_file_content_provider_ = false;
  10536. res.content_provider_success_ = false;
  10537. res.content_coding_ = EncodingType::None;
  10538. res.file_content_path_.clear();
  10539. res.file_content_content_type_.clear();
  10540. if (releaser) { releaser(success); }
  10541. }
  10542. inline void clear_content(Response &res) {
  10543. res.body.clear();
  10544. clear_content_provider(res);
  10545. }
  10546. // The Content-Type of the old content goes with it.
  10547. inline void set_content_type(Response &res, const std::string &content_type) {
  10548. res.headers.erase("Content-Type");
  10549. res.set_header("Content-Type", content_type);
  10550. }
  10551. // `body` is public, so it can be assigned directly after a provider or a file
  10552. // was set. It came last, so it wins.
  10553. inline void prefer_assigned_body(Response &res) {
  10554. if (!res.body.empty() &&
  10555. (res.content_provider_ || !res.file_content_path_.empty())) {
  10556. clear_content_provider(res);
  10557. }
  10558. }
  10559. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10560. inline bool body_allowed_for_status(int status) {
  10561. return status >= 200 && status != StatusCode::NoContent_204 &&
  10562. status != StatusCode::NotModified_304;
  10563. }
  10564. // Only a 206 response is served as a partial representation. range_error()
  10565. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10566. // status would start from an unchecked offset.
  10567. inline bool is_partial_content(const Request &req, const Response &res) {
  10568. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10569. }
  10570. // Sets the Content-Length or Transfer-Encoding framing the body that
  10571. // Server::write_response_core() writes, or closes the connection after a body
  10572. // that has neither. Only the library sets them: one from a handler would go
  10573. // out next to it, or describe some other body.
  10574. inline void set_framing_headers(const Request &req, Response &res,
  10575. const std::string &boundary,
  10576. const std::string &content_type) {
  10577. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10578. auto head_length = req.method == "HEAD"
  10579. ? res.get_header_value("Content-Length")
  10580. : std::string();
  10581. res.headers.erase("Content-Length");
  10582. res.headers.erase("Transfer-Encoding");
  10583. if (!body_allowed_for_status(res.status)) { return; }
  10584. if (res.content_provider_) {
  10585. if (res.content_length_ == 0) {
  10586. if (res.is_chunked_content_provider_) {
  10587. res.set_header("Transfer-Encoding", "chunked");
  10588. } else if (req.method != "HEAD") {
  10589. // RFC 9112 6.3: a body with neither ends where the connection does.
  10590. res.headers.erase("Keep-Alive");
  10591. if (!has_header_token(res.headers, "Connection", "close")) {
  10592. res.set_header("Connection", "close");
  10593. }
  10594. }
  10595. return;
  10596. }
  10597. // The part Server::write_content_with_provider() writes.
  10598. auto length = res.content_length_;
  10599. if (is_partial_content(req, res)) {
  10600. length = req.ranges.size() == 1
  10601. ? get_range_offset_and_length(req.ranges[0], length).second
  10602. : get_multipart_ranges_data_length(req, boundary,
  10603. content_type, length);
  10604. }
  10605. res.set_header("Content-Length", std::to_string(length));
  10606. } else if (!res.body.empty()) {
  10607. res.set_header("Content-Length", std::to_string(res.body.size()));
  10608. } else {
  10609. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10610. }
  10611. }
  10612. } // namespace detail
  10613. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10614. size_t id) const {
  10615. return detail::get_header_value_u64(headers, key, def, id);
  10616. }
  10617. inline bool Response::has_header(const std::string &key) const {
  10618. return headers.find(key) != headers.end();
  10619. }
  10620. inline std::string Response::get_header_value(const std::string &key,
  10621. const char *def,
  10622. size_t id) const {
  10623. return detail::get_header_value(headers, key, def, id);
  10624. }
  10625. inline size_t Response::get_header_value_count(const std::string &key) const {
  10626. return detail::get_header_value_count(headers, key);
  10627. }
  10628. inline void Response::set_header(const std::string &key,
  10629. const std::string &val) {
  10630. detail::set_header(headers, key, val);
  10631. }
  10632. inline bool Response::has_trailer(const std::string &key) const {
  10633. return trailers.find(key) != trailers.end();
  10634. }
  10635. inline std::string Response::get_trailer_value(const std::string &key,
  10636. size_t id) const {
  10637. return detail::get_multimap_value(trailers, key, id);
  10638. }
  10639. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10640. return trailers.count(key);
  10641. }
  10642. inline void Response::set_redirect(const std::string &url, int stat) {
  10643. if (detail::fields::is_field_value(url)) {
  10644. set_header("Location", url);
  10645. if (300 <= stat && stat < 400) {
  10646. this->status = stat;
  10647. } else {
  10648. this->status = StatusCode::Found_302;
  10649. }
  10650. }
  10651. }
  10652. inline void Response::set_content(const char *s, size_t n,
  10653. const std::string &content_type) {
  10654. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10655. detail::clear_content_provider(*this);
  10656. detail::set_content_type(*this, content_type);
  10657. }
  10658. inline void Response::set_content(const std::string &s,
  10659. const std::string &content_type) {
  10660. set_content(s.data(), s.size(), content_type);
  10661. }
  10662. inline void Response::set_content(std::string &&s,
  10663. const std::string &content_type) {
  10664. body = std::move(s);
  10665. detail::clear_content_provider(*this);
  10666. detail::set_content_type(*this, content_type);
  10667. }
  10668. inline void Response::set_content_provider(
  10669. size_t in_length, const std::string &content_type, ContentProvider provider,
  10670. ContentProviderResourceReleaser resource_releaser) {
  10671. detail::clear_content(*this);
  10672. detail::set_content_type(*this, content_type);
  10673. content_length_ = in_length;
  10674. if (in_length > 0) { content_provider_ = std::move(provider); }
  10675. content_provider_resource_releaser_ = std::move(resource_releaser);
  10676. }
  10677. inline void Response::set_content_provider(
  10678. const std::string &content_type, ContentProviderWithoutLength provider,
  10679. ContentProviderResourceReleaser resource_releaser) {
  10680. detail::clear_content(*this);
  10681. detail::set_content_type(*this, content_type);
  10682. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10683. content_provider_resource_releaser_ = std::move(resource_releaser);
  10684. }
  10685. inline void Response::set_chunked_content_provider(
  10686. const std::string &content_type, ContentProviderWithoutLength provider,
  10687. ContentProviderResourceReleaser resource_releaser) {
  10688. set_content_provider(content_type, std::move(provider),
  10689. std::move(resource_releaser));
  10690. is_chunked_content_provider_ = true;
  10691. }
  10692. inline void Response::set_file_content(const std::string &path,
  10693. const std::string &content_type) {
  10694. detail::clear_content(*this);
  10695. headers.erase("Content-Type");
  10696. file_content_path_ = path;
  10697. file_content_content_type_ = content_type;
  10698. }
  10699. inline void Response::set_file_content(const std::string &path) {
  10700. set_file_content(path, std::string());
  10701. }
  10702. // Result implementation
  10703. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10704. size_t def,
  10705. size_t id) const {
  10706. return detail::get_header_value_u64(request_headers_, key, def, id);
  10707. }
  10708. inline bool Result::has_request_header(const std::string &key) const {
  10709. return request_headers_.find(key) != request_headers_.end();
  10710. }
  10711. inline std::string Result::get_request_header_value(const std::string &key,
  10712. const char *def,
  10713. size_t id) const {
  10714. return detail::get_header_value(request_headers_, key, def, id);
  10715. }
  10716. inline size_t
  10717. Result::get_request_header_value_count(const std::string &key) const {
  10718. return request_headers_.count(key);
  10719. }
  10720. // Stream implementation
  10721. inline ssize_t Stream::write(const char *ptr) {
  10722. return write(ptr, strlen(ptr));
  10723. }
  10724. inline ssize_t Stream::write(const std::string &s) {
  10725. return write(s.data(), s.size());
  10726. }
  10727. // BodyReader implementation
  10728. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10729. if (!stream) {
  10730. last_error = Error::Connection;
  10731. return -1;
  10732. }
  10733. if (eof) { return 0; }
  10734. if (!chunked) {
  10735. // Content-Length based reading
  10736. if (has_content_length && bytes_read >= content_length) {
  10737. eof = true;
  10738. return 0;
  10739. }
  10740. auto to_read = len;
  10741. if (has_content_length) {
  10742. auto remaining = content_length - bytes_read;
  10743. to_read = (std::min)(len, remaining);
  10744. }
  10745. auto n = stream->read(buf, to_read);
  10746. // Without Content-Length the body ends when the connection closes
  10747. // (RFC 9112 §6.3); with one, an EOF here came too early
  10748. if (n < 0 || (n == 0 && has_content_length)) {
  10749. last_error = stream->get_error();
  10750. if (last_error == Error::Success) { last_error = Error::Read; }
  10751. }
  10752. if (n <= 0) {
  10753. eof = true;
  10754. return n;
  10755. }
  10756. bytes_read += static_cast<size_t>(n);
  10757. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10758. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10759. last_error = Error::ExceedMaxPayloadSize;
  10760. eof = true;
  10761. return -1;
  10762. }
  10763. return n;
  10764. }
  10765. // Chunked transfer encoding: delegate to shared decoder instance.
  10766. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10767. size_t chunk_offset = 0;
  10768. size_t chunk_total = 0;
  10769. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10770. if (n < 0) {
  10771. last_error = stream->get_error();
  10772. if (last_error == Error::Success) { last_error = Error::Read; }
  10773. eof = true;
  10774. return n;
  10775. }
  10776. if (n == 0) {
  10777. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10778. eof = true;
  10779. return 0;
  10780. }
  10781. bytes_read += static_cast<size_t>(n);
  10782. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10783. last_error = Error::ExceedMaxPayloadSize;
  10784. eof = true;
  10785. return -1;
  10786. }
  10787. return n;
  10788. }
  10789. // ThreadPool implementation
  10790. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10791. time_t idle_timeout_sec)
  10792. : base_thread_count_(n), max_queued_requests_(mqr),
  10793. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10794. shutdown_(false) {
  10795. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10796. if (max_n != 0 && max_n < n) {
  10797. std::string msg = "max_threads must be >= base_threads";
  10798. throw std::invalid_argument(msg);
  10799. }
  10800. #endif
  10801. max_thread_count_ = max_n == 0 ? n : max_n;
  10802. threads_.reserve(base_thread_count_);
  10803. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10804. try {
  10805. #endif
  10806. for (size_t i = 0; i < base_thread_count_; i++) {
  10807. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10808. }
  10809. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10810. } catch (...) {
  10811. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10812. // signal the workers we already spawned to exit and join them so the
  10813. // vector destructor does not see joinable threads (which would call
  10814. // std::terminate). Then rethrow so the caller learns of the failure.
  10815. {
  10816. std::unique_lock<std::mutex> lock(mutex_);
  10817. shutdown_ = true;
  10818. }
  10819. cond_.notify_all();
  10820. for (auto &t : threads_) {
  10821. if (t.joinable()) { t.join(); }
  10822. }
  10823. throw;
  10824. }
  10825. #endif
  10826. }
  10827. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10828. {
  10829. std::unique_lock<std::mutex> lock(mutex_);
  10830. if (shutdown_) { return false; }
  10831. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10832. return false;
  10833. }
  10834. jobs_.push_back(std::move(fn));
  10835. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10836. if (jobs_.size() > idle_thread_count_ &&
  10837. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10838. cleanup_finished_threads();
  10839. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10840. try {
  10841. #endif
  10842. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10843. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10844. } catch (const std::system_error &) {
  10845. // No thread budget left: keep the job queued for an existing worker
  10846. // instead of letting the exception escape the accept loop.
  10847. }
  10848. #endif
  10849. }
  10850. }
  10851. cond_.notify_one();
  10852. return true;
  10853. }
  10854. inline void ThreadPool::shutdown() {
  10855. {
  10856. std::unique_lock<std::mutex> lock(mutex_);
  10857. shutdown_ = true;
  10858. }
  10859. cond_.notify_all();
  10860. for (auto &t : threads_) {
  10861. if (t.joinable()) { t.join(); }
  10862. }
  10863. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10864. // with worker threads that call move_to_finished() concurrently.
  10865. std::list<std::thread> remaining_dynamic;
  10866. {
  10867. std::unique_lock<std::mutex> lock(mutex_);
  10868. remaining_dynamic = std::move(dynamic_threads_);
  10869. }
  10870. for (auto &t : remaining_dynamic) {
  10871. if (t.joinable()) { t.join(); }
  10872. }
  10873. std::unique_lock<std::mutex> lock(mutex_);
  10874. cleanup_finished_threads();
  10875. }
  10876. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10877. // Must be called with mutex_ held
  10878. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10879. if (it->get_id() == id) {
  10880. finished_threads_.push_back(std::move(*it));
  10881. dynamic_threads_.erase(it);
  10882. return;
  10883. }
  10884. }
  10885. }
  10886. inline void ThreadPool::cleanup_finished_threads() {
  10887. // Must be called with mutex_ held
  10888. for (auto &t : finished_threads_) {
  10889. if (t.joinable()) { t.join(); }
  10890. }
  10891. finished_threads_.clear();
  10892. }
  10893. inline void ThreadPool::worker(bool is_dynamic) {
  10894. for (;;) {
  10895. std::function<void()> fn;
  10896. {
  10897. std::unique_lock<std::mutex> lock(mutex_);
  10898. idle_thread_count_++;
  10899. if (is_dynamic) {
  10900. auto has_work =
  10901. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10902. [&] { return !jobs_.empty() || shutdown_; });
  10903. if (!has_work) {
  10904. // Timed out with no work - exit this dynamic thread
  10905. idle_thread_count_--;
  10906. move_to_finished(std::this_thread::get_id());
  10907. break;
  10908. }
  10909. } else {
  10910. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10911. }
  10912. idle_thread_count_--;
  10913. if (shutdown_ && jobs_.empty()) { break; }
  10914. fn = std::move(jobs_.front());
  10915. jobs_.pop_front();
  10916. }
  10917. assert(true == static_cast<bool>(fn));
  10918. fn();
  10919. }
  10920. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10921. !defined(LIBRESSL_VERSION_NUMBER)
  10922. OPENSSL_thread_stop();
  10923. #endif
  10924. }
  10925. /*
  10926. * Group 1 (continued): detail namespace - Stream implementations
  10927. */
  10928. namespace detail {
  10929. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10930. time_t timeout_sec, time_t timeout_usec,
  10931. time_t &actual_timeout_sec,
  10932. time_t &actual_timeout_usec) {
  10933. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10934. auto actual_timeout_msec =
  10935. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10936. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10937. actual_timeout_sec = actual_timeout_msec / 1000;
  10938. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10939. }
  10940. // Socket stream implementation
  10941. inline SocketStream::SocketStream(
  10942. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10943. time_t write_timeout_sec, time_t write_timeout_usec,
  10944. time_t max_timeout_msec,
  10945. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10946. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10947. read_timeout_usec_(read_timeout_usec),
  10948. write_timeout_sec_(write_timeout_sec),
  10949. write_timeout_usec_(write_timeout_usec),
  10950. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10951. read_buff_(read_buff_size_, 0) {}
  10952. inline SocketStream::~SocketStream() = default;
  10953. inline bool SocketStream::is_readable() const {
  10954. return read_buff_off_ < read_buff_content_size_;
  10955. }
  10956. inline bool SocketStream::wait_readable() const {
  10957. if (max_timeout_msec_ <= 0) {
  10958. return select_read_interruptible(sock_, read_timeout_sec_,
  10959. read_timeout_usec_, read_interrupted_) > 0;
  10960. }
  10961. time_t read_timeout_sec;
  10962. time_t read_timeout_usec;
  10963. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10964. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10965. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10966. read_interrupted_) > 0;
  10967. }
  10968. inline bool SocketStream::wait_writable() const {
  10969. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10970. }
  10971. inline bool SocketStream::ensure_readable() {
  10972. if (readable_hint_) {
  10973. readable_hint_ = false;
  10974. return true;
  10975. }
  10976. return wait_readable();
  10977. }
  10978. inline const char *SocketStream::buffered_data(size_t &size) const {
  10979. size = read_buff_content_size_ - read_buff_off_;
  10980. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10981. }
  10982. inline void SocketStream::consume_buffered(size_t size) {
  10983. assert(size <= read_buff_content_size_ - read_buff_off_);
  10984. read_buff_off_ += size;
  10985. }
  10986. inline bool SocketStream::is_peer_alive() const {
  10987. return detail::is_socket_alive(sock_);
  10988. }
  10989. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10990. #ifdef _WIN32
  10991. size =
  10992. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10993. #else
  10994. size = (std::min)(size,
  10995. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10996. #endif
  10997. if (read_buff_off_ < read_buff_content_size_) {
  10998. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10999. if (size <= remaining_size) {
  11000. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  11001. read_buff_off_ += size;
  11002. return static_cast<ssize_t>(size);
  11003. } else {
  11004. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  11005. read_buff_off_ += remaining_size;
  11006. return static_cast<ssize_t>(remaining_size);
  11007. }
  11008. }
  11009. if (!ensure_readable()) {
  11010. error_ = Error::Timeout;
  11011. return -1;
  11012. }
  11013. read_buff_off_ = 0;
  11014. read_buff_content_size_ = 0;
  11015. if (size < read_buff_size_) {
  11016. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  11017. CPPHTTPLIB_RECV_FLAGS);
  11018. if (n <= 0) {
  11019. if (n == 0) {
  11020. error_ = Error::ConnectionClosed;
  11021. } else {
  11022. error_ = Error::Read;
  11023. }
  11024. return n;
  11025. } else if (n <= static_cast<ssize_t>(size)) {
  11026. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  11027. return n;
  11028. } else {
  11029. memcpy(ptr, read_buff_.data(), size);
  11030. read_buff_off_ = size;
  11031. read_buff_content_size_ = static_cast<size_t>(n);
  11032. return static_cast<ssize_t>(size);
  11033. }
  11034. } else {
  11035. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  11036. if (n <= 0) {
  11037. if (n == 0) {
  11038. error_ = Error::ConnectionClosed;
  11039. } else {
  11040. error_ = Error::Read;
  11041. }
  11042. }
  11043. return n;
  11044. }
  11045. }
  11046. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  11047. if (!wait_writable()) { return -1; }
  11048. // Winsock's send() takes an int length, even on 64-bit Windows
  11049. #ifdef _WIN32
  11050. size =
  11051. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11052. #endif
  11053. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  11054. }
  11055. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  11056. int &port) const {
  11057. return detail::get_remote_ip_and_port(sock_, ip, port);
  11058. }
  11059. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  11060. int &port) const {
  11061. return detail::get_local_ip_and_port(sock_, ip, port);
  11062. }
  11063. inline socket_t SocketStream::socket() const { return sock_; }
  11064. inline time_t SocketStream::duration() const {
  11065. return static_cast<time_t>(
  11066. std::chrono::duration_cast<std::chrono::milliseconds>(
  11067. std::chrono::steady_clock::now() - start_time_)
  11068. .count());
  11069. }
  11070. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  11071. read_timeout_sec_ = sec;
  11072. read_timeout_usec_ = usec;
  11073. }
  11074. inline void SocketStream::set_max_timeout(time_t msec) {
  11075. max_timeout_msec_ = msec;
  11076. start_time_ = std::chrono::steady_clock::now();
  11077. }
  11078. inline void
  11079. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11080. read_interrupted_ = std::move(interrupted);
  11081. }
  11082. // Buffer stream implementation
  11083. inline bool BufferStream::is_readable() const { return true; }
  11084. inline bool BufferStream::wait_readable() const { return true; }
  11085. inline bool BufferStream::wait_writable() const { return true; }
  11086. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  11087. #if defined(_MSC_VER) && _MSC_VER < 1910
  11088. auto len_read = buffer._Copy_s(ptr, size, size, position);
  11089. #else
  11090. auto len_read = buffer.copy(ptr, size, position);
  11091. #endif
  11092. position += static_cast<size_t>(len_read);
  11093. return static_cast<ssize_t>(len_read);
  11094. }
  11095. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  11096. buffer.append(ptr, size);
  11097. return static_cast<ssize_t>(size);
  11098. }
  11099. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  11100. int & /*port*/) const {}
  11101. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  11102. int & /*port*/) const {}
  11103. inline socket_t BufferStream::socket() const { return 0; }
  11104. inline time_t BufferStream::duration() const { return 0; }
  11105. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  11106. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  11107. : MatcherBase(pattern) {
  11108. constexpr const char marker[] = "/:";
  11109. // One past the last ending position of a path param substring
  11110. std::size_t last_param_end = 0;
  11111. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11112. // Needed to ensure that parameter names are unique during matcher
  11113. // construction
  11114. // If exceptions are disabled, only last duplicate path
  11115. // parameter will be set
  11116. std::unordered_set<std::string> param_name_set;
  11117. #endif
  11118. while (true) {
  11119. const auto marker_pos = pattern.find(
  11120. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  11121. if (marker_pos == std::string::npos) { break; }
  11122. static_fragments_.push_back(
  11123. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  11124. const auto param_name_start = marker_pos + str_len(marker);
  11125. auto sep_pos = pattern.find(separator, param_name_start);
  11126. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  11127. auto param_name =
  11128. pattern.substr(param_name_start, sep_pos - param_name_start);
  11129. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11130. if (param_name_set.find(param_name) != param_name_set.cend()) {
  11131. std::string msg = "Encountered path parameter '" + param_name +
  11132. "' multiple times in route pattern '" + pattern + "'.";
  11133. throw std::invalid_argument(msg);
  11134. }
  11135. #endif
  11136. param_names_.push_back(std::move(param_name));
  11137. last_param_end = sep_pos + 1;
  11138. }
  11139. if (last_param_end < pattern.length()) {
  11140. static_fragments_.push_back(pattern.substr(last_param_end));
  11141. }
  11142. }
  11143. inline bool PathParamsMatcher::match(Request &request) const {
  11144. request.matches = std::smatch();
  11145. request.path_params.clear();
  11146. // A pattern without parameters is just a literal path to compare against
  11147. if (param_names_.empty()) { return request.path == pattern(); }
  11148. request.path_params.reserve(param_names_.size());
  11149. // One past the position at which the path matched the pattern last time
  11150. std::size_t starting_pos = 0;
  11151. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11152. const auto &fragment = static_fragments_[i];
  11153. if (starting_pos + fragment.length() > request.path.length()) {
  11154. return false;
  11155. }
  11156. // Avoid unnecessary allocation by using strncmp instead of substr +
  11157. // comparison
  11158. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11159. fragment.length()) != 0) {
  11160. return false;
  11161. }
  11162. starting_pos += fragment.length();
  11163. // Should only happen when we have a static fragment after a param
  11164. // Example: '/users/:id/subscriptions'
  11165. // The 'subscriptions' fragment here does not have a corresponding param
  11166. if (i >= param_names_.size()) { continue; }
  11167. auto sep_pos = request.path.find(separator, starting_pos);
  11168. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11169. const auto &param_name = param_names_[i];
  11170. request.path_params.emplace(
  11171. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11172. // Mark everything up to '/' as matched
  11173. starting_pos = sep_pos + 1;
  11174. }
  11175. // Returns false if the path is longer than the pattern
  11176. return starting_pos >= request.path.length();
  11177. }
  11178. inline bool RegexMatcher::match(Request &request) const {
  11179. request.path_params.clear();
  11180. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11181. // a non-match rather than risking a stack overflow in std::regex_match.
  11182. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11183. return false;
  11184. }
  11185. return std::regex_match(request.path, request.matches, regex_);
  11186. }
  11187. // Enclose IPv6 address in brackets if needed
  11188. inline std::string prepare_host_string(const std::string &host) {
  11189. // Enclose IPv6 address in brackets (but not if already enclosed)
  11190. if (host.find(':') == std::string::npos ||
  11191. (!host.empty() && host[0] == '[')) {
  11192. // IPv4, hostname, or already bracketed IPv6
  11193. return host;
  11194. } else {
  11195. // IPv6 address without brackets
  11196. return "[" + host + "]";
  11197. }
  11198. }
  11199. inline std::string make_host_and_port_string(const std::string &host, int port,
  11200. bool is_ssl) {
  11201. auto result = prepare_host_string(host);
  11202. // Append port if not default
  11203. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11204. ; // do nothing
  11205. } else {
  11206. result += ":" + std::to_string(port);
  11207. }
  11208. return result;
  11209. }
  11210. // Create "host:port" string always including port number (for CONNECT method)
  11211. inline std::string
  11212. make_host_and_port_string_always_port(const std::string &host, int port) {
  11213. return prepare_host_string(host) + ":" + std::to_string(port);
  11214. }
  11215. // Where a client connects for `host`, as one string: the mapped address or
  11216. // name, or `host` itself.
  11217. inline std::string
  11218. addr_map_target(const std::map<std::string, std::string> &addr_map,
  11219. const std::string &host) {
  11220. std::string connect_host;
  11221. std::string ip;
  11222. apply_addr_map(addr_map, host, connect_host, ip);
  11223. return ip.empty() ? connect_host : ip;
  11224. }
  11225. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11226. inline std::string
  11227. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11228. const std::string &host, int port) {
  11229. return make_host_and_port_string_always_port(addr_map_target(addr_map, host),
  11230. port);
  11231. }
  11232. // Value for the Host header a client sends when the caller supplied none.
  11233. // Only the value: callers decide where in their header list it goes.
  11234. inline std::string make_default_host_header_value(const std::string &host,
  11235. int port, bool is_ssl,
  11236. int address_family) {
  11237. if (address_family == AF_UNIX) { return "localhost"; }
  11238. return make_host_and_port_string(host, port, is_ssl);
  11239. }
  11240. inline void add_default_user_agent_header(Request &req) {
  11241. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11242. if (!req.has_header("User-Agent")) {
  11243. req.set_header("User-Agent",
  11244. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11245. }
  11246. #else
  11247. (void)req;
  11248. #endif
  11249. }
  11250. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11251. NormalizedTarget normalize_target(const std::string &host);
  11252. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11253. bool host_matches_no_proxy(const NormalizedTarget &target,
  11254. const std::vector<NoProxyEntry> &entries);
  11255. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11256. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11257. if (prefix_bits == 0) { return true; }
  11258. int full_bytes = prefix_bits / 8;
  11259. int rem_bits = prefix_bits % 8;
  11260. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11261. static_cast<size_t>(full_bytes)) != 0) {
  11262. return false;
  11263. }
  11264. if (rem_bits == 0) { return true; }
  11265. auto i = static_cast<size_t>(full_bytes);
  11266. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11267. return (ip[i] & mask) == (net[i] & mask);
  11268. }
  11269. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11270. if (token.empty()) { return false; }
  11271. if (token == "*") {
  11272. out.kind = NoProxyKind::Wildcard;
  11273. return true;
  11274. }
  11275. auto slash = token.find('/');
  11276. std::string addr_part =
  11277. (slash == std::string::npos) ? token : token.substr(0, slash);
  11278. std::string prefix_part =
  11279. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11280. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11281. // don't silently treat it as a /32 (or /128).
  11282. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11283. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11284. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11285. // when brackets are present.
  11286. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11287. addr_part.back() == ']';
  11288. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11289. if (!bracketed) {
  11290. struct in_addr v4;
  11291. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11292. int prefix = 32;
  11293. if (!prefix_part.empty() &&
  11294. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11295. prefix)) {
  11296. return false;
  11297. }
  11298. out.kind = NoProxyKind::IPv4Cidr;
  11299. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11300. out.prefix_bits = prefix;
  11301. return true;
  11302. }
  11303. }
  11304. struct in6_addr v6;
  11305. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11306. int prefix = 128;
  11307. if (!prefix_part.empty() &&
  11308. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11309. prefix)) {
  11310. return false;
  11311. }
  11312. out.kind = NoProxyKind::IPv6Cidr;
  11313. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11314. out.prefix_bits = prefix;
  11315. return true;
  11316. }
  11317. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11318. // the entry is malformed — don't fall through to the hostname branch.
  11319. if (bracketed) { return false; }
  11320. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11321. if (slash != std::string::npos) { return false; }
  11322. // Port-specific entries (host:port) are not supported.
  11323. if (token.find(':') != std::string::npos) { return false; }
  11324. std::string hostname = case_ignore::to_lower(token);
  11325. while (!hostname.empty() && hostname.front() == '.') {
  11326. hostname.erase(hostname.begin());
  11327. }
  11328. while (!hostname.empty() && hostname.back() == '.') {
  11329. hostname.pop_back();
  11330. }
  11331. if (hostname.empty()) { return false; }
  11332. out.kind = NoProxyKind::HostnameSuffix;
  11333. out.hostname_pattern = std::move(hostname);
  11334. return true;
  11335. }
  11336. inline std::vector<NoProxyEntry>
  11337. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11338. std::vector<NoProxyEntry> entries;
  11339. entries.reserve(patterns.size());
  11340. for (const auto &p : patterns) {
  11341. auto trimmed = trim_copy(p);
  11342. if (trimmed.empty()) { continue; }
  11343. NoProxyEntry entry;
  11344. if (parse_no_proxy_entry(trimmed, entry)) {
  11345. entries.push_back(std::move(entry));
  11346. }
  11347. }
  11348. return entries;
  11349. }
  11350. inline NormalizedTarget normalize_target(const std::string &host) {
  11351. NormalizedTarget t;
  11352. std::string h = host;
  11353. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11354. h = h.substr(1, h.size() - 2);
  11355. }
  11356. // Strip a single trailing dot so "example.com." canonicalizes to
  11357. // "example.com".
  11358. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11359. t.hostname = case_ignore::to_lower(h);
  11360. if (!t.hostname.empty()) {
  11361. struct in_addr v4;
  11362. struct in6_addr v6;
  11363. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11364. t.is_ipv4 = true;
  11365. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11366. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11367. t.is_ipv6 = true;
  11368. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11369. }
  11370. }
  11371. return t;
  11372. }
  11373. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11374. const std::vector<NoProxyEntry> &entries) {
  11375. if (target.hostname.empty()) { return false; }
  11376. for (const auto &e : entries) {
  11377. switch (e.kind) {
  11378. case NoProxyKind::Wildcard: return true;
  11379. case NoProxyKind::IPv4Cidr:
  11380. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11381. return true;
  11382. }
  11383. break;
  11384. case NoProxyKind::IPv6Cidr:
  11385. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11386. return true;
  11387. }
  11388. break;
  11389. case NoProxyKind::HostnameSuffix:
  11390. if (target.is_ipv4 || target.is_ipv6) { break; }
  11391. if (target.hostname == e.hostname_pattern) { return true; }
  11392. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11393. // an entry of "example.com".
  11394. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11395. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11396. if (target.hostname[offset - 1] == '.' &&
  11397. target.hostname.compare(offset, e.hostname_pattern.size(),
  11398. e.hostname_pattern) == 0) {
  11399. return true;
  11400. }
  11401. }
  11402. break;
  11403. }
  11404. }
  11405. return false;
  11406. }
  11407. template <typename T>
  11408. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11409. T header_writer, Error &error) {
  11410. for (const auto &h : headers) {
  11411. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11412. error = Error::InvalidHeaders;
  11413. return false;
  11414. }
  11415. }
  11416. if (header_writer(strm, headers) <= 0) {
  11417. error = Error::Write;
  11418. return false;
  11419. }
  11420. return true;
  11421. }
  11422. } // namespace detail
  11423. /*
  11424. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11425. */
  11426. #ifdef CPPHTTPLIB_SSL_ENABLED
  11427. namespace detail {
  11428. // SSL socket stream implementation
  11429. inline SSLSocketStream::SSLSocketStream(
  11430. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11431. time_t read_timeout_usec, time_t write_timeout_sec,
  11432. time_t write_timeout_usec, time_t max_timeout_msec,
  11433. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11434. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11435. read_timeout_usec_(read_timeout_usec),
  11436. write_timeout_sec_(write_timeout_sec),
  11437. write_timeout_usec_(write_timeout_usec),
  11438. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11439. tls_error_.code = tls::ErrorCode::Success;
  11440. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11441. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11442. // Note: create_session() also clears this, but SSLClient currently
  11443. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11444. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11445. // SSL session was created.
  11446. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11447. #endif
  11448. }
  11449. inline SSLSocketStream::~SSLSocketStream() = default;
  11450. inline bool SSLSocketStream::is_readable() const {
  11451. return tls::pending(session_) > 0;
  11452. }
  11453. inline bool SSLSocketStream::wait_readable() const {
  11454. if (max_timeout_msec_ <= 0) {
  11455. return select_read_interruptible(sock_, read_timeout_sec_,
  11456. read_timeout_usec_, read_interrupted_) > 0;
  11457. }
  11458. time_t read_timeout_sec;
  11459. time_t read_timeout_usec;
  11460. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11461. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11462. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11463. read_interrupted_) > 0;
  11464. }
  11465. inline bool SSLSocketStream::wait_writable() const {
  11466. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11467. !tls::is_peer_closed(session_, sock_);
  11468. }
  11469. inline bool SSLSocketStream::ensure_readable() {
  11470. if (readable_hint_) {
  11471. readable_hint_ = false;
  11472. return true;
  11473. }
  11474. return wait_readable();
  11475. }
  11476. inline bool SSLSocketStream::is_peer_alive() const {
  11477. return !tls::is_peer_closed(session_, sock_);
  11478. }
  11479. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11480. if (tls::pending(session_) > 0) {
  11481. tls::TlsError err;
  11482. auto ret = tls::read(session_, ptr, size, err);
  11483. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11484. error_ = Error::ConnectionClosed;
  11485. } else if (ret < 0) {
  11486. tls_error_ = err;
  11487. }
  11488. return ret;
  11489. } else if (ensure_readable()) {
  11490. tls::TlsError err;
  11491. auto ret = tls::read(session_, ptr, size, err);
  11492. if (ret < 0) {
  11493. auto n = 1000;
  11494. #ifdef _WIN32
  11495. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11496. (err.code == tls::ErrorCode::SyscallError &&
  11497. WSAGetLastError() == WSAETIMEDOUT))) {
  11498. #else
  11499. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11500. #endif
  11501. if (tls::pending(session_) > 0) {
  11502. ret = tls::read(session_, ptr, size, err);
  11503. if (ret >= 0) { return ret; }
  11504. break;
  11505. } else if (wait_readable()) {
  11506. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11507. ret = tls::read(session_, ptr, size, err);
  11508. if (ret >= 0) { return ret; }
  11509. } else {
  11510. break;
  11511. }
  11512. }
  11513. assert(ret < 0);
  11514. tls_error_ = err;
  11515. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11516. error_ = Error::ConnectionClosed;
  11517. }
  11518. return ret;
  11519. } else {
  11520. error_ = Error::Timeout;
  11521. return -1;
  11522. }
  11523. }
  11524. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11525. if (wait_writable()) {
  11526. auto handle_size =
  11527. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11528. tls::TlsError err;
  11529. auto ret = tls::write(session_, ptr, handle_size, err);
  11530. if (ret < 0) {
  11531. auto n = 1000;
  11532. #ifdef _WIN32
  11533. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11534. (err.code == tls::ErrorCode::SyscallError &&
  11535. WSAGetLastError() == WSAETIMEDOUT))) {
  11536. #else
  11537. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11538. #endif
  11539. if (wait_writable()) {
  11540. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11541. ret = tls::write(session_, ptr, handle_size, err);
  11542. if (ret >= 0) { return ret; }
  11543. } else {
  11544. break;
  11545. }
  11546. }
  11547. assert(ret < 0);
  11548. tls_error_ = err;
  11549. }
  11550. return ret;
  11551. }
  11552. return -1;
  11553. }
  11554. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11555. int &port) const {
  11556. detail::get_remote_ip_and_port(sock_, ip, port);
  11557. }
  11558. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11559. int &port) const {
  11560. detail::get_local_ip_and_port(sock_, ip, port);
  11561. }
  11562. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11563. inline time_t SSLSocketStream::duration() const {
  11564. return static_cast<time_t>(
  11565. std::chrono::duration_cast<std::chrono::milliseconds>(
  11566. std::chrono::steady_clock::now() - start_time_)
  11567. .count());
  11568. }
  11569. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11570. read_timeout_sec_ = sec;
  11571. read_timeout_usec_ = usec;
  11572. }
  11573. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11574. max_timeout_msec_ = msec;
  11575. start_time_ = std::chrono::steady_clock::now();
  11576. }
  11577. inline void
  11578. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11579. read_interrupted_ = std::move(interrupted);
  11580. }
  11581. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11582. tls::session_t session,
  11583. time_t read_timeout_sec,
  11584. time_t read_timeout_usec,
  11585. time_t write_timeout_sec,
  11586. time_t write_timeout_usec)
  11587. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11588. read_timeout_usec_(read_timeout_usec),
  11589. write_timeout_sec_(write_timeout_sec),
  11590. write_timeout_usec_(write_timeout_usec),
  11591. start_time_(std::chrono::steady_clock::now().time_since_epoch().count()) {
  11592. // The receive and send paths run on different threads, so each TLS call is
  11593. // driven in non-blocking mode and readiness is awaited with select()
  11594. // outside the session lock. Set the socket non-blocking once here; it is
  11595. // never flipped back, so no thread races on the flag.
  11596. detail::set_nonblocking(sock_, true);
  11597. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11598. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11599. #endif
  11600. }
  11601. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11602. inline bool WebSocketSSLStream::is_readable() const {
  11603. std::lock_guard<std::mutex> guard(session_mutex_);
  11604. return tls::pending(session_) > 0;
  11605. }
  11606. inline bool WebSocketSSLStream::wait_readable() const {
  11607. auto max_timeout_msec = max_timeout_msec_.load();
  11608. if (max_timeout_msec <= 0) {
  11609. return select_read_interruptible(sock_, read_timeout_sec_,
  11610. read_timeout_usec_, read_interrupted_) > 0;
  11611. }
  11612. time_t read_timeout_sec;
  11613. time_t read_timeout_usec;
  11614. calc_actual_timeout(max_timeout_msec, duration(), read_timeout_sec_,
  11615. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11616. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11617. read_interrupted_) > 0;
  11618. }
  11619. inline bool WebSocketSSLStream::wait_writable() const {
  11620. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11621. // that probe toggles the socket's blocking flag, which would race with the
  11622. // concurrent reader on a permanently non-blocking socket.
  11623. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11624. }
  11625. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11626. tls::TlsError err;
  11627. auto n = 1000;
  11628. while (--n >= 0) {
  11629. {
  11630. std::lock_guard<std::mutex> guard(session_mutex_);
  11631. auto ret = tls::read(session_, ptr, size, err);
  11632. if (ret > 0) { return ret; }
  11633. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11634. error_ = Error::ConnectionClosed;
  11635. return ret;
  11636. }
  11637. }
  11638. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11639. // direction: the send path shares this session, so output it left pending
  11640. // has to be flushed before more input can be decrypted. Anything else is
  11641. // a hard error.
  11642. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11643. #ifdef _WIN32
  11644. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11645. needs_readable =
  11646. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11647. WSAGetLastError() == WSAETIMEDOUT);
  11648. #endif
  11649. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11650. error_ = Error::Read;
  11651. return -1;
  11652. }
  11653. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11654. error_ = Error::Timeout;
  11655. return -1;
  11656. }
  11657. }
  11658. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11659. // to tell a timeout from a close would otherwise see whatever the previous
  11660. // failure left behind (error_ is never cleared on success).
  11661. error_ = Error::Read;
  11662. return -1;
  11663. }
  11664. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11665. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11666. tls::TlsError err;
  11667. auto n = 1000;
  11668. while (--n >= 0) {
  11669. {
  11670. std::lock_guard<std::mutex> guard(session_mutex_);
  11671. auto ret = tls::write(session_, ptr, handle_size, err);
  11672. if (ret >= 0) { return ret; }
  11673. }
  11674. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11675. // or a post-handshake message must be consumed before the record goes
  11676. // out. Anything else is a hard error.
  11677. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11678. #ifdef _WIN32
  11679. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11680. needs_writable =
  11681. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11682. WSAGetLastError() == WSAETIMEDOUT);
  11683. #endif
  11684. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11685. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11686. }
  11687. return -1;
  11688. }
  11689. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11690. int &port) const {
  11691. detail::get_remote_ip_and_port(sock_, ip, port);
  11692. }
  11693. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11694. int &port) const {
  11695. detail::get_local_ip_and_port(sock_, ip, port);
  11696. }
  11697. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11698. inline time_t WebSocketSSLStream::duration() const {
  11699. auto start = std::chrono::steady_clock::time_point(
  11700. std::chrono::steady_clock::duration(start_time_.load()));
  11701. return static_cast<time_t>(
  11702. std::chrono::duration_cast<std::chrono::milliseconds>(
  11703. std::chrono::steady_clock::now() - start)
  11704. .count());
  11705. }
  11706. // Start time first: a reader that sees the new bound also sees its start
  11707. inline void WebSocketSSLStream::set_max_timeout(time_t msec) {
  11708. start_time_ = std::chrono::steady_clock::now().time_since_epoch().count();
  11709. max_timeout_msec_ = msec;
  11710. }
  11711. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11712. read_timeout_sec_ = sec;
  11713. read_timeout_usec_ = usec;
  11714. }
  11715. inline void
  11716. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11717. read_interrupted_ = std::move(interrupted);
  11718. }
  11719. } // namespace detail
  11720. #endif // CPPHTTPLIB_SSL_ENABLED
  11721. /*
  11722. * Group 4: Server implementation
  11723. */
  11724. // HTTP server implementation
  11725. inline Server::Server()
  11726. : new_task_queue([] {
  11727. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11728. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11729. }) {
  11730. #ifndef _WIN32
  11731. signal(SIGPIPE, SIG_IGN);
  11732. #endif
  11733. }
  11734. inline Server::~Server() = default;
  11735. inline std::unique_ptr<detail::MatcherBase>
  11736. Server::make_matcher(const std::string &pattern) {
  11737. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11738. // a path params pattern
  11739. if (pattern.find("/:") != std::string::npos) {
  11740. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11741. }
  11742. // A pattern with no regex metacharacter only has to be compared literally,
  11743. // which is what PathParamsMatcher already does when it captures no
  11744. // parameter, so std::regex is only worth building for the patterns that
  11745. // actually need it
  11746. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11747. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11748. }
  11749. return detail::make_unique<detail::RegexMatcher>(pattern);
  11750. }
  11751. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11752. return add_handler(get_handlers_, pattern, std::move(handler));
  11753. }
  11754. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11755. return add_handler(post_handlers_, pattern, std::move(handler));
  11756. }
  11757. inline Server &Server::Post(const std::string &pattern,
  11758. HandlerWithContentReader handler) {
  11759. return add_handler(post_handlers_for_content_reader_, pattern,
  11760. std::move(handler));
  11761. }
  11762. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11763. return add_handler(put_handlers_, pattern, std::move(handler));
  11764. }
  11765. inline Server &Server::Put(const std::string &pattern,
  11766. HandlerWithContentReader handler) {
  11767. return add_handler(put_handlers_for_content_reader_, pattern,
  11768. std::move(handler));
  11769. }
  11770. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11771. return add_handler(patch_handlers_, pattern, std::move(handler));
  11772. }
  11773. inline Server &Server::Patch(const std::string &pattern,
  11774. HandlerWithContentReader handler) {
  11775. return add_handler(patch_handlers_for_content_reader_, pattern,
  11776. std::move(handler));
  11777. }
  11778. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11779. return add_handler(delete_handlers_, pattern, std::move(handler));
  11780. }
  11781. inline Server &Server::Delete(const std::string &pattern,
  11782. HandlerWithContentReader handler) {
  11783. return add_handler(delete_handlers_for_content_reader_, pattern,
  11784. std::move(handler));
  11785. }
  11786. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11787. return add_handler(options_handlers_, pattern, std::move(handler));
  11788. }
  11789. inline const std::set<std::string> &Server::builtin_methods() {
  11790. thread_local const std::set<std::string> methods{
  11791. "GET", "HEAD", "POST", "PUT", "DELETE",
  11792. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11793. return methods;
  11794. }
  11795. inline Server::CustomHandlerEntry *
  11796. Server::custom_entry_for_registration(const std::string &method) {
  11797. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11798. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11799. // routing() before the custom tables are consulted, so a route registered
  11800. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11801. // there and would be reachable, but they carry protocol-level meaning
  11802. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11803. // library does not route.
  11804. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11805. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11806. has_invalid_registration_ = true;
  11807. return nullptr;
  11808. }
  11809. return &custom_handlers_[method];
  11810. }
  11811. inline Server &Server::CustomRoute(const std::string &method,
  11812. const std::string &pattern,
  11813. Handler handler) {
  11814. auto *entry = custom_entry_for_registration(method);
  11815. if (!entry) { return *this; }
  11816. return add_handler(entry->handlers, pattern, std::move(handler));
  11817. }
  11818. inline Server &Server::CustomRoute(const std::string &method,
  11819. const std::string &pattern,
  11820. HandlerWithContentReader handler) {
  11821. auto *entry = custom_entry_for_registration(method);
  11822. if (!entry) { return *this; }
  11823. return add_handler(entry->handlers_for_content_reader, pattern,
  11824. std::move(handler));
  11825. }
  11826. inline const Server::CustomHandlerEntry *
  11827. Server::find_custom_entry(const std::string &method) const {
  11828. // find() alone would be correct here. The empty() check is what keeps the
  11829. // per-request cost off servers that never call CustomRoute(), which is the
  11830. // overwhelmingly common case; keep it rather than walking into the tree.
  11831. if (custom_handlers_.empty()) { return nullptr; }
  11832. auto it = custom_handlers_.find(method);
  11833. return it == custom_handlers_.end() ? nullptr : &it->second;
  11834. }
  11835. inline Server &Server::WebSocket(const std::string &pattern,
  11836. WebSocketHandler handler) {
  11837. websocket_handlers_.push_back(
  11838. {make_matcher(pattern), std::move(handler), nullptr});
  11839. return *this;
  11840. }
  11841. inline Server &Server::WebSocket(const std::string &pattern,
  11842. WebSocketHandler handler,
  11843. SubProtocolSelector sub_protocol_selector) {
  11844. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11845. std::move(sub_protocol_selector)});
  11846. return *this;
  11847. }
  11848. inline bool Server::set_base_dir(const std::string &dir,
  11849. const std::string &mount_point) {
  11850. return set_mount_point(mount_point, dir);
  11851. }
  11852. inline bool Server::set_mount_point(const std::string &mount_point,
  11853. const std::string &dir, Headers headers) {
  11854. detail::FileStat stat(dir);
  11855. if (stat.is_dir()) {
  11856. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11857. if (!mnt.empty() && mnt[0] == '/') {
  11858. // Without the resolved directory, a file could not be checked to be
  11859. // inside it.
  11860. std::string resolved_base;
  11861. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11862. return false;
  11863. }
  11864. #if defined(_WIN32)
  11865. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11866. resolved_base += '\\';
  11867. }
  11868. #else
  11869. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11870. #endif
  11871. base_dirs_.push_back(
  11872. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11873. return true;
  11874. }
  11875. }
  11876. return false;
  11877. }
  11878. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11879. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11880. if (it->mount_point == mount_point) {
  11881. base_dirs_.erase(it);
  11882. return true;
  11883. }
  11884. }
  11885. return false;
  11886. }
  11887. inline Server &
  11888. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11889. const std::string &mime) {
  11890. // Keyed as find_content_type() looks it up
  11891. auto key = detail::case_ignore::to_lower(ext);
  11892. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  11893. file_extension_and_mimetype_map_[key] = mime;
  11894. return *this;
  11895. }
  11896. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11897. default_file_mimetype_ = mime;
  11898. return *this;
  11899. }
  11900. inline Server &Server::set_file_request_handler(Handler handler) {
  11901. file_request_handler_ = std::move(handler);
  11902. return *this;
  11903. }
  11904. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11905. std::true_type) {
  11906. error_handler_ = std::move(handler);
  11907. return *this;
  11908. }
  11909. inline Server &Server::set_error_handler_core(Handler handler,
  11910. std::false_type) {
  11911. error_handler_ = [handler](const Request &req, Response &res) {
  11912. handler(req, res);
  11913. return HandlerResponse::Handled;
  11914. };
  11915. return *this;
  11916. }
  11917. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11918. exception_handler_ = std::move(handler);
  11919. return *this;
  11920. }
  11921. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11922. pre_routing_handler_ = std::move(handler);
  11923. return *this;
  11924. }
  11925. inline Server &Server::set_post_routing_handler(Handler handler) {
  11926. post_routing_handler_ = std::move(handler);
  11927. return *this;
  11928. }
  11929. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11930. pre_request_handler_ = std::move(handler);
  11931. return *this;
  11932. }
  11933. inline Server &Server::set_logger(Logger logger) {
  11934. logger_ = std::move(logger);
  11935. return *this;
  11936. }
  11937. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11938. error_logger_ = std::move(error_logger);
  11939. return *this;
  11940. }
  11941. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11942. pre_compression_logger_ = std::move(logger);
  11943. return *this;
  11944. }
  11945. inline Server &
  11946. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11947. expect_100_continue_handler_ = std::move(handler);
  11948. return *this;
  11949. }
  11950. inline Server &Server::set_start_handler(StartHandler handler) {
  11951. start_handler_ = std::move(handler);
  11952. return *this;
  11953. }
  11954. inline Server &Server::set_address_family(int family) {
  11955. address_family_ = family;
  11956. return *this;
  11957. }
  11958. inline Server &Server::set_tcp_nodelay(bool on) {
  11959. tcp_nodelay_ = on;
  11960. return *this;
  11961. }
  11962. inline Server &Server::set_ipv6_v6only(bool on) {
  11963. ipv6_v6only_ = on;
  11964. return *this;
  11965. }
  11966. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11967. socket_options_ = std::move(socket_options);
  11968. return *this;
  11969. }
  11970. inline Server &Server::set_default_headers(Headers headers) {
  11971. default_headers_ = std::move(headers);
  11972. return *this;
  11973. }
  11974. inline Server &Server::set_header_writer(
  11975. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11976. header_writer_ = writer;
  11977. return *this;
  11978. }
  11979. inline Server &
  11980. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11981. trusted_proxies_.clear();
  11982. trusted_proxies_.reserve(proxies.size());
  11983. for (const auto &proxy : proxies) {
  11984. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  11985. }
  11986. return *this;
  11987. }
  11988. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11989. keep_alive_max_count_ = count;
  11990. return *this;
  11991. }
  11992. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11993. keep_alive_timeout_sec_ = sec;
  11994. return *this;
  11995. }
  11996. template <class Rep, class Period>
  11997. inline Server &Server::set_keep_alive_timeout(
  11998. const std::chrono::duration<Rep, Period> &duration) {
  11999. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12000. set_keep_alive_timeout(sec);
  12001. });
  12002. return *this;
  12003. }
  12004. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  12005. read_timeout_sec_ = sec;
  12006. read_timeout_usec_ = usec;
  12007. return *this;
  12008. }
  12009. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  12010. write_timeout_sec_ = sec;
  12011. write_timeout_usec_ = usec;
  12012. return *this;
  12013. }
  12014. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  12015. idle_interval_sec_ = sec;
  12016. idle_interval_usec_ = usec;
  12017. return *this;
  12018. }
  12019. inline Server &Server::set_payload_max_length(size_t length) {
  12020. payload_max_length_ = length;
  12021. return *this;
  12022. }
  12023. inline Server &Server::set_compress(bool on) {
  12024. compress_ = on;
  12025. return *this;
  12026. }
  12027. inline Server &Server::set_static_file_compression(bool on) {
  12028. static_file_compression_ = on;
  12029. return *this;
  12030. }
  12031. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  12032. static_file_compression_min_length_ = length;
  12033. return *this;
  12034. }
  12035. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  12036. static_file_compression_max_length_ = length;
  12037. return *this;
  12038. }
  12039. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  12040. websocket_max_missed_pongs_ = count;
  12041. return *this;
  12042. }
  12043. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  12044. websocket_ping_interval_sec_ = sec;
  12045. return *this;
  12046. }
  12047. template <class Rep, class Period>
  12048. inline Server &Server::set_websocket_ping_interval(
  12049. const std::chrono::duration<Rep, Period> &duration) {
  12050. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12051. set_websocket_ping_interval(sec);
  12052. });
  12053. return *this;
  12054. }
  12055. inline bool Server::bind_to_port(const std::string &host, int port,
  12056. int socket_flags) {
  12057. auto ret = bind_internal(host, port, socket_flags);
  12058. if (ret == -1) { is_decommissioned = true; }
  12059. return ret >= 0;
  12060. }
  12061. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  12062. auto ret = bind_internal(host, 0, socket_flags);
  12063. if (ret == -1) { is_decommissioned = true; }
  12064. return ret;
  12065. }
  12066. inline bool Server::listen_after_bind() { return listen_internal(); }
  12067. inline bool Server::listen(const std::string &host, int port,
  12068. int socket_flags) {
  12069. return bind_to_port(host, port, socket_flags) && listen_internal();
  12070. }
  12071. inline bool Server::is_running() const { return is_running_; }
  12072. inline void Server::wait_until_ready() const {
  12073. while (!is_running_ && !is_decommissioned) {
  12074. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12075. }
  12076. }
  12077. inline void Server::stop() noexcept {
  12078. // Release the listening socket whether or not the accept loop is running:
  12079. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  12080. // exchange is what makes this safe to call concurrently with the accept loop.
  12081. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  12082. if (sock != INVALID_SOCKET) {
  12083. detail::shutdown_socket(sock);
  12084. detail::close_socket(sock);
  12085. }
  12086. is_decommissioned = false;
  12087. }
  12088. inline void Server::decommission() { is_decommissioned = true; }
  12089. inline bool Server::parse_request_line(const char *s, Request &req) const {
  12090. auto len = strlen(s);
  12091. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  12092. len -= 2;
  12093. {
  12094. // RFC 9112 §3: exactly one SP between the method, the target and the
  12095. // version. Taking other whitespace as a separator too lets recipients
  12096. // that parse more strictly see a different request.
  12097. auto end = s + len;
  12098. if (std::count(s, end, ' ') != 2) { return false; }
  12099. auto sp1 = std::find(s, end, ' ');
  12100. auto sp2 = std::find(sp1 + 1, end, ' ');
  12101. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  12102. req.method.assign(s, sp1);
  12103. req.target.assign(sp1 + 1, sp2);
  12104. req.version.assign(sp2 + 1, end);
  12105. }
  12106. // A method outside the built-in set is accepted only when a handler has been
  12107. // registered for it with CustomRoute().
  12108. const auto &methods = builtin_methods();
  12109. if (methods.find(req.method) == methods.end() &&
  12110. !find_custom_entry(req.method)) {
  12111. output_error_log(Error::InvalidHTTPMethod, &req);
  12112. return false;
  12113. }
  12114. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  12115. output_error_log(Error::InvalidHTTPVersion, &req);
  12116. return false;
  12117. }
  12118. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  12119. // would leave this server routing a different path than a cache or a
  12120. // filter in front of it sees.
  12121. if (!detail::fields::is_request_target(req.target) ||
  12122. req.target.find('#') != std::string::npos) {
  12123. return false;
  12124. }
  12125. {
  12126. detail::divide(req.target, '?',
  12127. [&](const char *lhs_data, std::size_t lhs_size,
  12128. const char *rhs_data, std::size_t rhs_size) {
  12129. req.path =
  12130. decode_path_component(std::string(lhs_data, lhs_size));
  12131. detail::parse_query_text(rhs_data, rhs_size, req.params);
  12132. });
  12133. }
  12134. return true;
  12135. }
  12136. inline bool Server::write_response(Stream &strm, bool close_connection,
  12137. Request &req, Response &res) {
  12138. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  12139. // incorrectly to the error content.
  12140. req.ranges.clear();
  12141. return write_response_core(strm, close_connection, req, res, false);
  12142. }
  12143. inline bool Server::write_response_with_content(Stream &strm,
  12144. bool close_connection,
  12145. const Request &req,
  12146. Response &res) {
  12147. return write_response_core(strm, close_connection, req, res, true);
  12148. }
  12149. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  12150. const Request &req, Response &res,
  12151. bool need_apply_ranges) {
  12152. assert(res.status != -1);
  12153. if (400 <= res.status && error_handler_ &&
  12154. error_handler_(req, res) == HandlerResponse::Handled) {
  12155. need_apply_ranges = true;
  12156. }
  12157. // Before anything below reads res.headers, which the handlers may have
  12158. // filled directly
  12159. detail::erase_invalid_fields(res.headers);
  12160. if (!detail::body_allowed_for_status(res.status)) {
  12161. detail::clear_content(res);
  12162. }
  12163. detail::prefer_assigned_body(res);
  12164. std::string content_type;
  12165. std::string boundary;
  12166. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  12167. // Prepare additional headers
  12168. if (close_connection ||
  12169. detail::has_header_token(req.headers, "Connection", "close") ||
  12170. 400 <= res.status || // Don't leave connections open after errors
  12171. // The client withholds the body until `100 Continue`, which was never
  12172. // sent, so whether and when the body follows is unknown.
  12173. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  12174. // The body was left partway, e.g. by a content receiver that returned
  12175. // false, so the rest of it cannot be told from the next request.
  12176. (req.body_read_started_ && !req.body_consumed_)) {
  12177. res.set_header("Connection", "close");
  12178. } else {
  12179. std::string s = "timeout=";
  12180. s += std::to_string(keep_alive_timeout_sec_);
  12181. if (keep_alive_max_count_ > 0) {
  12182. s += ", max=";
  12183. s += std::to_string(keep_alive_max_count_);
  12184. }
  12185. res.set_header("Keep-Alive", s);
  12186. }
  12187. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12188. !res.has_header("Content-Type")) {
  12189. res.set_header("Content-Type", "text/plain");
  12190. }
  12191. detail::set_framing_headers(req, res, boundary, content_type);
  12192. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12193. res.set_header("Accept-Ranges", "bytes");
  12194. }
  12195. if (post_routing_handler_) {
  12196. post_routing_handler_(req, res);
  12197. detail::erase_invalid_fields(res.headers);
  12198. // Again, for a body or framing headers the handler changed.
  12199. detail::set_framing_headers(req, res, boundary, content_type);
  12200. }
  12201. // Response line and headers
  12202. detail::BufferStream bstrm;
  12203. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12204. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12205. // Combine a small body with the headers so the whole response leaves in a
  12206. // single write. A large body is written on its own instead: a copy of it
  12207. // costs more than the extra write saves.
  12208. auto send_body =
  12209. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12210. auto body_is_separate = false;
  12211. auto provider_done = false;
  12212. if (send_body && !res.body.empty() && !res.content_provider_) {
  12213. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12214. bstrm.write(res.body.data(), res.body.size());
  12215. } else {
  12216. body_is_separate = true;
  12217. }
  12218. } else if (send_body && res.content_provider_ &&
  12219. res.is_file_content_provider_ &&
  12220. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12221. // A small file is read into the same buffer. Other providers may produce
  12222. // their data over time, so they are never held back.
  12223. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12224. return false;
  12225. }
  12226. provider_done = true;
  12227. }
  12228. // Log before writing to avoid race condition with client-side code that
  12229. // accesses logger-captured data immediately after receiving the response.
  12230. output_log(req, res);
  12231. // Flush buffer
  12232. auto &data = bstrm.get_buffer();
  12233. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12234. if (body_is_separate) {
  12235. return detail::write_data(strm, res.body.data(), res.body.size());
  12236. }
  12237. // Streaming body
  12238. if (send_body && res.content_provider_) {
  12239. if (!provider_done &&
  12240. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12241. return false;
  12242. }
  12243. res.content_provider_success_ = true;
  12244. }
  12245. return true;
  12246. }
  12247. inline bool
  12248. Server::write_content_with_provider(Stream &strm, const Request &req,
  12249. Response &res, const std::string &boundary,
  12250. const std::string &content_type) {
  12251. auto is_shutting_down = [this]() { return is_stopping(); };
  12252. if (res.content_length_ > 0) {
  12253. if (!detail::is_partial_content(req, res)) {
  12254. return detail::write_content(strm, res.content_provider_, 0,
  12255. res.content_length_, is_shutting_down);
  12256. } else if (req.ranges.size() == 1) {
  12257. auto offset_and_length = detail::get_range_offset_and_length(
  12258. req.ranges[0], res.content_length_);
  12259. return detail::write_content(strm, res.content_provider_,
  12260. offset_and_length.first,
  12261. offset_and_length.second, is_shutting_down);
  12262. } else {
  12263. return detail::write_multipart_ranges_data(
  12264. strm, req, res, boundary, content_type, res.content_length_,
  12265. is_shutting_down);
  12266. }
  12267. } else {
  12268. if (res.is_chunked_content_provider_) {
  12269. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12270. // re-negotiating here would disagree with them, e.g. once a handler's
  12271. // own Content-Encoding header suppresses the negotiation.
  12272. auto compressor = detail::make_compressor(res.content_coding_);
  12273. if (!compressor) {
  12274. compressor = detail::make_unique<detail::nocompressor>();
  12275. }
  12276. return detail::write_content_chunked(strm, res.content_provider_,
  12277. is_shutting_down, *compressor);
  12278. } else {
  12279. return detail::write_content_without_length(strm, res.content_provider_,
  12280. is_shutting_down);
  12281. }
  12282. }
  12283. }
  12284. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12285. FormFields::iterator cur_field;
  12286. FormFiles::iterator cur_file;
  12287. auto is_text_field = false;
  12288. size_t count = 0;
  12289. if (read_content_core(
  12290. strm, req, res,
  12291. // Regular
  12292. [&](const char *buf, size_t n) {
  12293. // Prevent arithmetic overflow when checking sizes.
  12294. // Avoid computing (req.body.size() + n) directly because
  12295. // adding two unsigned `size_t` values can wrap around and
  12296. // produce a small result instead of indicating overflow.
  12297. // Instead, check using subtraction: ensure `n` does not
  12298. // exceed the remaining capacity `max_size() - size()`.
  12299. if (req.body.size() >= req.body.max_size() ||
  12300. n > req.body.max_size() - req.body.size()) {
  12301. return false;
  12302. }
  12303. // Limit decompressed body size to payload_max_length_ to protect
  12304. // against "zip bomb" attacks where a small compressed payload
  12305. // decompresses to a massive size.
  12306. if (payload_max_length_ > 0 &&
  12307. (req.body.size() >= payload_max_length_ ||
  12308. n > payload_max_length_ - req.body.size())) {
  12309. return false;
  12310. }
  12311. req.body.append(buf, n);
  12312. return true;
  12313. },
  12314. // Multipart FormData
  12315. [&](const FormData &file) {
  12316. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12317. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12318. output_error_log(Error::TooManyFormDataFiles, &req);
  12319. return false;
  12320. }
  12321. if (file.filename.empty()) {
  12322. cur_field = req.form.fields.emplace(
  12323. file.name, FormField{file.name, file.content, file.headers});
  12324. is_text_field = true;
  12325. } else {
  12326. cur_file = req.form.files.emplace(file.name, file);
  12327. is_text_field = false;
  12328. }
  12329. return true;
  12330. },
  12331. [&](const char *buf, size_t n) {
  12332. if (is_text_field) {
  12333. auto &content = cur_field->second.content;
  12334. if (content.size() + n > content.max_size()) { return false; }
  12335. content.append(buf, n);
  12336. } else {
  12337. auto &content = cur_file->second.content;
  12338. if (content.size() + n > content.max_size()) { return false; }
  12339. content.append(buf, n);
  12340. }
  12341. return true;
  12342. })) {
  12343. const auto &content_type = req.get_header_value("Content-Type");
  12344. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12345. "application/x-www-form-urlencoded")) {
  12346. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12347. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12348. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12349. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12350. return false;
  12351. }
  12352. detail::parse_query_text(req.body, req.params);
  12353. }
  12354. return true;
  12355. }
  12356. return false;
  12357. }
  12358. inline bool Server::read_content_with_content_receiver(
  12359. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12360. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12361. return read_content_core(strm, req, res, std::move(receiver),
  12362. std::move(multipart_header),
  12363. std::move(multipart_receiver));
  12364. }
  12365. inline bool Server::read_content_core(
  12366. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12367. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12368. detail::FormDataParser multipart_form_data_parser;
  12369. ContentReceiverWithProgress out;
  12370. if (req.is_multipart_form_data()) {
  12371. const auto &content_type = req.get_header_value("Content-Type");
  12372. std::string boundary;
  12373. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12374. res.status = StatusCode::BadRequest_400;
  12375. output_error_log(Error::MultipartParsing, &req);
  12376. return false;
  12377. }
  12378. multipart_form_data_parser.set_boundary(std::move(boundary));
  12379. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12380. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12381. multipart_receiver);
  12382. };
  12383. } else {
  12384. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12385. size_t /*len*/) { return receiver(buf, n); };
  12386. }
  12387. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12388. if (!req.has_header("Content-Length") &&
  12389. !detail::is_chunked_transfer_encoding(req.headers)) {
  12390. return true;
  12391. }
  12392. // A second read would start where the first one stopped, or in the next
  12393. // request.
  12394. if (req.body_read_started_) { return false; }
  12395. // The client is waiting for this before it sends the body.
  12396. if (req.expect_100_continue_pending_) {
  12397. req.expect_100_continue_pending_ = false;
  12398. detail::write_response_line(strm, StatusCode::Continue_100);
  12399. strm.write("\r\n");
  12400. }
  12401. // Set before reading, since a receiver may also stop by throwing.
  12402. req.body_read_started_ = true;
  12403. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12404. out, true)) {
  12405. return false;
  12406. }
  12407. req.body_consumed_ = true;
  12408. if (req.is_multipart_form_data()) {
  12409. if (!multipart_form_data_parser.is_valid()) {
  12410. res.status = StatusCode::BadRequest_400;
  12411. output_error_log(Error::MultipartParsing, &req);
  12412. return false;
  12413. }
  12414. }
  12415. return true;
  12416. }
  12417. inline bool Server::handle_file_request(Request &req, Response &res) {
  12418. if (!detail::is_valid_path(req.path)) { return false; }
  12419. for (const auto &entry : base_dirs_) {
  12420. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12421. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12422. // One that already ends in '/' (the root mount among them) carries its own
  12423. // boundary; set_mount_point() guarantees the mount point is not empty.
  12424. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12425. (entry.mount_point.back() == '/' ||
  12426. req.path.size() == entry.mount_point.size() ||
  12427. req.path[entry.mount_point.size()] == '/')) {
  12428. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12429. auto path = entry.base_dir + sub_path;
  12430. if (path.back() == '/') { path += "index.html"; }
  12431. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12432. // but symlinks/junctions can still escape the base directory. A path
  12433. // that cannot be resolved, which includes one that does not exist, is
  12434. // not served from here.
  12435. std::string resolved_path;
  12436. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12437. if (!detail::is_path_within_base(resolved_path,
  12438. entry.resolved_base_dir)) {
  12439. res.status = StatusCode::Forbidden_403;
  12440. return true;
  12441. }
  12442. detail::FileStat stat(path);
  12443. if (stat.is_dir()) {
  12444. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12445. // in the name from reading as a scheme.
  12446. auto name = req.path.substr(req.path.rfind('/') + 1);
  12447. res.set_redirect("./" + encode_path_component(name) + "/",
  12448. StatusCode::MovedPermanently_301);
  12449. return true;
  12450. }
  12451. if (stat.is_file()) {
  12452. for (const auto &kv : entry.headers) {
  12453. res.set_header(kv.first, kv.second);
  12454. }
  12455. auto content_type = detail::find_content_type(
  12456. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12457. auto encoding = detail::EncodingType::None;
  12458. if (static_file_compression_) {
  12459. encoding = static_file_encoding(req, res, content_type, stat.size());
  12460. }
  12461. // The ETag names the representation actually sent, so a client that
  12462. // cached the compressed form revalidates against the compressed ETag
  12463. // and still gets a 304, while one that took identity keeps the plain
  12464. // ETag.
  12465. auto etag = detail::compute_etag(
  12466. stat, encoding == detail::EncodingType::None
  12467. ? std::string()
  12468. : std::string("-") + detail::encoding_name(encoding));
  12469. if (!etag.empty()) { res.set_header("ETag", etag); }
  12470. auto mtime = stat.mtime();
  12471. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12472. if (!last_modified.empty()) {
  12473. res.set_header("Last-Modified", last_modified);
  12474. }
  12475. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12476. check_if_range(req, etag, mtime);
  12477. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12478. if (!mm->is_open()) {
  12479. output_error_log(Error::OpenFile, &req);
  12480. return false;
  12481. }
  12482. detail::set_file_content_provider(res, mm, content_type, encoding);
  12483. if (req.method != "HEAD" && file_request_handler_) {
  12484. file_request_handler_(req, res);
  12485. }
  12486. return true;
  12487. } else {
  12488. output_error_log(Error::OpenFile, &req);
  12489. }
  12490. }
  12491. }
  12492. return false;
  12493. }
  12494. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12495. const std::string &etag,
  12496. time_t mtime) const {
  12497. // Handle conditional GET:
  12498. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12499. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12500. if (req.has_header("If-None-Match")) {
  12501. if (!etag.empty()) {
  12502. auto val =
  12503. detail::get_combined_header_value(req.headers, "If-None-Match");
  12504. // NOTE: We use exact string matching here. This works correctly
  12505. // because our server always generates weak ETags (W/"..."), and
  12506. // clients typically send back the same ETag they received.
  12507. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12508. // If-None-Match, where W/"x" and "x" would match, but this
  12509. // simplified implementation requires exact matches.
  12510. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12511. [&](const char *b, const char *e) {
  12512. auto seg_len = static_cast<size_t>(e - b);
  12513. return (seg_len == 1 && *b == '*') ||
  12514. (seg_len == etag.size() &&
  12515. std::equal(b, e, etag.begin()));
  12516. });
  12517. if (ret) {
  12518. res.status = StatusCode::NotModified_304;
  12519. return true;
  12520. }
  12521. }
  12522. } else if (req.has_header("If-Modified-Since")) {
  12523. auto val = req.get_header_value("If-Modified-Since");
  12524. auto t = detail::parse_http_date(val);
  12525. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12526. res.status = StatusCode::NotModified_304;
  12527. return true;
  12528. }
  12529. }
  12530. return false;
  12531. }
  12532. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12533. time_t mtime) const {
  12534. // Handle If-Range for partial content requests (RFC 9110
  12535. // Section 13.1.5). If-Range is only evaluated when Range header is
  12536. // present. If the validator matches, serve partial content; otherwise
  12537. // serve full content.
  12538. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12539. auto val = req.get_header_value("If-Range");
  12540. auto is_valid_range = [&]() {
  12541. if (detail::is_strong_etag(val)) {
  12542. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12543. // comparison.
  12544. return (!etag.empty() && val == etag);
  12545. } else if (detail::is_weak_etag(val)) {
  12546. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12547. return false;
  12548. } else {
  12549. // HTTP-date comparison
  12550. auto t = detail::parse_http_date(val);
  12551. return (t != static_cast<time_t>(-1) && mtime <= t);
  12552. }
  12553. };
  12554. if (!is_valid_range()) {
  12555. // Validator doesn't match: ignore Range and serve full content
  12556. req.ranges.clear();
  12557. return false;
  12558. }
  12559. }
  12560. return true;
  12561. }
  12562. inline socket_t
  12563. Server::create_server_socket(const std::string &host, int port,
  12564. int socket_flags,
  12565. SocketOptions socket_options) const {
  12566. return detail::create_socket(
  12567. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12568. ipv6_v6only_, std::move(socket_options),
  12569. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12570. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12571. output_error_log(Error::BindIPAddress, nullptr);
  12572. return false;
  12573. }
  12574. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12575. output_error_log(Error::Listen, nullptr);
  12576. return false;
  12577. }
  12578. return true;
  12579. });
  12580. }
  12581. inline int Server::bind_internal(const std::string &host, int port,
  12582. int socket_flags) {
  12583. if (is_decommissioned) { return -1; }
  12584. if (!is_valid()) { return -1; }
  12585. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12586. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12587. if (port == 0) {
  12588. struct sockaddr_storage addr;
  12589. socklen_t addr_len = sizeof(addr);
  12590. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12591. &addr_len) == -1) {
  12592. output_error_log(Error::GetSockName, nullptr);
  12593. return -1;
  12594. }
  12595. if (addr.ss_family == AF_INET) {
  12596. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12597. } else if (addr.ss_family == AF_INET6) {
  12598. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12599. } else {
  12600. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12601. return -1;
  12602. }
  12603. } else {
  12604. return port;
  12605. }
  12606. }
  12607. inline bool Server::listen_internal() {
  12608. // A stop() between bind and listen leaves nothing to accept on. Report
  12609. // failure instead of returning success without ever serving, and mark the
  12610. // server decommissioned the way any failed listen does so that a concurrent
  12611. // wait_until_ready() wakes up instead of spinning forever.
  12612. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12613. is_decommissioned = true;
  12614. return false;
  12615. }
  12616. auto ret = true;
  12617. is_running_ = true;
  12618. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12619. if (start_handler_) { start_handler_(); }
  12620. {
  12621. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12622. while (svr_sock_ != INVALID_SOCKET) {
  12623. #ifndef _WIN32
  12624. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12625. #endif
  12626. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12627. idle_interval_usec_);
  12628. if (val == 0) { // Timeout
  12629. task_queue->on_idle();
  12630. continue;
  12631. }
  12632. #ifndef _WIN32
  12633. }
  12634. #endif
  12635. #if defined _WIN32
  12636. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12637. // OVERLAPPED
  12638. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12639. #elif defined SOCK_CLOEXEC
  12640. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12641. #else
  12642. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12643. #endif
  12644. if (sock == INVALID_SOCKET) {
  12645. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12646. // touches the CRT errno, so the two have to be asked platform by
  12647. // platform rather than by testing errno here.
  12648. if (detail::is_accept_resource_error()) {
  12649. // The per-process descriptor limit or the network stack's buffer
  12650. // space has been reached. Try to accept new connections after a
  12651. // short sleep.
  12652. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12653. continue;
  12654. } else if (detail::is_accept_transient_error()) {
  12655. continue;
  12656. }
  12657. // Take the descriptor out of svr_sock_ before closing it: a later
  12658. // stop() would otherwise shutdown()/close() a value the OS may have
  12659. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12660. // gone. The exchange also settles the race with a concurrent stop(),
  12661. // since whichever side takes the descriptor closes it exactly once.
  12662. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12663. if (listen_sock != INVALID_SOCKET) {
  12664. detail::close_socket(listen_sock);
  12665. ret = false;
  12666. output_error_log(Error::Connection, nullptr);
  12667. } else {
  12668. ; // The server socket was closed by user.
  12669. }
  12670. break;
  12671. }
  12672. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12673. read_timeout_sec_, read_timeout_usec_);
  12674. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12675. write_timeout_sec_, write_timeout_usec_);
  12676. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12677. if (!task_queue->enqueue(
  12678. [this, sock]() { process_and_close_socket(sock); })) {
  12679. output_error_log(Error::ResourceExhaustion, nullptr);
  12680. detail::shutdown_socket(sock);
  12681. detail::close_socket(sock);
  12682. }
  12683. }
  12684. task_queue->shutdown();
  12685. }
  12686. is_decommissioned = !ret;
  12687. return ret;
  12688. }
  12689. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  12690. // Call from a catch block. The response is a 500 unless the exception handler
  12691. // sets another status. Returns whether the exception handler ran.
  12692. inline bool Server::handle_exception(Request &req, Response &res) {
  12693. res.status = StatusCode::InternalServerError_500;
  12694. if (!exception_handler_) { return false; }
  12695. exception_handler_(req, res, std::current_exception());
  12696. return true;
  12697. }
  12698. #endif
  12699. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12700. bool skip_pre_routing) {
  12701. if (!skip_pre_routing && pre_routing_handler_ &&
  12702. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12703. return true;
  12704. }
  12705. // File handler
  12706. if ((req.method == "GET" || req.method == "HEAD") &&
  12707. handle_file_request(req, res)) {
  12708. return true;
  12709. }
  12710. const auto *custom = find_custom_entry(req.method);
  12711. // The second clause mirrors what expect_content() does unconditionally for
  12712. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12713. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12714. // `allprop`) would skip its handler and fall through to 404.
  12715. if (detail::expect_content(req) ||
  12716. (custom && !custom->handlers_for_content_reader.empty())) {
  12717. // Content reader handler
  12718. {
  12719. // Track whether the ContentReader was aborted due to the decompressed
  12720. // payload exceeding `payload_max_length_`.
  12721. // The user handler runs after the lambda returns, so we must restore the
  12722. // 413 status if the handler overwrites it.
  12723. bool content_reader_payload_too_large = false;
  12724. ContentReader reader(
  12725. [&](ContentReceiver receiver) {
  12726. auto result = read_content_with_content_receiver(
  12727. strm, req, res, std::move(receiver), nullptr, nullptr);
  12728. if (!result) {
  12729. output_error_log(Error::Read, &req);
  12730. if (res.status == StatusCode::PayloadTooLarge_413) {
  12731. content_reader_payload_too_large = true;
  12732. }
  12733. }
  12734. return result;
  12735. },
  12736. [&](FormDataHeader header, ContentReceiver receiver) {
  12737. auto result = read_content_with_content_receiver(
  12738. strm, req, res, nullptr, std::move(header),
  12739. std::move(receiver));
  12740. if (!result) {
  12741. output_error_log(Error::Read, &req);
  12742. if (res.status == StatusCode::PayloadTooLarge_413) {
  12743. content_reader_payload_too_large = true;
  12744. }
  12745. }
  12746. return result;
  12747. });
  12748. bool dispatched = false;
  12749. if (req.method == "POST") {
  12750. dispatched = dispatch_request_for_content_reader(
  12751. req, res, std::move(reader), post_handlers_for_content_reader_);
  12752. } else if (req.method == "PUT") {
  12753. dispatched = dispatch_request_for_content_reader(
  12754. req, res, std::move(reader), put_handlers_for_content_reader_);
  12755. } else if (req.method == "PATCH") {
  12756. dispatched = dispatch_request_for_content_reader(
  12757. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12758. } else if (req.method == "DELETE") {
  12759. dispatched = dispatch_request_for_content_reader(
  12760. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12761. } else if (custom) {
  12762. dispatched = dispatch_request_for_content_reader(
  12763. req, res, std::move(reader), custom->handlers_for_content_reader);
  12764. }
  12765. if (dispatched) {
  12766. if (content_reader_payload_too_large) {
  12767. // Enforce the limit: override any status the handler may have set
  12768. // and return false so the error path sends a plain 413 response.
  12769. res.status = StatusCode::PayloadTooLarge_413;
  12770. detail::clear_content(res);
  12771. return false;
  12772. }
  12773. return true;
  12774. }
  12775. }
  12776. // NOTE: `req.body` is not read here. For a regular handler the body is
  12777. // read inside dispatch_request(), after the route has matched and the
  12778. // pre-request handler has approved the request, so that a rejected
  12779. // request (e.g. failed authentication) never forces us to buffer a
  12780. // potentially large body.
  12781. }
  12782. // Regular handler
  12783. if (req.method == "GET" || req.method == "HEAD") {
  12784. return dispatch_request(req, res, get_handlers_, strm);
  12785. } else if (req.method == "POST") {
  12786. return dispatch_request(req, res, post_handlers_, strm);
  12787. } else if (req.method == "PUT") {
  12788. return dispatch_request(req, res, put_handlers_, strm);
  12789. } else if (req.method == "DELETE") {
  12790. return dispatch_request(req, res, delete_handlers_, strm);
  12791. } else if (req.method == "OPTIONS") {
  12792. return dispatch_request(req, res, options_handlers_, strm);
  12793. } else if (req.method == "PATCH") {
  12794. return dispatch_request(req, res, patch_handlers_, strm);
  12795. } else if (custom) {
  12796. return dispatch_request(req, res, custom->handlers, strm);
  12797. }
  12798. res.status = StatusCode::BadRequest_400;
  12799. return false;
  12800. }
  12801. inline bool Server::dispatch_request(Request &req, Response &res,
  12802. const Handlers &handlers, Stream &strm) {
  12803. for (const auto &x : handlers) {
  12804. const auto &matcher = x.first;
  12805. const auto &handler = x.second;
  12806. if (matcher->match(req)) {
  12807. req.matched_route = matcher->pattern();
  12808. // Run the pre-request handler before reading the body so a rejected
  12809. // request (e.g. failed authentication) never forces us to buffer a
  12810. // potentially large body. `req.matched_route` is available here.
  12811. if (pre_request_handler_ &&
  12812. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12813. return true;
  12814. }
  12815. // The route matched and the request was approved; read the body now.
  12816. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12817. output_error_log(Error::Read, &req);
  12818. return false;
  12819. }
  12820. handler(req, res);
  12821. return true;
  12822. }
  12823. }
  12824. return false;
  12825. }
  12826. // Decides the content coding for a response served straight from a file. Both
  12827. // the ETag, which has to name the representation actually sent, and
  12828. // `apply_static_file_compression()` go through this, so the two cannot drift
  12829. // apart.
  12830. inline detail::EncodingType
  12831. Server::static_file_encoding(const Request &req, const Response &res,
  12832. const std::string &content_type,
  12833. size_t length) const {
  12834. if (!static_file_compression_) { return detail::EncodingType::None; }
  12835. // Nothing to compress, and an empty file already answers with
  12836. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12837. // turn an empty body into a 20-byte gzip stream.
  12838. if (length == 0) { return detail::EncodingType::None; }
  12839. // A file that already fits in a single packet gains nothing from being made
  12840. // smaller, since it still travels in that one segment, and a file of a few
  12841. // bytes comes out larger than it went in.
  12842. if (length < static_file_compression_min_length_) {
  12843. return detail::EncodingType::None;
  12844. }
  12845. // RFC 9110 applies Range to the representation after content coding, so a
  12846. // compressed 206 would mean compressing the whole file and then slicing it.
  12847. // Serve ranges from the identity representation instead.
  12848. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12849. if (static_file_compression_max_length_ > 0 &&
  12850. length > static_file_compression_max_length_) {
  12851. return detail::EncodingType::None;
  12852. }
  12853. return detail::encoding_type(req, res, content_type);
  12854. }
  12855. // Compresses a file-backed content provider into `res.body`. Returns false when
  12856. // the response is left untouched.
  12857. inline bool Server::apply_static_file_compression(const Request &req,
  12858. Response &res) const {
  12859. auto type = res.content_coding_;
  12860. if (type == detail::EncodingType::None || !res.content_provider_) {
  12861. return false;
  12862. }
  12863. auto compressor = detail::make_compressor(type);
  12864. if (!compressor) { return false; }
  12865. output_pre_compression_log(req, res);
  12866. std::string compressed;
  12867. if (!detail::compress_content_provider(res.content_provider_,
  12868. res.content_length_, *compressor,
  12869. compressed)) {
  12870. return false;
  12871. }
  12872. res.body.swap(compressed);
  12873. // The provider was consumed in full, so its releaser hears about a success.
  12874. res.content_provider_success_ = true;
  12875. detail::clear_content_provider(res);
  12876. res.set_header("Content-Encoding", detail::encoding_name(type));
  12877. res.set_header("Vary", "Accept-Encoding");
  12878. return true;
  12879. }
  12880. inline void Server::apply_ranges(const Request &req, Response &res,
  12881. std::string &content_type,
  12882. std::string &boundary) const {
  12883. // A known-length content provider leaves `res.body` empty, so the compressor
  12884. // at the end of this function never runs for one (issue #2545). A file-backed
  12885. // provider is fully readable right here, so compress it and answer with an
  12886. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12887. // takes the same path as `set_content()` from here on. Range requests never
  12888. // get a content coding, so `Content-Range` still names identity bytes and
  12889. // none of the range handling below applies.
  12890. if (apply_static_file_compression(req, res)) { return; }
  12891. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12892. auto it = res.headers.find("Content-Type");
  12893. if (it != res.headers.end()) {
  12894. content_type = it->second;
  12895. res.headers.erase(it);
  12896. }
  12897. boundary = detail::make_multipart_data_boundary();
  12898. res.set_header("Content-Type",
  12899. "multipart/byteranges; boundary=" + boundary);
  12900. }
  12901. auto type =
  12902. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  12903. if (res.body.empty()) {
  12904. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12905. res.status == StatusCode::PartialContent_206) {
  12906. auto offset_and_length = detail::get_range_offset_and_length(
  12907. req.ranges[0], res.content_length_);
  12908. auto content_range = detail::make_content_range_header_field(
  12909. offset_and_length, res.content_length_);
  12910. res.set_header("Content-Range", content_range);
  12911. } else if (res.is_chunked_content_provider_) {
  12912. res.content_coding_ = type;
  12913. if (type != detail::EncodingType::None) {
  12914. res.set_header("Content-Encoding", detail::encoding_name(type));
  12915. res.set_header("Vary", "Accept-Encoding");
  12916. }
  12917. }
  12918. } else {
  12919. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12920. ;
  12921. } else if (req.ranges.size() == 1) {
  12922. auto offset_and_length =
  12923. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12924. auto offset = offset_and_length.first;
  12925. auto length = offset_and_length.second;
  12926. auto content_range = detail::make_content_range_header_field(
  12927. offset_and_length, res.body.size());
  12928. res.set_header("Content-Range", content_range);
  12929. assert(offset + length <= res.body.size());
  12930. res.body = res.body.substr(offset, length);
  12931. } else {
  12932. std::string data;
  12933. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12934. res.body.size(), data);
  12935. res.body.swap(data);
  12936. }
  12937. if (type != detail::EncodingType::None) {
  12938. output_pre_compression_log(req, res);
  12939. if (auto compressor = detail::make_compressor(type)) {
  12940. std::string compressed;
  12941. if (compressor->compress(res.body.data(), res.body.size(), true,
  12942. [&](const char *data, size_t data_len) {
  12943. compressed.append(data, data_len);
  12944. return true;
  12945. })) {
  12946. res.body.swap(compressed);
  12947. res.set_header("Content-Encoding", detail::encoding_name(type));
  12948. res.set_header("Vary", "Accept-Encoding");
  12949. }
  12950. }
  12951. }
  12952. res.content_length_ = res.body.size();
  12953. }
  12954. }
  12955. inline bool Server::dispatch_request_for_content_reader(
  12956. Request &req, Response &res, ContentReader content_reader,
  12957. const HandlersForContentReader &handlers) const {
  12958. for (const auto &x : handlers) {
  12959. const auto &matcher = x.first;
  12960. const auto &handler = x.second;
  12961. if (matcher->match(req)) {
  12962. req.matched_route = matcher->pattern();
  12963. if (!pre_request_handler_ ||
  12964. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12965. handler(req, res, content_reader);
  12966. }
  12967. return true;
  12968. }
  12969. }
  12970. return false;
  12971. }
  12972. inline std::string
  12973. get_client_ip(const std::string &x_forwarded_for,
  12974. const std::vector<std::string> &trusted_proxies) {
  12975. // X-Forwarded-For is a comma-separated list per RFC 7239
  12976. std::vector<std::string> ip_list;
  12977. detail::split(x_forwarded_for.data(),
  12978. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12979. [&](const char *b, const char *e) {
  12980. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12981. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12982. });
  12983. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12984. // no segments. Signal "no client IP derived" with an empty string so the
  12985. // caller can fall back to the connection-level remote address.
  12986. if (ip_list.empty()) { return std::string(); }
  12987. // Each hop appends the address it received the request from, so the rightmost
  12988. // entries are the ones written by our own infrastructure while the leftmost
  12989. // are whatever the original client chose to send. Walk from the right and
  12990. // skip trusted proxies; the first address that is not a trusted proxy is the
  12991. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12992. // from the left instead lets a client forge an arbitrary address by following
  12993. // it with a trusted proxy's address, which the left-to-right scan then
  12994. // returned as the client.
  12995. for (size_t i = ip_list.size(); i-- > 0;) {
  12996. const auto &ip = ip_list[i];
  12997. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  12998. }
  12999. // Every hop was a trusted proxy; fall back to the first entry.
  13000. return ip_list.front();
  13001. }
  13002. inline bool
  13003. Server::process_request(Stream &strm, const std::string &remote_addr,
  13004. int remote_port, const std::string &local_addr,
  13005. int local_port, bool close_connection,
  13006. bool &connection_closed,
  13007. const std::function<void(Request &)> &setup_request,
  13008. bool *websocket_upgraded) {
  13009. std::array<char, 2048> buf{};
  13010. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13011. // The read timeout bounds the request line and headers as a whole, so a
  13012. // client sending them a byte at a time cannot hold the worker any longer.
  13013. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  13014. strm.set_max_timeout(read_timeout_msec);
  13015. // Connection has been closed on client
  13016. if (!line_reader.getline()) { return false; }
  13017. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  13018. // clients send an extra CRLF after a request body, which would otherwise be
  13019. // parsed as the next request on a persistent connection.
  13020. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  13021. return false;
  13022. }
  13023. Request req;
  13024. req.start_time_ = std::chrono::steady_clock::now();
  13025. req.remote_addr = remote_addr;
  13026. req.remote_port = remote_port;
  13027. req.local_addr = local_addr;
  13028. req.local_port = local_port;
  13029. Response res;
  13030. res.version = "HTTP/1.1";
  13031. res.headers = default_headers_;
  13032. // RFC 9112 §9.6: a server that sends the "close" connection option must
  13033. // close the connection after that response, whichever path wrote it (an
  13034. // error status, a handler, or a rejected request). Reading on would also
  13035. // parse whatever the client sent next on a connection it considers done.
  13036. auto honor_connection_close = detail::scope_exit([&] {
  13037. if (detail::has_header_token(res.headers, "Connection", "close")) {
  13038. connection_closed = true;
  13039. }
  13040. });
  13041. // Request line and headers. A rejected message leaves the rest of it (and
  13042. // any body) unread, so the connection cannot be reused: the leftover bytes
  13043. // would be parsed as the next request.
  13044. if (!parse_request_line(line_reader.ptr(), req)) {
  13045. connection_closed = true;
  13046. res.status = StatusCode::BadRequest_400;
  13047. output_error_log(Error::InvalidRequestLine, &req);
  13048. return write_response(strm, close_connection, req, res);
  13049. }
  13050. // Request headers
  13051. if (!detail::read_headers(strm, req.headers)) {
  13052. connection_closed = true;
  13053. res.status = StatusCode::BadRequest_400;
  13054. output_error_log(Error::InvalidHeaders, &req);
  13055. return write_response(strm, close_connection, req, res);
  13056. }
  13057. strm.set_max_timeout(0);
  13058. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  13059. // which would otherwise let an intermediary and this parser disagree on
  13060. // where the body ends and enable request smuggling. Three cases: a
  13061. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  13062. // or empty), which would otherwise be read as "no body"; a non-zero
  13063. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  13064. // tolerated for compatibility with existing clients); and a
  13065. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  13066. // length undeterminable. None of them may fall through to the "no body"
  13067. // path, or the body bytes are parsed as the next request on a persistent
  13068. // connection.
  13069. auto is_invalid_content_length = false;
  13070. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  13071. is_invalid_content_length);
  13072. if (is_invalid_content_length ||
  13073. detail::has_conflicting_content_length(req.headers) ||
  13074. (req.has_header("Transfer-Encoding") &&
  13075. !detail::is_chunked_transfer_encoding(req.headers))) {
  13076. connection_closed = true;
  13077. res.status = StatusCode::BadRequest_400;
  13078. return write_response(strm, close_connection, req, res);
  13079. }
  13080. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  13081. if (req.has_header("Transfer-Encoding") &&
  13082. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  13083. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  13084. "chunked"))) {
  13085. connection_closed = true;
  13086. res.status = StatusCode::NotImplemented_501;
  13087. return write_response(strm, close_connection, req, res);
  13088. }
  13089. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  13090. // HTTP/1.0 request, is honoured, but the connection closes after the
  13091. // response.
  13092. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  13093. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  13094. // value, or none in HTTP/1.1, so that every recipient of the request sees
  13095. // the same authority.
  13096. auto host_count = req.get_header_value_count("Host");
  13097. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  13098. !detail::fields::is_host(req.get_header_value("Host"))) {
  13099. connection_closed = true;
  13100. res.status = StatusCode::BadRequest_400;
  13101. output_error_log(Error::InvalidHeaders, &req);
  13102. return write_response(strm, close_connection, req, res);
  13103. }
  13104. // Check if the request URI doesn't exceed the limit
  13105. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13106. connection_closed = true;
  13107. res.status = StatusCode::UriTooLong_414;
  13108. output_error_log(Error::ExceedUriMaxLength, &req);
  13109. return write_response(strm, close_connection, req, res);
  13110. }
  13111. if (detail::has_header_token(req.headers, "Connection", "close")) {
  13112. connection_closed = true;
  13113. }
  13114. if (req.version == "HTTP/1.0" &&
  13115. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  13116. connection_closed = true;
  13117. }
  13118. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  13119. // itself a trusted proxy. Otherwise any direct client could spoof
  13120. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  13121. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  13122. req.has_header("X-Forwarded-For")) {
  13123. // Some proxies append the address they observed as a separate
  13124. // X-Forwarded-For field line instead of extending the one the client sent
  13125. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  13126. // be scanned. Reading only the first occurrence would hand back the
  13127. // client-supplied, and therefore forgeable, value.
  13128. auto x_forwarded_for =
  13129. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  13130. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  13131. req.remote_addr = derived.empty() ? remote_addr : derived;
  13132. } else {
  13133. req.remote_addr = remote_addr;
  13134. }
  13135. req.remote_port = remote_port;
  13136. req.local_addr = local_addr;
  13137. req.local_port = local_port;
  13138. if (req.has_header("Accept")) {
  13139. auto accept_header =
  13140. detail::get_combined_header_value(req.headers, "Accept");
  13141. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  13142. connection_closed = true;
  13143. res.status = StatusCode::BadRequest_400;
  13144. output_error_log(Error::HTTPParsing, &req);
  13145. return write_response(strm, close_connection, req, res);
  13146. }
  13147. }
  13148. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  13149. if ((req.method == "GET" || req.method == "HEAD") &&
  13150. req.has_header("Range")) {
  13151. const auto &range_header_value = req.get_header_value("Range");
  13152. // RFC 9110 14.2: a range unit other than bytes must be ignored
  13153. auto unit = range_header_value.substr(0, range_header_value.find('='));
  13154. if (detail::case_ignore::equal(unit, "bytes") &&
  13155. !detail::parse_range_header(range_header_value, req.ranges)) {
  13156. connection_closed = true;
  13157. res.status = StatusCode::RangeNotSatisfiable_416;
  13158. output_error_log(Error::InvalidRangeHeader, &req);
  13159. return write_response(strm, close_connection, req, res);
  13160. }
  13161. }
  13162. if (setup_request) { setup_request(req); }
  13163. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  13164. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  13165. // must be ignored. An expectation we do not recognize is left alone; the
  13166. // 417 the section allows for one is a MAY, not a requirement.
  13167. //
  13168. // `100 Continue` itself is deferred until the body is actually read (see
  13169. // read_content_core), so a request rejected by a later handler never
  13170. // invites the client to send a body nobody will read.
  13171. if (req.version != "HTTP/1.0" &&
  13172. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  13173. int status = StatusCode::Continue_100;
  13174. if (expect_100_continue_handler_) {
  13175. status = expect_100_continue_handler_(req, res);
  13176. }
  13177. if (status == StatusCode::Continue_100) {
  13178. req.expect_100_continue_pending_ = true;
  13179. } else {
  13180. if (res.status == -1) { res.status = status; }
  13181. connection_closed = true;
  13182. return write_response(strm, true, req, res);
  13183. }
  13184. }
  13185. // Setup `is_connection_closed` method
  13186. auto sock = strm.socket();
  13187. req.is_connection_closed = [sock]() {
  13188. return !detail::is_socket_alive(sock);
  13189. };
  13190. // WebSocket upgrade
  13191. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13192. // that authentication and other middleware can reject the request with an
  13193. // HTTP response (e.g., 401) before the protocol switches.
  13194. // The response says so when this connection closes after it.
  13195. auto close_after_response = close_connection || connection_closed;
  13196. // An upgrade request has been through pre-routing before it reaches routing()
  13197. auto is_upgrade = detail::is_websocket_upgrade(req);
  13198. if (is_upgrade) {
  13199. // A response given here leaves the body unread, and it would be parsed as
  13200. // the next request.
  13201. auto close_if_answered =
  13202. close_after_response || detail::has_framed_body(req);
  13203. const WebSocketHandlerEntry *ws_route = nullptr;
  13204. std::string selected_subprotocol;
  13205. auto answer_before_upgrade = [&]() -> bool {
  13206. if (pre_routing_handler_ &&
  13207. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13208. return true;
  13209. }
  13210. for (const auto &entry : websocket_handlers_) {
  13211. if (!entry.matcher->match(req)) { continue; }
  13212. req.matched_route = entry.matcher->pattern();
  13213. if (pre_request_handler_ &&
  13214. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13215. return true;
  13216. }
  13217. ws_route = &entry;
  13218. if (entry.sub_protocol_selector) {
  13219. auto protocol_header = detail::get_combined_header_value(
  13220. req.headers, "Sec-WebSocket-Protocol");
  13221. if (!protocol_header.empty()) {
  13222. std::vector<std::string> protocols;
  13223. detail::split(protocol_header.data(),
  13224. protocol_header.data() + protocol_header.size(), ',',
  13225. [&](const char *b, const char *e) {
  13226. protocols.emplace_back(b, e);
  13227. });
  13228. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13229. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13230. if (std::find(protocols.begin(), protocols.end(),
  13231. selected_subprotocol) == protocols.end()) {
  13232. selected_subprotocol.clear();
  13233. }
  13234. }
  13235. }
  13236. return false;
  13237. }
  13238. return false;
  13239. };
  13240. auto answered = false;
  13241. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13242. answered = answer_before_upgrade();
  13243. #else
  13244. try {
  13245. answered = answer_before_upgrade();
  13246. } catch (...) {
  13247. if (!handle_exception(req, res)) {
  13248. return write_response(strm, close_if_answered, req, res);
  13249. }
  13250. answered = true;
  13251. }
  13252. #endif
  13253. if (answered) {
  13254. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13255. return write_response_with_content(strm, close_if_answered, req, res);
  13256. }
  13257. if (ws_route) {
  13258. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13259. auto accept_key = detail::websocket_accept_key(client_key);
  13260. // Send 101 Switching Protocols
  13261. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13262. "Upgrade: websocket\r\n"
  13263. "Connection: Upgrade\r\n"
  13264. "Sec-WebSocket-Accept: " +
  13265. accept_key + "\r\n";
  13266. if (!selected_subprotocol.empty()) {
  13267. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13268. return false;
  13269. }
  13270. handshake_response +=
  13271. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13272. }
  13273. handshake_response += "\r\n";
  13274. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13275. 0) {
  13276. return false;
  13277. }
  13278. connection_closed = true;
  13279. if (websocket_upgraded) { *websocket_upgraded = true; }
  13280. auto stopping = [this] { return is_stopping(); };
  13281. if (CPPHTTPLIB_WEBSOCKET_TCP_NODELAY) {
  13282. set_socket_opt(strm.socket(), IPPROTO_TCP, TCP_NODELAY, 1);
  13283. }
  13284. #ifdef CPPHTTPLIB_SSL_ENABLED
  13285. if (req.ssl) {
  13286. // wss: the heartbeat ping thread and the read path enter the same
  13287. // TLS session from different threads. Hand the WebSocket a stream
  13288. // that serializes every TLS call, so the shared SSLSocketStream on
  13289. // the plain HTTP/HTTPS paths stays untouched.
  13290. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13291. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13292. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13293. write_timeout_sec_, write_timeout_usec_));
  13294. ws::WebSocket ws(std::move(ws_strm), req, true,
  13295. websocket_ping_interval_sec_,
  13296. websocket_max_missed_pongs_, stopping);
  13297. ws_route->handler(req, ws);
  13298. return true;
  13299. }
  13300. #endif
  13301. // Use WebSocket-specific read timeout instead of HTTP timeout
  13302. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13303. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13304. websocket_max_missed_pongs_, stopping);
  13305. ws_route->handler(req, ws);
  13306. return true;
  13307. }
  13308. // No WebSocket route: route it as a plain HTTP request
  13309. }
  13310. // Routing
  13311. auto routed = false;
  13312. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13313. routed = routing(req, res, strm, is_upgrade);
  13314. #else
  13315. try {
  13316. routed = routing(req, res, strm, is_upgrade);
  13317. } catch (...) { routed = handle_exception(req, res); }
  13318. #endif
  13319. auto ret = false;
  13320. if (routed) {
  13321. if (res.status == -1) {
  13322. res.status = req.ranges.empty() ? StatusCode::OK_200
  13323. : StatusCode::PartialContent_206;
  13324. }
  13325. // Before the Range checks below, so they see the body's own length.
  13326. detail::prefer_assigned_body(res);
  13327. // Serve file content by using a content provider
  13328. auto file_open_error = false;
  13329. if (!res.file_content_path_.empty()) {
  13330. const auto &path = res.file_content_path_;
  13331. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13332. if (!mm->is_open()) {
  13333. res.status = StatusCode::NotFound_404;
  13334. output_error_log(Error::OpenFile, &req);
  13335. file_open_error = true;
  13336. } else {
  13337. auto content_type = res.file_content_content_type_;
  13338. if (content_type.empty()) {
  13339. // One the handler set after set_file_content()
  13340. content_type = res.get_header_value("Content-Type");
  13341. }
  13342. if (content_type.empty()) {
  13343. content_type = detail::find_content_type(
  13344. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13345. }
  13346. detail::set_file_content_provider(
  13347. res, mm, content_type,
  13348. static_file_encoding(req, res, content_type, mm->size()));
  13349. }
  13350. }
  13351. if (file_open_error) {
  13352. ret = write_response(strm, close_after_response, req, res);
  13353. } else if (detail::range_error(req, res)) {
  13354. detail::clear_content(res);
  13355. res.status = StatusCode::RangeNotSatisfiable_416;
  13356. ret = write_response(strm, close_after_response, req, res);
  13357. } else {
  13358. ret = write_response_with_content(strm, close_after_response, req, res);
  13359. }
  13360. } else {
  13361. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13362. ret = write_response(strm, close_after_response, req, res);
  13363. }
  13364. // Drain any unconsumed framed body to prevent request smuggling on
  13365. // keep-alive. Without framing there is no body to drain — reading would
  13366. // consume the next request (issue #2450). If the response has committed the
  13367. // connection to close, there is no next request to protect. A body read in
  13368. // part cannot be drained from where it stopped, so the connection closes,
  13369. // as it does when the body is longer than the drain limit or does not
  13370. // arrive within the read timeout.
  13371. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13372. !detail::has_header_token(res.headers, "Connection", "close")) {
  13373. strm.set_max_timeout(read_timeout_msec);
  13374. int dummy_status;
  13375. if (req.body_read_started_ ||
  13376. !detail::read_content(
  13377. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13378. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13379. false)) {
  13380. connection_closed = true;
  13381. }
  13382. }
  13383. return ret;
  13384. }
  13385. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13386. inline bool Server::process_and_close_socket(socket_t sock) {
  13387. std::string remote_addr;
  13388. int remote_port = 0;
  13389. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13390. std::string local_addr;
  13391. int local_port = 0;
  13392. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13393. bool websocket_upgraded = false;
  13394. auto ret = serve_guarded([&]() {
  13395. return detail::process_server_socket(
  13396. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13397. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13398. write_timeout_usec_,
  13399. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13400. return process_request(strm, remote_addr, remote_port, local_addr,
  13401. local_port, close_connection,
  13402. connection_closed, nullptr,
  13403. &websocket_upgraded);
  13404. });
  13405. });
  13406. detail::drain_and_close_socket(sock);
  13407. return ret;
  13408. }
  13409. inline void Server::output_log(const Request &req, const Response &res) const {
  13410. if (logger_) {
  13411. std::lock_guard<std::mutex> guard(logger_mutex_);
  13412. logger_(req, res);
  13413. }
  13414. }
  13415. inline void Server::output_pre_compression_log(const Request &req,
  13416. const Response &res) const {
  13417. if (pre_compression_logger_) {
  13418. std::lock_guard<std::mutex> guard(logger_mutex_);
  13419. pre_compression_logger_(req, res);
  13420. }
  13421. }
  13422. inline void Server::output_error_log(const Error &err,
  13423. const Request *req) const {
  13424. if (error_logger_) {
  13425. std::lock_guard<std::mutex> guard(logger_mutex_);
  13426. error_logger_(err, req);
  13427. }
  13428. }
  13429. /*
  13430. * Group 5: ClientImpl and Client (Universal) implementation
  13431. */
  13432. // HTTP client implementation
  13433. inline ClientImpl::ClientImpl(const std::string &host)
  13434. : ClientImpl(host, 80, std::string(), std::string()) {}
  13435. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13436. : ClientImpl(host, port, std::string(), std::string()) {}
  13437. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13438. const std::string &client_cert_path,
  13439. const std::string &client_key_path)
  13440. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13441. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13442. inline ClientImpl::~ClientImpl() {
  13443. // Wait until all the requests in flight are handled.
  13444. size_t retry_count = 10;
  13445. while (retry_count-- > 0) {
  13446. {
  13447. std::lock_guard<std::mutex> guard(socket_mutex_);
  13448. if (socket_requests_in_flight_ == 0) { break; }
  13449. }
  13450. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13451. }
  13452. std::lock_guard<std::mutex> guard(socket_mutex_);
  13453. shutdown_socket(socket_);
  13454. close_socket(socket_);
  13455. }
  13456. inline bool ClientImpl::is_valid() const { return true; }
  13457. inline bool
  13458. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13459. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13460. if (no_proxy_entries_.empty()) { return true; }
  13461. // host_ is const so its normalized form is invariant; cache it. The
  13462. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13463. if (host == host_) {
  13464. if (!host_normalized_valid_) {
  13465. host_normalized_ = detail::normalize_target(host_);
  13466. host_normalized_valid_ = true;
  13467. }
  13468. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13469. }
  13470. auto target = detail::normalize_target(host);
  13471. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13472. }
  13473. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13474. if (is_proxy_enabled_for_host(host_)) {
  13475. return detail::create_client_socket(
  13476. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13477. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13478. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13479. write_timeout_sec_, write_timeout_usec_, interface_, error,
  13480. stop_interrupt());
  13481. }
  13482. // Check is custom IP or hostname specified for host_
  13483. std::string connect_host;
  13484. std::string ip;
  13485. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13486. return detail::create_client_socket(
  13487. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13488. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13489. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13490. write_timeout_usec_, interface_, error, stop_interrupt());
  13491. }
  13492. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13493. Error &error) {
  13494. auto sock = create_client_socket(error);
  13495. if (sock == INVALID_SOCKET) { return false; }
  13496. socket.sock = sock;
  13497. return true;
  13498. }
  13499. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13500. socket_tls_settings_version_ = tls_settings_version_;
  13501. return create_and_connect_socket(socket, error);
  13502. }
  13503. inline bool ClientImpl::setup_proxy_connection(
  13504. Socket & /*socket*/,
  13505. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13506. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13507. return true;
  13508. }
  13509. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13510. bool /*shutdown_gracefully*/) {
  13511. // If there are any requests in flight from threads other than us, then it's
  13512. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13513. assert(socket_requests_in_flight_ == 0 ||
  13514. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13515. }
  13516. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13517. if (socket.sock == INVALID_SOCKET) { return; }
  13518. detail::shutdown_socket(socket.sock);
  13519. }
  13520. inline void ClientImpl::close_socket(Socket &socket) {
  13521. // If there are requests in flight in another thread, usually closing
  13522. // the socket will be fine and they will simply receive an error when
  13523. // using the closed socket, but it is still a bug since rarely the OS
  13524. // may reassign the socket id to be used for a new socket, and then
  13525. // suddenly they will be operating on a live socket that is different
  13526. // than the one they intended!
  13527. assert(socket_requests_in_flight_ == 0 ||
  13528. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13529. // It is also a bug if this happens while SSL is still active
  13530. #ifdef CPPHTTPLIB_SSL_ENABLED
  13531. assert(socket.ssl == nullptr);
  13532. #endif
  13533. if (socket.sock == INVALID_SOCKET) { return; }
  13534. detail::close_socket(socket.sock);
  13535. socket.sock = INVALID_SOCKET;
  13536. }
  13537. inline void ClientImpl::disconnect(bool gracefully) {
  13538. shutdown_ssl(socket_, gracefully);
  13539. shutdown_socket(socket_);
  13540. close_socket(socket_);
  13541. }
  13542. inline bool ClientImpl::socket_reusable() {
  13543. if (!socket_.is_open()) { return false; }
  13544. // RFC 9112 9.2: data with no request outstanding is not a response
  13545. if (detail::select_read(socket_.sock, 0, 0) != 0) {
  13546. disconnect(/*gracefully=*/false);
  13547. return false;
  13548. }
  13549. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13550. disconnect(/*gracefully=*/true);
  13551. return false;
  13552. }
  13553. return true;
  13554. }
  13555. inline bool ClientImpl::prepare_socket(
  13556. std::unique_lock<std::mutex> &guard,
  13557. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13558. Response &res, bool &success, Error &error) {
  13559. auto opened = true;
  13560. if (!socket_reusable()) {
  13561. Socket socket;
  13562. guard.unlock();
  13563. opened = ensure_socket_connection(socket, error);
  13564. if (opened) {
  13565. opened = setup_proxy_connection(socket, start_time, res, success, error);
  13566. } else {
  13567. success = false;
  13568. }
  13569. guard.lock();
  13570. socket_ = socket;
  13571. }
  13572. if (stop_requested_) {
  13573. disconnect(/*gracefully=*/false);
  13574. error = Error::Canceled;
  13575. success = false;
  13576. return false;
  13577. }
  13578. return opened;
  13579. }
  13580. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13581. Response &res,
  13582. bool skip_100_continue) const {
  13583. std::array<char, 2048> buf{};
  13584. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13585. if (!line_reader.getline()) { return false; }
  13586. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13587. res.reason)) {
  13588. return req.method == "CONNECT";
  13589. }
  13590. // Skip interim (1xx) responses along with their header fields, except a 100
  13591. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13592. // HTTP on the connection, so it is final. A server sending them without end
  13593. // would hold the client, so there may be only so many.
  13594. size_t interim_count = 0;
  13595. while (100 <= res.status && res.status < 200 &&
  13596. res.status != StatusCode::SwitchingProtocol_101 &&
  13597. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13598. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13599. return false;
  13600. }
  13601. Headers interim_headers;
  13602. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13603. if (!line_reader.getline()) { return false; } // next response line
  13604. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13605. res.reason)) {
  13606. return false;
  13607. }
  13608. }
  13609. return true;
  13610. }
  13611. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13612. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13613. // A same-origin redirect and a digest retry send through here again. Only
  13614. // the call the caller made reports a failure, once, with its request.
  13615. auto outermost = send_depth_++ == 0;
  13616. auto se = detail::scope_exit([&] { send_depth_--; });
  13617. if (outermost) {
  13618. error = Error::Success;
  13619. stop_requested_ = false;
  13620. }
  13621. auto ret = send_(req, res, error);
  13622. if (error == Error::SSLPeerCouldBeClosed_) {
  13623. assert(!ret);
  13624. ret = send_(req, res, error);
  13625. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13626. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13627. }
  13628. // Also an answer that carries an error, such as a proxy's 407
  13629. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13630. return ret;
  13631. }
  13632. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13633. #ifdef CPPHTTPLIB_SSL_ENABLED
  13634. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13635. // client that failed to set up its TLS context keeps reporting why.
  13636. if (is_valid()) {
  13637. last_ssl_error_ = 0;
  13638. last_backend_error_ = 0;
  13639. }
  13640. #endif
  13641. {
  13642. std::unique_lock<std::mutex> guard(socket_mutex_);
  13643. // Set this to false immediately - if it ever gets set to true by the end
  13644. // of the request, we know another thread instructed us to close the
  13645. // socket.
  13646. socket_should_be_closed_when_request_is_done_ = false;
  13647. auto success = true;
  13648. if (!prepare_socket(guard, req.start_time_, res, success, error)) {
  13649. return success;
  13650. }
  13651. // Mark the current socket as being in use so that it cannot be closed by
  13652. // anyone else while this request is ongoing, even though we will be
  13653. // releasing the mutex.
  13654. if (socket_requests_in_flight_ > 1) {
  13655. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13656. }
  13657. socket_requests_in_flight_ += 1;
  13658. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13659. }
  13660. for (const auto &header : default_headers_) {
  13661. if (req.headers.find(header.first) == req.headers.end()) {
  13662. req.headers.insert(header);
  13663. }
  13664. }
  13665. auto ret = false;
  13666. auto close_connection = !keep_alive_;
  13667. auto se = detail::scope_exit([&]() {
  13668. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13669. std::lock_guard<std::mutex> guard(socket_mutex_);
  13670. socket_requests_in_flight_ -= 1;
  13671. if (socket_requests_in_flight_ <= 0) {
  13672. assert(socket_requests_in_flight_ == 0);
  13673. socket_requests_are_from_thread_ = std::thread::id();
  13674. }
  13675. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13676. !ret) {
  13677. disconnect(/*gracefully=*/true);
  13678. }
  13679. });
  13680. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13681. strm.set_read_interrupt(stop_interrupt());
  13682. return handle_request(strm, req, res, close_connection, error);
  13683. });
  13684. if (!ret) {
  13685. if (error == Error::Success) { error = Error::Unknown; }
  13686. }
  13687. return ret;
  13688. }
  13689. inline Result ClientImpl::send(const Request &req) {
  13690. auto req2 = req;
  13691. return send_(std::move(req2));
  13692. }
  13693. inline Result ClientImpl::send_(Request &&req) {
  13694. auto res = detail::make_unique<Response>();
  13695. auto error = Error::Success;
  13696. #ifdef CPPHTTPLIB_SSL_ENABLED
  13697. // Hold the request lock until the Result has read this request's TLS error
  13698. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13699. #endif
  13700. auto ret = send(req, *res, error);
  13701. #ifdef CPPHTTPLIB_SSL_ENABLED
  13702. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13703. last_ssl_error_, last_backend_error_};
  13704. #else
  13705. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13706. #endif
  13707. }
  13708. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13709. const std::string &ct) {
  13710. (void)for_stream;
  13711. // Default headers are meant for the origin and may carry its credentials, so
  13712. // keep them off the CONNECT request the proxy reads.
  13713. if (r.method != "CONNECT") {
  13714. for (const auto &header : default_headers_) {
  13715. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13716. }
  13717. }
  13718. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13719. // prepend it rather than appending it after the caller's own fields.
  13720. if (!r.has_header("Host")) {
  13721. r.headers.emplace_front(
  13722. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13723. address_family_));
  13724. }
  13725. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13726. if (!r.content_receiver) {
  13727. if (!r.has_header("Accept-Encoding")) {
  13728. std::string accept_encoding;
  13729. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13730. accept_encoding = "br";
  13731. #endif
  13732. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13733. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13734. accept_encoding += "gzip, deflate";
  13735. #endif
  13736. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13737. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13738. accept_encoding += "zstd";
  13739. #endif
  13740. r.set_header("Accept-Encoding", accept_encoding);
  13741. }
  13742. detail::add_default_user_agent_header(r);
  13743. }
  13744. if (!r.body.empty()) {
  13745. if (!ct.empty() && !r.has_header("Content-Type")) {
  13746. r.headers.emplace("Content-Type", ct);
  13747. }
  13748. if (!r.has_header("Content-Length")) {
  13749. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13750. }
  13751. }
  13752. }
  13753. inline ClientImpl::StreamHandle
  13754. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13755. const Params &params, const Headers &headers,
  13756. const std::string &body,
  13757. const std::string &content_type) {
  13758. // Encode the target exactly like the buffered send path does, so that the
  13759. // same `path` produces the same request line through either API.
  13760. auto raw_query_path =
  13761. params.empty() ? path : append_query_params(path, params);
  13762. Request req;
  13763. req.method = method;
  13764. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13765. req.headers = headers;
  13766. req.body = body;
  13767. prepare_default_headers(req, true, content_type);
  13768. auto handle = open_stream_(req);
  13769. // Like a buffered request, a stream that fails to open is reported once
  13770. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13771. return handle;
  13772. }
  13773. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13774. StreamHandle handle;
  13775. handle.response = detail::make_unique<Response>();
  13776. handle.error = Error::Success;
  13777. handle.connection_ = detail::make_unique<ClientConnection>();
  13778. {
  13779. // A request in flight uses socket_ without holding socket_mutex_
  13780. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13781. if (send_depth_ == 0) { stop_requested_ = false; }
  13782. std::unique_lock<std::mutex> guard(socket_mutex_);
  13783. auto success = true;
  13784. if (!prepare_socket(guard, std::chrono::steady_clock::now(),
  13785. *handle.response, success, handle.error)) {
  13786. if (!success) { handle.response.reset(); }
  13787. return handle;
  13788. }
  13789. transfer_socket_ownership_to_handle(handle);
  13790. }
  13791. #ifdef CPPHTTPLIB_SSL_ENABLED
  13792. if (is_ssl() && handle.connection_->session) {
  13793. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13794. handle.connection_->sock, handle.connection_->session,
  13795. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13796. write_timeout_usec_);
  13797. } else {
  13798. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13799. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13800. write_timeout_sec_, write_timeout_usec_);
  13801. }
  13802. #else
  13803. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13804. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13805. write_timeout_sec_, write_timeout_usec_);
  13806. #endif
  13807. handle.stream_ = handle.socket_stream_.get();
  13808. auto &strm = *handle.stream_;
  13809. // Only for the head, as the handle may outlive this client
  13810. strm.set_read_interrupt(stop_interrupt());
  13811. auto release_interrupt =
  13812. detail::scope_exit([&] { strm.set_read_interrupt(nullptr); });
  13813. // After connecting, as for a buffered request
  13814. add_credential_headers(req);
  13815. // Build the request line and headers in memory first, like write_request()
  13816. // does, so that a rejected header leaves nothing on the wire.
  13817. {
  13818. detail::BufferStream bstrm;
  13819. // The path follows the authority in absolute-form, so one that does not
  13820. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13821. auto prefix = proxy_target_prefix();
  13822. if ((!prefix.empty() && req.path[0] != '/') ||
  13823. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  13824. handle.error = Error::Write;
  13825. handle.response.reset();
  13826. return handle;
  13827. }
  13828. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13829. handle.error)) {
  13830. handle.response.reset();
  13831. return handle;
  13832. }
  13833. const auto &data = bstrm.get_buffer();
  13834. if (!detail::write_data(strm, data.data(), data.size())) {
  13835. handle.error = Error::Write;
  13836. handle.response.reset();
  13837. return handle;
  13838. }
  13839. }
  13840. if (!req.body.empty()) {
  13841. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13842. handle.error = Error::Write;
  13843. handle.response.reset();
  13844. return handle;
  13845. }
  13846. }
  13847. if (!read_response_line(strm, req, *handle.response) ||
  13848. !detail::read_headers(strm, handle.response->headers)) {
  13849. handle.error = Error::Read;
  13850. handle.response.reset();
  13851. return handle;
  13852. }
  13853. handle.body_reader_.stream = handle.stream_;
  13854. handle.body_reader_.payload_max_length = payload_max_length_;
  13855. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13856. // header section, so none of its framing or coding headers apply.
  13857. if (req.method == "HEAD" ||
  13858. handle.response->status == StatusCode::NoContent_204 ||
  13859. handle.response->status == StatusCode::NotModified_304) {
  13860. handle.body_reader_.eof = true;
  13861. return handle;
  13862. }
  13863. // Same framing check as ClientImpl::process_request()
  13864. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13865. handle.error = Error::Read;
  13866. handle.response.reset();
  13867. return handle;
  13868. }
  13869. if (handle.response->has_header("Content-Length")) {
  13870. bool is_invalid = false;
  13871. auto content_length = detail::get_header_value_u64(
  13872. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13873. if (is_invalid) {
  13874. handle.error = Error::Read;
  13875. handle.response.reset();
  13876. return handle;
  13877. }
  13878. handle.body_reader_.has_content_length = true;
  13879. handle.body_reader_.content_length = content_length;
  13880. }
  13881. handle.body_reader_.chunked =
  13882. detail::is_chunked_transfer_encoding(handle.response->headers);
  13883. auto content_encoding = detail::get_combined_header_value(
  13884. handle.response->headers, "Content-Encoding");
  13885. if (decompress_ && !content_encoding.empty()) {
  13886. // Same policy as prepare_content_receiver(): reject a coding we know about
  13887. // but were not built with, pass an unrecognized one through as-is.
  13888. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13889. if (!handle.decompressor_) {
  13890. if (detail::is_known_content_encoding(content_encoding)) {
  13891. handle.error = Error::UnsupportedContentEncoding;
  13892. handle.response.reset();
  13893. return handle;
  13894. }
  13895. } else if (!handle.decompressor_->is_valid()) {
  13896. handle.error = Error::Compression;
  13897. handle.response.reset();
  13898. return handle;
  13899. }
  13900. }
  13901. return handle;
  13902. }
  13903. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13904. if (!is_valid() || !response) { return -1; }
  13905. auto n = decompressor_
  13906. ? read_with_decompression(buf, len)
  13907. : detail::read_body_content(stream_, body_reader_, buf, len);
  13908. if (n == 0) { parse_trailers_if_needed(); }
  13909. return n;
  13910. }
  13911. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13912. size_t len) {
  13913. if (decompress_offset_ < decompress_buffer_.size()) {
  13914. auto available = decompress_buffer_.size() - decompress_offset_;
  13915. auto to_copy = (std::min)(len, available);
  13916. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13917. decompress_offset_ += to_copy;
  13918. decompressed_bytes_read_ += to_copy;
  13919. return static_cast<ssize_t>(to_copy);
  13920. }
  13921. decompress_buffer_.clear();
  13922. decompress_offset_ = 0;
  13923. constexpr size_t kDecompressionBufferSize = 8192;
  13924. char compressed_buf[kDecompressionBufferSize];
  13925. while (true) {
  13926. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13927. sizeof(compressed_buf));
  13928. if (n <= 0) { return n; }
  13929. auto exceeded = false;
  13930. bool decompress_ok = decompressor_->decompress(
  13931. compressed_buf, static_cast<size_t>(n),
  13932. [&](const char *data, size_t data_len) {
  13933. decompress_buffer_.append(data, data_len);
  13934. auto limit = body_reader_.payload_max_length;
  13935. exceeded =
  13936. limit > 0 &&
  13937. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13938. return !exceeded;
  13939. });
  13940. if (!decompress_ok) {
  13941. body_reader_.last_error =
  13942. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13943. return -1;
  13944. }
  13945. if (!decompress_buffer_.empty()) { break; }
  13946. }
  13947. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13948. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13949. decompress_offset_ = to_copy;
  13950. decompressed_bytes_read_ += to_copy;
  13951. return static_cast<ssize_t>(to_copy);
  13952. }
  13953. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13954. // The trailers follow the last chunk, so there are none before it
  13955. auto &decoder = body_reader_.chunked_decoder;
  13956. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13957. return;
  13958. }
  13959. trailers_parsed_ = true;
  13960. decoder->parse_trailers_into(response->trailers, response->headers);
  13961. }
  13962. namespace detail {
  13963. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13964. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13965. size_t &out_chunk_offset,
  13966. size_t &out_chunk_total) {
  13967. if (finished) { return 0; }
  13968. if (chunk_remaining == 0) {
  13969. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13970. if (!lr.getline()) { return -1; }
  13971. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13972. // the line terminator is never mistaken for line content.
  13973. const char *eol = lr.ptr() + lr.size();
  13974. if (lr.end_with_crlf()) {
  13975. eol -= 2;
  13976. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13977. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13978. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13979. // has to come off here or the check below would reject the line.
  13980. eol -= 1;
  13981. }
  13982. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13983. const char *p = lr.ptr();
  13984. int v = 0;
  13985. if (p == eol || !is_hex(*p, v)) { return -1; }
  13986. size_t chunk_len = 0;
  13987. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13988. for (; p < eol && is_hex(*p, v); ++p) {
  13989. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13990. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13991. }
  13992. while (p < eol && is_space_or_tab(*p)) {
  13993. ++p;
  13994. }
  13995. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13996. // terminator, and it is built from tokens and quoted-strings, so it never
  13997. // holds a CR, LF or any other control character. getline() reads up to the
  13998. // CRLF, so a bare LF left in here would be swallowed as extension text
  13999. // while an intermediary that ends the line on it delimits the chunks
  14000. // differently, and the two disagree on where the body ends (request
  14001. // smuggling).
  14002. if (p < eol && *p != ';') { return -1; }
  14003. for (; p < eol; ++p) {
  14004. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  14005. }
  14006. // The bytes around the data are no payload, so they are counted on their
  14007. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  14008. // them, which lets a stream send a byte at a time, and what goes past that
  14009. // in padding, leading zeros and extensions builds up to one header field.
  14010. overhead += lr.size() + 2;
  14011. overhead = overhead > 16 ? overhead - 16 : 0;
  14012. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  14013. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  14014. if (chunk_len == 0) {
  14015. chunk_remaining = 0;
  14016. finished = true;
  14017. out_chunk_offset = 0;
  14018. out_chunk_total = 0;
  14019. return 0;
  14020. }
  14021. chunk_remaining = chunk_len;
  14022. last_chunk_total = chunk_remaining;
  14023. last_chunk_offset = 0;
  14024. }
  14025. auto to_read = (std::min)(chunk_remaining, len);
  14026. auto n = strm.read(buf, to_read);
  14027. if (n <= 0) { return -1; }
  14028. auto offset_before = last_chunk_offset;
  14029. last_chunk_offset += static_cast<size_t>(n);
  14030. chunk_remaining -= static_cast<size_t>(n);
  14031. out_chunk_offset = offset_before;
  14032. out_chunk_total = last_chunk_total;
  14033. if (chunk_remaining == 0) {
  14034. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14035. if (!lr.getline()) { return -1; }
  14036. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  14037. }
  14038. return n;
  14039. }
  14040. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  14041. const Headers &src_headers) {
  14042. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14043. if (!lr.getline()) { return false; }
  14044. return parse_trailers(lr, dest, src_headers);
  14045. }
  14046. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  14047. // a redirect without a Location, is a final response.
  14048. inline bool is_redirect(const Response &res) {
  14049. switch (res.status) {
  14050. case StatusCode::MovedPermanently_301:
  14051. case StatusCode::Found_302:
  14052. case StatusCode::SeeOther_303:
  14053. case StatusCode::TemporaryRedirect_307:
  14054. case StatusCode::PermanentRedirect_308:
  14055. return !res.get_header_value("Location").empty();
  14056. default: return false;
  14057. }
  14058. }
  14059. } // namespace detail
  14060. inline void
  14061. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  14062. handle.connection_->sock = socket_.sock;
  14063. #ifdef CPPHTTPLIB_SSL_ENABLED
  14064. handle.connection_->session = socket_.ssl;
  14065. socket_.ssl = nullptr;
  14066. #endif
  14067. socket_.sock = INVALID_SOCKET;
  14068. }
  14069. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  14070. inline std::string ClientImpl::proxy_target_prefix() const {
  14071. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  14072. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  14073. }
  14074. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  14075. Response &res, bool close_connection,
  14076. Error &error) {
  14077. if (req.path.empty()) {
  14078. error = Error::Connection;
  14079. return false;
  14080. }
  14081. auto req_save = req;
  14082. bool ret;
  14083. auto prefix = proxy_target_prefix();
  14084. if (!prefix.empty()) {
  14085. // The path follows the authority in absolute-form, so one that does not
  14086. // begin with '/' (e.g. "@evil.example/x") would name another host.
  14087. if (req.path[0] != '/') {
  14088. error = Error::Write;
  14089. return false;
  14090. }
  14091. auto req2 = req;
  14092. req2.path = prefix + req.path;
  14093. ret = process_request(strm, req2, res, close_connection, error);
  14094. req = std::move(req2);
  14095. req.path = req_save.path;
  14096. } else {
  14097. ret = process_request(strm, req, res, close_connection, error);
  14098. }
  14099. if (!ret) { return false; }
  14100. {
  14101. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  14102. // for this to be safe.
  14103. // This is safe to call because handle_request is only called by send_
  14104. // which locks the request mutex during the process. It would be a bug
  14105. // to call it from a different thread since it's a thread-safety issue
  14106. // to do these things to the socket if another thread is using the socket.
  14107. std::lock_guard<std::mutex> guard(socket_mutex_);
  14108. // Also when the request asked for it (e.g. a body that was never sent,
  14109. // or "Connection: close") or bytes follow the response (RFC 9112 9.2), so
  14110. // that a redirect or an auth retry below does not reuse the socket.
  14111. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14112. strm.is_readable() ||
  14113. detail::has_header_token(res.headers, "Connection", "close") ||
  14114. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  14115. disconnect(/*gracefully=*/true);
  14116. }
  14117. }
  14118. if (follow_location_ && detail::is_redirect(res)) {
  14119. req = std::move(req_save);
  14120. // The client that followed the redirect has answered any challenge it
  14121. // could. Retrying below would sign another host's challenge and send it
  14122. // here.
  14123. return redirect(req, res, error);
  14124. }
  14125. #ifdef CPPHTTPLIB_SSL_ENABLED
  14126. if ((res.status == StatusCode::Unauthorized_401 ||
  14127. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  14128. req.authorization_count_ < 5) {
  14129. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  14130. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  14131. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  14132. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  14133. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  14134. return ret;
  14135. }
  14136. const auto &username =
  14137. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  14138. const auto &password =
  14139. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  14140. if (!username.empty() && !password.empty()) {
  14141. std::map<std::string, std::string> auth;
  14142. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  14143. Request new_req = req;
  14144. new_req.authorization_count_ += 1;
  14145. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  14146. : "Authorization");
  14147. new_req.headers.insert(detail::make_digest_authentication_header(
  14148. req, make_request_target(req), auth, new_req.authorization_count_,
  14149. detail::random_string(10), username, password, is_proxy));
  14150. Response new_res;
  14151. ret = send(new_req, new_res, error);
  14152. if (ret) { res = std::move(new_res); }
  14153. }
  14154. }
  14155. }
  14156. #endif
  14157. return ret;
  14158. }
  14159. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  14160. if (req.redirect_count_ == 0) {
  14161. error = Error::ExceedRedirectCount;
  14162. return false;
  14163. }
  14164. auto location = res.get_header_value("location");
  14165. if (location.empty()) { return false; }
  14166. auto next_url = detail::resolve_relative_location(location, req.path);
  14167. detail::UrlComponents uc;
  14168. if (!detail::parse_url(next_url, uc)) { return false; }
  14169. // Follow only http/https URLs and references starting with '/'
  14170. if (next_url[0] != '/' && uc.scheme != "http" && uc.scheme != "https") {
  14171. return false;
  14172. }
  14173. auto scheme = is_ssl() ? "https" : "http";
  14174. auto next_scheme = std::move(uc.scheme);
  14175. auto next_host = std::move(uc.host);
  14176. auto port_str = std::move(uc.port);
  14177. auto next_path = std::move(uc.path);
  14178. auto next_query = std::move(uc.query);
  14179. auto next_port = port_;
  14180. if (!port_str.empty()) {
  14181. if (!detail::parse_port(port_str, next_port)) { return false; }
  14182. } else if (!next_scheme.empty()) {
  14183. next_port = next_scheme == "https" ? 443 : 80;
  14184. }
  14185. if (next_scheme.empty()) { next_scheme = scheme; }
  14186. if (next_host.empty()) { next_host = host_; }
  14187. if (next_path.empty()) { next_path = "/"; }
  14188. // An absolute or absolute-path location can have dot segments too.
  14189. if (next_path[0] == '/') {
  14190. next_path = detail::remove_dot_segments(next_path);
  14191. }
  14192. auto path = std::move(next_path) + next_query;
  14193. // A Unix socket client sends "Host: localhost", so a Location naming
  14194. // localhost names this client too.
  14195. auto is_same_host = next_host == host_ ||
  14196. (address_family_ == AF_UNIX && next_host == "localhost");
  14197. // Same host redirect - use current client
  14198. if (next_scheme == scheme && is_same_host && next_port == port_) {
  14199. return detail::redirect(*this, req, res, path, location, error);
  14200. }
  14201. // Cross-host/scheme redirect - create new client with robust setup
  14202. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14203. path, location, error);
  14204. }
  14205. // New method for robust redirect client creation
  14206. inline bool ClientImpl::create_redirect_client(
  14207. const std::string &scheme, const std::string &host, int port, Request &req,
  14208. Response &res, const std::string &path, const std::string &location,
  14209. Error &error) {
  14210. // Determine if we need SSL
  14211. auto need_ssl = (scheme == "https");
  14212. // Clean up request headers that are host/client specific
  14213. // Remove headers that should not be carried over to new host
  14214. auto headers_to_remove = std::vector<std::string>{
  14215. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14216. for (const auto &header_name : headers_to_remove) {
  14217. auto it = req.headers.find(header_name);
  14218. while (it != req.headers.end()) {
  14219. it = req.headers.erase(it);
  14220. it = req.headers.find(header_name);
  14221. }
  14222. }
  14223. // Create appropriate client type and handle redirect
  14224. if (need_ssl) {
  14225. #ifdef CPPHTTPLIB_SSL_ENABLED
  14226. // Create SSL client for HTTPS redirect
  14227. SSLClient redirect_client(host, port);
  14228. // Setup basic client configuration first
  14229. setup_redirect_client(redirect_client);
  14230. redirect_client.enable_server_certificate_verification(
  14231. server_certificate_verification_);
  14232. redirect_client.enable_server_hostname_verification(
  14233. server_hostname_verification_);
  14234. redirect_client.system_ca_mode_ = system_ca_mode_;
  14235. // Transfer CA certificate to redirect client
  14236. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14237. if (is_ssl()) {
  14238. auto &self = static_cast<SSLClient &>(*this);
  14239. // A store given to set_ca_cert_store() lives only in this client's
  14240. // context, which then holds all that is trusted.
  14241. if (self.ca_cert_store_set_) {
  14242. std::string pem;
  14243. {
  14244. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14245. pem = detail::ca_certs_to_pem(self.ctx_);
  14246. }
  14247. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14248. redirect_client.ca_cert_store_set_ = true;
  14249. } else if (self.custom_ca_loaded_) {
  14250. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14251. ca_cert_pem_.size());
  14252. }
  14253. redirect_client.set_session_verifier(self.session_verifier_);
  14254. if (self.server_certificate_verifier_) {
  14255. redirect_client.set_server_certificate_verifier(
  14256. self.server_certificate_verifier_);
  14257. }
  14258. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14259. redirect_client.enable_windows_cert_verification_ =
  14260. self.enable_windows_cert_verification_;
  14261. #endif
  14262. }
  14263. // Client certificates are set through constructor for SSLClient
  14264. // NOTE: SSLClient constructor already takes client_cert_path and
  14265. // client_key_path so we need to create it properly if client certs are
  14266. // needed
  14267. // Execute the redirect
  14268. return detail::redirect(redirect_client, req, res, path, location, error);
  14269. #else
  14270. // SSL not supported - set appropriate error
  14271. error = Error::SSLConnection;
  14272. return false;
  14273. #endif
  14274. } else {
  14275. // HTTP redirect
  14276. ClientImpl redirect_client(host, port);
  14277. // Setup client with robust configuration
  14278. setup_redirect_client(redirect_client);
  14279. // Execute the redirect
  14280. return detail::redirect(redirect_client, req, res, path, location, error);
  14281. }
  14282. }
  14283. // New method for robust client setup (based on basic_manual_redirect.cpp
  14284. // logic)
  14285. template <typename ClientType>
  14286. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14287. // Copy basic settings first
  14288. client.set_connection_timeout(connection_timeout_sec_,
  14289. connection_timeout_usec_);
  14290. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14291. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14292. client.set_max_timeout(max_timeout_msec_);
  14293. if (has_payload_max_length_) {
  14294. client.set_payload_max_length(payload_max_length_);
  14295. }
  14296. client.set_keep_alive(keep_alive_);
  14297. client.set_follow_location(
  14298. true); // Enable redirects to handle multi-step redirects
  14299. client.set_path_encode(path_encode_);
  14300. client.set_compress(compress_);
  14301. client.set_decompress(decompress_);
  14302. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14303. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14304. // 15.4, credentials must not be forwarded when redirecting to a different
  14305. // host. This function is only called for cross-host redirects; same-host
  14306. // redirects are handled directly in ClientImpl::redirect().
  14307. // Copy the proxy configuration unconditionally; the per-target bypass is
  14308. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14309. // still use the proxy.
  14310. client.no_proxy_entries_ = no_proxy_entries_;
  14311. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14312. client.set_proxy(proxy_host_, proxy_port_);
  14313. if (!proxy_basic_auth_username_.empty() ||
  14314. !proxy_basic_auth_password_.empty()) {
  14315. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14316. proxy_basic_auth_password_);
  14317. }
  14318. if (!proxy_bearer_token_auth_token_.empty()) {
  14319. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14320. }
  14321. #ifdef CPPHTTPLIB_SSL_ENABLED
  14322. if (!proxy_digest_auth_username_.empty()) {
  14323. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14324. proxy_digest_auth_password_);
  14325. }
  14326. #endif
  14327. }
  14328. // Copy network and socket settings
  14329. client.addr_map_ = addr_map_;
  14330. client.tunnel_addr_map_ = tunnel_addr_map_;
  14331. // A Unix socket client reaches every host through its own socket, as curl's
  14332. // --unix-socket does, unless the caller mapped that host elsewhere. The
  14333. // Location's host is never taken as a socket path.
  14334. if (address_family_ == AF_UNIX) {
  14335. auto &target = client.addr_map_[client.host()];
  14336. if (target.empty()) { target = detail::addr_map_target(addr_map_, host_); }
  14337. }
  14338. client.set_address_family(address_family_);
  14339. client.set_tcp_nodelay(tcp_nodelay_);
  14340. client.set_ipv6_v6only(ipv6_v6only_);
  14341. if (socket_options_) { client.set_socket_options(socket_options_); }
  14342. if (!interface_.empty()) { client.set_interface(interface_); }
  14343. // Copy logging and headers. Not the error logger: a failure comes back to
  14344. // this client's send(), which reports it with the caller's request.
  14345. if (logger_) { client.set_logger(logger_); }
  14346. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14347. // Each new client should generate its own headers based on its target host
  14348. }
  14349. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14350. const Request &req,
  14351. Error &error) const {
  14352. auto is_shutting_down = []() { return false; };
  14353. if (req.is_chunked_content_provider_) {
  14354. auto compressor = compress_ ? detail::create_compressor().first
  14355. : std::unique_ptr<detail::compressor>();
  14356. if (!compressor) {
  14357. compressor = detail::make_unique<detail::nocompressor>();
  14358. }
  14359. return detail::write_content_chunked(strm, req.content_provider_,
  14360. is_shutting_down, *compressor, error);
  14361. } else {
  14362. return detail::write_content_with_progress(
  14363. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14364. req.upload_progress, error);
  14365. }
  14366. }
  14367. // What goes on the request line for req: its path, encoded and without the
  14368. // fragment, with `req.params` as the query when the path has none.
  14369. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14370. auto target = detail::encode_request_target(req.path, path_encode_);
  14371. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14372. target = append_query_params(target, req.params);
  14373. }
  14374. return target;
  14375. }
  14376. inline void ClientImpl::add_credential_headers(Request &req) {
  14377. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14378. // it opens is read by the origin. Each credential goes only to its own hop.
  14379. auto is_connect = req.method == "CONNECT";
  14380. if (!is_connect) {
  14381. detail::add_authorization_header(req, basic_auth_username_,
  14382. basic_auth_password_,
  14383. bearer_token_auth_token_, false);
  14384. }
  14385. // Proxy-Authorization is only sent when the proxy reads this message —
  14386. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14387. // would leak proxy credentials to the destination server.
  14388. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14389. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14390. proxy_basic_auth_password_,
  14391. proxy_bearer_token_auth_token_, true);
  14392. }
  14393. }
  14394. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14395. bool close_connection, Error &error,
  14396. bool skip_body, bool &rejected_locally) {
  14397. rejected_locally = false;
  14398. // Prepare additional headers
  14399. if (close_connection) {
  14400. if (!req.has_header("Connection")) {
  14401. req.set_header("Connection", "close");
  14402. }
  14403. }
  14404. std::string ct_for_defaults;
  14405. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14406. ct_for_defaults = "text/plain";
  14407. }
  14408. prepare_default_headers(req, false, ct_for_defaults);
  14409. if (req.body.empty()) {
  14410. if (req.content_provider_) {
  14411. if (!req.is_chunked_content_provider_) {
  14412. if (!req.has_header("Content-Length")) {
  14413. auto length = std::to_string(req.content_length_);
  14414. req.set_header("Content-Length", length);
  14415. }
  14416. }
  14417. } else {
  14418. if (req.method == "POST" || req.method == "PUT" ||
  14419. req.method == "PATCH") {
  14420. req.set_header("Content-Length", "0");
  14421. }
  14422. }
  14423. }
  14424. add_credential_headers(req);
  14425. // Request line and headers
  14426. {
  14427. detail::BufferStream bstrm;
  14428. auto path_with_query = make_request_target(req);
  14429. // The query already came in through `req.path`; still populate
  14430. // `req.params` for handlers/users who read them.
  14431. auto query_part = detail::query_of(req.path);
  14432. if (!query_part.empty()) {
  14433. detail::parse_query_text(query_part, req.params);
  14434. }
  14435. // Write request line and headers
  14436. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14437. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14438. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14439. // fail the request cleanly instead of emitting a request-line-less,
  14440. // header-injecting request.
  14441. error = Error::Write;
  14442. rejected_locally = true;
  14443. return false;
  14444. }
  14445. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14446. error)) {
  14447. rejected_locally = true;
  14448. return false;
  14449. }
  14450. // Flush buffer
  14451. auto &data = bstrm.get_buffer();
  14452. if (!detail::write_data(strm, data.data(), data.size())) {
  14453. error = Error::Write;
  14454. return false;
  14455. }
  14456. }
  14457. // After sending request line and headers, wait briefly for an early server
  14458. // response (e.g. 4xx) and avoid sending a potentially large request body
  14459. // unnecessarily. This workaround is only enabled on Windows because Unix
  14460. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14461. // buffering can accept large writes even when the peer already responded.
  14462. // Check the stream first (which covers SSL via `is_readable()`), then
  14463. // fall back to select on the socket. Only perform the wait for very large
  14464. // request bodies to avoid interfering with normal small requests and
  14465. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14466. // response. Skip this check when using Expect: 100-continue, as the protocol
  14467. // handles early responses properly.
  14468. #if defined(_WIN32)
  14469. if (!skip_body &&
  14470. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14471. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14472. auto start = std::chrono::high_resolution_clock::now();
  14473. for (;;) {
  14474. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14475. // from SSL internals. If the underlying socket is readable, assume an
  14476. // early response may be present.
  14477. auto sock = strm.socket();
  14478. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14479. return false;
  14480. }
  14481. // Fallback to stream-level check for non-socket streams or when the
  14482. // socket isn't reporting readable. Avoid using `is_readable()` for
  14483. // SSL, since `SSL_pending()` may report buffered records that do not
  14484. // indicate a complete application-level response yet.
  14485. if (!is_ssl() && strm.is_readable()) { return false; }
  14486. auto now = std::chrono::high_resolution_clock::now();
  14487. auto elapsed =
  14488. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14489. .count();
  14490. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14491. break;
  14492. }
  14493. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14494. }
  14495. }
  14496. #endif
  14497. // Body
  14498. if (skip_body) { return true; }
  14499. return write_request_body(strm, req, error);
  14500. }
  14501. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14502. Error &error) {
  14503. if (req.body.empty()) {
  14504. return write_content_with_provider(strm, req, error);
  14505. }
  14506. if (req.upload_progress) {
  14507. auto body_size = req.body.size();
  14508. size_t written = 0;
  14509. auto data = req.body.data();
  14510. while (written < body_size) {
  14511. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14512. if (!detail::write_data(strm, data + written, to_write)) {
  14513. error = Error::Write;
  14514. return false;
  14515. }
  14516. written += to_write;
  14517. if (!req.upload_progress(written, body_size)) {
  14518. error = Error::Canceled;
  14519. return false;
  14520. }
  14521. }
  14522. } else {
  14523. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14524. error = Error::Write;
  14525. return false;
  14526. }
  14527. }
  14528. return true;
  14529. }
  14530. inline std::unique_ptr<Response>
  14531. ClientImpl::send_with_content_provider_and_receiver(
  14532. Request &req, const char *body, size_t content_length,
  14533. ContentProvider content_provider,
  14534. ContentProviderWithoutLength content_provider_without_length,
  14535. const std::string &content_type, ContentReceiver content_receiver,
  14536. Error &error) {
  14537. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14538. auto enc = compress_
  14539. ? detail::create_compressor()
  14540. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14541. nullptr, nullptr);
  14542. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14543. // A compressed or chunked body is framed by the library, not the caller
  14544. if (enc.second || content_provider_without_length) {
  14545. req.headers.erase("Content-Length");
  14546. }
  14547. if (enc.first && !content_provider_without_length) {
  14548. auto &compressor = enc.first;
  14549. if (content_provider) {
  14550. auto ok = true;
  14551. auto finished = false;
  14552. size_t offset = 0;
  14553. DataSink data_sink;
  14554. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14555. if (ok) {
  14556. auto last = offset + data_len == content_length;
  14557. auto ret = compressor->compress(
  14558. data, data_len, last,
  14559. [&](const char *compressed_data, size_t compressed_data_len) {
  14560. req.body.append(compressed_data, compressed_data_len);
  14561. return true;
  14562. });
  14563. if (ret) {
  14564. offset += data_len;
  14565. } else {
  14566. ok = false;
  14567. }
  14568. }
  14569. return ok;
  14570. };
  14571. // As in detail::write_content_with_progress(): the body is framed by
  14572. // content_length, so a provider that finishes early has truncated it.
  14573. // Stop and report that instead of calling the provider forever.
  14574. data_sink.done = [&]() { finished = true; };
  14575. while (ok && !finished && offset < content_length) {
  14576. if (!content_provider(offset, content_length - offset, data_sink)) {
  14577. error = Error::Canceled;
  14578. output_error_log(error, &req);
  14579. return nullptr;
  14580. }
  14581. }
  14582. // A short body here means either the provider stopped early or the
  14583. // compressor gave up. The branch below reports a failing compressor as
  14584. // Error::Compression, so keep the two distinguishable.
  14585. if (offset < content_length) {
  14586. error = ok ? Error::Write : Error::Compression;
  14587. output_error_log(error, &req);
  14588. return nullptr;
  14589. }
  14590. } else {
  14591. if (!compressor->compress(body, content_length, true,
  14592. [&](const char *data, size_t data_len) {
  14593. req.body.append(data, data_len);
  14594. return true;
  14595. })) {
  14596. error = Error::Compression;
  14597. output_error_log(error, &req);
  14598. return nullptr;
  14599. }
  14600. }
  14601. } else {
  14602. if (content_provider) {
  14603. req.content_length_ = content_length;
  14604. req.content_provider_ = std::move(content_provider);
  14605. req.is_chunked_content_provider_ = false;
  14606. } else if (content_provider_without_length) {
  14607. req.content_length_ = 0;
  14608. req.content_provider_ = detail::ContentProviderAdapter(
  14609. std::move(content_provider_without_length));
  14610. req.is_chunked_content_provider_ = true;
  14611. req.set_header("Transfer-Encoding", "chunked");
  14612. } else {
  14613. req.body.assign(body, content_length);
  14614. }
  14615. }
  14616. if (content_receiver) {
  14617. req.content_receiver =
  14618. [content_receiver](const char *data, size_t data_length,
  14619. size_t /*offset*/, size_t /*total_length*/) {
  14620. return content_receiver(data, data_length);
  14621. };
  14622. }
  14623. auto res = detail::make_unique<Response>();
  14624. return send(req, *res, error) ? std::move(res) : nullptr;
  14625. }
  14626. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14627. const std::string &method, const std::string &path, const Headers &headers,
  14628. const char *body, size_t content_length, ContentProvider content_provider,
  14629. ContentProviderWithoutLength content_provider_without_length,
  14630. const std::string &content_type, ContentReceiver content_receiver,
  14631. UploadProgress progress) {
  14632. Request req;
  14633. req.method = method;
  14634. req.headers = headers;
  14635. req.path = path;
  14636. req.upload_progress = std::move(progress);
  14637. if (max_timeout_msec_ > 0) {
  14638. req.start_time_ = std::chrono::steady_clock::now();
  14639. }
  14640. auto error = Error::Success;
  14641. #ifdef CPPHTTPLIB_SSL_ENABLED
  14642. // Hold the request lock until the Result has read this request's TLS error
  14643. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14644. #endif
  14645. auto res = send_with_content_provider_and_receiver(
  14646. req, body, content_length, std::move(content_provider),
  14647. std::move(content_provider_without_length), content_type,
  14648. std::move(content_receiver), error);
  14649. #ifdef CPPHTTPLIB_SSL_ENABLED
  14650. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14651. last_backend_error_};
  14652. #else
  14653. return Result{std::move(res), error, std::move(req.headers)};
  14654. #endif
  14655. }
  14656. inline void ClientImpl::output_log(const Request &req,
  14657. const Response &res) const {
  14658. if (logger_) {
  14659. std::lock_guard<std::mutex> guard(logger_mutex_);
  14660. logger_(req, res);
  14661. }
  14662. }
  14663. inline void ClientImpl::output_error_log(const Error &err,
  14664. const Request *req) const {
  14665. if (error_logger_) {
  14666. std::lock_guard<std::mutex> guard(logger_mutex_);
  14667. error_logger_(err, req);
  14668. }
  14669. }
  14670. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14671. Response &res, bool close_connection,
  14672. Error &error) {
  14673. // Auto-add Expect: 100-continue for large bodies
  14674. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14675. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14676. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14677. req.set_header("Expect", "100-continue");
  14678. }
  14679. }
  14680. // Check for Expect: 100-continue
  14681. auto expect_100_continue =
  14682. detail::has_header_token(req.headers, "Expect", "100-continue");
  14683. // Send request (skip body if using Expect: 100-continue)
  14684. auto rejected_locally = false;
  14685. auto write_request_success =
  14686. write_request(strm, req, close_connection, error, expect_100_continue,
  14687. rejected_locally);
  14688. // A failed write normally still reads the response below, since the server
  14689. // may have answered early (e.g. 413/414) and closed while the body was being
  14690. // sent. A request rejected before any byte reached the socket gets no such
  14691. // response, and waiting for one would block until the read timeout.
  14692. if (rejected_locally) { return false; }
  14693. #ifdef CPPHTTPLIB_SSL_ENABLED
  14694. if (is_ssl() && !expect_100_continue) {
  14695. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14696. if (!is_proxy_enabled) {
  14697. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14698. error = Error::SSLPeerCouldBeClosed_;
  14699. return false;
  14700. }
  14701. }
  14702. }
  14703. #endif
  14704. // Handle Expect: 100-continue.
  14705. //
  14706. // Wait for an interim/early response by attempting to read the status line
  14707. // under a short timeout, instead of trusting raw socket readability. Over
  14708. // TLS, post-handshake records (e.g. session tickets) make the socket
  14709. // readable without any HTTP response being available; relying on
  14710. // `select_read` there caused the body to be withheld forever and the
  14711. // request to fail with `Read` (#2458). If no status line arrives within the
  14712. // timeout, send the body anyway (matching curl's behavior).
  14713. auto status_line_read = false;
  14714. if (expect_100_continue && write_request_success) {
  14715. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14716. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14717. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14718. strm.set_read_timeout(sec, usec);
  14719. status_line_read = read_response_line(strm, req, res, false);
  14720. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14721. }
  14722. if (!status_line_read) {
  14723. // No interim response within the timeout: send the body and handle the
  14724. // response as usual.
  14725. if (!write_request_body(strm, req, error)) { return false; }
  14726. expect_100_continue = false; // Switch to normal response handling
  14727. }
  14728. }
  14729. // Receive response and headers
  14730. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14731. if ((!status_line_read &&
  14732. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14733. !detail::read_headers(strm, res.headers)) {
  14734. if (write_request_success) { error = Error::Read; }
  14735. return false;
  14736. }
  14737. if (!write_request_success) { return false; }
  14738. // Handle Expect: 100-continue response
  14739. if (expect_100_continue) {
  14740. if (res.status == StatusCode::Continue_100) {
  14741. // Server accepted, send the body
  14742. if (!write_request_body(strm, req, error)) { return false; }
  14743. // Read the actual response
  14744. res.headers.clear();
  14745. res.body.clear();
  14746. if (!read_response_line(strm, req, res) ||
  14747. !detail::read_headers(strm, res.headers)) {
  14748. error = Error::Read;
  14749. return false;
  14750. }
  14751. } else {
  14752. // A final response came first, so the body this request declared was
  14753. // never sent, and the server may still be waiting for it. The
  14754. // connection cannot carry another request.
  14755. std::lock_guard<std::mutex> guard(socket_mutex_);
  14756. socket_should_be_closed_when_request_is_done_ = true;
  14757. }
  14758. }
  14759. // Body
  14760. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14761. req.method != "CONNECT") {
  14762. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14763. // whose final transfer coding is not chunked is not ambiguous: its body
  14764. // runs until the server closes the connection, so it is not rejected.
  14765. // HEAD/204 are excluded above and a 304 carries no body.
  14766. if (res.status != StatusCode::NotModified_304) {
  14767. if (detail::has_conflicting_content_length(res.headers)) {
  14768. error = Error::Read;
  14769. return false;
  14770. }
  14771. if (detail::has_faulty_transfer_encoding(res)) {
  14772. std::lock_guard<std::mutex> guard(socket_mutex_);
  14773. socket_should_be_closed_when_request_is_done_ = true;
  14774. }
  14775. }
  14776. auto redirect = follow_location_ && detail::is_redirect(res);
  14777. if (req.response_handler && !redirect) {
  14778. if (!req.response_handler(res)) {
  14779. error = Error::Canceled;
  14780. return false;
  14781. }
  14782. }
  14783. auto out =
  14784. req.content_receiver
  14785. ? static_cast<ContentReceiverWithProgress>(
  14786. [&](const char *buf, size_t n, size_t off, size_t len) {
  14787. if (redirect) { return true; }
  14788. auto ret = req.content_receiver(buf, n, off, len);
  14789. if (!ret) { error = Error::Canceled; }
  14790. return ret;
  14791. })
  14792. : static_cast<ContentReceiverWithProgress>(
  14793. [&](const char *buf, size_t n, size_t /*off*/,
  14794. size_t /*len*/) {
  14795. assert(res.body.size() + n <= res.body.max_size());
  14796. if (payload_max_length_ > 0 &&
  14797. (res.body.size() >= payload_max_length_ ||
  14798. n > payload_max_length_ - res.body.size())) {
  14799. return false;
  14800. }
  14801. res.body.append(buf, n);
  14802. return true;
  14803. });
  14804. auto progress = [&](size_t current, size_t total) {
  14805. if (!req.download_progress || redirect) { return true; }
  14806. auto ret = req.download_progress(current, total);
  14807. if (!ret) { error = Error::Canceled; }
  14808. return ret;
  14809. };
  14810. if (res.has_header("Content-Length")) {
  14811. if (!req.content_receiver) {
  14812. auto len = res.get_header_value_u64("Content-Length");
  14813. if (len > res.body.max_size()) {
  14814. error = Error::Read;
  14815. return false;
  14816. }
  14817. // Content-Length is only the server's claim, so reserve no more than
  14818. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14819. // body has arrived. A longer body grows as it is read.
  14820. auto reserve_len =
  14821. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14822. if (payload_max_length_ > 0) {
  14823. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14824. }
  14825. res.body.reserve(reserve_len);
  14826. }
  14827. }
  14828. if (res.status != StatusCode::NotModified_304) {
  14829. auto content_status = 0;
  14830. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14831. ? (std::numeric_limits<size_t>::max)()
  14832. : payload_max_length_;
  14833. if (!detail::read_content(strm, res, max_length, content_status,
  14834. std::move(progress), std::move(out),
  14835. decompress_)) {
  14836. if (error != Error::Canceled) {
  14837. // Tell the caller apart from a plain read failure when the body was
  14838. // over the payload limit or could not be decoded because of its
  14839. // Content-Encoding.
  14840. switch (content_status) {
  14841. case StatusCode::PayloadTooLarge_413:
  14842. error = Error::ExceedMaxPayloadSize;
  14843. break;
  14844. case StatusCode::UnsupportedMediaType_415:
  14845. error = Error::UnsupportedContentEncoding;
  14846. break;
  14847. case StatusCode::InternalServerError_500:
  14848. error = Error::Compression;
  14849. break;
  14850. default: error = Error::Read; break;
  14851. }
  14852. }
  14853. return false;
  14854. }
  14855. }
  14856. }
  14857. // Log
  14858. output_log(req, res);
  14859. return true;
  14860. }
  14861. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14862. const std::string &boundary, const UploadFormDataItems &items,
  14863. const FormDataProviderItems &provider_items) const {
  14864. size_t cur_item = 0;
  14865. size_t cur_start = 0;
  14866. // cur_item and cur_start are copied to within the std::function and
  14867. // maintain state between successive calls
  14868. return [&, cur_item, cur_start](size_t offset,
  14869. DataSink &sink) mutable -> bool {
  14870. if (!offset && !items.empty()) {
  14871. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14872. return true;
  14873. } else if (cur_item < provider_items.size()) {
  14874. if (!cur_start) {
  14875. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14876. provider_items[cur_item], boundary);
  14877. offset += begin.size();
  14878. cur_start = offset;
  14879. sink.os << begin;
  14880. }
  14881. DataSink cur_sink;
  14882. auto has_data = true;
  14883. cur_sink.write = sink.write;
  14884. // Forward is_writable so a provider item asking whether it may keep
  14885. // going gets the outer sink's answer rather than the default `true`.
  14886. cur_sink.is_writable = sink.is_writable;
  14887. cur_sink.done = [&]() { has_data = false; };
  14888. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14889. return false;
  14890. }
  14891. if (!has_data) {
  14892. sink.os << detail::serialize_multipart_formdata_item_end();
  14893. cur_item++;
  14894. cur_start = 0;
  14895. }
  14896. return true;
  14897. } else {
  14898. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14899. sink.done();
  14900. return true;
  14901. }
  14902. };
  14903. }
  14904. inline bool ClientImpl::process_socket(
  14905. const Socket &socket,
  14906. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14907. std::function<bool(Stream &strm)> callback) {
  14908. return detail::process_client_socket(
  14909. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14910. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14911. }
  14912. inline bool ClientImpl::is_ssl() const { return false; }
  14913. inline Result ClientImpl::Get(const std::string &path,
  14914. DownloadProgress progress) {
  14915. return Get(path, Headers(), std::move(progress));
  14916. }
  14917. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14918. DownloadProgress progress) {
  14919. return Get(path, params, Headers(), std::move(progress));
  14920. }
  14921. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14922. const Headers &headers,
  14923. DownloadProgress progress) {
  14924. if (params.empty()) { return Get(path, headers); }
  14925. std::string path_with_query = append_query_params(path, params);
  14926. return Get(path_with_query, headers, std::move(progress));
  14927. }
  14928. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14929. DownloadProgress progress) {
  14930. Request req;
  14931. req.method = "GET";
  14932. req.path = path;
  14933. req.headers = headers;
  14934. req.download_progress = std::move(progress);
  14935. if (max_timeout_msec_ > 0) {
  14936. req.start_time_ = std::chrono::steady_clock::now();
  14937. }
  14938. return send_(std::move(req));
  14939. }
  14940. inline Result ClientImpl::Get(const std::string &path,
  14941. ContentReceiver content_receiver,
  14942. DownloadProgress progress) {
  14943. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14944. std::move(progress));
  14945. }
  14946. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14947. ContentReceiver content_receiver,
  14948. DownloadProgress progress) {
  14949. return Get(path, headers, nullptr, std::move(content_receiver),
  14950. std::move(progress));
  14951. }
  14952. inline Result ClientImpl::Get(const std::string &path,
  14953. ResponseHandler response_handler,
  14954. ContentReceiver content_receiver,
  14955. DownloadProgress progress) {
  14956. return Get(path, Headers(), std::move(response_handler),
  14957. std::move(content_receiver), std::move(progress));
  14958. }
  14959. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14960. ResponseHandler response_handler,
  14961. ContentReceiver content_receiver,
  14962. DownloadProgress progress) {
  14963. Request req;
  14964. req.method = "GET";
  14965. req.path = path;
  14966. req.headers = headers;
  14967. req.response_handler = std::move(response_handler);
  14968. req.content_receiver =
  14969. [content_receiver](const char *data, size_t data_length,
  14970. size_t /*offset*/, size_t /*total_length*/) {
  14971. return content_receiver(data, data_length);
  14972. };
  14973. req.download_progress = std::move(progress);
  14974. if (max_timeout_msec_ > 0) {
  14975. req.start_time_ = std::chrono::steady_clock::now();
  14976. }
  14977. return send_(std::move(req));
  14978. }
  14979. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14980. const Headers &headers,
  14981. ContentReceiver content_receiver,
  14982. DownloadProgress progress) {
  14983. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14984. std::move(progress));
  14985. }
  14986. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14987. const Headers &headers,
  14988. ResponseHandler response_handler,
  14989. ContentReceiver content_receiver,
  14990. DownloadProgress progress) {
  14991. if (params.empty()) {
  14992. return Get(path, headers, std::move(response_handler),
  14993. std::move(content_receiver), std::move(progress));
  14994. }
  14995. std::string path_with_query = append_query_params(path, params);
  14996. return Get(path_with_query, headers, std::move(response_handler),
  14997. std::move(content_receiver), std::move(progress));
  14998. }
  14999. inline Result ClientImpl::Head(const std::string &path) {
  15000. return Head(path, Headers());
  15001. }
  15002. inline Result ClientImpl::Head(const std::string &path,
  15003. const Headers &headers) {
  15004. Request req;
  15005. req.method = "HEAD";
  15006. req.headers = headers;
  15007. req.path = path;
  15008. if (max_timeout_msec_ > 0) {
  15009. req.start_time_ = std::chrono::steady_clock::now();
  15010. }
  15011. return send_(std::move(req));
  15012. }
  15013. inline Result ClientImpl::Post(const std::string &path) {
  15014. return Post(path, std::string(), std::string());
  15015. }
  15016. inline Result ClientImpl::Post(const std::string &path,
  15017. const Headers &headers) {
  15018. return Post(path, headers, nullptr, 0, std::string());
  15019. }
  15020. inline Result ClientImpl::Post(const std::string &path, const char *body,
  15021. size_t content_length,
  15022. const std::string &content_type,
  15023. UploadProgress progress) {
  15024. return Post(path, Headers(), body, content_length, content_type, progress);
  15025. }
  15026. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  15027. const std::string &content_type,
  15028. UploadProgress progress) {
  15029. return Post(path, Headers(), body, content_type, progress);
  15030. }
  15031. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  15032. return Post(path, Headers(), params);
  15033. }
  15034. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15035. ContentProvider content_provider,
  15036. const std::string &content_type,
  15037. UploadProgress progress) {
  15038. return Post(path, Headers(), content_length, std::move(content_provider),
  15039. content_type, progress);
  15040. }
  15041. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15042. ContentProvider content_provider,
  15043. const std::string &content_type,
  15044. ContentReceiver content_receiver,
  15045. UploadProgress progress) {
  15046. return Post(path, Headers(), content_length, std::move(content_provider),
  15047. content_type, std::move(content_receiver), progress);
  15048. }
  15049. inline Result ClientImpl::Post(const std::string &path,
  15050. ContentProviderWithoutLength content_provider,
  15051. const std::string &content_type,
  15052. UploadProgress progress) {
  15053. return Post(path, Headers(), std::move(content_provider), content_type,
  15054. progress);
  15055. }
  15056. inline Result ClientImpl::Post(const std::string &path,
  15057. ContentProviderWithoutLength content_provider,
  15058. const std::string &content_type,
  15059. ContentReceiver content_receiver,
  15060. UploadProgress progress) {
  15061. return Post(path, Headers(), std::move(content_provider), content_type,
  15062. std::move(content_receiver), progress);
  15063. }
  15064. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15065. const Params &params) {
  15066. auto query = detail::params_to_query_str(params);
  15067. return Post(path, headers, query, "application/x-www-form-urlencoded");
  15068. }
  15069. inline Result ClientImpl::Post(const std::string &path,
  15070. const UploadFormDataItems &items,
  15071. UploadProgress progress) {
  15072. return Post(path, Headers(), items, progress);
  15073. }
  15074. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15075. const UploadFormDataItems &items,
  15076. UploadProgress progress) {
  15077. const auto &boundary = detail::make_multipart_data_boundary();
  15078. const auto &content_type =
  15079. detail::serialize_multipart_formdata_get_content_type(boundary);
  15080. auto content_length = detail::get_multipart_content_length(items, boundary);
  15081. return Post(path, headers, content_length,
  15082. detail::make_multipart_content_provider(items, boundary),
  15083. content_type, progress);
  15084. }
  15085. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15086. const UploadFormDataItems &items,
  15087. const std::string &boundary,
  15088. UploadProgress progress) {
  15089. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15090. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15091. }
  15092. const auto &content_type =
  15093. detail::serialize_multipart_formdata_get_content_type(boundary);
  15094. auto content_length = detail::get_multipart_content_length(items, boundary);
  15095. return Post(path, headers, content_length,
  15096. detail::make_multipart_content_provider(items, boundary),
  15097. content_type, progress);
  15098. }
  15099. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15100. const char *body, size_t content_length,
  15101. const std::string &content_type,
  15102. UploadProgress progress) {
  15103. return send_with_content_provider_and_receiver(
  15104. "POST", path, headers, body, content_length, nullptr, nullptr,
  15105. content_type, nullptr, progress);
  15106. }
  15107. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15108. const std::string &body,
  15109. const std::string &content_type,
  15110. UploadProgress progress) {
  15111. return send_with_content_provider_and_receiver(
  15112. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  15113. content_type, nullptr, progress);
  15114. }
  15115. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15116. size_t content_length,
  15117. ContentProvider content_provider,
  15118. const std::string &content_type,
  15119. UploadProgress progress) {
  15120. return send_with_content_provider_and_receiver(
  15121. "POST", path, headers, nullptr, content_length,
  15122. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15123. }
  15124. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15125. size_t content_length,
  15126. ContentProvider content_provider,
  15127. const std::string &content_type,
  15128. ContentReceiver content_receiver,
  15129. DownloadProgress progress) {
  15130. return send_with_content_provider_and_receiver(
  15131. "POST", path, headers, nullptr, content_length,
  15132. std::move(content_provider), nullptr, content_type,
  15133. std::move(content_receiver), std::move(progress));
  15134. }
  15135. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15136. ContentProviderWithoutLength content_provider,
  15137. const std::string &content_type,
  15138. UploadProgress progress) {
  15139. return send_with_content_provider_and_receiver(
  15140. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15141. content_type, nullptr, progress);
  15142. }
  15143. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15144. ContentProviderWithoutLength content_provider,
  15145. const std::string &content_type,
  15146. ContentReceiver content_receiver,
  15147. DownloadProgress progress) {
  15148. return send_with_content_provider_and_receiver(
  15149. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15150. content_type, std::move(content_receiver), std::move(progress));
  15151. }
  15152. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15153. const UploadFormDataItems &items,
  15154. const FormDataProviderItems &provider_items,
  15155. UploadProgress progress) {
  15156. const auto &boundary = detail::make_multipart_data_boundary();
  15157. const auto &content_type =
  15158. detail::serialize_multipart_formdata_get_content_type(boundary);
  15159. return send_with_content_provider_and_receiver(
  15160. "POST", path, headers, nullptr, 0, nullptr,
  15161. get_multipart_content_provider(boundary, items, provider_items),
  15162. content_type, nullptr, progress);
  15163. }
  15164. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15165. const std::string &body,
  15166. const std::string &content_type,
  15167. ContentReceiver content_receiver,
  15168. DownloadProgress progress) {
  15169. Request req;
  15170. req.method = "POST";
  15171. req.path = path;
  15172. req.headers = headers;
  15173. req.body = body;
  15174. req.content_receiver =
  15175. [content_receiver](const char *data, size_t data_length,
  15176. size_t /*offset*/, size_t /*total_length*/) {
  15177. return content_receiver(data, data_length);
  15178. };
  15179. req.download_progress = std::move(progress);
  15180. if (max_timeout_msec_ > 0) {
  15181. req.start_time_ = std::chrono::steady_clock::now();
  15182. }
  15183. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15184. return send_(std::move(req));
  15185. }
  15186. inline Result ClientImpl::Put(const std::string &path) {
  15187. return Put(path, std::string(), std::string());
  15188. }
  15189. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  15190. return Put(path, headers, nullptr, 0, std::string());
  15191. }
  15192. inline Result ClientImpl::Put(const std::string &path, const char *body,
  15193. size_t content_length,
  15194. const std::string &content_type,
  15195. UploadProgress progress) {
  15196. return Put(path, Headers(), body, content_length, content_type, progress);
  15197. }
  15198. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  15199. const std::string &content_type,
  15200. UploadProgress progress) {
  15201. return Put(path, Headers(), body, content_type, progress);
  15202. }
  15203. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  15204. return Put(path, Headers(), params);
  15205. }
  15206. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15207. ContentProvider content_provider,
  15208. const std::string &content_type,
  15209. UploadProgress progress) {
  15210. return Put(path, Headers(), content_length, std::move(content_provider),
  15211. content_type, progress);
  15212. }
  15213. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15214. ContentProvider content_provider,
  15215. const std::string &content_type,
  15216. ContentReceiver content_receiver,
  15217. UploadProgress progress) {
  15218. return Put(path, Headers(), content_length, std::move(content_provider),
  15219. content_type, std::move(content_receiver), progress);
  15220. }
  15221. inline Result ClientImpl::Put(const std::string &path,
  15222. ContentProviderWithoutLength content_provider,
  15223. const std::string &content_type,
  15224. UploadProgress progress) {
  15225. return Put(path, Headers(), std::move(content_provider), content_type,
  15226. progress);
  15227. }
  15228. inline Result ClientImpl::Put(const std::string &path,
  15229. ContentProviderWithoutLength content_provider,
  15230. const std::string &content_type,
  15231. ContentReceiver content_receiver,
  15232. UploadProgress progress) {
  15233. return Put(path, Headers(), std::move(content_provider), content_type,
  15234. std::move(content_receiver), progress);
  15235. }
  15236. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15237. const Params &params) {
  15238. auto query = detail::params_to_query_str(params);
  15239. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15240. }
  15241. inline Result ClientImpl::Put(const std::string &path,
  15242. const UploadFormDataItems &items,
  15243. UploadProgress progress) {
  15244. return Put(path, Headers(), items, progress);
  15245. }
  15246. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15247. const UploadFormDataItems &items,
  15248. UploadProgress progress) {
  15249. const auto &boundary = detail::make_multipart_data_boundary();
  15250. const auto &content_type =
  15251. detail::serialize_multipart_formdata_get_content_type(boundary);
  15252. auto content_length = detail::get_multipart_content_length(items, boundary);
  15253. return Put(path, headers, content_length,
  15254. detail::make_multipart_content_provider(items, boundary),
  15255. content_type, progress);
  15256. }
  15257. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15258. const UploadFormDataItems &items,
  15259. const std::string &boundary,
  15260. UploadProgress progress) {
  15261. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15262. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15263. }
  15264. const auto &content_type =
  15265. detail::serialize_multipart_formdata_get_content_type(boundary);
  15266. auto content_length = detail::get_multipart_content_length(items, boundary);
  15267. return Put(path, headers, content_length,
  15268. detail::make_multipart_content_provider(items, boundary),
  15269. content_type, progress);
  15270. }
  15271. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15272. const char *body, size_t content_length,
  15273. const std::string &content_type,
  15274. UploadProgress progress) {
  15275. return send_with_content_provider_and_receiver(
  15276. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15277. content_type, nullptr, progress);
  15278. }
  15279. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15280. const std::string &body,
  15281. const std::string &content_type,
  15282. UploadProgress progress) {
  15283. return send_with_content_provider_and_receiver(
  15284. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15285. content_type, nullptr, progress);
  15286. }
  15287. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15288. size_t content_length,
  15289. ContentProvider content_provider,
  15290. const std::string &content_type,
  15291. UploadProgress progress) {
  15292. return send_with_content_provider_and_receiver(
  15293. "PUT", path, headers, nullptr, content_length,
  15294. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15295. }
  15296. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15297. size_t content_length,
  15298. ContentProvider content_provider,
  15299. const std::string &content_type,
  15300. ContentReceiver content_receiver,
  15301. UploadProgress progress) {
  15302. return send_with_content_provider_and_receiver(
  15303. "PUT", path, headers, nullptr, content_length,
  15304. std::move(content_provider), nullptr, content_type,
  15305. std::move(content_receiver), progress);
  15306. }
  15307. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15308. ContentProviderWithoutLength content_provider,
  15309. const std::string &content_type,
  15310. UploadProgress progress) {
  15311. return send_with_content_provider_and_receiver(
  15312. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15313. content_type, nullptr, progress);
  15314. }
  15315. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15316. ContentProviderWithoutLength content_provider,
  15317. const std::string &content_type,
  15318. ContentReceiver content_receiver,
  15319. UploadProgress progress) {
  15320. return send_with_content_provider_and_receiver(
  15321. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15322. content_type, std::move(content_receiver), progress);
  15323. }
  15324. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15325. const UploadFormDataItems &items,
  15326. const FormDataProviderItems &provider_items,
  15327. UploadProgress progress) {
  15328. const auto &boundary = detail::make_multipart_data_boundary();
  15329. const auto &content_type =
  15330. detail::serialize_multipart_formdata_get_content_type(boundary);
  15331. return send_with_content_provider_and_receiver(
  15332. "PUT", path, headers, nullptr, 0, nullptr,
  15333. get_multipart_content_provider(boundary, items, provider_items),
  15334. content_type, nullptr, progress);
  15335. }
  15336. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15337. const std::string &body,
  15338. const std::string &content_type,
  15339. ContentReceiver content_receiver,
  15340. DownloadProgress progress) {
  15341. Request req;
  15342. req.method = "PUT";
  15343. req.path = path;
  15344. req.headers = headers;
  15345. req.body = body;
  15346. req.content_receiver =
  15347. [content_receiver](const char *data, size_t data_length,
  15348. size_t /*offset*/, size_t /*total_length*/) {
  15349. return content_receiver(data, data_length);
  15350. };
  15351. req.download_progress = std::move(progress);
  15352. if (max_timeout_msec_ > 0) {
  15353. req.start_time_ = std::chrono::steady_clock::now();
  15354. }
  15355. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15356. return send_(std::move(req));
  15357. }
  15358. inline Result ClientImpl::Patch(const std::string &path) {
  15359. return Patch(path, std::string(), std::string());
  15360. }
  15361. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15362. UploadProgress progress) {
  15363. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15364. }
  15365. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15366. size_t content_length,
  15367. const std::string &content_type,
  15368. UploadProgress progress) {
  15369. return Patch(path, Headers(), body, content_length, content_type, progress);
  15370. }
  15371. inline Result ClientImpl::Patch(const std::string &path,
  15372. const std::string &body,
  15373. const std::string &content_type,
  15374. UploadProgress progress) {
  15375. return Patch(path, Headers(), body, content_type, progress);
  15376. }
  15377. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15378. return Patch(path, Headers(), params);
  15379. }
  15380. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15381. ContentProvider content_provider,
  15382. const std::string &content_type,
  15383. UploadProgress progress) {
  15384. return Patch(path, Headers(), content_length, std::move(content_provider),
  15385. content_type, progress);
  15386. }
  15387. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15388. ContentProvider content_provider,
  15389. const std::string &content_type,
  15390. ContentReceiver content_receiver,
  15391. UploadProgress progress) {
  15392. return Patch(path, Headers(), content_length, std::move(content_provider),
  15393. content_type, std::move(content_receiver), progress);
  15394. }
  15395. inline Result ClientImpl::Patch(const std::string &path,
  15396. ContentProviderWithoutLength content_provider,
  15397. const std::string &content_type,
  15398. UploadProgress progress) {
  15399. return Patch(path, Headers(), std::move(content_provider), content_type,
  15400. progress);
  15401. }
  15402. inline Result ClientImpl::Patch(const std::string &path,
  15403. ContentProviderWithoutLength content_provider,
  15404. const std::string &content_type,
  15405. ContentReceiver content_receiver,
  15406. UploadProgress progress) {
  15407. return Patch(path, Headers(), std::move(content_provider), content_type,
  15408. std::move(content_receiver), progress);
  15409. }
  15410. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15411. const Params &params) {
  15412. auto query = detail::params_to_query_str(params);
  15413. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15414. }
  15415. inline Result ClientImpl::Patch(const std::string &path,
  15416. const UploadFormDataItems &items,
  15417. UploadProgress progress) {
  15418. return Patch(path, Headers(), items, progress);
  15419. }
  15420. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15421. const UploadFormDataItems &items,
  15422. UploadProgress progress) {
  15423. const auto &boundary = detail::make_multipart_data_boundary();
  15424. const auto &content_type =
  15425. detail::serialize_multipart_formdata_get_content_type(boundary);
  15426. auto content_length = detail::get_multipart_content_length(items, boundary);
  15427. return Patch(path, headers, content_length,
  15428. detail::make_multipart_content_provider(items, boundary),
  15429. content_type, progress);
  15430. }
  15431. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15432. const UploadFormDataItems &items,
  15433. const std::string &boundary,
  15434. UploadProgress progress) {
  15435. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15436. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15437. }
  15438. const auto &content_type =
  15439. detail::serialize_multipart_formdata_get_content_type(boundary);
  15440. auto content_length = detail::get_multipart_content_length(items, boundary);
  15441. return Patch(path, headers, content_length,
  15442. detail::make_multipart_content_provider(items, boundary),
  15443. content_type, progress);
  15444. }
  15445. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15446. const char *body, size_t content_length,
  15447. const std::string &content_type,
  15448. UploadProgress progress) {
  15449. return send_with_content_provider_and_receiver(
  15450. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15451. content_type, nullptr, progress);
  15452. }
  15453. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15454. const std::string &body,
  15455. const std::string &content_type,
  15456. UploadProgress progress) {
  15457. return send_with_content_provider_and_receiver(
  15458. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15459. content_type, nullptr, progress);
  15460. }
  15461. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15462. size_t content_length,
  15463. ContentProvider content_provider,
  15464. const std::string &content_type,
  15465. UploadProgress progress) {
  15466. return send_with_content_provider_and_receiver(
  15467. "PATCH", path, headers, nullptr, content_length,
  15468. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15469. }
  15470. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15471. size_t content_length,
  15472. ContentProvider content_provider,
  15473. const std::string &content_type,
  15474. ContentReceiver content_receiver,
  15475. UploadProgress progress) {
  15476. return send_with_content_provider_and_receiver(
  15477. "PATCH", path, headers, nullptr, content_length,
  15478. std::move(content_provider), nullptr, content_type,
  15479. std::move(content_receiver), progress);
  15480. }
  15481. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15482. ContentProviderWithoutLength content_provider,
  15483. const std::string &content_type,
  15484. UploadProgress progress) {
  15485. return send_with_content_provider_and_receiver(
  15486. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15487. content_type, nullptr, progress);
  15488. }
  15489. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15490. ContentProviderWithoutLength content_provider,
  15491. const std::string &content_type,
  15492. ContentReceiver content_receiver,
  15493. UploadProgress progress) {
  15494. return send_with_content_provider_and_receiver(
  15495. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15496. content_type, std::move(content_receiver), progress);
  15497. }
  15498. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15499. const UploadFormDataItems &items,
  15500. const FormDataProviderItems &provider_items,
  15501. UploadProgress progress) {
  15502. const auto &boundary = detail::make_multipart_data_boundary();
  15503. const auto &content_type =
  15504. detail::serialize_multipart_formdata_get_content_type(boundary);
  15505. return send_with_content_provider_and_receiver(
  15506. "PATCH", path, headers, nullptr, 0, nullptr,
  15507. get_multipart_content_provider(boundary, items, provider_items),
  15508. content_type, nullptr, progress);
  15509. }
  15510. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15511. const std::string &body,
  15512. const std::string &content_type,
  15513. ContentReceiver content_receiver,
  15514. DownloadProgress progress) {
  15515. Request req;
  15516. req.method = "PATCH";
  15517. req.path = path;
  15518. req.headers = headers;
  15519. req.body = body;
  15520. req.content_receiver =
  15521. [content_receiver](const char *data, size_t data_length,
  15522. size_t /*offset*/, size_t /*total_length*/) {
  15523. return content_receiver(data, data_length);
  15524. };
  15525. req.download_progress = std::move(progress);
  15526. if (max_timeout_msec_ > 0) {
  15527. req.start_time_ = std::chrono::steady_clock::now();
  15528. }
  15529. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15530. return send_(std::move(req));
  15531. }
  15532. inline Result ClientImpl::Delete(const std::string &path,
  15533. DownloadProgress progress) {
  15534. return Delete(path, Headers(), std::string(), std::string(), progress);
  15535. }
  15536. inline Result ClientImpl::Delete(const std::string &path,
  15537. const Headers &headers,
  15538. DownloadProgress progress) {
  15539. return Delete(path, headers, std::string(), std::string(), progress);
  15540. }
  15541. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15542. size_t content_length,
  15543. const std::string &content_type,
  15544. DownloadProgress progress) {
  15545. return Delete(path, Headers(), body, content_length, content_type, progress);
  15546. }
  15547. inline Result ClientImpl::Delete(const std::string &path,
  15548. const std::string &body,
  15549. const std::string &content_type,
  15550. DownloadProgress progress) {
  15551. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15552. progress);
  15553. }
  15554. inline Result ClientImpl::Delete(const std::string &path,
  15555. const Headers &headers,
  15556. const std::string &body,
  15557. const std::string &content_type,
  15558. DownloadProgress progress) {
  15559. return Delete(path, headers, body.data(), body.size(), content_type,
  15560. progress);
  15561. }
  15562. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15563. DownloadProgress progress) {
  15564. return Delete(path, Headers(), params, progress);
  15565. }
  15566. inline Result ClientImpl::Delete(const std::string &path,
  15567. const Headers &headers, const Params &params,
  15568. DownloadProgress progress) {
  15569. auto query = detail::params_to_query_str(params);
  15570. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15571. progress);
  15572. }
  15573. inline Result ClientImpl::Delete(const std::string &path,
  15574. const Headers &headers, const char *body,
  15575. size_t content_length,
  15576. const std::string &content_type,
  15577. DownloadProgress progress) {
  15578. Request req;
  15579. req.method = "DELETE";
  15580. req.headers = headers;
  15581. req.path = path;
  15582. req.download_progress = std::move(progress);
  15583. if (max_timeout_msec_ > 0) {
  15584. req.start_time_ = std::chrono::steady_clock::now();
  15585. }
  15586. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15587. req.body.assign(body, content_length);
  15588. return send_(std::move(req));
  15589. }
  15590. inline Result ClientImpl::Options(const std::string &path) {
  15591. return Options(path, Headers());
  15592. }
  15593. inline Result ClientImpl::Options(const std::string &path,
  15594. const Headers &headers) {
  15595. Request req;
  15596. req.method = "OPTIONS";
  15597. req.headers = headers;
  15598. req.path = path;
  15599. if (max_timeout_msec_ > 0) {
  15600. req.start_time_ = std::chrono::steady_clock::now();
  15601. }
  15602. return send_(std::move(req));
  15603. }
  15604. inline void ClientImpl::stop() {
  15605. std::lock_guard<std::mutex> guard(socket_mutex_);
  15606. stop_requested_ = true;
  15607. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15608. // do is to shutdown_socket, so that threads using this socket suddenly
  15609. // discover they can't read/write any more and error out. Everything else
  15610. // (closing the socket, shutting ssl down) is unsafe because these actions
  15611. // are not thread-safe.
  15612. if (socket_requests_in_flight_ > 0) {
  15613. shutdown_socket(socket_);
  15614. // Aside from that, we set a flag for the socket to be closed when we're
  15615. // done.
  15616. socket_should_be_closed_when_request_is_done_ = true;
  15617. return;
  15618. }
  15619. disconnect(/*gracefully=*/true);
  15620. }
  15621. inline std::string ClientImpl::host() const { return host_; }
  15622. inline int ClientImpl::port() const { return port_; }
  15623. inline size_t ClientImpl::is_socket_open() const {
  15624. std::lock_guard<std::mutex> guard(socket_mutex_);
  15625. return socket_.is_open();
  15626. }
  15627. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15628. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15629. connection_timeout_sec_ = sec;
  15630. connection_timeout_usec_ = usec;
  15631. }
  15632. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15633. read_timeout_sec_ = sec;
  15634. read_timeout_usec_ = usec;
  15635. }
  15636. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15637. write_timeout_sec_ = sec;
  15638. write_timeout_usec_ = usec;
  15639. }
  15640. inline void ClientImpl::set_max_timeout(time_t msec) {
  15641. max_timeout_msec_ = msec;
  15642. }
  15643. inline void ClientImpl::set_basic_auth(const std::string &username,
  15644. const std::string &password) {
  15645. basic_auth_username_ = username;
  15646. basic_auth_password_ = password;
  15647. }
  15648. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15649. bearer_token_auth_token_ = token;
  15650. }
  15651. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15652. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15653. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15654. inline void
  15655. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15656. set_direct_hostname_addr_map(std::move(addr_map));
  15657. }
  15658. inline void ClientImpl::set_direct_hostname_addr_map(
  15659. std::map<std::string, std::string> addr_map) {
  15660. addr_map_ = std::move(addr_map);
  15661. }
  15662. inline void ClientImpl::set_tunnel_hostname_addr_map(
  15663. std::map<std::string, std::string> addr_map) {
  15664. tunnel_addr_map_ = std::move(addr_map);
  15665. }
  15666. inline void ClientImpl::set_default_headers(Headers headers) {
  15667. default_headers_ = std::move(headers);
  15668. }
  15669. inline void ClientImpl::set_header_writer(
  15670. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15671. header_writer_ = writer;
  15672. }
  15673. inline void ClientImpl::set_address_family(int family) {
  15674. address_family_ = family;
  15675. }
  15676. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15677. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15678. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15679. socket_options_ = std::move(socket_options);
  15680. }
  15681. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15682. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15683. inline void ClientImpl::set_payload_max_length(size_t length) {
  15684. payload_max_length_ = length;
  15685. has_payload_max_length_ = true;
  15686. }
  15687. inline void ClientImpl::set_interface(const std::string &intf) {
  15688. interface_ = intf;
  15689. }
  15690. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15691. proxy_host_ = host;
  15692. proxy_port_ = port;
  15693. std::lock_guard<std::mutex> guard(socket_mutex_);
  15694. disconnect(/*gracefully=*/true);
  15695. }
  15696. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15697. const std::string &password) {
  15698. proxy_basic_auth_username_ = username;
  15699. proxy_basic_auth_password_ = password;
  15700. }
  15701. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15702. proxy_bearer_token_auth_token_ = token;
  15703. }
  15704. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15705. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15706. std::lock_guard<std::mutex> guard(socket_mutex_);
  15707. disconnect(/*gracefully=*/true);
  15708. }
  15709. #ifdef CPPHTTPLIB_SSL_ENABLED
  15710. inline void ClientImpl::set_digest_auth(const std::string &username,
  15711. const std::string &password) {
  15712. digest_auth_username_ = username;
  15713. digest_auth_password_ = password;
  15714. }
  15715. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15716. const std::string &ca_cert_dir_path) {
  15717. ca_cert_file_path_ = ca_cert_file_path;
  15718. ca_cert_dir_path_ = ca_cert_dir_path;
  15719. }
  15720. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15721. const std::string &password) {
  15722. proxy_digest_auth_username_ = username;
  15723. proxy_digest_auth_password_ = password;
  15724. }
  15725. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15726. if (server_certificate_verification_ == enabled) { return; }
  15727. server_certificate_verification_ = enabled;
  15728. tls_settings_changed();
  15729. }
  15730. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15731. if (server_hostname_verification_ == enabled) { return; }
  15732. server_hostname_verification_ = enabled;
  15733. tls_settings_changed();
  15734. }
  15735. inline void ClientImpl::enable_system_ca(bool enabled) {
  15736. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15737. }
  15738. #endif
  15739. inline void ClientImpl::set_logger(Logger logger) {
  15740. logger_ = std::move(logger);
  15741. }
  15742. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15743. error_logger_ = std::move(error_logger);
  15744. }
  15745. /*
  15746. * SSL/TLS Common Implementation
  15747. */
  15748. inline ClientConnection::~ClientConnection() {
  15749. #ifdef CPPHTTPLIB_SSL_ENABLED
  15750. if (session) {
  15751. tls::shutdown(session, true);
  15752. tls::free_session(session);
  15753. session = nullptr;
  15754. }
  15755. #endif
  15756. if (sock != INVALID_SOCKET) {
  15757. detail::close_socket(sock);
  15758. sock = INVALID_SOCKET;
  15759. }
  15760. }
  15761. // Universal client implementation
  15762. inline Client::Client(const std::string &scheme_host_port)
  15763. : Client(scheme_host_port, std::string(), std::string()) {}
  15764. inline Client::Client(const std::string &scheme_host_port,
  15765. const std::string &client_cert_path,
  15766. const std::string &client_key_path) {
  15767. detail::UrlComponents uc;
  15768. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15769. auto &scheme = uc.scheme;
  15770. #ifdef CPPHTTPLIB_SSL_ENABLED
  15771. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15772. #else
  15773. if (!scheme.empty() && scheme != "http") {
  15774. #endif
  15775. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15776. std::string msg = "'" + scheme + "' scheme is not supported.";
  15777. throw std::invalid_argument(msg);
  15778. #endif
  15779. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15780. return;
  15781. }
  15782. auto is_ssl = scheme == "https";
  15783. auto host = std::move(uc.host);
  15784. auto port = is_ssl ? 443 : 80;
  15785. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15786. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15787. return;
  15788. }
  15789. if (is_ssl) {
  15790. #ifdef CPPHTTPLIB_SSL_ENABLED
  15791. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15792. client_key_path);
  15793. is_ssl_ = is_ssl;
  15794. #endif
  15795. } else {
  15796. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15797. client_key_path);
  15798. }
  15799. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15800. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15801. // A URL, but not one this client can use, such as one with userinfo. A
  15802. // Unix socket path may have "//" further on.
  15803. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15804. } else {
  15805. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15806. // if port param below changes.
  15807. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15808. client_cert_path, client_key_path);
  15809. }
  15810. }
  15811. inline Client::Client(const std::string &host, int port)
  15812. : Client(host, port, std::string(), std::string()) {}
  15813. inline Client::Client(const std::string &host, int port,
  15814. const std::string &client_cert_path,
  15815. const std::string &client_key_path)
  15816. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15817. client_key_path)) {}
  15818. inline Client::~Client() = default;
  15819. inline bool Client::is_valid() const {
  15820. return cli_ != nullptr && cli_->is_valid();
  15821. }
  15822. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15823. return cli_->Get(path, std::move(progress));
  15824. }
  15825. inline Result Client::Get(const std::string &path, const Headers &headers,
  15826. DownloadProgress progress) {
  15827. return cli_->Get(path, headers, std::move(progress));
  15828. }
  15829. inline Result Client::Get(const std::string &path,
  15830. ContentReceiver content_receiver,
  15831. DownloadProgress progress) {
  15832. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15833. }
  15834. inline Result Client::Get(const std::string &path, const Headers &headers,
  15835. ContentReceiver content_receiver,
  15836. DownloadProgress progress) {
  15837. return cli_->Get(path, headers, std::move(content_receiver),
  15838. std::move(progress));
  15839. }
  15840. inline Result Client::Get(const std::string &path,
  15841. ResponseHandler response_handler,
  15842. ContentReceiver content_receiver,
  15843. DownloadProgress progress) {
  15844. return cli_->Get(path, std::move(response_handler),
  15845. std::move(content_receiver), std::move(progress));
  15846. }
  15847. inline Result Client::Get(const std::string &path, const Headers &headers,
  15848. ResponseHandler response_handler,
  15849. ContentReceiver content_receiver,
  15850. DownloadProgress progress) {
  15851. return cli_->Get(path, headers, std::move(response_handler),
  15852. std::move(content_receiver), std::move(progress));
  15853. }
  15854. inline Result Client::Get(const std::string &path, const Params &params,
  15855. DownloadProgress progress) {
  15856. return cli_->Get(path, params, std::move(progress));
  15857. }
  15858. inline Result Client::Get(const std::string &path, const Params &params,
  15859. const Headers &headers, DownloadProgress progress) {
  15860. return cli_->Get(path, params, headers, std::move(progress));
  15861. }
  15862. inline Result Client::Get(const std::string &path, const Params &params,
  15863. const Headers &headers,
  15864. ContentReceiver content_receiver,
  15865. DownloadProgress progress) {
  15866. return cli_->Get(path, params, headers, std::move(content_receiver),
  15867. std::move(progress));
  15868. }
  15869. inline Result Client::Get(const std::string &path, const Params &params,
  15870. const Headers &headers,
  15871. ResponseHandler response_handler,
  15872. ContentReceiver content_receiver,
  15873. DownloadProgress progress) {
  15874. return cli_->Get(path, params, headers, std::move(response_handler),
  15875. std::move(content_receiver), std::move(progress));
  15876. }
  15877. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15878. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15879. return cli_->Head(path, headers);
  15880. }
  15881. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15882. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15883. return cli_->Post(path, headers);
  15884. }
  15885. inline Result Client::Post(const std::string &path, const char *body,
  15886. size_t content_length,
  15887. const std::string &content_type,
  15888. UploadProgress progress) {
  15889. return cli_->Post(path, body, content_length, content_type, progress);
  15890. }
  15891. inline Result Client::Post(const std::string &path, const Headers &headers,
  15892. const char *body, size_t content_length,
  15893. const std::string &content_type,
  15894. UploadProgress progress) {
  15895. return cli_->Post(path, headers, body, content_length, content_type,
  15896. progress);
  15897. }
  15898. inline Result Client::Post(const std::string &path, const std::string &body,
  15899. const std::string &content_type,
  15900. UploadProgress progress) {
  15901. return cli_->Post(path, body, content_type, progress);
  15902. }
  15903. inline Result Client::Post(const std::string &path, const Headers &headers,
  15904. const std::string &body,
  15905. const std::string &content_type,
  15906. UploadProgress progress) {
  15907. return cli_->Post(path, headers, body, content_type, progress);
  15908. }
  15909. inline Result Client::Post(const std::string &path, size_t content_length,
  15910. ContentProvider content_provider,
  15911. const std::string &content_type,
  15912. UploadProgress progress) {
  15913. return cli_->Post(path, content_length, std::move(content_provider),
  15914. content_type, progress);
  15915. }
  15916. inline Result Client::Post(const std::string &path, size_t content_length,
  15917. ContentProvider content_provider,
  15918. const std::string &content_type,
  15919. ContentReceiver content_receiver,
  15920. UploadProgress progress) {
  15921. return cli_->Post(path, content_length, std::move(content_provider),
  15922. content_type, std::move(content_receiver), progress);
  15923. }
  15924. inline Result Client::Post(const std::string &path,
  15925. ContentProviderWithoutLength content_provider,
  15926. const std::string &content_type,
  15927. UploadProgress progress) {
  15928. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15929. }
  15930. inline Result Client::Post(const std::string &path,
  15931. ContentProviderWithoutLength content_provider,
  15932. const std::string &content_type,
  15933. ContentReceiver content_receiver,
  15934. UploadProgress progress) {
  15935. return cli_->Post(path, std::move(content_provider), content_type,
  15936. std::move(content_receiver), progress);
  15937. }
  15938. inline Result Client::Post(const std::string &path, const Headers &headers,
  15939. size_t content_length,
  15940. ContentProvider content_provider,
  15941. const std::string &content_type,
  15942. UploadProgress progress) {
  15943. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15944. content_type, progress);
  15945. }
  15946. inline Result Client::Post(const std::string &path, const Headers &headers,
  15947. size_t content_length,
  15948. ContentProvider content_provider,
  15949. const std::string &content_type,
  15950. ContentReceiver content_receiver,
  15951. DownloadProgress progress) {
  15952. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15953. content_type, std::move(content_receiver), progress);
  15954. }
  15955. inline Result Client::Post(const std::string &path, const Headers &headers,
  15956. ContentProviderWithoutLength content_provider,
  15957. const std::string &content_type,
  15958. UploadProgress progress) {
  15959. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15960. progress);
  15961. }
  15962. inline Result Client::Post(const std::string &path, const Headers &headers,
  15963. ContentProviderWithoutLength content_provider,
  15964. const std::string &content_type,
  15965. ContentReceiver content_receiver,
  15966. DownloadProgress progress) {
  15967. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15968. std::move(content_receiver), progress);
  15969. }
  15970. inline Result Client::Post(const std::string &path, const Params &params) {
  15971. return cli_->Post(path, params);
  15972. }
  15973. inline Result Client::Post(const std::string &path, const Headers &headers,
  15974. const Params &params) {
  15975. return cli_->Post(path, headers, params);
  15976. }
  15977. inline Result Client::Post(const std::string &path,
  15978. const UploadFormDataItems &items,
  15979. UploadProgress progress) {
  15980. return cli_->Post(path, items, progress);
  15981. }
  15982. inline Result Client::Post(const std::string &path, const Headers &headers,
  15983. const UploadFormDataItems &items,
  15984. UploadProgress progress) {
  15985. return cli_->Post(path, headers, items, progress);
  15986. }
  15987. inline Result Client::Post(const std::string &path, const Headers &headers,
  15988. const UploadFormDataItems &items,
  15989. const std::string &boundary,
  15990. UploadProgress progress) {
  15991. return cli_->Post(path, headers, items, boundary, progress);
  15992. }
  15993. inline Result Client::Post(const std::string &path, const Headers &headers,
  15994. const UploadFormDataItems &items,
  15995. const FormDataProviderItems &provider_items,
  15996. UploadProgress progress) {
  15997. return cli_->Post(path, headers, items, provider_items, progress);
  15998. }
  15999. inline Result Client::Post(const std::string &path, const Headers &headers,
  16000. const std::string &body,
  16001. const std::string &content_type,
  16002. ContentReceiver content_receiver,
  16003. DownloadProgress progress) {
  16004. return cli_->Post(path, headers, body, content_type,
  16005. std::move(content_receiver), progress);
  16006. }
  16007. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  16008. inline Result Client::Put(const std::string &path, const Headers &headers) {
  16009. return cli_->Put(path, headers);
  16010. }
  16011. inline Result Client::Put(const std::string &path, const char *body,
  16012. size_t content_length,
  16013. const std::string &content_type,
  16014. UploadProgress progress) {
  16015. return cli_->Put(path, body, content_length, content_type, progress);
  16016. }
  16017. inline Result Client::Put(const std::string &path, const Headers &headers,
  16018. const char *body, size_t content_length,
  16019. const std::string &content_type,
  16020. UploadProgress progress) {
  16021. return cli_->Put(path, headers, body, content_length, content_type, progress);
  16022. }
  16023. inline Result Client::Put(const std::string &path, const std::string &body,
  16024. const std::string &content_type,
  16025. UploadProgress progress) {
  16026. return cli_->Put(path, body, content_type, progress);
  16027. }
  16028. inline Result Client::Put(const std::string &path, const Headers &headers,
  16029. const std::string &body,
  16030. const std::string &content_type,
  16031. UploadProgress progress) {
  16032. return cli_->Put(path, headers, body, content_type, progress);
  16033. }
  16034. inline Result Client::Put(const std::string &path, size_t content_length,
  16035. ContentProvider content_provider,
  16036. const std::string &content_type,
  16037. UploadProgress progress) {
  16038. return cli_->Put(path, content_length, std::move(content_provider),
  16039. content_type, progress);
  16040. }
  16041. inline Result Client::Put(const std::string &path, size_t content_length,
  16042. ContentProvider content_provider,
  16043. const std::string &content_type,
  16044. ContentReceiver content_receiver,
  16045. UploadProgress progress) {
  16046. return cli_->Put(path, content_length, std::move(content_provider),
  16047. content_type, std::move(content_receiver), progress);
  16048. }
  16049. inline Result Client::Put(const std::string &path,
  16050. ContentProviderWithoutLength content_provider,
  16051. const std::string &content_type,
  16052. UploadProgress progress) {
  16053. return cli_->Put(path, std::move(content_provider), content_type, progress);
  16054. }
  16055. inline Result Client::Put(const std::string &path,
  16056. ContentProviderWithoutLength content_provider,
  16057. const std::string &content_type,
  16058. ContentReceiver content_receiver,
  16059. UploadProgress progress) {
  16060. return cli_->Put(path, std::move(content_provider), content_type,
  16061. std::move(content_receiver), progress);
  16062. }
  16063. inline Result Client::Put(const std::string &path, const Headers &headers,
  16064. size_t content_length,
  16065. ContentProvider content_provider,
  16066. const std::string &content_type,
  16067. UploadProgress progress) {
  16068. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16069. content_type, progress);
  16070. }
  16071. inline Result Client::Put(const std::string &path, const Headers &headers,
  16072. size_t content_length,
  16073. ContentProvider content_provider,
  16074. const std::string &content_type,
  16075. ContentReceiver content_receiver,
  16076. UploadProgress progress) {
  16077. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16078. content_type, std::move(content_receiver), progress);
  16079. }
  16080. inline Result Client::Put(const std::string &path, const Headers &headers,
  16081. ContentProviderWithoutLength content_provider,
  16082. const std::string &content_type,
  16083. UploadProgress progress) {
  16084. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16085. progress);
  16086. }
  16087. inline Result Client::Put(const std::string &path, const Headers &headers,
  16088. ContentProviderWithoutLength content_provider,
  16089. const std::string &content_type,
  16090. ContentReceiver content_receiver,
  16091. UploadProgress progress) {
  16092. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16093. std::move(content_receiver), progress);
  16094. }
  16095. inline Result Client::Put(const std::string &path, const Params &params) {
  16096. return cli_->Put(path, params);
  16097. }
  16098. inline Result Client::Put(const std::string &path, const Headers &headers,
  16099. const Params &params) {
  16100. return cli_->Put(path, headers, params);
  16101. }
  16102. inline Result Client::Put(const std::string &path,
  16103. const UploadFormDataItems &items,
  16104. UploadProgress progress) {
  16105. return cli_->Put(path, items, progress);
  16106. }
  16107. inline Result Client::Put(const std::string &path, const Headers &headers,
  16108. const UploadFormDataItems &items,
  16109. UploadProgress progress) {
  16110. return cli_->Put(path, headers, items, progress);
  16111. }
  16112. inline Result Client::Put(const std::string &path, const Headers &headers,
  16113. const UploadFormDataItems &items,
  16114. const std::string &boundary,
  16115. UploadProgress progress) {
  16116. return cli_->Put(path, headers, items, boundary, progress);
  16117. }
  16118. inline Result Client::Put(const std::string &path, const Headers &headers,
  16119. const UploadFormDataItems &items,
  16120. const FormDataProviderItems &provider_items,
  16121. UploadProgress progress) {
  16122. return cli_->Put(path, headers, items, provider_items, progress);
  16123. }
  16124. inline Result Client::Put(const std::string &path, const Headers &headers,
  16125. const std::string &body,
  16126. const std::string &content_type,
  16127. ContentReceiver content_receiver,
  16128. DownloadProgress progress) {
  16129. return cli_->Put(path, headers, body, content_type, content_receiver,
  16130. progress);
  16131. }
  16132. inline Result Client::Patch(const std::string &path) {
  16133. return cli_->Patch(path);
  16134. }
  16135. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  16136. return cli_->Patch(path, headers);
  16137. }
  16138. inline Result Client::Patch(const std::string &path, const char *body,
  16139. size_t content_length,
  16140. const std::string &content_type,
  16141. UploadProgress progress) {
  16142. return cli_->Patch(path, body, content_length, content_type, progress);
  16143. }
  16144. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16145. const char *body, size_t content_length,
  16146. const std::string &content_type,
  16147. UploadProgress progress) {
  16148. return cli_->Patch(path, headers, body, content_length, content_type,
  16149. progress);
  16150. }
  16151. inline Result Client::Patch(const std::string &path, const std::string &body,
  16152. const std::string &content_type,
  16153. UploadProgress progress) {
  16154. return cli_->Patch(path, body, content_type, progress);
  16155. }
  16156. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16157. const std::string &body,
  16158. const std::string &content_type,
  16159. UploadProgress progress) {
  16160. return cli_->Patch(path, headers, body, content_type, progress);
  16161. }
  16162. inline Result Client::Patch(const std::string &path, size_t content_length,
  16163. ContentProvider content_provider,
  16164. const std::string &content_type,
  16165. UploadProgress progress) {
  16166. return cli_->Patch(path, content_length, std::move(content_provider),
  16167. content_type, progress);
  16168. }
  16169. inline Result Client::Patch(const std::string &path, size_t content_length,
  16170. ContentProvider content_provider,
  16171. const std::string &content_type,
  16172. ContentReceiver content_receiver,
  16173. UploadProgress progress) {
  16174. return cli_->Patch(path, content_length, std::move(content_provider),
  16175. content_type, std::move(content_receiver), progress);
  16176. }
  16177. inline Result Client::Patch(const std::string &path,
  16178. ContentProviderWithoutLength content_provider,
  16179. const std::string &content_type,
  16180. UploadProgress progress) {
  16181. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  16182. }
  16183. inline Result Client::Patch(const std::string &path,
  16184. ContentProviderWithoutLength content_provider,
  16185. const std::string &content_type,
  16186. ContentReceiver content_receiver,
  16187. UploadProgress progress) {
  16188. return cli_->Patch(path, std::move(content_provider), content_type,
  16189. std::move(content_receiver), progress);
  16190. }
  16191. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16192. size_t content_length,
  16193. ContentProvider content_provider,
  16194. const std::string &content_type,
  16195. UploadProgress progress) {
  16196. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16197. content_type, progress);
  16198. }
  16199. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16200. size_t content_length,
  16201. ContentProvider content_provider,
  16202. const std::string &content_type,
  16203. ContentReceiver content_receiver,
  16204. UploadProgress progress) {
  16205. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16206. content_type, std::move(content_receiver), progress);
  16207. }
  16208. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16209. ContentProviderWithoutLength content_provider,
  16210. const std::string &content_type,
  16211. UploadProgress progress) {
  16212. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16213. progress);
  16214. }
  16215. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16216. ContentProviderWithoutLength content_provider,
  16217. const std::string &content_type,
  16218. ContentReceiver content_receiver,
  16219. UploadProgress progress) {
  16220. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16221. std::move(content_receiver), progress);
  16222. }
  16223. inline Result Client::Patch(const std::string &path, const Params &params) {
  16224. return cli_->Patch(path, params);
  16225. }
  16226. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16227. const Params &params) {
  16228. return cli_->Patch(path, headers, params);
  16229. }
  16230. inline Result Client::Patch(const std::string &path,
  16231. const UploadFormDataItems &items,
  16232. UploadProgress progress) {
  16233. return cli_->Patch(path, items, progress);
  16234. }
  16235. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16236. const UploadFormDataItems &items,
  16237. UploadProgress progress) {
  16238. return cli_->Patch(path, headers, items, progress);
  16239. }
  16240. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16241. const UploadFormDataItems &items,
  16242. const std::string &boundary,
  16243. UploadProgress progress) {
  16244. return cli_->Patch(path, headers, items, boundary, progress);
  16245. }
  16246. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16247. const UploadFormDataItems &items,
  16248. const FormDataProviderItems &provider_items,
  16249. UploadProgress progress) {
  16250. return cli_->Patch(path, headers, items, provider_items, progress);
  16251. }
  16252. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16253. const std::string &body,
  16254. const std::string &content_type,
  16255. ContentReceiver content_receiver,
  16256. DownloadProgress progress) {
  16257. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16258. progress);
  16259. }
  16260. inline Result Client::Delete(const std::string &path,
  16261. DownloadProgress progress) {
  16262. return cli_->Delete(path, progress);
  16263. }
  16264. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16265. DownloadProgress progress) {
  16266. return cli_->Delete(path, headers, progress);
  16267. }
  16268. inline Result Client::Delete(const std::string &path, const char *body,
  16269. size_t content_length,
  16270. const std::string &content_type,
  16271. DownloadProgress progress) {
  16272. return cli_->Delete(path, body, content_length, content_type, progress);
  16273. }
  16274. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16275. const char *body, size_t content_length,
  16276. const std::string &content_type,
  16277. DownloadProgress progress) {
  16278. return cli_->Delete(path, headers, body, content_length, content_type,
  16279. progress);
  16280. }
  16281. inline Result Client::Delete(const std::string &path, const std::string &body,
  16282. const std::string &content_type,
  16283. DownloadProgress progress) {
  16284. return cli_->Delete(path, body, content_type, progress);
  16285. }
  16286. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16287. const std::string &body,
  16288. const std::string &content_type,
  16289. DownloadProgress progress) {
  16290. return cli_->Delete(path, headers, body, content_type, progress);
  16291. }
  16292. inline Result Client::Delete(const std::string &path, const Params &params,
  16293. DownloadProgress progress) {
  16294. return cli_->Delete(path, params, progress);
  16295. }
  16296. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16297. const Params &params, DownloadProgress progress) {
  16298. return cli_->Delete(path, headers, params, progress);
  16299. }
  16300. inline Result Client::Options(const std::string &path) {
  16301. return cli_->Options(path);
  16302. }
  16303. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16304. return cli_->Options(path, headers);
  16305. }
  16306. inline ClientImpl::StreamHandle
  16307. Client::open_stream(const std::string &method, const std::string &path,
  16308. const Params &params, const Headers &headers,
  16309. const std::string &body, const std::string &content_type) {
  16310. return cli_->open_stream(method, path, params, headers, body, content_type);
  16311. }
  16312. inline bool Client::send(Request &req, Response &res, Error &error) {
  16313. return cli_->send(req, res, error);
  16314. }
  16315. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16316. inline void Client::stop() { cli_->stop(); }
  16317. inline std::string Client::host() const { return cli_->host(); }
  16318. inline int Client::port() const { return cli_->port(); }
  16319. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16320. inline socket_t Client::socket() const { return cli_->socket(); }
  16321. inline void
  16322. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16323. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16324. }
  16325. inline void Client::set_direct_hostname_addr_map(
  16326. std::map<std::string, std::string> addr_map) {
  16327. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16328. }
  16329. inline void Client::set_tunnel_hostname_addr_map(
  16330. std::map<std::string, std::string> addr_map) {
  16331. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16332. }
  16333. inline void Client::set_default_headers(Headers headers) {
  16334. cli_->set_default_headers(std::move(headers));
  16335. }
  16336. inline void Client::set_header_writer(
  16337. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16338. cli_->set_header_writer(writer);
  16339. }
  16340. inline void Client::set_address_family(int family) {
  16341. cli_->set_address_family(family);
  16342. }
  16343. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16344. inline void Client::set_socket_options(SocketOptions socket_options) {
  16345. cli_->set_socket_options(std::move(socket_options));
  16346. }
  16347. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16348. cli_->set_connection_timeout(sec, usec);
  16349. }
  16350. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16351. cli_->set_read_timeout(sec, usec);
  16352. }
  16353. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16354. cli_->set_write_timeout(sec, usec);
  16355. }
  16356. inline void Client::set_basic_auth(const std::string &username,
  16357. const std::string &password) {
  16358. cli_->set_basic_auth(username, password);
  16359. }
  16360. inline void Client::set_bearer_token_auth(const std::string &token) {
  16361. cli_->set_bearer_token_auth(token);
  16362. }
  16363. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16364. inline void Client::set_follow_location(bool on) {
  16365. cli_->set_follow_location(on);
  16366. }
  16367. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16368. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16369. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16370. inline void Client::set_payload_max_length(size_t length) {
  16371. cli_->set_payload_max_length(length);
  16372. }
  16373. inline void Client::set_interface(const std::string &intf) {
  16374. cli_->set_interface(intf);
  16375. }
  16376. inline void Client::set_proxy(const std::string &host, int port) {
  16377. cli_->set_proxy(host, port);
  16378. }
  16379. inline void Client::set_proxy_basic_auth(const std::string &username,
  16380. const std::string &password) {
  16381. cli_->set_proxy_basic_auth(username, password);
  16382. }
  16383. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16384. cli_->set_proxy_bearer_token_auth(token);
  16385. }
  16386. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16387. cli_->set_no_proxy(patterns);
  16388. }
  16389. inline void Client::set_logger(Logger logger) {
  16390. cli_->set_logger(std::move(logger));
  16391. }
  16392. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16393. cli_->set_error_logger(std::move(error_logger));
  16394. }
  16395. /*
  16396. * Group 6: SSL Server and Client implementation
  16397. */
  16398. #ifdef CPPHTTPLIB_SSL_ENABLED
  16399. // SSL HTTP server implementation
  16400. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16401. const char *client_ca_cert_file_path,
  16402. const char *client_ca_cert_dir_path,
  16403. const char *private_key_password) {
  16404. using namespace tls;
  16405. ctx_ = create_server_context();
  16406. if (!ctx_) { return; }
  16407. // Load server certificate and private key
  16408. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16409. private_key_password)) {
  16410. last_ssl_error_ = static_cast<int>(get_error());
  16411. free_context(ctx_);
  16412. ctx_ = nullptr;
  16413. return;
  16414. }
  16415. // Load client CA certificates for client authentication
  16416. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16417. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16418. client_ca_cert_dir_path)) {
  16419. last_ssl_error_ = static_cast<int>(get_error());
  16420. free_context(ctx_);
  16421. ctx_ = nullptr;
  16422. return;
  16423. }
  16424. // Enable client certificate verification
  16425. set_verify_client(ctx_, true);
  16426. }
  16427. }
  16428. inline SSLServer::SSLServer(const PemMemory &pem) {
  16429. using namespace tls;
  16430. ctx_ = create_server_context();
  16431. if (ctx_) {
  16432. std::string cert_buf, key_buf;
  16433. if (!set_server_cert_pem(
  16434. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16435. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16436. pem.private_key_password)) {
  16437. last_ssl_error_ = static_cast<int>(get_error());
  16438. free_context(ctx_);
  16439. ctx_ = nullptr;
  16440. } else if (pem.client_ca_pem) {
  16441. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16442. : strlen(pem.client_ca_pem);
  16443. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16444. last_ssl_error_ = static_cast<int>(get_error());
  16445. free_context(ctx_);
  16446. ctx_ = nullptr;
  16447. } else {
  16448. set_verify_client(ctx_, true);
  16449. }
  16450. }
  16451. }
  16452. }
  16453. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16454. using namespace tls;
  16455. ctx_ = create_server_context();
  16456. if (ctx_) {
  16457. if (!setup_callback(ctx_)) {
  16458. free_context(ctx_);
  16459. ctx_ = nullptr;
  16460. }
  16461. }
  16462. }
  16463. inline SSLServer::~SSLServer() {
  16464. if (ctx_) { tls::free_context(ctx_); }
  16465. }
  16466. inline bool SSLServer::is_valid() const {
  16467. return ctx_ != nullptr && Server::is_valid();
  16468. }
  16469. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16470. using namespace tls;
  16471. session_t session = nullptr;
  16472. {
  16473. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16474. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16475. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16476. if (session) { handshakes_in_progress_++; }
  16477. }
  16478. if (!session) {
  16479. last_ssl_error_ = static_cast<int>(get_error());
  16480. detail::shutdown_socket(sock);
  16481. detail::close_socket(sock);
  16482. return false;
  16483. }
  16484. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16485. bool handshake_done = false;
  16486. bool ret = false;
  16487. bool websocket_upgraded = false;
  16488. auto cleanup = detail::scope_exit([&] {
  16489. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16490. free_session(session);
  16491. if (handshake_done) {
  16492. detail::drain_and_close_socket(sock);
  16493. } else {
  16494. detail::shutdown_socket(sock);
  16495. detail::close_socket(sock);
  16496. }
  16497. });
  16498. // Perform TLS accept handshake with timeout
  16499. TlsError tls_err;
  16500. auto accepted = false;
  16501. {
  16502. auto handshake_left = detail::scope_exit([&] {
  16503. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16504. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16505. });
  16506. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16507. read_timeout_usec_, &tls_err);
  16508. }
  16509. if (!accepted) {
  16510. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16511. // Map TlsError to legacy ssl_error for backward compatibility
  16512. if (tls_err.code == ErrorCode::WantRead) {
  16513. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16514. } else if (tls_err.code == ErrorCode::WantWrite) {
  16515. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16516. } else {
  16517. last_ssl_error_ = SSL_ERROR_SSL;
  16518. }
  16519. #else
  16520. last_ssl_error_ = static_cast<int>(get_error());
  16521. #endif
  16522. return false;
  16523. }
  16524. handshake_done = true;
  16525. std::string remote_addr;
  16526. int remote_port = 0;
  16527. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16528. std::string local_addr;
  16529. int local_port = 0;
  16530. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16531. ret = serve_guarded([&]() {
  16532. return detail::process_server_socket_ssl(
  16533. svr_sock_, session, sock, keep_alive_max_count_,
  16534. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16535. write_timeout_sec_, write_timeout_usec_,
  16536. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16537. return process_request(
  16538. strm, remote_addr, remote_port, local_addr, local_port,
  16539. close_connection, connection_closed,
  16540. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16541. });
  16542. });
  16543. return ret;
  16544. }
  16545. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16546. const char *key_pem,
  16547. const char *client_ca_pem,
  16548. const char *password) {
  16549. if (!ctx_) { return false; }
  16550. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16551. updates_pending_++;
  16552. auto se = detail::scope_exit([&] {
  16553. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16554. });
  16555. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16556. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16557. return false;
  16558. }
  16559. if (client_ca_pem) {
  16560. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16561. // As in the constructors, a client CA makes client certificates required
  16562. tls::set_verify_client(ctx_, true);
  16563. }
  16564. return true;
  16565. }
  16566. // SSL HTTP client implementation
  16567. inline SSLClient::~SSLClient() {
  16568. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16569. // base function rather than the derived function once we get to the
  16570. // base class destructor, and won't free the SSL (causing a leak).
  16571. // This must happen before the context is freed below: some backends
  16572. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16573. // context, so freeing the context first leaves close_notify reading
  16574. // freed memory.
  16575. shutdown_ssl_impl(socket_, true);
  16576. if (ctx_) {
  16577. tls::free_context(ctx_);
  16578. ctx_ = nullptr;
  16579. }
  16580. }
  16581. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16582. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16583. shutdown_ssl_impl(socket, shutdown_gracefully);
  16584. }
  16585. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16586. bool shutdown_gracefully) {
  16587. if (socket.sock == INVALID_SOCKET) {
  16588. assert(socket.ssl == nullptr);
  16589. return;
  16590. }
  16591. if (socket.ssl) {
  16592. tls::shutdown(socket.ssl, shutdown_gracefully);
  16593. {
  16594. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16595. tls::free_session(socket.ssl);
  16596. }
  16597. socket.ssl = nullptr;
  16598. }
  16599. assert(socket.ssl == nullptr);
  16600. }
  16601. inline bool SSLClient::process_socket(
  16602. const Socket &socket,
  16603. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16604. std::function<bool(Stream &strm)> callback) {
  16605. assert(socket.ssl);
  16606. return detail::process_client_socket_ssl(
  16607. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16608. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16609. [&](detail::SSLSocketStream &strm) {
  16610. auto ret = callback(strm);
  16611. // A request that failed after the handshake reports Error::Read or
  16612. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16613. // from the server, for Result::ssl_error() and ssl_backend_error()
  16614. const auto &tls_error = strm.tls_error();
  16615. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16616. last_ssl_error_ = static_cast<int>(tls_error.code);
  16617. last_backend_error_ = tls_error.backend_code;
  16618. }
  16619. return ret;
  16620. });
  16621. }
  16622. inline bool SSLClient::is_ssl() const { return true; }
  16623. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16624. if (!is_valid()) {
  16625. error = Error::SSLConnection;
  16626. return false;
  16627. }
  16628. return ClientImpl::create_and_connect_socket(socket, error);
  16629. }
  16630. inline bool SSLClient::setup_proxy_connection(
  16631. Socket &socket,
  16632. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16633. Response &res, bool &success, Error &error) {
  16634. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16635. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16636. return false;
  16637. }
  16638. if (!initialize_ssl(socket, error)) {
  16639. shutdown_socket(socket);
  16640. close_socket(socket);
  16641. success = false;
  16642. return false;
  16643. }
  16644. return true;
  16645. }
  16646. // Assumes that socket is a connection being opened, which no other thread uses
  16647. inline bool SSLClient::connect_with_proxy(
  16648. Socket &socket,
  16649. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16650. Response &res, bool &success, Error &error) {
  16651. success = true;
  16652. auto connect_target =
  16653. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  16654. auto retargeted = connect_target !=
  16655. detail::make_host_and_port_string_always_port(host_, port_);
  16656. Response proxy_res;
  16657. if (!detail::process_client_socket(
  16658. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16659. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16660. start_time, [&](Stream &strm) {
  16661. strm.set_read_interrupt(stop_interrupt());
  16662. Request req2;
  16663. req2.method = "CONNECT";
  16664. req2.path = connect_target;
  16665. if (retargeted) { req2.set_header("Host", connect_target); }
  16666. if (max_timeout_msec_ > 0) {
  16667. req2.start_time_ = std::chrono::steady_clock::now();
  16668. }
  16669. return process_request(strm, req2, proxy_res, false, error);
  16670. })) {
  16671. // Thread-safe to close everything because we are assuming there are no
  16672. // requests in flight
  16673. shutdown_ssl(socket, true);
  16674. shutdown_socket(socket);
  16675. close_socket(socket);
  16676. success = false;
  16677. return false;
  16678. }
  16679. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16680. if (!proxy_digest_auth_username_.empty() &&
  16681. !proxy_digest_auth_password_.empty()) {
  16682. std::map<std::string, std::string> auth;
  16683. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16684. // Close the current socket and create a new one for the authenticated
  16685. // request
  16686. shutdown_ssl(socket, true);
  16687. shutdown_socket(socket);
  16688. close_socket(socket);
  16689. // Create a new socket for the authenticated CONNECT request
  16690. if (!ensure_socket_connection(socket, error)) {
  16691. success = false;
  16692. return false;
  16693. }
  16694. proxy_res = Response();
  16695. if (!detail::process_client_socket(
  16696. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16697. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16698. start_time, [&](Stream &strm) {
  16699. strm.set_read_interrupt(stop_interrupt());
  16700. Request req3;
  16701. req3.method = "CONNECT";
  16702. req3.path = connect_target;
  16703. if (retargeted) { req3.set_header("Host", connect_target); }
  16704. req3.headers.insert(detail::make_digest_authentication_header(
  16705. req3, make_request_target(req3), auth, 1,
  16706. detail::random_string(10), proxy_digest_auth_username_,
  16707. proxy_digest_auth_password_, true));
  16708. if (max_timeout_msec_ > 0) {
  16709. req3.start_time_ = std::chrono::steady_clock::now();
  16710. }
  16711. return process_request(strm, req3, proxy_res, false, error);
  16712. })) {
  16713. // Thread-safe to close everything because we are assuming there are
  16714. // no requests in flight
  16715. shutdown_ssl(socket, true);
  16716. shutdown_socket(socket);
  16717. close_socket(socket);
  16718. success = false;
  16719. return false;
  16720. }
  16721. }
  16722. }
  16723. }
  16724. // If status code is not 200, proxy request is failed.
  16725. // Set error to ProxyConnection. A 407 is returned as the response of the
  16726. // request, so the caller sees the proxy asks for credentials; any other
  16727. // status would read as the answer of the origin, which it never reached.
  16728. if (proxy_res.status != StatusCode::OK_200) {
  16729. error = Error::ProxyConnection;
  16730. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16731. res = std::move(proxy_res);
  16732. } else {
  16733. success = false;
  16734. }
  16735. // Thread-safe to close everything because we are assuming there are
  16736. // no requests in flight
  16737. shutdown_ssl(socket, true);
  16738. shutdown_socket(socket);
  16739. close_socket(socket);
  16740. return false;
  16741. }
  16742. return true;
  16743. }
  16744. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16745. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16746. if (is_proxy_enabled_for_host(host_)) { return true; }
  16747. if (!initialize_ssl(socket, error)) {
  16748. shutdown_socket(socket);
  16749. close_socket(socket);
  16750. return false;
  16751. }
  16752. return true;
  16753. }
  16754. // SSL HTTP client implementation
  16755. inline SSLClient::SSLClient(const std::string &host)
  16756. : SSLClient(host, 443, std::string(), std::string()) {}
  16757. inline SSLClient::SSLClient(const std::string &host, int port)
  16758. : SSLClient(host, port, std::string(), std::string()) {}
  16759. inline void SSLClient::init_ctx() {
  16760. ctx_ = tls::create_client_context();
  16761. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16762. }
  16763. inline void SSLClient::reset_ctx_on_error() {
  16764. last_backend_error_ = tls::get_error();
  16765. tls::free_context(ctx_);
  16766. ctx_ = nullptr;
  16767. }
  16768. inline SSLClient::SSLClient(const std::string &host, int port,
  16769. const std::string &client_cert_path,
  16770. const std::string &client_key_path,
  16771. const std::string &private_key_password)
  16772. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16773. init_ctx();
  16774. if (!ctx_) { return; }
  16775. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16776. const char *password =
  16777. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16778. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16779. client_key_path.c_str(), password)) {
  16780. reset_ctx_on_error();
  16781. }
  16782. }
  16783. }
  16784. inline SSLClient::SSLClient(const std::string &host, int port,
  16785. const PemMemory &pem)
  16786. : ClientImpl(host, port) {
  16787. init_ctx();
  16788. if (!ctx_) { return; }
  16789. if (pem.cert_pem && pem.key_pem) {
  16790. std::string cert_buf, key_buf;
  16791. if (!tls::set_client_cert_pem(
  16792. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16793. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16794. pem.private_key_password)) {
  16795. reset_ctx_on_error();
  16796. }
  16797. }
  16798. }
  16799. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16800. if (ca_cert_store && ctx_) {
  16801. // set_ca_store takes ownership of ca_cert_store
  16802. tls::set_ca_store(ctx_, ca_cert_store);
  16803. ca_cert_store_set_ = true;
  16804. } else if (ca_cert_store) {
  16805. tls::free_ca_store(ca_cert_store);
  16806. }
  16807. custom_ca_loaded_ = true;
  16808. tls_settings_changed();
  16809. }
  16810. inline void
  16811. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16812. if (!ctx_) { return; }
  16813. server_certificate_verifier_ = verifier;
  16814. {
  16815. // Under the lock that creating a session from ctx_ takes
  16816. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16817. tls::set_verify_callback(ctx_, std::move(verifier));
  16818. }
  16819. tls_settings_changed();
  16820. }
  16821. inline void SSLClient::set_session_verifier(
  16822. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16823. session_verifier_ = std::move(verifier);
  16824. tls_settings_changed();
  16825. }
  16826. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16827. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16828. if (enable_windows_cert_verification_ == enabled) { return; }
  16829. enable_windows_cert_verification_ = enabled;
  16830. tls_settings_changed();
  16831. }
  16832. #endif
  16833. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16834. std::size_t size) {
  16835. if (ctx_ && ca_cert && size > 0) {
  16836. // Every PEM loaded, for redirect transfer
  16837. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16838. ca_cert_pem_ += '\n';
  16839. }
  16840. ca_cert_pem_.append(ca_cert, size);
  16841. tls::load_ca_pem(ctx_, ca_cert, size);
  16842. }
  16843. custom_ca_loaded_ = true;
  16844. tls_settings_changed();
  16845. }
  16846. inline bool SSLClient::load_certs() {
  16847. auto ret = true;
  16848. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16849. // one client is shared across concurrent requests here.
  16850. std::call_once(initialize_cert_, [&]() {
  16851. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16852. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16853. ca_cert_dir_path_, custom_ca_loaded_,
  16854. system_ca_mode_, last_backend_error_);
  16855. });
  16856. return ret;
  16857. }
  16858. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16859. // Load CA certificates if server verification is enabled
  16860. if (server_certificate_verification_) {
  16861. if (!load_certs()) {
  16862. error = Error::SSLLoadingCerts;
  16863. return false;
  16864. }
  16865. }
  16866. detail::ClientTlsSessionOptions options;
  16867. options.server_hostname_verification = server_hostname_verification_;
  16868. options.session_verifier = session_verifier_;
  16869. options.interrupted = stop_interrupt();
  16870. options.ctx_mutex = &ctx_mutex_;
  16871. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16872. // Skip Schannel when a custom CA cert is specified, as the Windows
  16873. // certificate store would not know about user-provided CA certificates.
  16874. // Also skip when system CA trust is explicitly disabled.
  16875. options.windows_cert_verification =
  16876. enable_windows_cert_verification_ &&
  16877. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16878. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16879. // Only a verifier set through set_server_certificate_verifier() is seen
  16880. // here, not one installed with tls::set_verify_callback() directly.
  16881. options.server_certificate_verifier_set =
  16882. static_cast<bool>(server_certificate_verifier_);
  16883. #endif
  16884. tls::session_t session = nullptr;
  16885. // Use scope_exit to ensure session is freed on error paths
  16886. bool success = false;
  16887. auto session_guard = detail::scope_exit([&] {
  16888. if (!success) { tls::free_session(session); }
  16889. });
  16890. detail::ClientTlsSessionError tls_error;
  16891. if (!detail::setup_client_tls_session(
  16892. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16893. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16894. options)) {
  16895. error = tls_error.error;
  16896. last_ssl_error_ = tls_error.ssl_error;
  16897. last_backend_error_ = tls_error.backend_error;
  16898. return false;
  16899. }
  16900. success = true;
  16901. socket.ssl = session;
  16902. return true;
  16903. }
  16904. inline void Client::set_digest_auth(const std::string &username,
  16905. const std::string &password) {
  16906. cli_->set_digest_auth(username, password);
  16907. }
  16908. inline void Client::set_proxy_digest_auth(const std::string &username,
  16909. const std::string &password) {
  16910. cli_->set_proxy_digest_auth(username, password);
  16911. }
  16912. inline void Client::enable_server_certificate_verification(bool enabled) {
  16913. cli_->enable_server_certificate_verification(enabled);
  16914. }
  16915. inline void Client::enable_server_hostname_verification(bool enabled) {
  16916. cli_->enable_server_hostname_verification(enabled);
  16917. }
  16918. inline void Client::enable_system_ca(bool enabled) {
  16919. cli_->enable_system_ca(enabled);
  16920. }
  16921. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16922. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16923. if (is_ssl_) {
  16924. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16925. enabled);
  16926. }
  16927. }
  16928. #endif
  16929. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16930. const std::string &ca_cert_dir_path) {
  16931. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16932. }
  16933. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16934. if (is_ssl_) {
  16935. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16936. } else if (ca_cert_store) {
  16937. tls::free_ca_store(ca_cert_store);
  16938. }
  16939. }
  16940. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16941. if (is_ssl_) {
  16942. // Use the PEM-based path so the CA data is retained for redirect transfer
  16943. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16944. }
  16945. }
  16946. inline void
  16947. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16948. if (is_ssl_) {
  16949. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16950. std::move(verifier));
  16951. }
  16952. }
  16953. inline void Client::set_session_verifier(
  16954. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16955. if (is_ssl_) {
  16956. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16957. }
  16958. }
  16959. inline tls::ctx_t Client::tls_context() const {
  16960. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16961. return nullptr;
  16962. }
  16963. #endif // CPPHTTPLIB_SSL_ENABLED
  16964. /*
  16965. * Group 7: TLS abstraction layer - Common API
  16966. */
  16967. #ifdef CPPHTTPLIB_SSL_ENABLED
  16968. namespace tls {
  16969. // Helper for PeerCert construction
  16970. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16971. return PeerCert(get_peer_cert(session));
  16972. }
  16973. namespace impl {
  16974. // set_verify_callback() can replace a callback while handshakes on other
  16975. // threads run it, so they share it, and take their reference under this lock.
  16976. inline std::mutex &verify_callback_mutex() {
  16977. static std::mutex mutex;
  16978. return mutex;
  16979. }
  16980. // The TLS libraries are C, so an exception from a verify callback must not
  16981. // unwind through them. It rejects the certificate instead.
  16982. inline bool run_verify_callback(const VerifyCallback &callback,
  16983. const VerifyContext &ctx) {
  16984. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16985. return callback(ctx);
  16986. #else
  16987. try {
  16988. return callback(ctx);
  16989. } catch (...) { return false; }
  16990. #endif
  16991. }
  16992. // Check if a string is an IPv4 address
  16993. inline bool is_ipv4_address(const std::string &str) {
  16994. int dots = 0;
  16995. for (char c : str) {
  16996. if (c == '.') {
  16997. dots++;
  16998. } else if (!detail::is_ascii_digit(c)) {
  16999. return false;
  17000. }
  17001. }
  17002. return dots == 3;
  17003. }
  17004. // Parse IPv4 address string to bytes
  17005. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  17006. const char *p = str.c_str();
  17007. for (int i = 0; i < 4; i++) {
  17008. if (i > 0) {
  17009. if (*p != '.') { return false; }
  17010. p++;
  17011. }
  17012. int val = 0;
  17013. int digits = 0;
  17014. while (detail::is_ascii_digit(*p)) {
  17015. val = val * 10 + (*p - '0');
  17016. if (val > 255) { return false; }
  17017. p++;
  17018. digits++;
  17019. }
  17020. if (digits == 0) { return false; }
  17021. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  17022. if (digits > 1 && *(p - digits) == '0') { return false; }
  17023. out[i] = static_cast<unsigned char>(val);
  17024. }
  17025. return *p == '\0';
  17026. }
  17027. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  17028. // `out` must have room for at least 16 bytes. Returns the address length
  17029. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  17030. // literal. Used to match a host against iPAddress SANs the same way the
  17031. // OpenSSL backend does via X509_check_ip.
  17032. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  17033. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  17034. struct in6_addr addr6 = {};
  17035. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  17036. memcpy(out, &addr6, 16);
  17037. return 16;
  17038. }
  17039. return 0;
  17040. }
  17041. #ifdef _WIN32
  17042. // Enumerate Windows system certificates and call callback with DER data
  17043. template <typename Callback>
  17044. inline bool enumerate_windows_system_certs(Callback cb) {
  17045. bool loaded = false;
  17046. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17047. for (auto store_name : store_names) {
  17048. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  17049. if (hStore) {
  17050. PCCERT_CONTEXT pContext = nullptr;
  17051. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17052. nullptr) {
  17053. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  17054. loaded = true;
  17055. }
  17056. }
  17057. CertCloseStore(hStore, 0);
  17058. }
  17059. }
  17060. return loaded;
  17061. }
  17062. #endif
  17063. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17064. // The trust a certificate's Trust Settings give it for SSL server
  17065. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  17066. // Otherwise the first usage-constraints dictionary that applies decides: one
  17067. // naming a policy other than SSL, a host name or an application does not
  17068. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  17069. // Trust" as kSecTrustSettingsResultDeny.
  17070. inline SecTrustSettingsResult
  17071. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  17072. auto count = CFArrayGetCount(trust_settings);
  17073. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  17074. for (CFIndex i = 0; i < count; i++) {
  17075. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  17076. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  17077. auto constraint = static_cast<CFDictionaryRef>(value);
  17078. auto policy_value =
  17079. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  17080. if (policy_value) {
  17081. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  17082. auto is_ssl = false;
  17083. if (auto properties = SecPolicyCopyProperties(policy)) {
  17084. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  17085. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  17086. CFRelease(properties);
  17087. }
  17088. if (!is_ssl) { continue; }
  17089. }
  17090. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  17091. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  17092. continue;
  17093. }
  17094. auto result = kSecTrustSettingsResultTrustRoot;
  17095. auto number = static_cast<CFNumberRef>(
  17096. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  17097. if (number) {
  17098. SInt32 number_value = 0;
  17099. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  17100. continue;
  17101. }
  17102. result = static_cast<SecTrustSettingsResult>(number_value);
  17103. }
  17104. if (result == kSecTrustSettingsResultTrustRoot ||
  17105. result == kSecTrustSettingsResultTrustAsRoot ||
  17106. result == kSecTrustSettingsResultDeny) {
  17107. return result;
  17108. }
  17109. }
  17110. return kSecTrustSettingsResultUnspecified;
  17111. }
  17112. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  17113. // with DER data. A certificate with Trust Settings is not trusted just by
  17114. // having them: the settings say whether it is, and a per-user setting
  17115. // overrides the admin domain's, which overrides the system domain's (whose
  17116. // roots are all trusted). So a system root the user set to "Never Trust" is
  17117. // left out, as is one trusted only for S/MIME or code signing.
  17118. template <typename Callback>
  17119. inline bool enumerate_macos_keychain_certs(Callback cb) {
  17120. const SecTrustSettingsDomain domains[] = {
  17121. kSecTrustSettingsDomainUser,
  17122. kSecTrustSettingsDomainAdmin,
  17123. kSecTrustSettingsDomainSystem,
  17124. };
  17125. std::set<std::string> decided;
  17126. std::vector<std::string> trusted;
  17127. for (auto domain : domains) {
  17128. CFArrayRef certs = nullptr;
  17129. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  17130. if (status != errSecSuccess || !certs) {
  17131. if (certs) CFRelease(certs);
  17132. continue;
  17133. }
  17134. CFIndex count = CFArrayGetCount(certs);
  17135. for (CFIndex i = 0; i < count; i++) {
  17136. SecCertificateRef cert =
  17137. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  17138. CFDataRef data = SecCertificateCopyData(cert);
  17139. if (!data) { continue; }
  17140. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  17141. static_cast<size_t>(CFDataGetLength(data)));
  17142. CFRelease(data);
  17143. // Decided by a domain that overrides this one
  17144. if (decided.find(der) != decided.end()) { continue; }
  17145. auto result = kSecTrustSettingsResultTrustRoot;
  17146. if (domain != kSecTrustSettingsDomainSystem) {
  17147. result = kSecTrustSettingsResultUnspecified;
  17148. CFArrayRef trust_settings = nullptr;
  17149. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  17150. errSecSuccess &&
  17151. trust_settings) {
  17152. result = macos_ssl_trust_settings_result(trust_settings);
  17153. }
  17154. if (trust_settings) CFRelease(trust_settings);
  17155. }
  17156. // Neither trusted nor distrusted here; a domain below may decide
  17157. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  17158. decided.insert(der);
  17159. if (result == kSecTrustSettingsResultTrustRoot ||
  17160. result == kSecTrustSettingsResultTrustAsRoot) {
  17161. trusted.push_back(std::move(der));
  17162. }
  17163. }
  17164. CFRelease(certs);
  17165. }
  17166. bool loaded = false;
  17167. for (const auto &der : trusted) {
  17168. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  17169. loaded = true;
  17170. }
  17171. }
  17172. return loaded;
  17173. }
  17174. #endif
  17175. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  17176. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  17177. // Common CA certificate file paths on Linux/Unix
  17178. inline const char **system_ca_paths() {
  17179. static const char *paths[] = {
  17180. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  17181. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  17182. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  17183. "/etc/pki/tls/cacert.pem", // OpenELEC
  17184. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  17185. nullptr};
  17186. return paths;
  17187. }
  17188. // Common CA certificate directory paths on Linux/Unix
  17189. inline const char **system_ca_dirs() {
  17190. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  17191. "/etc/pki/tls/certs", // RHEL/CentOS
  17192. "/usr/share/ca-certificates", // Other
  17193. nullptr};
  17194. return dirs;
  17195. }
  17196. #endif
  17197. } // namespace impl
  17198. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  17199. const char *ca_dir) {
  17200. if (!ctx) { return false; }
  17201. bool success = true;
  17202. if (ca_file && *ca_file) {
  17203. if (!load_ca_file(ctx, ca_file)) { success = false; }
  17204. }
  17205. if (ca_dir && *ca_dir) {
  17206. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  17207. }
  17208. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17209. // Set CA list for client certificate request (CertificateRequest message)
  17210. if (ca_file && *ca_file) {
  17211. auto list = SSL_load_client_CA_file(ca_file);
  17212. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  17213. }
  17214. #endif
  17215. return success;
  17216. }
  17217. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17218. const char *password) {
  17219. return set_client_cert_pem(ctx, cert, key, password);
  17220. }
  17221. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17222. const char *key_path, const char *password) {
  17223. return set_client_cert_file(ctx, cert_path, key_path, password);
  17224. }
  17225. // PeerCert implementation
  17226. inline PeerCert::PeerCert() = default;
  17227. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17228. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17229. other.cert_ = nullptr;
  17230. }
  17231. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17232. if (this != &other) {
  17233. if (cert_) { free_cert(cert_); }
  17234. cert_ = other.cert_;
  17235. other.cert_ = nullptr;
  17236. }
  17237. return *this;
  17238. }
  17239. inline PeerCert::~PeerCert() {
  17240. if (cert_) { free_cert(cert_); }
  17241. }
  17242. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17243. inline std::string PeerCert::subject_cn() const {
  17244. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17245. }
  17246. inline std::string PeerCert::issuer_name() const {
  17247. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17248. }
  17249. inline bool PeerCert::check_hostname(const char *hostname) const {
  17250. return cert_ ? verify_hostname(cert_, hostname) : false;
  17251. }
  17252. inline std::vector<SanEntry> PeerCert::sans() const {
  17253. std::vector<SanEntry> result;
  17254. if (cert_) { get_cert_sans(cert_, result); }
  17255. return result;
  17256. }
  17257. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17258. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17259. }
  17260. inline std::string PeerCert::serial() const {
  17261. return cert_ ? get_cert_serial(cert_) : std::string();
  17262. }
  17263. // VerifyContext method implementations
  17264. inline std::string VerifyContext::subject_cn() const {
  17265. return cert ? get_cert_subject_cn(cert) : std::string();
  17266. }
  17267. inline std::string VerifyContext::issuer_name() const {
  17268. return cert ? get_cert_issuer_name(cert) : std::string();
  17269. }
  17270. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17271. return cert ? verify_hostname(cert, hostname) : false;
  17272. }
  17273. inline std::vector<SanEntry> VerifyContext::sans() const {
  17274. std::vector<SanEntry> result;
  17275. if (cert) { get_cert_sans(cert, result); }
  17276. return result;
  17277. }
  17278. inline bool VerifyContext::validity(time_t &not_before,
  17279. time_t &not_after) const {
  17280. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17281. }
  17282. inline std::string VerifyContext::serial() const {
  17283. return cert ? get_cert_serial(cert) : std::string();
  17284. }
  17285. // TlsError static method implementation
  17286. inline std::string TlsError::verify_error_to_string(long error_code) {
  17287. return verify_error_string(error_code);
  17288. }
  17289. } // namespace tls
  17290. // Request::peer_cert() implementation
  17291. inline tls::PeerCert Request::peer_cert() const {
  17292. return tls::get_peer_cert_from_session(ssl);
  17293. }
  17294. // Request::sni() implementation
  17295. inline std::string Request::sni() const {
  17296. if (!ssl) { return std::string(); }
  17297. const char *s = tls::get_sni(ssl);
  17298. return s ? std::string(s) : std::string();
  17299. }
  17300. #endif // CPPHTTPLIB_SSL_ENABLED
  17301. /*
  17302. * Group 8: TLS abstraction layer - OpenSSL backend
  17303. */
  17304. /*
  17305. * OpenSSL Backend Implementation
  17306. */
  17307. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17308. namespace tls {
  17309. namespace impl {
  17310. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17311. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17312. switch (ssl_error) {
  17313. case SSL_ERROR_NONE: return ErrorCode::Success;
  17314. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17315. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17316. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17317. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17318. case SSL_ERROR_SSL:
  17319. default: return ErrorCode::Fatal;
  17320. }
  17321. }
  17322. // Fills in a failed SSL_connect(). One that the server certificate's
  17323. // verification stopped reports the verify result, as the other backends and
  17324. // a check after the handshake do.
  17325. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17326. auto ssl_err = SSL_get_error(ssl, ret);
  17327. auto error = ERR_get_error();
  17328. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17329. err.backend_code = error;
  17330. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17331. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17332. return;
  17333. }
  17334. // A certificate only a verify callback turned down carries no verdict of
  17335. // its own, and fails as any other handshake does
  17336. auto verify_result = SSL_get_verify_result(ssl);
  17337. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17338. return;
  17339. }
  17340. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17341. ? ErrorCode::HostnameMismatch
  17342. : ErrorCode::CertVerifyFailed;
  17343. err.backend_code = static_cast<uint64_t>(verify_result);
  17344. }
  17345. // Helper: Create client CA list from PEM string
  17346. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17347. // Caller takes ownership of returned list
  17348. inline STACK_OF(X509_NAME) *
  17349. create_client_ca_list_from_pem(const char *ca_pem) {
  17350. if (!ca_pem) { return nullptr; }
  17351. auto ca_list = sk_X509_NAME_new_null();
  17352. if (!ca_list) { return nullptr; }
  17353. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17354. if (!bio) {
  17355. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17356. return nullptr;
  17357. }
  17358. X509 *cert = nullptr;
  17359. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17360. nullptr) {
  17361. const X509_NAME *name = X509_get_subject_name(cert);
  17362. if (name) {
  17363. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17364. }
  17365. X509_free(cert);
  17366. }
  17367. BIO_free(bio);
  17368. return ca_list;
  17369. }
  17370. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17371. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17372. long /*argl*/, void * /*argp*/) {
  17373. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17374. }
  17375. // The SSL_CTX owns its verify callback, so each client or server sees only
  17376. // its own, on whichever thread runs the handshake.
  17377. inline int verify_callback_index() {
  17378. static const auto index = SSL_CTX_get_ex_new_index(
  17379. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17380. return index;
  17381. }
  17382. // OpenSSL verify callback wrapper
  17383. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17384. // Get SSL object from X509_STORE_CTX
  17385. auto ssl = static_cast<SSL *>(
  17386. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17387. if (!ssl) { return preverify_ok; }
  17388. std::shared_ptr<VerifyCallback> callback;
  17389. {
  17390. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17391. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17392. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17393. if (stored) { callback = *stored; }
  17394. }
  17395. if (!callback) { return preverify_ok; }
  17396. // Get current certificate and depth
  17397. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17398. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17399. int error = X509_STORE_CTX_get_error(ctx);
  17400. // Build context
  17401. VerifyContext verify_ctx;
  17402. verify_ctx.session = static_cast<session_t>(ssl);
  17403. verify_ctx.cert = static_cast<cert_t>(cert);
  17404. verify_ctx.depth = depth;
  17405. verify_ctx.preverify_ok = (preverify_ok != 0);
  17406. verify_ctx.error_code = error;
  17407. verify_ctx.error_string =
  17408. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17409. auto accepted = run_verify_callback(*callback, verify_ctx);
  17410. // A client verifying the server during the handshake, which is what
  17411. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17412. if (!SSL_is_server(ssl) &&
  17413. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17414. accepted = accepted && preverify_ok;
  17415. }
  17416. return accepted ? 1 : 0;
  17417. }
  17418. // Sets the verify mode from whether the peer's certificate is required and
  17419. // whether a verify callback is set.
  17420. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17421. auto has_callback =
  17422. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17423. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17424. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17425. SSL_CTX_set_verify(ssl_ctx, mode,
  17426. has_callback ? openssl_verify_callback : nullptr);
  17427. }
  17428. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17429. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17430. // that must be released with release_store_objects
  17431. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17432. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17433. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17434. #endif
  17435. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17436. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17437. return X509_STORE_get1_objects(store);
  17438. #else
  17439. return X509_STORE_get0_objects(store);
  17440. #endif
  17441. }
  17442. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17443. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17444. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17445. #else
  17446. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17447. #endif
  17448. }
  17449. } // namespace impl
  17450. inline ctx_t create_client_context() {
  17451. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17452. if (ctx) {
  17453. // Disable auto-retry to properly handle non-blocking I/O
  17454. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17455. // Set minimum TLS version
  17456. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17457. }
  17458. return static_cast<ctx_t>(ctx);
  17459. }
  17460. inline void free_context(ctx_t ctx) {
  17461. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17462. }
  17463. inline bool set_min_version(ctx_t ctx, Version version) {
  17464. if (!ctx) return false;
  17465. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17466. static_cast<uint16_t>(version)) == 1;
  17467. }
  17468. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17469. if (!ctx || !pem || len == 0) return false;
  17470. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17471. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17472. if (!store) return false;
  17473. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17474. if (!bio) return false;
  17475. bool ok = true;
  17476. X509 *cert = nullptr;
  17477. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17478. nullptr) {
  17479. if (X509_STORE_add_cert(store, cert) != 1) {
  17480. // Ignore duplicate errors
  17481. auto err = ERR_peek_last_error();
  17482. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17483. ok = false;
  17484. }
  17485. }
  17486. X509_free(cert);
  17487. if (!ok) break;
  17488. }
  17489. BIO_free(bio);
  17490. // Clear any "no more certificates" errors
  17491. ERR_clear_error();
  17492. return ok;
  17493. }
  17494. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17495. if (!ctx || !file_path) return false;
  17496. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17497. nullptr) == 1;
  17498. }
  17499. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17500. if (!ctx || !dir_path) return false;
  17501. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17502. dir_path) == 1;
  17503. }
  17504. inline bool load_system_certs(ctx_t ctx) {
  17505. if (!ctx) return false;
  17506. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17507. #ifdef _WIN32
  17508. // Windows: Load from system certificate store (ROOT and CA)
  17509. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17510. if (!store) return false;
  17511. bool loaded_any = false;
  17512. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17513. for (auto store_name : store_names) {
  17514. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17515. if (!hStore) continue;
  17516. PCCERT_CONTEXT pContext = nullptr;
  17517. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17518. nullptr) {
  17519. const unsigned char *data = pContext->pbCertEncoded;
  17520. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17521. if (x509) {
  17522. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17523. X509_free(x509);
  17524. }
  17525. }
  17526. CertCloseStore(hStore, 0);
  17527. }
  17528. return loaded_any;
  17529. #elif defined(__APPLE__)
  17530. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17531. // macOS: Load from Keychain
  17532. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17533. if (!store) return false;
  17534. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17535. [&](const unsigned char *data, size_t len) {
  17536. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17537. if (!x509) { return false; }
  17538. auto added = X509_STORE_add_cert(store, x509) == 1;
  17539. X509_free(x509);
  17540. return added;
  17541. });
  17542. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17543. #else
  17544. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17545. #endif
  17546. #else
  17547. // Other Unix: use default verify paths
  17548. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17549. #endif
  17550. }
  17551. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17552. const char *password) {
  17553. if (!ctx || !cert || !key) return false;
  17554. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17555. // Load certificate
  17556. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17557. if (!cert_bio) return false;
  17558. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17559. BIO_free(cert_bio);
  17560. if (!x509) return false;
  17561. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17562. X509_free(x509);
  17563. if (!cert_ok) return false;
  17564. // Load private key
  17565. auto key_bio = BIO_new_mem_buf(key, -1);
  17566. if (!key_bio) return false;
  17567. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17568. password ? const_cast<char *>(password)
  17569. : nullptr);
  17570. BIO_free(key_bio);
  17571. if (!pkey) return false;
  17572. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17573. EVP_PKEY_free(pkey);
  17574. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17575. }
  17576. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17577. const char *key_path, const char *password) {
  17578. if (!ctx || !cert_path || !key_path) return false;
  17579. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17580. if (password && password[0] != '\0') {
  17581. SSL_CTX_set_default_passwd_cb_userdata(
  17582. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17583. }
  17584. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17585. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17586. }
  17587. inline ctx_t create_server_context() {
  17588. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17589. if (ctx) {
  17590. // No renegotiation, as on the other backends: it would run a handshake
  17591. // that SSLServer::update_certs_pem() does not wait for
  17592. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17593. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17594. SSL_OP_NO_RENEGOTIATION);
  17595. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17596. // Without one, a client resuming its session is sent a fatal alert once
  17597. // client certificates are verified.
  17598. static const unsigned char sid_ctx[] = "cpp-httplib";
  17599. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17600. }
  17601. return static_cast<ctx_t>(ctx);
  17602. }
  17603. inline void set_verify_client(ctx_t ctx, bool require) {
  17604. if (!ctx) return;
  17605. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17606. }
  17607. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17608. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17609. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17610. SSL *ssl = SSL_new(ssl_ctx);
  17611. if (!ssl) return nullptr;
  17612. // Disable auto-retry for proper non-blocking I/O handling
  17613. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17614. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17615. if (!bio) {
  17616. SSL_free(ssl);
  17617. return nullptr;
  17618. }
  17619. SSL_set_bio(ssl, bio, bio);
  17620. return static_cast<session_t>(ssl);
  17621. }
  17622. inline void free_session(session_t session) {
  17623. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17624. }
  17625. inline bool set_sni(session_t session, const char *hostname,
  17626. bool verify_hostname) {
  17627. if (!session || !hostname) return false;
  17628. auto ssl = static_cast<SSL *>(session);
  17629. // The handshake's chain verification then checks the name as well
  17630. if (verify_hostname) {
  17631. auto param = SSL_get0_param(ssl);
  17632. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  17633. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  17634. return false;
  17635. }
  17636. }
  17637. #if defined(OPENSSL_IS_BORINGSSL)
  17638. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17639. #else
  17640. // Direct call instead of macro to suppress -Wold-style-cast warning
  17641. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17642. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17643. #endif
  17644. }
  17645. inline TlsError connect(session_t session) {
  17646. if (!session) { return TlsError(); }
  17647. auto ssl = static_cast<SSL *>(session);
  17648. auto ret = SSL_connect(ssl);
  17649. TlsError err;
  17650. if (ret == 1) {
  17651. err.code = ErrorCode::Success;
  17652. } else {
  17653. impl::fill_connect_error(ssl, ret, err);
  17654. }
  17655. return err;
  17656. }
  17657. inline TlsError accept(session_t session) {
  17658. if (!session) { return TlsError(); }
  17659. auto ssl = static_cast<SSL *>(session);
  17660. auto ret = SSL_accept(ssl);
  17661. TlsError err;
  17662. if (ret == 1) {
  17663. err.code = ErrorCode::Success;
  17664. } else {
  17665. auto ssl_err = SSL_get_error(ssl, ret);
  17666. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17667. err.backend_code = ERR_get_error();
  17668. }
  17669. return err;
  17670. }
  17671. inline bool connect_nonblocking(session_t session, socket_t sock,
  17672. time_t timeout_sec, time_t timeout_usec,
  17673. TlsError *err,
  17674. const std::function<bool()> &interrupted) {
  17675. if (!session) {
  17676. if (err) { err->code = ErrorCode::Fatal; }
  17677. return false;
  17678. }
  17679. auto ssl = static_cast<SSL *>(session);
  17680. auto bio = SSL_get_rbio(ssl);
  17681. // Set non-blocking mode for handshake
  17682. detail::set_nonblocking(sock, true);
  17683. if (bio) { BIO_set_nbio(bio, 1); }
  17684. auto cleanup = detail::scope_exit([&]() {
  17685. // Restore blocking mode after handshake
  17686. if (bio) { BIO_set_nbio(bio, 0); }
  17687. detail::set_nonblocking(sock, false);
  17688. });
  17689. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17690. auto res = 0;
  17691. while ((res = SSL_connect(ssl)) != 1) {
  17692. auto ssl_err = SSL_get_error(ssl, res);
  17693. switch (ssl_err) {
  17694. case SSL_ERROR_WANT_READ:
  17695. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  17696. continue;
  17697. }
  17698. break;
  17699. case SSL_ERROR_WANT_WRITE:
  17700. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  17701. continue;
  17702. }
  17703. break;
  17704. default: break;
  17705. }
  17706. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17707. return false;
  17708. }
  17709. if (err) { err->code = ErrorCode::Success; }
  17710. return true;
  17711. }
  17712. inline bool accept_nonblocking(session_t session, socket_t sock,
  17713. time_t timeout_sec, time_t timeout_usec,
  17714. TlsError *err) {
  17715. if (!session) {
  17716. if (err) { err->code = ErrorCode::Fatal; }
  17717. return false;
  17718. }
  17719. auto ssl = static_cast<SSL *>(session);
  17720. auto bio = SSL_get_rbio(ssl);
  17721. // Set non-blocking mode for handshake
  17722. detail::set_nonblocking(sock, true);
  17723. if (bio) { BIO_set_nbio(bio, 1); }
  17724. auto cleanup = detail::scope_exit([&]() {
  17725. // Restore blocking mode after handshake
  17726. if (bio) { BIO_set_nbio(bio, 0); }
  17727. detail::set_nonblocking(sock, false);
  17728. });
  17729. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17730. auto res = 0;
  17731. while ((res = SSL_accept(ssl)) != 1) {
  17732. auto ssl_err = SSL_get_error(ssl, res);
  17733. switch (ssl_err) {
  17734. case SSL_ERROR_WANT_READ:
  17735. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17736. break;
  17737. case SSL_ERROR_WANT_WRITE:
  17738. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17739. break;
  17740. default: break;
  17741. }
  17742. if (err) {
  17743. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17744. err->backend_code = ERR_get_error();
  17745. }
  17746. return false;
  17747. }
  17748. if (err) { err->code = ErrorCode::Success; }
  17749. return true;
  17750. }
  17751. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17752. if (!session || !buf) {
  17753. err.code = ErrorCode::Fatal;
  17754. return -1;
  17755. }
  17756. auto ssl = static_cast<SSL *>(session);
  17757. constexpr auto max_len =
  17758. static_cast<size_t>((std::numeric_limits<int>::max)());
  17759. if (len > max_len) { len = max_len; }
  17760. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17761. if (ret > 0) {
  17762. err.code = ErrorCode::Success;
  17763. return ret;
  17764. }
  17765. auto ssl_err = SSL_get_error(ssl, ret);
  17766. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17767. if (err.code == ErrorCode::PeerClosed) {
  17768. return 0;
  17769. } // Gracefully handle the peer closed state.
  17770. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17771. return -1;
  17772. }
  17773. inline ssize_t write(session_t session, const void *buf, size_t len,
  17774. TlsError &err) {
  17775. if (!session || !buf) {
  17776. err.code = ErrorCode::Fatal;
  17777. return -1;
  17778. }
  17779. auto ssl = static_cast<SSL *>(session);
  17780. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17781. if (ret > 0) {
  17782. err.code = ErrorCode::Success;
  17783. return ret;
  17784. }
  17785. auto ssl_err = SSL_get_error(ssl, ret);
  17786. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17787. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17788. return -1;
  17789. }
  17790. inline int pending(const_session_t session) {
  17791. if (!session) return 0;
  17792. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17793. }
  17794. inline void shutdown(session_t session, bool graceful) {
  17795. if (!session) return;
  17796. auto ssl = static_cast<SSL *>(session);
  17797. if (graceful) {
  17798. // Send close_notify without waiting for the peer's. The connection is
  17799. // closed right after this, so a unidirectional shutdown is enough, and an
  17800. // idle peer that never answers would otherwise hold this thread until the
  17801. // read timeout. The other backends do not wait either.
  17802. SSL_shutdown(ssl);
  17803. }
  17804. }
  17805. inline bool is_peer_closed(session_t session, socket_t sock) {
  17806. if (!session) return true;
  17807. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17808. detail::set_nonblocking(sock, true);
  17809. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17810. auto ssl = static_cast<SSL *>(session);
  17811. char buf;
  17812. auto ret = SSL_peek(ssl, &buf, 1);
  17813. if (ret > 0) return false;
  17814. auto err = SSL_get_error(ssl, ret);
  17815. return err == SSL_ERROR_ZERO_RETURN;
  17816. }
  17817. inline cert_t get_peer_cert(const_session_t session) {
  17818. if (!session) return nullptr;
  17819. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17820. static_cast<SSL *>(const_cast<void *>(session))));
  17821. }
  17822. inline size_t get_peer_certs(const_session_t session,
  17823. std::vector<cert_t> &certs) {
  17824. certs.clear();
  17825. if (!session) { return 0; }
  17826. auto ssl = static_cast<const SSL *>(session);
  17827. // On the server side, the chain leaves out the peer's own certificate
  17828. if (SSL_is_server(ssl)) {
  17829. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17830. }
  17831. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17832. auto count = sk_X509_num(sk);
  17833. for (decltype(count) i = 0; i < count; i++) {
  17834. auto x509 = sk_X509_value(sk, i);
  17835. X509_up_ref(x509);
  17836. certs.push_back(static_cast<cert_t>(x509));
  17837. }
  17838. }
  17839. return certs.size();
  17840. }
  17841. inline void free_cert(cert_t cert) {
  17842. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17843. }
  17844. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17845. if (!cert || !hostname) return false;
  17846. auto x509 = static_cast<X509 *>(cert);
  17847. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17848. if (detail::is_ip_address(hostname)) {
  17849. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17850. }
  17851. return X509_check_host(x509, hostname, strlen(hostname),
  17852. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  17853. }
  17854. inline uint64_t hostname_mismatch_code() {
  17855. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17856. }
  17857. inline long get_verify_result(const_session_t session) {
  17858. if (!session) return X509_V_ERR_UNSPECIFIED;
  17859. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17860. }
  17861. inline std::string get_cert_subject_cn(cert_t cert) {
  17862. if (!cert) return "";
  17863. auto x509 = static_cast<X509 *>(cert);
  17864. auto subject_name = X509_get_subject_name(x509);
  17865. if (!subject_name) return "";
  17866. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17867. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17868. if (idx < 0) return "";
  17869. auto entry = X509_NAME_get_entry(subject_name, idx);
  17870. if (!entry) return "";
  17871. auto data = X509_NAME_ENTRY_get_data(entry);
  17872. if (!data) return "";
  17873. return std::string(
  17874. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17875. static_cast<size_t>(ASN1_STRING_length(data)));
  17876. }
  17877. inline std::string get_cert_issuer_name(cert_t cert) {
  17878. if (!cert) return "";
  17879. auto x509 = static_cast<X509 *>(cert);
  17880. auto issuer_name = X509_get_issuer_name(x509);
  17881. if (!issuer_name) return "";
  17882. char buf[256];
  17883. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17884. return std::string(buf);
  17885. }
  17886. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17887. sans.clear();
  17888. if (!cert) return false;
  17889. auto x509 = static_cast<X509 *>(cert);
  17890. auto names = static_cast<GENERAL_NAMES *>(
  17891. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17892. if (!names) return true; // No SANs is valid
  17893. auto count = sk_GENERAL_NAME_num(names);
  17894. for (decltype(count) i = 0; i < count; i++) {
  17895. auto gen = sk_GENERAL_NAME_value(names, i);
  17896. if (!gen) continue;
  17897. SanEntry entry;
  17898. switch (gen->type) {
  17899. case GEN_DNS:
  17900. entry.type = SanType::DNS;
  17901. if (gen->d.dNSName) {
  17902. entry.value = std::string(
  17903. reinterpret_cast<const char *>(
  17904. ASN1_STRING_get0_data(gen->d.dNSName)),
  17905. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17906. }
  17907. break;
  17908. case GEN_IPADD:
  17909. entry.type = SanType::IP;
  17910. if (gen->d.iPAddress) {
  17911. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17912. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17913. if (len == 4) {
  17914. // IPv4
  17915. char buf[INET_ADDRSTRLEN];
  17916. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17917. entry.value = buf;
  17918. } else if (len == 16) {
  17919. // IPv6
  17920. char buf[INET6_ADDRSTRLEN];
  17921. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17922. entry.value = buf;
  17923. }
  17924. }
  17925. break;
  17926. case GEN_EMAIL:
  17927. entry.type = SanType::EMAIL;
  17928. if (gen->d.rfc822Name) {
  17929. entry.value = std::string(
  17930. reinterpret_cast<const char *>(
  17931. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17932. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17933. }
  17934. break;
  17935. case GEN_URI:
  17936. entry.type = SanType::URI;
  17937. if (gen->d.uniformResourceIdentifier) {
  17938. entry.value = std::string(
  17939. reinterpret_cast<const char *>(
  17940. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17941. static_cast<size_t>(
  17942. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17943. }
  17944. break;
  17945. default: entry.type = SanType::OTHER; break;
  17946. }
  17947. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17948. }
  17949. GENERAL_NAMES_free(names);
  17950. return true;
  17951. }
  17952. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17953. time_t &not_after) {
  17954. if (!cert) return false;
  17955. auto x509 = static_cast<X509 *>(cert);
  17956. auto nb = X509_get0_notBefore(x509);
  17957. auto na = X509_get0_notAfter(x509);
  17958. if (!nb || !na) return false;
  17959. ASN1_TIME *epoch = ASN1_TIME_new();
  17960. if (!epoch) return false;
  17961. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17962. if (!ASN1_TIME_set(epoch, 0)) return false;
  17963. int pday, psec;
  17964. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17965. not_before = 86400 * (time_t)pday + psec;
  17966. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17967. not_after = 86400 * (time_t)pday + psec;
  17968. return true;
  17969. }
  17970. inline std::string get_cert_serial(cert_t cert) {
  17971. if (!cert) return "";
  17972. auto x509 = static_cast<X509 *>(cert);
  17973. auto serial = X509_get_serialNumber(x509);
  17974. if (!serial) return "";
  17975. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17976. if (!bn) return "";
  17977. auto hex = BN_bn2hex(bn);
  17978. BN_free(bn);
  17979. if (!hex) return "";
  17980. std::string result(hex);
  17981. OPENSSL_free(hex);
  17982. return result;
  17983. }
  17984. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17985. if (!cert) return false;
  17986. auto x509 = static_cast<X509 *>(cert);
  17987. auto len = i2d_X509(x509, nullptr);
  17988. if (len < 0) return false;
  17989. der.resize(static_cast<size_t>(len));
  17990. auto p = der.data();
  17991. i2d_X509(x509, &p);
  17992. return true;
  17993. }
  17994. inline const char *get_sni(const_session_t session) {
  17995. if (!session) return nullptr;
  17996. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17997. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17998. }
  17999. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  18000. inline uint64_t get_error() { return ERR_get_error(); }
  18001. inline std::string error_string(uint64_t code) {
  18002. char buf[256];
  18003. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  18004. sizeof(buf));
  18005. return std::string(buf);
  18006. }
  18007. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18008. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  18009. if (!mem) { return nullptr; }
  18010. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  18011. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  18012. if (!inf) { return nullptr; }
  18013. auto store = X509_STORE_new();
  18014. if (store) {
  18015. auto count = sk_X509_INFO_num(inf);
  18016. for (decltype(count) i = 0; i < count; i++) {
  18017. auto itmp = sk_X509_INFO_value(inf, i);
  18018. if (!itmp) { continue; }
  18019. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  18020. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  18021. }
  18022. }
  18023. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  18024. return static_cast<ca_store_t>(store);
  18025. }
  18026. inline void free_ca_store(ca_store_t store) {
  18027. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  18028. }
  18029. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18030. if (!ctx || !store) { return false; }
  18031. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18032. auto x509_store = static_cast<X509_STORE *>(store);
  18033. // Check if same store is already set
  18034. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  18035. // SSL_CTX_set_cert_store takes ownership and frees the old store
  18036. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  18037. return true;
  18038. }
  18039. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18040. certs.clear();
  18041. if (!ctx) { return 0; }
  18042. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18043. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18044. if (!store) { return 0; }
  18045. auto objs = impl::get_store_objects(store);
  18046. if (!objs) { return 0; }
  18047. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18048. auto count = sk_X509_OBJECT_num(objs);
  18049. for (decltype(count) i = 0; i < count; i++) {
  18050. auto obj = sk_X509_OBJECT_value(objs, i);
  18051. if (!obj) { continue; }
  18052. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18053. auto x509 = X509_OBJECT_get0_X509(obj);
  18054. if (x509) {
  18055. // Increment reference count so caller can free it
  18056. X509_up_ref(x509);
  18057. certs.push_back(static_cast<cert_t>(x509));
  18058. }
  18059. }
  18060. }
  18061. return certs.size();
  18062. }
  18063. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18064. std::vector<std::string> names;
  18065. if (!ctx) { return names; }
  18066. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18067. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18068. if (!store) { return names; }
  18069. auto objs = impl::get_store_objects(store);
  18070. if (!objs) { return names; }
  18071. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18072. auto count = sk_X509_OBJECT_num(objs);
  18073. for (decltype(count) i = 0; i < count; i++) {
  18074. auto obj = sk_X509_OBJECT_value(objs, i);
  18075. if (!obj) { continue; }
  18076. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18077. auto x509 = X509_OBJECT_get0_X509(obj);
  18078. if (x509) {
  18079. auto subject = X509_get_subject_name(x509);
  18080. if (subject) {
  18081. char buf[512];
  18082. X509_NAME_oneline(subject, buf, sizeof(buf));
  18083. names.push_back(buf);
  18084. }
  18085. }
  18086. }
  18087. }
  18088. return names;
  18089. }
  18090. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18091. const char *key_pem, const char *password) {
  18092. if (!ctx || !cert_pem || !key_pem) { return false; }
  18093. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18094. // Load certificate from PEM
  18095. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  18096. if (!cert_bio) { return false; }
  18097. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  18098. BIO_free(cert_bio);
  18099. if (!cert) { return false; }
  18100. // Load private key from PEM
  18101. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  18102. if (!key_bio) {
  18103. X509_free(cert);
  18104. return false;
  18105. }
  18106. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  18107. password ? const_cast<char *>(password)
  18108. : nullptr);
  18109. BIO_free(key_bio);
  18110. if (!key) {
  18111. X509_free(cert);
  18112. return false;
  18113. }
  18114. // Update certificate and key
  18115. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  18116. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  18117. X509_free(cert);
  18118. EVP_PKEY_free(key);
  18119. return ret;
  18120. }
  18121. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18122. if (!ctx || !ca_pem) { return false; }
  18123. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18124. // Create new X509_STORE from PEM
  18125. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  18126. if (!store) { return false; }
  18127. // A resumed session is not verified again, so the ticket keys from before
  18128. // go, or a client verified under the old CAs could go on resuming.
  18129. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  18130. unsigned char ticket_keys[48];
  18131. #else
  18132. unsigned char ticket_keys[80];
  18133. #endif
  18134. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  18135. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  18136. sizeof(ticket_keys)) != 1) {
  18137. free_ca_store(store);
  18138. return false;
  18139. }
  18140. // SSL_CTX_set_cert_store takes ownership
  18141. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  18142. // Set client CA list for client certificate request
  18143. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  18144. if (ca_list) {
  18145. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  18146. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  18147. }
  18148. // The cached sessions go for the same reason.
  18149. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  18150. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  18151. #else
  18152. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  18153. #endif
  18154. return true;
  18155. }
  18156. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18157. if (!ctx) { return false; }
  18158. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18159. auto index = impl::verify_callback_index();
  18160. if (index < 0) { return false; }
  18161. std::shared_ptr<VerifyCallback> *stored = nullptr;
  18162. if (callback) {
  18163. stored = new std::shared_ptr<VerifyCallback>(
  18164. std::make_shared<VerifyCallback>(std::move(callback)));
  18165. }
  18166. std::shared_ptr<VerifyCallback> *previous = nullptr;
  18167. {
  18168. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  18169. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  18170. SSL_CTX_get_ex_data(ssl_ctx, index));
  18171. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  18172. delete stored;
  18173. return false;
  18174. }
  18175. }
  18176. // A handshake running the previous callback keeps it until it returns.
  18177. delete previous;
  18178. // A resumed handshake shows no certificate to run the callback on.
  18179. if (stored) {
  18180. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  18181. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  18182. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  18183. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  18184. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  18185. #endif
  18186. }
  18187. // Keep requiring the peer's certificate if set_verify_client() asked for it
  18188. auto require =
  18189. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  18190. impl::apply_verify_mode(ssl_ctx, require);
  18191. return true;
  18192. }
  18193. inline long get_verify_error(const_session_t session) {
  18194. if (!session) { return -1; }
  18195. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18196. return SSL_get_verify_result(ssl);
  18197. }
  18198. inline std::string verify_error_string(long error_code) {
  18199. if (error_code == X509_V_OK) { return ""; }
  18200. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  18201. return str ? str : "unknown error";
  18202. }
  18203. } // namespace tls
  18204. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  18205. /*
  18206. * Group 9: TLS abstraction layer - Mbed TLS backend
  18207. */
  18208. /*
  18209. * Mbed TLS Backend Implementation
  18210. */
  18211. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  18212. namespace tls {
  18213. namespace impl {
  18214. // Mbed TLS session wrapper
  18215. struct MbedTlsSession {
  18216. mbedtls_ssl_context ssl;
  18217. socket_t sock = INVALID_SOCKET;
  18218. std::string hostname; // For client: set via set_sni
  18219. std::string sni_hostname; // For server: received from client via SNI callback
  18220. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  18221. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  18222. // (e.g. a response that arrived while this side was still in its post-write
  18223. // check), the byte is pushed back here and served by the next read().
  18224. unsigned char peeked_byte = 0;
  18225. bool has_peeked_byte = false;
  18226. // Set by set_sni() when the caller disabled hostname verification, so the
  18227. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18228. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18229. // OpenSSL and wolfSSL keep them independent).
  18230. bool suppress_hostname_mismatch = false;
  18231. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18232. // ever runs the callback of its own context.
  18233. VerifyCallback verify_callback;
  18234. bool is_server = false;
  18235. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18236. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18237. MbedTlsSession(const MbedTlsSession &) = delete;
  18238. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18239. };
  18240. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18241. // queue)
  18242. inline int &mbedtls_last_error() {
  18243. static thread_local int err = 0;
  18244. return err;
  18245. }
  18246. // Helper to map Mbed TLS error to ErrorCode
  18247. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18248. uint32_t verify_flags) {
  18249. if (ret == 0) { return ErrorCode::Success; }
  18250. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18251. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18252. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18253. return ErrorCode::PeerClosed;
  18254. }
  18255. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18256. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18257. out_errno = errno;
  18258. return ErrorCode::SyscallError;
  18259. }
  18260. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18261. // EOF without close_notify
  18262. out_errno = 0;
  18263. return ErrorCode::SyscallError;
  18264. }
  18265. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18266. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18267. // the handshake's chain verification (see set_sni()); a mismatch there
  18268. // is reported the same way as any other verify_flags bit. Report it as
  18269. // HostnameMismatch, matching the other backends and the post-handshake
  18270. // identity check below, but only when naming is the sole problem -
  18271. // if the chain itself is also untrusted/expired/etc., that takes
  18272. // priority over the naming detail.
  18273. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18274. return ErrorCode::HostnameMismatch;
  18275. }
  18276. return ErrorCode::CertVerifyFailed;
  18277. }
  18278. return ErrorCode::Fatal;
  18279. }
  18280. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18281. // return value, including the verify-flags-dependent HostnameMismatch
  18282. // mapping; shared by connect() and connect_nonblocking() so the
  18283. // backend_code policy for that mapping only lives in one place.
  18284. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18285. int ret) {
  18286. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18287. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18288. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18289. ? static_cast<uint64_t>(verify_flags)
  18290. : static_cast<uint64_t>(-ret);
  18291. }
  18292. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18293. // non-fatal notification delivered between records, not an error and not
  18294. // application data, so I/O calls that see it should just be retried. Kept in
  18295. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18296. // splitting the closing brace across an #if.
  18297. inline bool mbedtls_is_session_ticket(int ret) {
  18298. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18299. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18300. #else
  18301. (void)ret;
  18302. return false;
  18303. #endif
  18304. }
  18305. // BIO-like send callback for Mbed TLS
  18306. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18307. size_t len) {
  18308. auto sock = *static_cast<socket_t *>(ctx);
  18309. #ifdef _WIN32
  18310. auto ret =
  18311. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18312. if (ret == SOCKET_ERROR) {
  18313. int err = WSAGetLastError();
  18314. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18315. return MBEDTLS_ERR_NET_SEND_FAILED;
  18316. }
  18317. #else
  18318. auto ret = send(sock, buf, len, 0);
  18319. if (ret < 0) {
  18320. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18321. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18322. }
  18323. return MBEDTLS_ERR_NET_SEND_FAILED;
  18324. }
  18325. #endif
  18326. return static_cast<int>(ret);
  18327. }
  18328. // BIO-like recv callback for Mbed TLS
  18329. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18330. auto sock = *static_cast<socket_t *>(ctx);
  18331. #ifdef _WIN32
  18332. auto ret =
  18333. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18334. if (ret == SOCKET_ERROR) {
  18335. int err = WSAGetLastError();
  18336. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18337. return MBEDTLS_ERR_NET_RECV_FAILED;
  18338. }
  18339. #else
  18340. auto ret = recv(sock, buf, len, 0);
  18341. if (ret < 0) {
  18342. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18343. return MBEDTLS_ERR_SSL_WANT_READ;
  18344. }
  18345. return MBEDTLS_ERR_NET_RECV_FAILED;
  18346. }
  18347. #endif
  18348. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18349. return static_cast<int>(ret);
  18350. }
  18351. // MbedTlsContext constructor/destructor implementations
  18352. inline MbedTlsContext::MbedTlsContext() {
  18353. mbedtls_ssl_config_init(&conf);
  18354. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18355. mbedtls_entropy_init(&entropy);
  18356. mbedtls_ctr_drbg_init(&ctr_drbg);
  18357. #endif
  18358. mbedtls_x509_crt_init(&ca_chain);
  18359. mbedtls_x509_crt_init(&own_cert);
  18360. mbedtls_pk_init(&own_key);
  18361. }
  18362. inline MbedTlsContext::~MbedTlsContext() {
  18363. mbedtls_pk_free(&own_key);
  18364. mbedtls_x509_crt_free(&own_cert);
  18365. mbedtls_x509_crt_free(&ca_chain);
  18366. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18367. mbedtls_ctr_drbg_free(&ctr_drbg);
  18368. mbedtls_entropy_free(&entropy);
  18369. #endif
  18370. mbedtls_ssl_config_free(&conf);
  18371. }
  18372. // Thread-local storage for SNI captured during handshake
  18373. // This is needed because the SNI callback doesn't have a way to pass
  18374. // session-specific data before the session is fully set up
  18375. inline std::string &mbedpending_sni() {
  18376. static thread_local std::string sni;
  18377. return sni;
  18378. }
  18379. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18380. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18381. const unsigned char *name, size_t name_len) {
  18382. (void)p_ctx;
  18383. (void)ssl;
  18384. // Store SNI name in thread-local storage
  18385. // It will be retrieved and stored in the session after handshake
  18386. if (name && name_len > 0) {
  18387. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18388. } else {
  18389. mbedpending_sni().clear();
  18390. }
  18391. return 0; // Accept any SNI
  18392. }
  18393. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18394. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18395. }
  18396. // MbedTLS verify callback wrapper
  18397. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18398. int cert_depth, uint32_t *flags) {
  18399. // data points to the MbedTlsSession
  18400. auto *session = static_cast<MbedTlsSession *>(data);
  18401. // set_sni() disabled hostname verification for this session: ignore the
  18402. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18403. // pass/fail decision still comes from the remaining flags (and, below, from
  18404. // the user's own verify callback).
  18405. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18406. const auto &callback = session->verify_callback;
  18407. if (!callback) { return 0; } // Continue with default verification
  18408. // Build context
  18409. VerifyContext verify_ctx;
  18410. verify_ctx.session = static_cast<session_t>(session);
  18411. verify_ctx.cert = static_cast<cert_t>(crt);
  18412. verify_ctx.depth = cert_depth;
  18413. verify_ctx.preverify_ok = (*flags == 0);
  18414. verify_ctx.error_code = static_cast<long>(*flags);
  18415. // Convert Mbed TLS flags to error string
  18416. static thread_local char error_buf[256];
  18417. if (*flags != 0) {
  18418. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18419. verify_ctx.error_string = error_buf;
  18420. } else {
  18421. verify_ctx.error_string = nullptr;
  18422. }
  18423. bool accepted = run_verify_callback(callback, verify_ctx);
  18424. if (accepted) {
  18425. // Overrides the built-in verification only on a server, as on OpenSSL and
  18426. // wolfSSL, whose clients check the verify result after the handshake
  18427. if (session->is_server) { *flags = 0; }
  18428. return 0;
  18429. }
  18430. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18431. }
  18432. // Sets the authentication mode from whether the peer's certificate is required
  18433. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18434. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18435. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18436. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18437. if (mctx.verify_client) {
  18438. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18439. } else if (mctx.verify_callback) {
  18440. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18441. }
  18442. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18443. }
  18444. } // namespace impl
  18445. inline ctx_t create_client_context() {
  18446. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18447. if (!ctx) { return nullptr; }
  18448. ctx->is_server = false;
  18449. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18450. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18451. if (!detail::ensure_mbedtls_psa_crypto()) {
  18452. delete ctx;
  18453. return nullptr;
  18454. }
  18455. int ret;
  18456. #else
  18457. // Seed the random number generator
  18458. const char *pers = "httplib_client";
  18459. int ret = mbedtls_ctr_drbg_seed(
  18460. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18461. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18462. if (ret != 0) {
  18463. impl::mbedtls_last_error() = ret;
  18464. delete ctx;
  18465. return nullptr;
  18466. }
  18467. #endif
  18468. // Set up SSL config for client
  18469. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18470. MBEDTLS_SSL_TRANSPORT_STREAM,
  18471. MBEDTLS_SSL_PRESET_DEFAULT);
  18472. if (ret != 0) {
  18473. impl::mbedtls_last_error() = ret;
  18474. delete ctx;
  18475. return nullptr;
  18476. }
  18477. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18478. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18479. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18480. #endif
  18481. // Default: verify peer certificate
  18482. ctx->verify_client = true;
  18483. impl::apply_verify_mode(*ctx);
  18484. // Set minimum TLS version to 1.2
  18485. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18486. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18487. #else
  18488. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18489. MBEDTLS_SSL_MINOR_VERSION_3);
  18490. #endif
  18491. return static_cast<ctx_t>(ctx);
  18492. }
  18493. inline ctx_t create_server_context() {
  18494. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18495. if (!ctx) { return nullptr; }
  18496. ctx->is_server = true;
  18497. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18498. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18499. if (!detail::ensure_mbedtls_psa_crypto()) {
  18500. delete ctx;
  18501. return nullptr;
  18502. }
  18503. int ret;
  18504. #else
  18505. // Seed the random number generator
  18506. const char *pers = "httplib_server";
  18507. int ret = mbedtls_ctr_drbg_seed(
  18508. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18509. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18510. if (ret != 0) {
  18511. impl::mbedtls_last_error() = ret;
  18512. delete ctx;
  18513. return nullptr;
  18514. }
  18515. #endif
  18516. // Set up SSL config for server
  18517. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18518. MBEDTLS_SSL_TRANSPORT_STREAM,
  18519. MBEDTLS_SSL_PRESET_DEFAULT);
  18520. if (ret != 0) {
  18521. impl::mbedtls_last_error() = ret;
  18522. delete ctx;
  18523. return nullptr;
  18524. }
  18525. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18526. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18527. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18528. #endif
  18529. // Default: don't verify client
  18530. impl::apply_verify_mode(*ctx);
  18531. // Set minimum TLS version to 1.2
  18532. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18533. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18534. #else
  18535. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18536. MBEDTLS_SSL_MINOR_VERSION_3);
  18537. #endif
  18538. // Set SNI callback to capture client's SNI hostname
  18539. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18540. return static_cast<ctx_t>(ctx);
  18541. }
  18542. inline void free_context(ctx_t ctx) {
  18543. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18544. }
  18545. inline bool set_min_version(ctx_t ctx, Version version) {
  18546. if (!ctx) { return false; }
  18547. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18548. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18549. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18550. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18551. if (version >= Version::TLS1_3) {
  18552. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18553. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18554. #endif
  18555. }
  18556. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18557. #else
  18558. // Mbed TLS 2.x uses major/minor version numbers
  18559. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18560. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18561. if (version >= Version::TLS1_3) {
  18562. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18563. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18564. #else
  18565. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18566. #endif
  18567. }
  18568. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18569. #endif
  18570. return true;
  18571. }
  18572. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18573. if (!ctx || !pem) { return false; }
  18574. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18575. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18576. // Add null terminator if not present
  18577. std::string pem_str(pem, len);
  18578. int ret = mbedtls_x509_crt_parse(
  18579. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18580. pem_str.size() + 1);
  18581. if (ret != 0) {
  18582. impl::mbedtls_last_error() = ret;
  18583. return false;
  18584. }
  18585. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18586. return true;
  18587. }
  18588. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18589. if (!ctx || !file_path) { return false; }
  18590. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18591. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18592. if (ret != 0) {
  18593. impl::mbedtls_last_error() = ret;
  18594. return false;
  18595. }
  18596. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18597. return true;
  18598. }
  18599. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18600. if (!ctx || !dir_path) { return false; }
  18601. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18602. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18603. if (ret < 0) { // Returns number of certs on success, negative on error
  18604. impl::mbedtls_last_error() = ret;
  18605. return false;
  18606. }
  18607. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18608. return true;
  18609. }
  18610. inline bool load_system_certs(ctx_t ctx) {
  18611. if (!ctx) { return false; }
  18612. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18613. bool loaded = false;
  18614. #ifdef _WIN32
  18615. loaded = impl::enumerate_windows_system_certs(
  18616. [&](const unsigned char *data, size_t len) {
  18617. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18618. });
  18619. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18620. loaded = impl::enumerate_macos_keychain_certs(
  18621. [&](const unsigned char *data, size_t len) {
  18622. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18623. });
  18624. #else
  18625. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18626. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18627. loaded = true;
  18628. break;
  18629. }
  18630. }
  18631. if (!loaded) {
  18632. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18633. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18634. loaded = true;
  18635. break;
  18636. }
  18637. }
  18638. }
  18639. #endif
  18640. if (loaded) {
  18641. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18642. }
  18643. return loaded;
  18644. }
  18645. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18646. const char *password) {
  18647. if (!ctx || !cert || !key) { return false; }
  18648. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18649. // Parse certificate
  18650. std::string cert_str(cert);
  18651. int ret = mbedtls_x509_crt_parse(
  18652. &mctx->own_cert,
  18653. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18654. cert_str.size() + 1);
  18655. if (ret != 0) {
  18656. impl::mbedtls_last_error() = ret;
  18657. return false;
  18658. }
  18659. // Parse private key
  18660. std::string key_str(key);
  18661. const unsigned char *pwd =
  18662. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18663. size_t pwd_len = password ? strlen(password) : 0;
  18664. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18665. ret = mbedtls_pk_parse_key(
  18666. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18667. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18668. &mctx->ctr_drbg);
  18669. #else
  18670. ret = mbedtls_pk_parse_key(
  18671. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18672. key_str.size() + 1, pwd, pwd_len);
  18673. #endif
  18674. if (ret != 0) {
  18675. impl::mbedtls_last_error() = ret;
  18676. return false;
  18677. }
  18678. // Verify that the certificate and private key match.
  18679. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18680. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18681. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18682. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18683. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18684. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18685. #else
  18686. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18687. #endif
  18688. if (ret != 0) {
  18689. impl::mbedtls_last_error() = ret;
  18690. return false;
  18691. }
  18692. #endif
  18693. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18694. if (ret != 0) {
  18695. impl::mbedtls_last_error() = ret;
  18696. return false;
  18697. }
  18698. return true;
  18699. }
  18700. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18701. const char *key_path, const char *password) {
  18702. if (!ctx || !cert_path || !key_path) { return false; }
  18703. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18704. // Parse certificate file
  18705. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18706. if (ret != 0) {
  18707. impl::mbedtls_last_error() = ret;
  18708. return false;
  18709. }
  18710. // Parse private key file
  18711. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18712. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18713. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18714. #else
  18715. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18716. #endif
  18717. if (ret != 0) {
  18718. impl::mbedtls_last_error() = ret;
  18719. return false;
  18720. }
  18721. // Verify that the certificate and private key match.
  18722. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18723. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18724. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18725. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18726. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18727. #else
  18728. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18729. #endif
  18730. if (ret != 0) {
  18731. impl::mbedtls_last_error() = ret;
  18732. return false;
  18733. }
  18734. #endif
  18735. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18736. if (ret != 0) {
  18737. impl::mbedtls_last_error() = ret;
  18738. return false;
  18739. }
  18740. return true;
  18741. }
  18742. inline void set_verify_client(ctx_t ctx, bool require) {
  18743. if (!ctx) { return; }
  18744. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18745. mctx->verify_client = require;
  18746. impl::apply_verify_mode(*mctx);
  18747. }
  18748. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18749. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18750. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18751. auto session = new (std::nothrow) impl::MbedTlsSession();
  18752. if (!session) { return nullptr; }
  18753. session->sock = sock;
  18754. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18755. if (ret != 0) {
  18756. impl::mbedtls_last_error() = ret;
  18757. delete session;
  18758. return nullptr;
  18759. }
  18760. // Explicitly opt out of in-handshake hostname verification by default;
  18761. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18762. // fails outright when no hostname was set. set_sni() installs the real
  18763. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18764. // caller verifies the certificate identity post-handshake via
  18765. // verify_hostname().
  18766. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18767. // Set BIO callbacks
  18768. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18769. impl::mbedtls_net_recv_cb, nullptr);
  18770. // Installed always, as it also masks the hostname mismatch that set_sni()
  18771. // may ask for. The session runs its own copy of the user's callback, which
  18772. // set_verify_callback() cannot replace under a handshake.
  18773. session->verify_callback = mctx->verify_callback;
  18774. session->is_server = mctx->is_server;
  18775. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18776. return static_cast<session_t>(session);
  18777. }
  18778. inline void free_session(session_t session) {
  18779. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18780. }
  18781. inline bool set_sni(session_t session, const char *hostname,
  18782. bool verify_hostname) {
  18783. if (!session || !hostname) { return false; }
  18784. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18785. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18786. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18787. // independently, so a disabled hostname check is handled below by masking
  18788. // the resulting mismatch flag instead of skipping this call.
  18789. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18790. if (ret != 0) {
  18791. impl::mbedtls_last_error() = ret;
  18792. return false;
  18793. }
  18794. msession->hostname = hostname;
  18795. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18796. return true;
  18797. }
  18798. inline TlsError connect(session_t session) {
  18799. TlsError err;
  18800. if (!session) {
  18801. err.code = ErrorCode::Fatal;
  18802. return err;
  18803. }
  18804. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18805. int ret;
  18806. do {
  18807. ret = mbedtls_ssl_handshake(&msession->ssl);
  18808. } while (impl::mbedtls_is_session_ticket(ret));
  18809. if (ret == 0) {
  18810. err.code = ErrorCode::Success;
  18811. } else {
  18812. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18813. impl::mbedtls_last_error() = ret;
  18814. }
  18815. return err;
  18816. }
  18817. inline TlsError accept(session_t session) {
  18818. // A failed handshake leaves its SNI behind, so start without it
  18819. impl::mbedpending_sni().clear();
  18820. // Same as connect for Mbed TLS - handshake works for both client and server
  18821. auto result = connect(session);
  18822. // After successful handshake, capture SNI from thread-local storage
  18823. if (result.code == ErrorCode::Success && session) {
  18824. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18825. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18826. }
  18827. return result;
  18828. }
  18829. inline bool connect_nonblocking(session_t session, socket_t sock,
  18830. time_t timeout_sec, time_t timeout_usec,
  18831. TlsError *err,
  18832. const std::function<bool()> &interrupted) {
  18833. if (!session) {
  18834. if (err) { err->code = ErrorCode::Fatal; }
  18835. return false;
  18836. }
  18837. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18838. // Set socket to non-blocking mode
  18839. detail::set_nonblocking(sock, true);
  18840. auto cleanup =
  18841. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18842. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18843. int ret;
  18844. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18845. // Non-fatal TLS 1.3 ticket; retry immediately.
  18846. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18847. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18848. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  18849. continue;
  18850. }
  18851. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18852. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  18853. continue;
  18854. }
  18855. }
  18856. // TlsError or timeout
  18857. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18858. impl::mbedtls_last_error() = ret;
  18859. return false;
  18860. }
  18861. if (err) { err->code = ErrorCode::Success; }
  18862. return true;
  18863. }
  18864. inline bool accept_nonblocking(session_t session, socket_t sock,
  18865. time_t timeout_sec, time_t timeout_usec,
  18866. TlsError *err) {
  18867. // A failed handshake leaves its SNI behind, so start without it
  18868. impl::mbedpending_sni().clear();
  18869. // Same implementation as connect for Mbed TLS
  18870. bool result =
  18871. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18872. // After successful handshake, capture SNI from thread-local storage
  18873. if (result && session) {
  18874. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18875. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18876. }
  18877. return result;
  18878. }
  18879. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18880. if (!session || !buf) {
  18881. err.code = ErrorCode::Fatal;
  18882. return -1;
  18883. }
  18884. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18885. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18886. if (msession->has_peeked_byte) {
  18887. if (len == 0) { return 0; }
  18888. auto p = static_cast<unsigned char *>(buf);
  18889. p[0] = msession->peeked_byte;
  18890. msession->has_peeked_byte = false;
  18891. size_t n = 1;
  18892. // Top up with any already-decrypted bytes without risking a block.
  18893. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18894. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18895. if (extra > 0) { n += static_cast<size_t>(extra); }
  18896. }
  18897. err.code = ErrorCode::Success;
  18898. return static_cast<ssize_t>(n);
  18899. }
  18900. int ret;
  18901. do {
  18902. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18903. len);
  18904. } while (impl::mbedtls_is_session_ticket(ret));
  18905. if (ret > 0) {
  18906. err.code = ErrorCode::Success;
  18907. return static_cast<ssize_t>(ret);
  18908. }
  18909. // 0 means EOF without close_notify, which is an error as on OpenSSL
  18910. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  18911. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18912. err.backend_code = static_cast<uint64_t>(-ret);
  18913. impl::mbedtls_last_error() = ret;
  18914. // mbedTLS signals a clean close_notify via a negative error code rather
  18915. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18916. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18917. return -1;
  18918. }
  18919. inline ssize_t write(session_t session, const void *buf, size_t len,
  18920. TlsError &err) {
  18921. if (!session || !buf) {
  18922. err.code = ErrorCode::Fatal;
  18923. return -1;
  18924. }
  18925. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18926. int ret;
  18927. do {
  18928. ret = mbedtls_ssl_write(&msession->ssl,
  18929. static_cast<const unsigned char *>(buf), len);
  18930. } while (impl::mbedtls_is_session_ticket(ret));
  18931. if (ret > 0) {
  18932. err.code = ErrorCode::Success;
  18933. return static_cast<ssize_t>(ret);
  18934. }
  18935. if (ret == 0) {
  18936. err.code = ErrorCode::PeerClosed;
  18937. return 0;
  18938. }
  18939. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18940. err.backend_code = static_cast<uint64_t>(-ret);
  18941. impl::mbedtls_last_error() = ret;
  18942. return -1;
  18943. }
  18944. inline int pending(const_session_t session) {
  18945. if (!session) { return 0; }
  18946. auto msession =
  18947. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18948. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18949. (msession->has_peeked_byte ? 1 : 0);
  18950. }
  18951. inline void shutdown(session_t session, bool graceful) {
  18952. if (!session) { return; }
  18953. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18954. if (graceful) {
  18955. // Try to send close_notify, but don't block forever
  18956. int ret;
  18957. int attempts = 0;
  18958. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18959. attempts < 3) {
  18960. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18961. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18962. break;
  18963. }
  18964. attempts++;
  18965. }
  18966. }
  18967. }
  18968. inline bool is_peer_closed(session_t session, socket_t sock) {
  18969. if (!session || sock == INVALID_SOCKET) { return true; }
  18970. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18971. // Check if there's already decrypted or pushed-back data available.
  18972. // If so, the connection is definitely alive.
  18973. if (msession->has_peeked_byte ||
  18974. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18975. return false;
  18976. }
  18977. // Set socket to non-blocking to avoid blocking on read
  18978. detail::set_nonblocking(sock, true);
  18979. auto cleanup =
  18980. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18981. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18982. // on application data — e.g. a response that already arrived — push the
  18983. // byte back so the next read() delivers it instead of losing it.
  18984. unsigned char buf;
  18985. int ret;
  18986. do {
  18987. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18988. } while (impl::mbedtls_is_session_ticket(ret));
  18989. // If we got data or WANT_READ (would block), connection is alive
  18990. if (ret > 0) {
  18991. msession->peeked_byte = buf;
  18992. msession->has_peeked_byte = true;
  18993. return false;
  18994. }
  18995. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18996. // If we get a peer close notify or a connection reset, the peer is closed
  18997. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18998. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18999. }
  19000. inline cert_t get_peer_cert(const_session_t session) {
  19001. if (!session) { return nullptr; }
  19002. auto msession =
  19003. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19004. // Mbed TLS returns a pointer to the internal peer cert chain.
  19005. // WARNING: This pointer is only valid while the session is active.
  19006. // Do not use the certificate after calling free_session().
  19007. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  19008. return const_cast<mbedtls_x509_crt *>(cert);
  19009. }
  19010. inline size_t get_peer_certs(const_session_t session,
  19011. std::vector<cert_t> &certs) {
  19012. certs.clear();
  19013. // Mbed TLS parses the whole received chain into a list headed by the peer
  19014. // certificate, owned by the session like get_peer_cert()'s result
  19015. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  19016. crt && crt->raw.len > 0; crt = crt->next) {
  19017. certs.push_back(static_cast<cert_t>(crt));
  19018. }
  19019. return certs.size();
  19020. }
  19021. inline void free_cert(cert_t cert) {
  19022. // Mbed TLS: every cert_t handed out points into a session's or a context's
  19023. // chain, so there is nothing to free. Callers still call this for the other
  19024. // backends.
  19025. (void)cert;
  19026. }
  19027. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19028. if (!cert || !hostname) { return false; }
  19029. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  19030. std::string host_str(hostname);
  19031. // Check if hostname is an IP address (IPv4 or IPv6)
  19032. unsigned char ip_bytes[16];
  19033. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19034. auto is_ip = ip_len > 0;
  19035. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  19036. // in buf.tag and the raw value in buf.p / buf.len.
  19037. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  19038. if (!san->buf.p || san->buf.len == 0) { continue; }
  19039. const unsigned char *p = san->buf.p;
  19040. size_t len = san->buf.len;
  19041. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  19042. if (is_ip) {
  19043. // For an IP host, only a matching iPAddress SAN of the same family
  19044. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  19045. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  19046. memcmp(p, ip_bytes, ip_len) == 0) {
  19047. return true;
  19048. }
  19049. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  19050. std::string san_name(reinterpret_cast<const char *>(p), len);
  19051. if (detail::match_hostname(san_name, host_str)) { return true; }
  19052. }
  19053. }
  19054. return false;
  19055. }
  19056. inline uint64_t hostname_mismatch_code() {
  19057. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  19058. }
  19059. inline long get_verify_result(const_session_t session) {
  19060. if (!session) { return -1; }
  19061. auto msession =
  19062. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19063. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  19064. // Return 0 (X509_V_OK equivalent) if verification passed
  19065. return flags == 0 ? 0 : static_cast<long>(flags);
  19066. }
  19067. inline std::string get_cert_subject_cn(cert_t cert) {
  19068. if (!cert) return "";
  19069. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19070. // Find the CN in the subject
  19071. const mbedtls_x509_name *name = &x509->subject;
  19072. while (name != nullptr) {
  19073. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  19074. return std::string(reinterpret_cast<const char *>(name->val.p),
  19075. name->val.len);
  19076. }
  19077. name = name->next;
  19078. }
  19079. return "";
  19080. }
  19081. inline std::string get_cert_issuer_name(cert_t cert) {
  19082. if (!cert) return "";
  19083. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19084. // Build a human-readable issuer name string
  19085. char buf[512];
  19086. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  19087. if (ret < 0) return "";
  19088. return std::string(buf);
  19089. }
  19090. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19091. sans.clear();
  19092. if (!cert) return false;
  19093. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19094. // Parse the Subject Alternative Name extension
  19095. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  19096. while (cur != nullptr) {
  19097. if (cur->buf.len > 0) {
  19098. const unsigned char *p = cur->buf.p;
  19099. size_t value_len = cur->buf.len;
  19100. SanEntry entry;
  19101. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  19102. case MBEDTLS_X509_SAN_DNS_NAME:
  19103. entry.type = SanType::DNS;
  19104. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19105. break;
  19106. case MBEDTLS_X509_SAN_IP_ADDRESS:
  19107. entry.type = SanType::IP;
  19108. if (value_len == 4) {
  19109. // IPv4
  19110. char buf[16];
  19111. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  19112. entry.value = buf;
  19113. } else if (value_len == 16) {
  19114. // IPv6
  19115. char buf[64];
  19116. snprintf(buf, sizeof(buf),
  19117. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19118. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19119. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  19120. p[10], p[11], p[12], p[13], p[14], p[15]);
  19121. entry.value = buf;
  19122. }
  19123. break;
  19124. case MBEDTLS_X509_SAN_RFC822_NAME:
  19125. entry.type = SanType::EMAIL;
  19126. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19127. break;
  19128. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  19129. entry.type = SanType::URI;
  19130. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19131. break;
  19132. default: entry.type = SanType::OTHER; break;
  19133. }
  19134. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19135. }
  19136. cur = cur->next;
  19137. }
  19138. return true;
  19139. }
  19140. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19141. time_t &not_after) {
  19142. if (!cert) return false;
  19143. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19144. // Convert mbedtls_x509_time to time_t
  19145. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  19146. struct tm tm_time = {};
  19147. tm_time.tm_year = t.year - 1900;
  19148. tm_time.tm_mon = t.mon - 1;
  19149. tm_time.tm_mday = t.day;
  19150. tm_time.tm_hour = t.hour;
  19151. tm_time.tm_min = t.min;
  19152. tm_time.tm_sec = t.sec;
  19153. #ifdef _WIN32
  19154. return _mkgmtime(&tm_time);
  19155. #else
  19156. return timegm(&tm_time);
  19157. #endif
  19158. };
  19159. not_before = to_time_t(x509->valid_from);
  19160. not_after = to_time_t(x509->valid_to);
  19161. return true;
  19162. }
  19163. inline std::string get_cert_serial(cert_t cert) {
  19164. if (!cert) return "";
  19165. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19166. // Convert serial number to hex string
  19167. std::string result;
  19168. result.reserve(x509->serial.len * 2);
  19169. for (size_t i = 0; i < x509->serial.len; i++) {
  19170. char hex[3];
  19171. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  19172. result += hex;
  19173. }
  19174. return result;
  19175. }
  19176. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19177. if (!cert) return false;
  19178. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  19179. if (!crt->raw.p || crt->raw.len == 0) return false;
  19180. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  19181. return true;
  19182. }
  19183. inline const char *get_sni(const_session_t session) {
  19184. if (!session) return nullptr;
  19185. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  19186. // For server: return SNI received from client during handshake
  19187. if (!msession->sni_hostname.empty()) {
  19188. return msession->sni_hostname.c_str();
  19189. }
  19190. // For client: return the hostname set via set_sni
  19191. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  19192. return nullptr;
  19193. }
  19194. inline uint64_t peek_error() {
  19195. // Mbed TLS doesn't have an error queue, return the last error
  19196. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  19197. }
  19198. inline uint64_t get_error() {
  19199. // Mbed TLS doesn't have an error queue, return and clear the last error
  19200. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  19201. impl::mbedtls_last_error() = 0;
  19202. return err;
  19203. }
  19204. inline std::string error_string(uint64_t code) {
  19205. char buf[256];
  19206. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  19207. return std::string(buf);
  19208. }
  19209. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19210. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19211. // Parsing certificates needs PSA Crypto, and no context may exist yet
  19212. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  19213. #endif
  19214. if (!pem) { return nullptr; }
  19215. // mbedtls_x509_crt_parse expects null-terminated PEM
  19216. std::string pem_str(pem, len);
  19217. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  19218. if (!ca_chain) { return nullptr; }
  19219. mbedtls_x509_crt_init(ca_chain);
  19220. auto ret = mbedtls_x509_crt_parse(
  19221. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19222. pem_str.size() + 1);
  19223. if (ret != 0) {
  19224. mbedtls_x509_crt_free(ca_chain);
  19225. delete ca_chain;
  19226. return nullptr;
  19227. }
  19228. return static_cast<ca_store_t>(ca_chain);
  19229. }
  19230. inline void free_ca_store(ca_store_t store) {
  19231. if (store) {
  19232. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19233. mbedtls_x509_crt_free(ca_chain);
  19234. delete ca_chain;
  19235. }
  19236. }
  19237. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19238. if (!ctx || !store) { return false; }
  19239. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19240. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19241. // Free existing CA chain
  19242. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19243. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19244. // Copy the CA chain (deep copy)
  19245. // Parse from the raw data of the source cert
  19246. mbedtls_x509_crt *src = ca_chain;
  19247. while (src != nullptr) {
  19248. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19249. src->raw.len);
  19250. if (ret != 0) {
  19251. free_ca_store(store);
  19252. return false;
  19253. }
  19254. src = src->next;
  19255. }
  19256. // This function takes ownership of the store; the chain was deep-copied
  19257. // above, so release the source
  19258. free_ca_store(store);
  19259. // Update the SSL config to use the new CA chain
  19260. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19261. return true;
  19262. }
  19263. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19264. certs.clear();
  19265. if (!ctx) { return 0; }
  19266. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19267. // Owned by the context; see free_cert()
  19268. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19269. cert = cert->next) {
  19270. certs.push_back(static_cast<cert_t>(cert));
  19271. }
  19272. return certs.size();
  19273. }
  19274. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19275. std::vector<std::string> names;
  19276. if (!ctx) { return names; }
  19277. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19278. // Iterate through the CA chain
  19279. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19280. while (cert != nullptr && cert->raw.len > 0) {
  19281. char buf[512];
  19282. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19283. if (ret > 0) { names.push_back(buf); }
  19284. cert = cert->next;
  19285. }
  19286. return names;
  19287. }
  19288. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19289. const char *key_pem, const char *password) {
  19290. if (!ctx || !cert_pem || !key_pem) { return false; }
  19291. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19292. // Parse into new objects first, so that a bad pair leaves the old one in
  19293. // place, and swap them in after; the old ones are freed on the way out.
  19294. mbedtls_x509_crt cert;
  19295. mbedtls_pk_context key;
  19296. mbedtls_x509_crt_init(&cert);
  19297. mbedtls_pk_init(&key);
  19298. auto se = detail::scope_exit([&] {
  19299. mbedtls_x509_crt_free(&cert);
  19300. mbedtls_pk_free(&key);
  19301. });
  19302. // Parse certificate PEM
  19303. int ret = mbedtls_x509_crt_parse(
  19304. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19305. strlen(cert_pem) + 1);
  19306. if (ret != 0) {
  19307. impl::mbedtls_last_error() = ret;
  19308. return false;
  19309. }
  19310. // Parse private key PEM
  19311. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19312. ret = mbedtls_pk_parse_key(
  19313. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19314. strlen(key_pem) + 1,
  19315. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19316. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19317. &mbed_ctx->ctr_drbg);
  19318. #else
  19319. ret = mbedtls_pk_parse_key(
  19320. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19321. strlen(key_pem) + 1,
  19322. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19323. password ? strlen(password) : 0);
  19324. #endif
  19325. if (ret != 0) {
  19326. impl::mbedtls_last_error() = ret;
  19327. return false;
  19328. }
  19329. std::swap(mbed_ctx->own_cert, cert);
  19330. std::swap(mbed_ctx->own_key, key);
  19331. // Configure SSL to use the new certificate and key
  19332. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19333. &mbed_ctx->own_key);
  19334. if (ret != 0) {
  19335. impl::mbedtls_last_error() = ret;
  19336. return false;
  19337. }
  19338. return true;
  19339. }
  19340. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19341. if (!ctx || !ca_pem) { return false; }
  19342. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19343. // Parse into a new chain first, so that a bad one leaves the old in place
  19344. mbedtls_x509_crt chain;
  19345. mbedtls_x509_crt_init(&chain);
  19346. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19347. // Parse CA PEM
  19348. int ret = mbedtls_x509_crt_parse(
  19349. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19350. strlen(ca_pem) + 1);
  19351. if (ret != 0) {
  19352. impl::mbedtls_last_error() = ret;
  19353. return false;
  19354. }
  19355. std::swap(mbed_ctx->ca_chain, chain);
  19356. // Update SSL config to use new CA chain
  19357. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19358. return true;
  19359. }
  19360. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19361. if (!ctx) { return false; }
  19362. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19363. // create_session() hands each session its own copy to run.
  19364. mbed_ctx->verify_callback = std::move(callback);
  19365. impl::apply_verify_mode(*mbed_ctx);
  19366. return true;
  19367. }
  19368. inline long get_verify_error(const_session_t session) {
  19369. if (!session) { return -1; }
  19370. auto *msession =
  19371. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19372. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19373. }
  19374. inline std::string verify_error_string(long error_code) {
  19375. if (error_code == 0) { return ""; }
  19376. char buf[256];
  19377. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19378. static_cast<uint32_t>(error_code));
  19379. // Remove trailing newline if present
  19380. std::string result(buf);
  19381. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19382. result.pop_back();
  19383. }
  19384. return result;
  19385. }
  19386. } // namespace tls
  19387. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19388. /*
  19389. * Group 10: TLS abstraction layer - wolfSSL backend
  19390. */
  19391. /*
  19392. * wolfSSL Backend Implementation
  19393. */
  19394. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19395. namespace tls {
  19396. namespace impl {
  19397. // wolfSSL session wrapper
  19398. struct WolfSSLSession {
  19399. WOLFSSL *ssl = nullptr;
  19400. socket_t sock = INVALID_SOCKET;
  19401. std::string hostname; // For client: set via set_sni
  19402. std::string sni_hostname; // For server: received from client via SNI callback
  19403. WolfSSLSession() = default;
  19404. ~WolfSSLSession() {
  19405. if (ssl) { wolfSSL_free(ssl); }
  19406. }
  19407. WolfSSLSession(const WolfSSLSession &) = delete;
  19408. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19409. };
  19410. // Thread-local error code accessor for wolfSSL
  19411. inline uint64_t &wolfssl_last_error() {
  19412. static thread_local uint64_t err = 0;
  19413. return err;
  19414. }
  19415. // Helper to map wolfSSL error to ErrorCode.
  19416. // ssl_error is the value from wolfSSL_get_error().
  19417. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19418. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19419. int &out_errno) {
  19420. switch (ssl_error) {
  19421. case SSL_ERROR_NONE: return ErrorCode::Success;
  19422. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19423. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19424. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19425. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19426. // EOF without close_notify
  19427. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19428. default:
  19429. if (ssl) {
  19430. // wolfSSL stores the low-level error code as a negative value.
  19431. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19432. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19433. if (low_err == DOMAIN_NAME_MISMATCH) {
  19434. return ErrorCode::HostnameMismatch;
  19435. }
  19436. // Check verify result to distinguish cert verification from generic SSL
  19437. // errors.
  19438. long vr = wolfSSL_get_verify_result(ssl);
  19439. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19440. }
  19441. return ErrorCode::Fatal;
  19442. }
  19443. }
  19444. // WolfSSLContext constructor/destructor implementations
  19445. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19446. inline WolfSSLContext::~WolfSSLContext() {
  19447. if (ctx) { wolfSSL_CTX_free(ctx); }
  19448. }
  19449. // Thread-local storage for SNI captured during handshake
  19450. inline std::string &wolfssl_pending_sni() {
  19451. static thread_local std::string sni;
  19452. return sni;
  19453. }
  19454. // SNI callback for wolfSSL server to capture client's SNI hostname
  19455. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19456. (void)ret;
  19457. (void)exArg;
  19458. void *name_data = nullptr;
  19459. unsigned short name_len =
  19460. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19461. if (name_data && name_len > 0) {
  19462. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19463. name_len);
  19464. } else {
  19465. wolfssl_pending_sni().clear();
  19466. }
  19467. return 0; // Continue regardless
  19468. }
  19469. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19470. // runs the verify callback of its own context.
  19471. inline int context_ex_data_index() {
  19472. static const auto index =
  19473. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19474. return index;
  19475. }
  19476. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19477. // other tls:: function takes.
  19478. inline int session_ex_data_index() {
  19479. static const auto index =
  19480. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19481. return index;
  19482. }
  19483. // A resumed session skips the client's certificate, so a server that checks
  19484. // one would let in a certificate checked against another server's CA, as
  19485. // wolfSSL shares its session cache between contexts, or against a CA since
  19486. // replaced by update_server_client_ca().
  19487. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19488. if (!wctx->is_server) { return; }
  19489. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19490. #ifdef HAVE_SESSION_TICKET
  19491. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19492. #endif
  19493. }
  19494. // wolfSSL verify callback wrapper
  19495. inline int wolfssl_verify_callback(int preverify_ok,
  19496. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19497. // Get the WOLFSSL object from the X509_STORE_CTX
  19498. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19499. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19500. if (!ssl) { return preverify_ok; }
  19501. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19502. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19503. if (!wctx) { return preverify_ok; }
  19504. std::shared_ptr<VerifyCallback> callback;
  19505. {
  19506. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19507. callback = wctx->verify_callback;
  19508. }
  19509. if (!callback) { return preverify_ok; }
  19510. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19511. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19512. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19513. VerifyContext verify_ctx;
  19514. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19515. verify_ctx.cert = static_cast<cert_t>(cert);
  19516. verify_ctx.depth = depth;
  19517. verify_ctx.preverify_ok = (preverify_ok != 0);
  19518. verify_ctx.error_code = static_cast<long>(err);
  19519. if (err != 0) {
  19520. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19521. } else {
  19522. verify_ctx.error_string = nullptr;
  19523. }
  19524. auto accepted = run_verify_callback(*callback, verify_ctx);
  19525. // A client verifying the server during the handshake, which is what
  19526. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19527. if (!wolfSSL_is_server(ssl) &&
  19528. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19529. accepted = accepted && preverify_ok;
  19530. }
  19531. return accepted ? 1 : 0;
  19532. }
  19533. // Sets the verify mode from whether the peer's certificate is required and
  19534. // whether a verify callback is set.
  19535. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19536. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19537. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19538. auto mode = wctx.verify_client
  19539. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19540. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19541. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19542. has_callback ? wolfssl_verify_callback : nullptr);
  19543. }
  19544. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19545. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19546. wolfSSL_CTX_set_default_passwd_cb(
  19547. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19548. auto *pwd = static_cast<const char *>(userdata);
  19549. if (!pwd) return 0;
  19550. auto len = static_cast<int>(strlen(pwd));
  19551. if (len > size) len = size;
  19552. memcpy(buf, pwd, static_cast<size_t>(len));
  19553. return len;
  19554. });
  19555. }
  19556. } // namespace impl
  19557. inline ctx_t create_client_context() {
  19558. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19559. if (!ctx) { return nullptr; }
  19560. ctx->is_server = false;
  19561. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19562. if (!method) {
  19563. delete ctx;
  19564. return nullptr;
  19565. }
  19566. ctx->ctx = wolfSSL_CTX_new(method);
  19567. if (!ctx->ctx ||
  19568. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19569. WOLFSSL_SUCCESS) {
  19570. delete ctx;
  19571. return nullptr;
  19572. }
  19573. // Default: verify peer certificate
  19574. ctx->verify_client = true;
  19575. impl::apply_verify_mode(*ctx);
  19576. return static_cast<ctx_t>(ctx);
  19577. }
  19578. inline ctx_t create_server_context() {
  19579. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19580. if (!ctx) { return nullptr; }
  19581. ctx->is_server = true;
  19582. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19583. if (!method) {
  19584. delete ctx;
  19585. return nullptr;
  19586. }
  19587. ctx->ctx = wolfSSL_CTX_new(method);
  19588. if (!ctx->ctx ||
  19589. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19590. WOLFSSL_SUCCESS) {
  19591. delete ctx;
  19592. return nullptr;
  19593. }
  19594. // Default: don't verify client
  19595. impl::apply_verify_mode(*ctx);
  19596. // Enable SNI on server
  19597. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19598. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19599. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19600. return static_cast<ctx_t>(ctx);
  19601. }
  19602. inline void free_context(ctx_t ctx) {
  19603. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19604. }
  19605. inline bool set_min_version(ctx_t ctx, Version version) {
  19606. if (!ctx) { return false; }
  19607. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19608. int min_ver = WOLFSSL_TLSV1_2;
  19609. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19610. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19611. }
  19612. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19613. if (!ctx || !pem) { return false; }
  19614. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19615. int ret = wolfSSL_CTX_load_verify_buffer(
  19616. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19617. static_cast<long>(len), SSL_FILETYPE_PEM);
  19618. if (ret != SSL_SUCCESS) {
  19619. impl::wolfssl_last_error() =
  19620. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19621. return false;
  19622. }
  19623. wctx->ca_pem_data_.append(pem, len);
  19624. return true;
  19625. }
  19626. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19627. if (!ctx || !file_path) { return false; }
  19628. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19629. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19630. if (ret != SSL_SUCCESS) {
  19631. impl::wolfssl_last_error() =
  19632. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19633. return false;
  19634. }
  19635. return true;
  19636. }
  19637. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19638. if (!ctx || !dir_path) { return false; }
  19639. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19640. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19641. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19642. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19643. // immediately. Return true even on failure since the CA file may have
  19644. // already been loaded, matching OpenSSL's lenient behavior.
  19645. (void)ret;
  19646. return true;
  19647. }
  19648. inline bool load_system_certs(ctx_t ctx) {
  19649. if (!ctx) { return false; }
  19650. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19651. bool loaded = false;
  19652. #ifdef _WIN32
  19653. loaded = impl::enumerate_windows_system_certs(
  19654. [&](const unsigned char *data, size_t len) {
  19655. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19656. static_cast<long>(len),
  19657. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19658. });
  19659. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19660. loaded = impl::enumerate_macos_keychain_certs(
  19661. [&](const unsigned char *data, size_t len) {
  19662. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19663. static_cast<long>(len),
  19664. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19665. });
  19666. #else
  19667. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19668. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19669. SSL_SUCCESS) {
  19670. loaded = true;
  19671. break;
  19672. }
  19673. }
  19674. if (!loaded) {
  19675. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19676. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19677. SSL_SUCCESS) {
  19678. loaded = true;
  19679. break;
  19680. }
  19681. }
  19682. }
  19683. #endif
  19684. return loaded;
  19685. }
  19686. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19687. const char *password) {
  19688. if (!ctx || !cert || !key) { return false; }
  19689. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19690. // Load certificate
  19691. int ret = wolfSSL_CTX_use_certificate_buffer(
  19692. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19693. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19694. if (ret != SSL_SUCCESS) {
  19695. impl::wolfssl_last_error() =
  19696. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19697. return false;
  19698. }
  19699. // Set password callback if password is provided
  19700. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19701. // Load private key
  19702. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19703. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19704. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19705. if (ret != SSL_SUCCESS) {
  19706. impl::wolfssl_last_error() =
  19707. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19708. return false;
  19709. }
  19710. // Verify that the certificate and private key match
  19711. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19712. }
  19713. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19714. const char *key_path, const char *password) {
  19715. if (!ctx || !cert_path || !key_path) { return false; }
  19716. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19717. // Load certificate file
  19718. int ret =
  19719. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19720. if (ret != SSL_SUCCESS) {
  19721. impl::wolfssl_last_error() =
  19722. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19723. return false;
  19724. }
  19725. // Set password callback if password is provided
  19726. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19727. // Load private key file
  19728. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19729. if (ret != SSL_SUCCESS) {
  19730. impl::wolfssl_last_error() =
  19731. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19732. return false;
  19733. }
  19734. // Verify that the certificate and private key match
  19735. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19736. }
  19737. inline void set_verify_client(ctx_t ctx, bool require) {
  19738. if (!ctx) { return; }
  19739. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19740. wctx->verify_client = require;
  19741. impl::apply_verify_mode(*wctx);
  19742. }
  19743. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19744. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19745. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19746. auto session = new (std::nothrow) impl::WolfSSLSession();
  19747. if (!session) { return nullptr; }
  19748. session->sock = sock;
  19749. session->ssl = wolfSSL_new(wctx->ctx);
  19750. if (!session->ssl) {
  19751. impl::wolfssl_last_error() =
  19752. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19753. delete session;
  19754. return nullptr;
  19755. }
  19756. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19757. session) != WOLFSSL_SUCCESS) {
  19758. delete session;
  19759. return nullptr;
  19760. }
  19761. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19762. return static_cast<session_t>(session);
  19763. }
  19764. inline void free_session(session_t session) {
  19765. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19766. }
  19767. inline bool set_sni(session_t session, const char *hostname,
  19768. bool verify_hostname) {
  19769. if (!session || !hostname) { return false; }
  19770. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19771. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19772. static_cast<word16>(strlen(hostname)));
  19773. if (ret != WOLFSSL_SUCCESS) {
  19774. impl::wolfssl_last_error() =
  19775. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19776. return false;
  19777. }
  19778. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19779. // separately from the SNI extension sent above; skip it when hostname
  19780. // verification is disabled so only the chain is checked, matching OpenSSL.
  19781. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19782. wsession->hostname = hostname;
  19783. return true;
  19784. }
  19785. inline TlsError connect(session_t session) {
  19786. TlsError err;
  19787. if (!session) {
  19788. err.code = ErrorCode::Fatal;
  19789. return err;
  19790. }
  19791. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19792. int ret = wolfSSL_connect(wsession->ssl);
  19793. if (ret == SSL_SUCCESS) {
  19794. err.code = ErrorCode::Success;
  19795. } else {
  19796. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19797. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19798. err.backend_code = static_cast<uint64_t>(ssl_error);
  19799. impl::wolfssl_last_error() = err.backend_code;
  19800. }
  19801. return err;
  19802. }
  19803. inline TlsError accept(session_t session) {
  19804. TlsError err;
  19805. if (!session) {
  19806. err.code = ErrorCode::Fatal;
  19807. return err;
  19808. }
  19809. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19810. int ret = wolfSSL_accept(wsession->ssl);
  19811. if (ret == SSL_SUCCESS) {
  19812. err.code = ErrorCode::Success;
  19813. // Capture SNI from thread-local storage after successful handshake
  19814. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19815. impl::wolfssl_pending_sni().clear();
  19816. } else {
  19817. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19818. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19819. err.backend_code = static_cast<uint64_t>(ssl_error);
  19820. impl::wolfssl_last_error() = err.backend_code;
  19821. }
  19822. return err;
  19823. }
  19824. inline bool connect_nonblocking(session_t session, socket_t sock,
  19825. time_t timeout_sec, time_t timeout_usec,
  19826. TlsError *err,
  19827. const std::function<bool()> &interrupted) {
  19828. if (!session) {
  19829. if (err) { err->code = ErrorCode::Fatal; }
  19830. return false;
  19831. }
  19832. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19833. // Set socket to non-blocking mode
  19834. detail::set_nonblocking(sock, true);
  19835. auto cleanup =
  19836. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19837. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19838. int ret;
  19839. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19840. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19841. if (ssl_error == SSL_ERROR_WANT_READ) {
  19842. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  19843. continue;
  19844. }
  19845. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19846. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  19847. continue;
  19848. }
  19849. }
  19850. // Error or timeout
  19851. if (err) {
  19852. err->code =
  19853. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19854. err->backend_code = static_cast<uint64_t>(ssl_error);
  19855. }
  19856. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19857. return false;
  19858. }
  19859. if (err) { err->code = ErrorCode::Success; }
  19860. return true;
  19861. }
  19862. inline bool accept_nonblocking(session_t session, socket_t sock,
  19863. time_t timeout_sec, time_t timeout_usec,
  19864. TlsError *err) {
  19865. if (!session) {
  19866. if (err) { err->code = ErrorCode::Fatal; }
  19867. return false;
  19868. }
  19869. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19870. // Set socket to non-blocking mode
  19871. detail::set_nonblocking(sock, true);
  19872. auto cleanup =
  19873. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19874. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19875. int ret;
  19876. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19877. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19878. if (ssl_error == SSL_ERROR_WANT_READ) {
  19879. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19880. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19881. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19882. }
  19883. // Error or timeout
  19884. if (err) {
  19885. err->code =
  19886. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19887. err->backend_code = static_cast<uint64_t>(ssl_error);
  19888. }
  19889. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19890. return false;
  19891. }
  19892. if (err) { err->code = ErrorCode::Success; }
  19893. // Capture SNI from thread-local storage after successful handshake
  19894. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19895. impl::wolfssl_pending_sni().clear();
  19896. return true;
  19897. }
  19898. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19899. if (!session || !buf) {
  19900. err.code = ErrorCode::Fatal;
  19901. return -1;
  19902. }
  19903. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19904. constexpr auto max_len =
  19905. static_cast<size_t>((std::numeric_limits<int>::max)());
  19906. if (len > max_len) { len = max_len; }
  19907. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19908. if (ret > 0) {
  19909. err.code = ErrorCode::Success;
  19910. return static_cast<ssize_t>(ret);
  19911. }
  19912. // 0 is also returned for EOF without close_notify; get_error tells them apart
  19913. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19914. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19915. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19916. err.backend_code = static_cast<uint64_t>(ssl_error);
  19917. impl::wolfssl_last_error() = err.backend_code;
  19918. return -1;
  19919. }
  19920. inline ssize_t write(session_t session, const void *buf, size_t len,
  19921. TlsError &err) {
  19922. if (!session || !buf) {
  19923. err.code = ErrorCode::Fatal;
  19924. return -1;
  19925. }
  19926. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19927. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19928. if (ret > 0) {
  19929. err.code = ErrorCode::Success;
  19930. return static_cast<ssize_t>(ret);
  19931. }
  19932. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19933. // Treat this as an error (return -1) so callers don't spin in a
  19934. // write loop adding zero to the offset.
  19935. if (ret == 0) {
  19936. err.code = ErrorCode::PeerClosed;
  19937. return -1;
  19938. }
  19939. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19940. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19941. err.backend_code = static_cast<uint64_t>(ssl_error);
  19942. impl::wolfssl_last_error() = err.backend_code;
  19943. return -1;
  19944. }
  19945. inline int pending(const_session_t session) {
  19946. if (!session) { return 0; }
  19947. auto wsession =
  19948. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19949. return wolfSSL_pending(wsession->ssl);
  19950. }
  19951. inline void shutdown(session_t session, bool graceful) {
  19952. if (!session) { return; }
  19953. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19954. if (graceful) {
  19955. int ret;
  19956. int attempts = 0;
  19957. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19958. attempts < 3) {
  19959. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19960. if (ssl_error != SSL_ERROR_WANT_READ &&
  19961. ssl_error != SSL_ERROR_WANT_WRITE) {
  19962. break;
  19963. }
  19964. attempts++;
  19965. }
  19966. } else {
  19967. wolfSSL_shutdown(wsession->ssl);
  19968. }
  19969. }
  19970. inline bool is_peer_closed(session_t session, socket_t sock) {
  19971. if (!session || sock == INVALID_SOCKET) { return true; }
  19972. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19973. // Check if there's already decrypted data available
  19974. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19975. // Set socket to non-blocking to avoid blocking on read
  19976. detail::set_nonblocking(sock, true);
  19977. auto cleanup =
  19978. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19979. // Peek 1 byte to check connection status without consuming data
  19980. unsigned char buf;
  19981. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19982. // If we got data or WANT_READ (would block), connection is alive
  19983. if (ret > 0) { return false; }
  19984. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19985. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19986. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19987. ret == 0;
  19988. }
  19989. inline cert_t get_peer_cert(const_session_t session) {
  19990. if (!session) { return nullptr; }
  19991. auto wsession =
  19992. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19993. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19994. return static_cast<cert_t>(cert);
  19995. }
  19996. inline size_t get_peer_certs(const_session_t session,
  19997. std::vector<cert_t> &certs) {
  19998. certs.clear();
  19999. if (!session) { return 0; }
  20000. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  20001. #ifdef SESSION_CERTS
  20002. auto wsession =
  20003. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20004. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  20005. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  20006. for (int i = 0; i < count; i++) {
  20007. auto x509 = wolfSSL_get_chain_X509(chain, i);
  20008. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20009. }
  20010. #endif
  20011. return certs.size();
  20012. }
  20013. inline void free_cert(cert_t cert) {
  20014. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  20015. }
  20016. inline bool verify_hostname(cert_t cert, const char *hostname) {
  20017. if (!cert || !hostname) { return false; }
  20018. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20019. std::string host_str(hostname);
  20020. // Check if hostname is an IP address (IPv4 or IPv6)
  20021. unsigned char ip_bytes[16];
  20022. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  20023. auto is_ip = ip_len > 0;
  20024. // Check Subject Alternative Names
  20025. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20026. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20027. if (san_names) {
  20028. int san_count = wolfSSL_sk_num(san_names);
  20029. for (int i = 0; i < san_count; i++) {
  20030. auto *names =
  20031. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20032. if (!names) continue;
  20033. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  20034. // DNS name
  20035. unsigned char *dns_name = nullptr;
  20036. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  20037. if (dns_name && dns_len > 0) {
  20038. std::string san_name(reinterpret_cast<char *>(dns_name),
  20039. static_cast<size_t>(dns_len));
  20040. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20041. if (detail::match_hostname(san_name, host_str)) {
  20042. wolfSSL_sk_free(san_names);
  20043. return true;
  20044. }
  20045. }
  20046. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  20047. // IP address: only an iPAddress SAN of the same family (4 bytes for
  20048. // IPv4, 16 bytes for IPv6) may authenticate the host.
  20049. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  20050. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  20051. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  20052. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  20053. wolfSSL_sk_free(san_names);
  20054. return true;
  20055. }
  20056. }
  20057. }
  20058. wolfSSL_sk_free(san_names);
  20059. }
  20060. return false;
  20061. }
  20062. inline uint64_t hostname_mismatch_code() {
  20063. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  20064. }
  20065. inline long get_verify_result(const_session_t session) {
  20066. if (!session) { return -1; }
  20067. auto wsession =
  20068. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20069. long result = wolfSSL_get_verify_result(wsession->ssl);
  20070. return result;
  20071. }
  20072. inline std::string get_cert_subject_cn(cert_t cert) {
  20073. if (!cert) return "";
  20074. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20075. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20076. if (!subject) return "";
  20077. char cn[256] = {};
  20078. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  20079. sizeof(cn));
  20080. if (cn_len <= 0) return "";
  20081. return std::string(cn, static_cast<size_t>(cn_len));
  20082. }
  20083. inline std::string get_cert_issuer_name(cert_t cert) {
  20084. if (!cert) return "";
  20085. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20086. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  20087. if (!issuer) return "";
  20088. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  20089. if (!name_str) return "";
  20090. std::string result(name_str);
  20091. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20092. return result;
  20093. }
  20094. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  20095. sans.clear();
  20096. if (!cert) return false;
  20097. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20098. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20099. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20100. if (!san_names) return true; // No SANs is not an error
  20101. int count = wolfSSL_sk_num(san_names);
  20102. for (int i = 0; i < count; i++) {
  20103. auto *name =
  20104. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20105. if (!name) continue;
  20106. SanEntry entry;
  20107. switch (name->type) {
  20108. case WOLFSSL_GEN_DNS: {
  20109. entry.type = SanType::DNS;
  20110. unsigned char *dns_name = nullptr;
  20111. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  20112. if (dns_name && dns_len > 0) {
  20113. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  20114. static_cast<size_t>(dns_len));
  20115. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20116. }
  20117. break;
  20118. }
  20119. case WOLFSSL_GEN_IPADD: {
  20120. entry.type = SanType::IP;
  20121. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  20122. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  20123. if (ip_data && ip_len == 4) {
  20124. char buf[16];
  20125. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  20126. ip_data[2], ip_data[3]);
  20127. entry.value = buf;
  20128. } else if (ip_data && ip_len == 16) {
  20129. char buf[64];
  20130. snprintf(buf, sizeof(buf),
  20131. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  20132. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  20133. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  20134. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  20135. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  20136. ip_data[14], ip_data[15]);
  20137. entry.value = buf;
  20138. }
  20139. break;
  20140. }
  20141. case WOLFSSL_GEN_EMAIL:
  20142. entry.type = SanType::EMAIL;
  20143. {
  20144. unsigned char *email = nullptr;
  20145. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  20146. if (email && email_len > 0) {
  20147. entry.value = std::string(reinterpret_cast<char *>(email),
  20148. static_cast<size_t>(email_len));
  20149. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  20150. }
  20151. }
  20152. break;
  20153. case WOLFSSL_GEN_URI:
  20154. entry.type = SanType::URI;
  20155. {
  20156. unsigned char *uri = nullptr;
  20157. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  20158. &uri, name->d.uniformResourceIdentifier);
  20159. if (uri && uri_len > 0) {
  20160. entry.value = std::string(reinterpret_cast<char *>(uri),
  20161. static_cast<size_t>(uri_len));
  20162. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  20163. }
  20164. }
  20165. break;
  20166. default: entry.type = SanType::OTHER; break;
  20167. }
  20168. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  20169. }
  20170. wolfSSL_sk_free(san_names);
  20171. return true;
  20172. }
  20173. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  20174. time_t &not_after) {
  20175. if (!cert) return false;
  20176. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20177. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  20178. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  20179. if (!nb || !na) return false;
  20180. // wolfSSL_ASN1_TIME_to_tm is available
  20181. struct tm tm_nb = {}, tm_na = {};
  20182. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  20183. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  20184. #ifdef _WIN32
  20185. not_before = _mkgmtime(&tm_nb);
  20186. not_after = _mkgmtime(&tm_na);
  20187. #else
  20188. not_before = timegm(&tm_nb);
  20189. not_after = timegm(&tm_na);
  20190. #endif
  20191. return true;
  20192. }
  20193. inline std::string get_cert_serial(cert_t cert) {
  20194. if (!cert) return "";
  20195. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20196. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  20197. if (!serial_asn1) return "";
  20198. // Get the serial number data
  20199. int len = serial_asn1->length;
  20200. unsigned char *data = serial_asn1->data;
  20201. if (!data || len <= 0) return "";
  20202. std::string result;
  20203. result.reserve(static_cast<size_t>(len) * 2);
  20204. for (int i = 0; i < len; i++) {
  20205. char hex[3];
  20206. snprintf(hex, sizeof(hex), "%02X", data[i]);
  20207. result += hex;
  20208. }
  20209. return result;
  20210. }
  20211. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20212. if (!cert) return false;
  20213. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20214. int der_len = 0;
  20215. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  20216. if (!der_data || der_len <= 0) return false;
  20217. der.assign(der_data, der_data + der_len);
  20218. return true;
  20219. }
  20220. inline const char *get_sni(const_session_t session) {
  20221. if (!session) return nullptr;
  20222. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  20223. // For server: return SNI received from client during handshake
  20224. if (!wsession->sni_hostname.empty()) {
  20225. return wsession->sni_hostname.c_str();
  20226. }
  20227. // For client: return the hostname set via set_sni
  20228. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  20229. return nullptr;
  20230. }
  20231. inline uint64_t peek_error() {
  20232. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20233. }
  20234. inline uint64_t get_error() {
  20235. uint64_t err = impl::wolfssl_last_error();
  20236. impl::wolfssl_last_error() = 0;
  20237. return err;
  20238. }
  20239. inline std::string error_string(uint64_t code) {
  20240. char buf[256];
  20241. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20242. return std::string(buf);
  20243. }
  20244. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20245. if (!pem || len == 0) { return nullptr; }
  20246. // Validate by attempting to load into a temporary ctx
  20247. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20248. if (!tmp_ctx) { return nullptr; }
  20249. int ret = wolfSSL_CTX_load_verify_buffer(
  20250. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20251. static_cast<long>(len), SSL_FILETYPE_PEM);
  20252. wolfSSL_CTX_free(tmp_ctx);
  20253. if (ret != SSL_SUCCESS) { return nullptr; }
  20254. return static_cast<ca_store_t>(
  20255. new impl::WolfSSLCAStore{std::string(pem, len)});
  20256. }
  20257. inline void free_ca_store(ca_store_t store) {
  20258. delete static_cast<impl::WolfSSLCAStore *>(store);
  20259. }
  20260. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20261. if (!ctx || !store) { return false; }
  20262. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20263. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20264. int ret = wolfSSL_CTX_load_verify_buffer(
  20265. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20266. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20267. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20268. // This function takes ownership of the store; the PEM data was copied into
  20269. // the context, so release the source
  20270. free_ca_store(store);
  20271. return ret == SSL_SUCCESS;
  20272. }
  20273. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20274. certs.clear();
  20275. if (!ctx) { return 0; }
  20276. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20277. if (wctx->ca_pem_data_.empty()) { return 0; }
  20278. const std::string &pem = wctx->ca_pem_data_;
  20279. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20280. const std::string end_marker = "-----END CERTIFICATE-----";
  20281. size_t pos = 0;
  20282. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20283. size_t end_pos = pem.find(end_marker, pos);
  20284. if (end_pos == std::string::npos) { break; }
  20285. end_pos += end_marker.size();
  20286. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20287. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20288. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20289. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20290. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20291. pos = end_pos;
  20292. }
  20293. return certs.size();
  20294. }
  20295. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20296. std::vector<std::string> names;
  20297. if (!ctx) { return names; }
  20298. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20299. if (wctx->ca_pem_data_.empty()) { return names; }
  20300. const std::string &pem = wctx->ca_pem_data_;
  20301. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20302. const std::string end_marker = "-----END CERTIFICATE-----";
  20303. size_t pos = 0;
  20304. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20305. size_t end_pos = pem.find(end_marker, pos);
  20306. if (end_pos == std::string::npos) { break; }
  20307. end_pos += end_marker.size();
  20308. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20309. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20310. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20311. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20312. if (x509) {
  20313. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20314. if (subject) {
  20315. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20316. if (name_str) {
  20317. names.push_back(name_str);
  20318. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20319. }
  20320. }
  20321. wolfSSL_X509_free(x509);
  20322. }
  20323. pos = end_pos;
  20324. }
  20325. return names;
  20326. }
  20327. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20328. const char *key_pem, const char *password) {
  20329. if (!ctx || !cert_pem || !key_pem) { return false; }
  20330. // Try the pair on a scratch context first, so that a bad one leaves the
  20331. // server's certificate and key as they were
  20332. auto tmp = create_server_context();
  20333. if (!tmp) { return false; }
  20334. auto se = detail::scope_exit([&] { free_context(tmp); });
  20335. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20336. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20337. }
  20338. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20339. if (!ctx || !ca_pem) { return false; }
  20340. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20341. // Replace the CAs rather than add to them, as the other backends do, once
  20342. // the new ones are known to load
  20343. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20344. if (!store) { return false; }
  20345. free_ca_store(store);
  20346. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20347. wctx->ca_pem_data_.clear();
  20348. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20349. }
  20350. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20351. if (!ctx) { return false; }
  20352. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20353. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20354. : nullptr;
  20355. {
  20356. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20357. // A handshake running the previous callback keeps it until it returns.
  20358. wctx->verify_callback.swap(stored);
  20359. }
  20360. impl::apply_verify_mode(*wctx);
  20361. return true;
  20362. }
  20363. inline long get_verify_error(const_session_t session) {
  20364. if (!session) { return -1; }
  20365. auto *wsession =
  20366. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20367. return wolfSSL_get_verify_result(wsession->ssl);
  20368. }
  20369. inline std::string verify_error_string(long error_code) {
  20370. if (error_code == 0) { return ""; }
  20371. const char *str =
  20372. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20373. return str ? std::string(str) : std::string();
  20374. }
  20375. } // namespace tls
  20376. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20377. // WebSocket implementation
  20378. namespace ws {
  20379. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20380. bool fin) {
  20381. std::lock_guard<std::mutex> lock(write_mutex_);
  20382. if (closed_) { return false; }
  20383. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20384. }
  20385. inline ReadResult WebSocket::read(std::string &msg) {
  20386. // Answers a control frame; any other opcode here is a protocol error.
  20387. // Returns false when the connection is done.
  20388. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20389. switch (op) {
  20390. case Opcode::Ping: {
  20391. std::lock_guard<std::mutex> lock(write_mutex_);
  20392. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20393. payload.size(), true, !is_server_);
  20394. return true;
  20395. }
  20396. case Opcode::Pong: {
  20397. std::lock_guard<std::mutex> lock(ping_mutex_);
  20398. unacked_pings_ = 0;
  20399. return true;
  20400. }
  20401. case Opcode::Close: {
  20402. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20403. // malformed, which is answered with a protocol error instead.
  20404. if (closed_.exchange(true)) { return false; }
  20405. auto reply = payload;
  20406. if (!impl::is_valid_close_payload(payload)) {
  20407. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20408. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20409. }
  20410. std::lock_guard<std::mutex> lock(write_mutex_);
  20411. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20412. reply.size(), true, !is_server_);
  20413. return false;
  20414. }
  20415. default: closed_ = true; return false;
  20416. }
  20417. };
  20418. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20419. // A server going down closes the connection rather than wait on it: its
  20420. // listen() waits for this handler to return.
  20421. auto going_away = [&]() -> ReadResult {
  20422. read_lock.unlock();
  20423. close(CloseStatus::GoingAway, "server stopping");
  20424. return Fail;
  20425. };
  20426. // close() ends the read, even while the peer keeps sending fragments
  20427. while (!closed_) {
  20428. Opcode opcode;
  20429. std::string payload;
  20430. bool fin;
  20431. // While a message is assembled, only what is left of the limit, but room
  20432. // for a control frame, which may come between its fragments.
  20433. auto max_len =
  20434. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0 || message_kind_ == Fail
  20435. ? size_t(CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)
  20436. : (std::max)(size_t(125), CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20437. message_.size());
  20438. auto r = frames_.read(strm_, opcode, payload, fin, is_server_, max_len);
  20439. if (r != impl::FrameRead::Ok && server_stopping()) { return going_away(); }
  20440. // A timeout leaves what was read of the frame and of the message for the
  20441. // next read(), so the connection is still usable wherever it landed: hand
  20442. // control back without closing it. That is only useful to a caller who
  20443. // asked for the timeout; the compile-time default is a backstop against a
  20444. // peer gone quiet, and elapsing it closes the connection so a plain
  20445. // `while (ws.read(msg))` loop ends. A wait that a pong timeout cut short
  20446. // finds the connection closed.
  20447. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20448. return Timeout;
  20449. }
  20450. if (r != impl::FrameRead::Ok) {
  20451. closed_ = true;
  20452. return Fail;
  20453. }
  20454. auto continues = opcode == Opcode::Continuation;
  20455. if (opcode != Opcode::Text && opcode != Opcode::Binary && !continues) {
  20456. if (handle_control(opcode, payload)) { continue; }
  20457. return Fail;
  20458. }
  20459. // RFC 6455 5.4: a message is a Text or Binary frame and the continuation
  20460. // frames after it, with only control frames between them.
  20461. if (continues == (message_kind_ == Fail)) {
  20462. closed_ = true;
  20463. return Fail;
  20464. }
  20465. if (continues) {
  20466. message_ += payload;
  20467. } else {
  20468. message_ = std::move(payload);
  20469. message_kind_ = opcode == Opcode::Text ? Text : Binary;
  20470. }
  20471. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20472. message_.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20473. closed_ = true;
  20474. return Fail;
  20475. }
  20476. if (!fin) { continue; }
  20477. auto result = message_kind_;
  20478. msg = std::move(message_);
  20479. message_.clear();
  20480. message_kind_ = Fail;
  20481. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20482. if (result == Text && !impl::is_valid_utf8(msg)) {
  20483. // close() takes the read lock to wait for the peer's Close reply, so
  20484. // it must not run while this thread still holds it.
  20485. read_lock.unlock();
  20486. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20487. return Fail;
  20488. }
  20489. return result;
  20490. }
  20491. return Fail;
  20492. }
  20493. inline bool WebSocket::send(const std::string &data) {
  20494. return send_frame(Opcode::Text, data.data(), data.size());
  20495. }
  20496. inline bool WebSocket::send(const char *data, size_t len) {
  20497. return send_frame(Opcode::Binary, data, len);
  20498. }
  20499. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20500. if (closed_.exchange(true)) { return; }
  20501. ping_cv_.notify_all();
  20502. std::string payload;
  20503. auto code = static_cast<uint16_t>(status);
  20504. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20505. payload.push_back(static_cast<char>(code & 0xFF));
  20506. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20507. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20508. // cut back to a whole UTF-8 character
  20509. auto short_reason = reason.substr(0, 123);
  20510. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20511. short_reason.pop_back();
  20512. }
  20513. payload += short_reason;
  20514. // A code that may not be sent, such as NoStatus, goes without a payload
  20515. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20516. {
  20517. std::lock_guard<std::mutex> lock(write_mutex_);
  20518. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20519. payload.size(), true, !is_server_);
  20520. }
  20521. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20522. // Close response before closing the TCP connection.
  20523. //
  20524. // Wait only when no other thread is parsing frames. When one is, it is the
  20525. // thread positioned to see the peer's reply, and reading here would take
  20526. // bytes out of the message it is assembling. Bailing out also leaves the
  20527. // stream, including its read timeout, entirely to that thread.
  20528. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20529. if (!read_lock.owns_lock()) { return; }
  20530. // A max timeout turns a negative (unbounded) read timeout into 0
  20531. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20532. strm_.set_max_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND * 1000);
  20533. // The max timeout cuts a trickled frame short, the deadline a frame flood
  20534. auto deadline =
  20535. detail::deadline_after(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20536. // From where the last read() left the stream, inside a frame as it may be
  20537. Opcode op;
  20538. std::string resp;
  20539. bool fin;
  20540. while (std::chrono::steady_clock::now() < deadline &&
  20541. frames_.read(strm_, op, resp, fin, is_server_, 125) ==
  20542. impl::FrameRead::Ok) {
  20543. if (op == Opcode::Close) { break; }
  20544. }
  20545. }
  20546. inline WebSocket::~WebSocket() {
  20547. {
  20548. std::lock_guard<std::mutex> lock(ping_mutex_);
  20549. closed_ = true;
  20550. }
  20551. ping_cv_.notify_all();
  20552. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20553. // A server's stream outlives this object
  20554. strm_.set_read_interrupt(nullptr);
  20555. }
  20556. // A pong timeout ends a read() blocked on the silent peer, and so does the
  20557. // server stopping: its listen() waits for every handler to return.
  20558. inline void WebSocket::interrupt_reads() {
  20559. auto watches_pongs = ping_interval_sec_ > 0 && max_missed_pongs_ > 0;
  20560. if (!watches_pongs && !server_stopping_) { return; }
  20561. strm_.set_read_interrupt(
  20562. [this] { return pong_timed_out_.load() || server_stopping(); });
  20563. }
  20564. inline void WebSocket::start_heartbeat() {
  20565. if (ping_interval_sec_ <= 0) { return; }
  20566. ping_thread_ = std::thread([this]() {
  20567. std::unique_lock<std::mutex> lock(ping_mutex_);
  20568. // The predicate keeps a spurious wakeup from sending a ping early
  20569. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20570. [this]() { return closed_.load(); })) {
  20571. // If the peer has failed to respond to the previous pings, give up.
  20572. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20573. // opt-in liveness check controlled by max_missed_pongs_.
  20574. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20575. lock.unlock();
  20576. close(CloseStatus::GoingAway, "pong timeout");
  20577. pong_timed_out_ = true;
  20578. return;
  20579. }
  20580. lock.unlock();
  20581. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20582. lock.lock();
  20583. closed_ = true;
  20584. break;
  20585. }
  20586. lock.lock();
  20587. unacked_pings_++;
  20588. }
  20589. });
  20590. }
  20591. inline const Request &WebSocket::request() const { return req_; }
  20592. inline bool WebSocket::is_open() const { return !closed_; }
  20593. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20594. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20595. // poll(), where 0 would instead mean "return immediately", so hand it the
  20596. // negative poll uses for an unbounded wait.
  20597. if (sec == 0 && usec == 0) { sec = -1; }
  20598. strm_.set_read_timeout(sec, usec);
  20599. read_timeout_set_ = true;
  20600. }
  20601. // WebSocketClient implementation
  20602. inline WebSocketClient::WebSocketClient(
  20603. const std::string &scheme_host_port_path, const Headers &headers)
  20604. : headers_(headers) {
  20605. detail::UrlComponents uc;
  20606. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20607. !uc.host.empty() && !uc.path.empty()) {
  20608. auto &scheme = uc.scheme;
  20609. #ifdef CPPHTTPLIB_SSL_ENABLED
  20610. if (scheme != "ws" && scheme != "wss") {
  20611. #else
  20612. if (scheme != "ws") {
  20613. #endif
  20614. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20615. std::string msg = "'" + scheme + "' scheme is not supported.";
  20616. throw std::invalid_argument(msg);
  20617. #endif
  20618. return;
  20619. }
  20620. auto is_ssl = scheme == "wss";
  20621. host_ = std::move(uc.host);
  20622. port_ = is_ssl ? 443 : 80;
  20623. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20624. path_ = std::move(uc.path);
  20625. if (!uc.query.empty()) { path_ += uc.query; }
  20626. #ifdef CPPHTTPLIB_SSL_ENABLED
  20627. is_ssl_ = is_ssl;
  20628. if (is_ssl_) {
  20629. // The context lives as long as the client so that CA configuration
  20630. // survives reconnects; sessions are created per connection.
  20631. tls_ctx_ = tls::create_client_context();
  20632. if (!tls_ctx_) { return; }
  20633. }
  20634. #else
  20635. if (is_ssl) { return; }
  20636. #endif
  20637. is_valid_ = true;
  20638. }
  20639. }
  20640. #ifdef CPPHTTPLIB_SSL_ENABLED
  20641. inline WebSocketClient::WebSocketClient(
  20642. const std::string &scheme_host_port_path, const PemMemory &pem,
  20643. const Headers &headers)
  20644. : WebSocketClient(scheme_host_port_path, headers) {
  20645. // For ws:// URLs the client certificate is silently ignored, consistent
  20646. // with the TLS-only setters such as set_ca_cert_path().
  20647. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20648. std::string cert_buf, key_buf;
  20649. if (!tls::set_client_cert_pem(
  20650. tls_ctx_,
  20651. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20652. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20653. pem.private_key_password)) {
  20654. tls::free_context(tls_ctx_);
  20655. tls_ctx_ = nullptr;
  20656. is_valid_ = false;
  20657. }
  20658. }
  20659. }
  20660. #endif
  20661. inline WebSocketClient::~WebSocketClient() {
  20662. shutdown_and_close();
  20663. #ifdef CPPHTTPLIB_SSL_ENABLED
  20664. if (tls_ctx_) {
  20665. tls::free_context(tls_ctx_);
  20666. tls_ctx_ = nullptr;
  20667. }
  20668. #endif
  20669. }
  20670. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20671. inline void WebSocketClient::shutdown_and_close() {
  20672. // Send the close frame while the TLS session is still alive: ws_ holds an
  20673. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20674. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20675. if (ws_ && ws_->is_open()) { ws_->close(); }
  20676. ws_.reset();
  20677. #ifdef CPPHTTPLIB_SSL_ENABLED
  20678. if (is_ssl_) {
  20679. if (tls_session_) {
  20680. tls::shutdown(tls_session_, true);
  20681. tls::free_session(tls_session_);
  20682. tls_session_ = nullptr;
  20683. }
  20684. }
  20685. #endif
  20686. if (sock_ != INVALID_SOCKET) {
  20687. detail::shutdown_socket(sock_);
  20688. detail::close_socket(sock_);
  20689. sock_ = INVALID_SOCKET;
  20690. }
  20691. }
  20692. // The handshakes belong to establishing the connection, so an unset read
  20693. // timeout leaves them bounded by the connection timeout instead of forever.
  20694. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20695. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20696. return {connection_timeout_sec_, connection_timeout_usec_};
  20697. }
  20698. return {read_timeout_sec_, read_timeout_usec_};
  20699. }
  20700. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20701. Error &error, int &ssl_error,
  20702. uint64_t &ssl_backend_error) {
  20703. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20704. // The streams wait with poll(), where 0 instead means "return immediately",
  20705. // so they are given the negative poll uses for an unbounded wait.
  20706. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20707. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20708. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20709. #ifdef CPPHTTPLIB_SSL_ENABLED
  20710. if (is_ssl_) {
  20711. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20712. // is not safe to call concurrently on one client to begin with, since
  20713. // nothing else here is guarded either.
  20714. if (server_certificate_verification_ && !certs_loaded_) {
  20715. uint64_t backend_error = 0;
  20716. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20717. ca_cert_dir_path_, custom_ca_loaded_,
  20718. system_ca_mode_, backend_error);
  20719. certs_loaded_ = true;
  20720. }
  20721. detail::ClientTlsSessionOptions options;
  20722. options.server_hostname_verification = server_hostname_verification_;
  20723. options.session_verifier = session_verifier_;
  20724. auto timeout = handshake_timeout();
  20725. detail::ClientTlsSessionError tls_error;
  20726. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20727. server_certificate_verification_,
  20728. timeout.first, timeout.second,
  20729. &tls_error, options)) {
  20730. error = tls_error.error;
  20731. ssl_error = tls_error.ssl_error;
  20732. ssl_backend_error = tls_error.backend_error;
  20733. return false;
  20734. }
  20735. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20736. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20737. write_timeout_usec_));
  20738. return true;
  20739. }
  20740. #else
  20741. (void)error;
  20742. (void)ssl_error;
  20743. (void)ssl_backend_error;
  20744. #endif
  20745. strm = std::unique_ptr<Stream>(
  20746. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20747. write_timeout_sec_, write_timeout_usec_));
  20748. return true;
  20749. }
  20750. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20751. #ifdef CPPHTTPLIB_SSL_ENABLED
  20752. auto is_ssl = is_ssl_;
  20753. #else
  20754. auto is_ssl = false;
  20755. #endif
  20756. if (!req.has_header("Host")) {
  20757. req.headers.emplace("Host", detail::make_default_host_header_value(
  20758. host_, port_, is_ssl, address_family_));
  20759. }
  20760. detail::add_default_user_agent_header(req);
  20761. detail::add_authorization_header(req, basic_auth_username_,
  20762. basic_auth_password_,
  20763. bearer_token_auth_token_, false);
  20764. }
  20765. inline Result WebSocketClient::connect() {
  20766. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20767. shutdown_and_close();
  20768. auto error = Error::Success;
  20769. if (!create_and_connect_socket(error)) {
  20770. return Result{error, -1, Headers{}};
  20771. }
  20772. if (is_proxy_enabled()) {
  20773. Response proxy_res;
  20774. if (!connect_with_proxy(proxy_res, error)) {
  20775. shutdown_and_close();
  20776. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20777. }
  20778. }
  20779. std::unique_ptr<Stream> strm;
  20780. auto stream_error = Error::SSLConnection;
  20781. int ssl_error = 0;
  20782. uint64_t ssl_backend_error = 0;
  20783. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20784. shutdown_and_close();
  20785. #ifdef CPPHTTPLIB_SSL_ENABLED
  20786. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20787. #else
  20788. return Result{stream_error, -1, Headers{}};
  20789. #endif
  20790. }
  20791. Request req;
  20792. req.method = "GET";
  20793. req.path = path_;
  20794. req.headers = headers_;
  20795. prepare_default_headers(req);
  20796. detail::WebSocketUpgradeResponse upgrade;
  20797. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20798. shutdown_and_close();
  20799. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20800. }
  20801. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20802. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20803. websocket_ping_interval_sec_,
  20804. websocket_max_missed_pongs_));
  20805. // The stream was created with the timeout already; tell the WebSocket
  20806. // whether it came from the caller, so read() knows to report it as Timeout.
  20807. ws_->read_timeout_set_ = read_timeout_set_;
  20808. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20809. }
  20810. inline ReadResult WebSocketClient::read(std::string &msg) {
  20811. if (!ws_) { return Fail; }
  20812. return ws_->read(msg);
  20813. }
  20814. inline bool WebSocketClient::send(const std::string &data) {
  20815. if (!ws_) { return false; }
  20816. return ws_->send(data);
  20817. }
  20818. inline bool WebSocketClient::send(const char *data, size_t len) {
  20819. if (!ws_) { return false; }
  20820. return ws_->send(data, len);
  20821. }
  20822. inline void WebSocketClient::close(CloseStatus status,
  20823. const std::string &reason) {
  20824. if (ws_) { ws_->close(status, reason); }
  20825. }
  20826. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20827. inline const std::string &WebSocketClient::subprotocol() const {
  20828. return subprotocol_;
  20829. }
  20830. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20831. read_timeout_sec_ = sec;
  20832. read_timeout_usec_ = usec;
  20833. read_timeout_set_ = true;
  20834. // The members above only seed the next connect(); read() consults the
  20835. // stream, so an already-open connection has to be told directly.
  20836. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20837. }
  20838. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20839. write_timeout_sec_ = sec;
  20840. write_timeout_usec_ = usec;
  20841. }
  20842. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20843. websocket_ping_interval_sec_ = sec;
  20844. }
  20845. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20846. websocket_max_missed_pongs_ = count;
  20847. }
  20848. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20849. inline void WebSocketClient::set_address_family(int family) {
  20850. address_family_ = family;
  20851. }
  20852. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20853. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20854. socket_options_ = std::move(socket_options);
  20855. }
  20856. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20857. connection_timeout_sec_ = sec;
  20858. connection_timeout_usec_ = usec;
  20859. }
  20860. inline void WebSocketClient::set_interface(const std::string &intf) {
  20861. interface_ = intf;
  20862. }
  20863. inline void WebSocketClient::set_hostname_addr_map(
  20864. std::map<std::string, std::string> addr_map) {
  20865. set_direct_hostname_addr_map(std::move(addr_map));
  20866. }
  20867. inline void WebSocketClient::set_direct_hostname_addr_map(
  20868. std::map<std::string, std::string> addr_map) {
  20869. addr_map_ = std::move(addr_map);
  20870. }
  20871. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  20872. std::map<std::string, std::string> addr_map) {
  20873. tunnel_addr_map_ = std::move(addr_map);
  20874. }
  20875. inline bool WebSocketClient::is_proxy_enabled() const {
  20876. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20877. if (no_proxy_entries_.empty()) { return true; }
  20878. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20879. no_proxy_entries_);
  20880. }
  20881. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20882. std::string connect_host;
  20883. std::string ip;
  20884. auto port = port_;
  20885. if (is_proxy_enabled()) {
  20886. connect_host = proxy_host_;
  20887. port = proxy_port_;
  20888. } else {
  20889. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20890. }
  20891. sock_ = detail::create_client_socket(
  20892. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20893. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20894. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20895. write_timeout_usec_, interface_, error);
  20896. if (sock_ != INVALID_SOCKET) { return true; }
  20897. if (error == Error::Success) { error = Error::Connection; }
  20898. return false;
  20899. }
  20900. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20901. Response &proxy_res,
  20902. Error &error) {
  20903. auto timeout = handshake_timeout();
  20904. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20905. write_timeout_sec_, write_timeout_usec_);
  20906. if (!detail::write_request_head(strm, req, error)) { return false; }
  20907. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20908. error = Error::Read;
  20909. return false;
  20910. }
  20911. return true;
  20912. }
  20913. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20914. // forward an Upgrade request.
  20915. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20916. Error &error) {
  20917. Request req;
  20918. req.method = "CONNECT";
  20919. req.path =
  20920. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  20921. req.headers.emplace("Host", req.path);
  20922. detail::add_default_user_agent_header(req);
  20923. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20924. proxy_basic_auth_password_,
  20925. proxy_bearer_token_auth_token_, true);
  20926. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20927. #ifdef CPPHTTPLIB_SSL_ENABLED
  20928. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20929. std::map<std::string, std::string> auth;
  20930. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20931. !proxy_digest_auth_username_.empty() &&
  20932. !proxy_digest_auth_password_.empty() &&
  20933. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20934. proxy_res = Response();
  20935. shutdown_and_close();
  20936. if (!create_and_connect_socket(error)) { return false; }
  20937. req.headers.erase("Proxy-Authorization");
  20938. req.headers.insert(detail::make_digest_authentication_header(
  20939. req, req.path, auth, 1, detail::random_string(10),
  20940. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20941. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20942. }
  20943. #endif
  20944. if (proxy_res.status != StatusCode::OK_200) {
  20945. error = Error::ProxyConnection;
  20946. return false;
  20947. }
  20948. return true;
  20949. }
  20950. inline void WebSocketClient::set_basic_auth(const std::string &username,
  20951. const std::string &password) {
  20952. basic_auth_username_ = username;
  20953. basic_auth_password_ = password;
  20954. }
  20955. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  20956. bearer_token_auth_token_ = token;
  20957. }
  20958. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20959. proxy_host_ = host;
  20960. proxy_port_ = port;
  20961. }
  20962. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20963. const std::string &password) {
  20964. proxy_basic_auth_username_ = username;
  20965. proxy_basic_auth_password_ = password;
  20966. }
  20967. inline void
  20968. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20969. proxy_bearer_token_auth_token_ = token;
  20970. }
  20971. inline void
  20972. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20973. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20974. }
  20975. #ifdef CPPHTTPLIB_SSL_ENABLED
  20976. inline void
  20977. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20978. const std::string &ca_cert_dir_path) {
  20979. ca_cert_file_path_ = ca_cert_file_path;
  20980. ca_cert_dir_path_ = ca_cert_dir_path;
  20981. }
  20982. inline void
  20983. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20984. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20985. }
  20986. inline void WebSocketClient::set_session_verifier(
  20987. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20988. session_verifier_ = std::move(verifier);
  20989. }
  20990. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20991. if (store && tls_ctx_) {
  20992. // set_ca_store takes ownership of store
  20993. tls::set_ca_store(tls_ctx_, store);
  20994. } else if (store) {
  20995. tls::free_ca_store(store);
  20996. }
  20997. custom_ca_loaded_ = true;
  20998. }
  20999. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  21000. std::size_t size) {
  21001. if (tls_ctx_ && ca_cert && size > 0) {
  21002. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  21003. }
  21004. custom_ca_loaded_ = true;
  21005. }
  21006. inline void
  21007. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  21008. server_certificate_verification_ = enabled;
  21009. }
  21010. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  21011. server_hostname_verification_ = enabled;
  21012. }
  21013. inline void WebSocketClient::enable_system_ca(bool enabled) {
  21014. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  21015. }
  21016. inline void
  21017. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  21018. const std::string &password) {
  21019. proxy_digest_auth_username_ = username;
  21020. proxy_digest_auth_password_ = password;
  21021. }
  21022. #endif // CPPHTTPLIB_SSL_ENABLED
  21023. } // namespace ws
  21024. // ----------------------------------------------------------------------------
  21025. } // namespace httplib
  21026. #endif // CPPHTTPLIB_HTTPLIB_H