httplib.h 852 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615
  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. // Schemes are case-insensitive (RFC 3986 3.1)
  769. uc.scheme = case_ignore::to_lower(url.substr(0, sep));
  770. // Scheme must be [a-z]+ only
  771. if (uc.scheme.empty()) { return false; }
  772. for (auto c : uc.scheme) {
  773. if (c < 'a' || c > 'z') { return false; }
  774. }
  775. pos = sep + 3;
  776. } else if (url.compare(0, 2, "//") == 0) {
  777. pos = 2;
  778. }
  779. auto has_authority_prefix = pos > 0;
  780. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  781. url[0] != '?' && url[0] != '#');
  782. if (has_authority) {
  783. // userinfo is not supported, and a backslash that some parsers take for
  784. // '/' would leave them seeing another host than this one.
  785. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  786. return false;
  787. }
  788. if (pos < url.size() && url[pos] == '[') {
  789. auto close = url.find(']', pos);
  790. if (close == std::string::npos) { return false; }
  791. uc.host = url.substr(pos + 1, close - pos - 1);
  792. // IPv6 host must be [a-fA-F0-9:]+ only
  793. if (uc.host.empty()) { return false; }
  794. for (auto c : uc.host) {
  795. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  796. (c >= 'A' && c <= 'F') || c == ':')) {
  797. return false;
  798. }
  799. }
  800. pos = close + 1;
  801. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  802. // path, query or fragment delimiter (or the end of input). Otherwise the
  803. // trailing bytes would be folded into the path while the connection
  804. // still targets the bracketed address.
  805. if (pos < url.size()) {
  806. auto c = url[pos];
  807. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  808. }
  809. } else {
  810. auto end = url.find_first_of(":/?#", pos);
  811. if (end == std::string::npos) { end = url.size(); }
  812. uc.host = url.substr(pos, end - pos);
  813. pos = end;
  814. }
  815. if (pos < url.size() && url[pos] == ':') {
  816. ++pos;
  817. auto end = url.find_first_of("/?#", pos);
  818. if (end == std::string::npos) { end = url.size(); }
  819. uc.port = url.substr(pos, end - pos);
  820. pos = end;
  821. }
  822. // Without :// or //, the entire input must be consumed as host[:port].
  823. // If there is leftover (path, query, etc.), this is not a valid
  824. // host[:port] string — clear and reparse as a plain path.
  825. if (!has_authority_prefix && pos < url.size()) {
  826. uc.host.clear();
  827. uc.port.clear();
  828. pos = 0;
  829. }
  830. }
  831. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  832. auto end = url.find_first_of("?#", pos);
  833. if (end == std::string::npos) { end = url.size(); }
  834. uc.path = url.substr(pos, end - pos);
  835. pos = end;
  836. }
  837. if (pos < url.size() && url[pos] == '?') {
  838. auto end = url.find('#', pos);
  839. if (end == std::string::npos) { end = url.size(); }
  840. uc.query = url.substr(pos, end - pos);
  841. }
  842. return true;
  843. }
  844. // Removes "." and ".." segments from a path that starts with '/' (RFC 3986
  845. // section 5.2.4).
  846. inline std::string remove_dot_segments(const std::string &path) {
  847. std::string out;
  848. size_t i = 0;
  849. while (i < path.size()) {
  850. auto next = (std::min)(path.find('/', i + 1), path.size());
  851. auto segment = path.substr(i + 1, next - i - 1);
  852. auto is_last = next == path.size();
  853. if (segment == "." || segment == "..") {
  854. if (segment == "..") {
  855. out.erase((std::min)(out.rfind('/'), out.size()));
  856. }
  857. if (is_last) { out += '/'; }
  858. } else {
  859. out += '/';
  860. out += segment;
  861. }
  862. i = next;
  863. }
  864. if (out.empty()) { out = "/"; }
  865. return out;
  866. }
  867. // Resolves a relative-path or query-only Location value against the path of
  868. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  869. // references starting with '/' are returned unchanged.
  870. inline std::string resolve_relative_location(const std::string &location,
  871. const std::string &base) {
  872. if (location.empty() || location[0] == '/') { return location; }
  873. // A ':' in the first segment means the value has a scheme.
  874. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  875. // A path starting with "//" would be re-parsed as an authority. Prefix "/."
  876. // (as the URL Standard does); remove_dot_segments strips it later.
  877. auto on_this_host = [](std::string path) -> std::string {
  878. if (path.compare(0, 2, "//") == 0) { path.insert(0, "/."); }
  879. return path;
  880. };
  881. if (location[0] == '#') {
  882. return on_this_host(base.substr(0, base.find('#')) + location);
  883. }
  884. auto base_path = base.substr(0, base.find_first_of("?#"));
  885. if (location[0] == '?') { return on_this_host(base_path + location); }
  886. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  887. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  888. // Remove "." and ".." segments from the merged path.
  889. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  890. return on_this_host(remove_dot_segments(merged.substr(0, path_end)) +
  891. merged.substr(path_end));
  892. }
  893. } // namespace detail
  894. enum class SSLVerifierResponse {
  895. // no decision has been made, use the built-in certificate verifier
  896. NoDecisionMade,
  897. // connection certificate is verified and accepted
  898. CertificateAccepted,
  899. // connection certificate was processed but is rejected
  900. CertificateRejected
  901. };
  902. // System CA loading policy for SSL clients. Auto (the default) loads system
  903. // CA certs only when no custom CA is configured; enable_system_ca() switches
  904. // to an explicit policy.
  905. enum class SystemCAMode { Auto, Enabled, Disabled };
  906. enum StatusCode {
  907. // Information responses
  908. Continue_100 = 100,
  909. SwitchingProtocol_101 = 101,
  910. Processing_102 = 102,
  911. EarlyHints_103 = 103,
  912. // Successful responses
  913. OK_200 = 200,
  914. Created_201 = 201,
  915. Accepted_202 = 202,
  916. NonAuthoritativeInformation_203 = 203,
  917. NoContent_204 = 204,
  918. ResetContent_205 = 205,
  919. PartialContent_206 = 206,
  920. MultiStatus_207 = 207,
  921. AlreadyReported_208 = 208,
  922. IMUsed_226 = 226,
  923. // Redirection messages
  924. MultipleChoices_300 = 300,
  925. MovedPermanently_301 = 301,
  926. Found_302 = 302,
  927. SeeOther_303 = 303,
  928. NotModified_304 = 304,
  929. UseProxy_305 = 305,
  930. unused_306 = 306,
  931. TemporaryRedirect_307 = 307,
  932. PermanentRedirect_308 = 308,
  933. // Client error responses
  934. BadRequest_400 = 400,
  935. Unauthorized_401 = 401,
  936. PaymentRequired_402 = 402,
  937. Forbidden_403 = 403,
  938. NotFound_404 = 404,
  939. MethodNotAllowed_405 = 405,
  940. NotAcceptable_406 = 406,
  941. ProxyAuthenticationRequired_407 = 407,
  942. RequestTimeout_408 = 408,
  943. Conflict_409 = 409,
  944. Gone_410 = 410,
  945. LengthRequired_411 = 411,
  946. PreconditionFailed_412 = 412,
  947. PayloadTooLarge_413 = 413,
  948. UriTooLong_414 = 414,
  949. UnsupportedMediaType_415 = 415,
  950. RangeNotSatisfiable_416 = 416,
  951. ExpectationFailed_417 = 417,
  952. ImATeapot_418 = 418,
  953. MisdirectedRequest_421 = 421,
  954. UnprocessableContent_422 = 422,
  955. Locked_423 = 423,
  956. FailedDependency_424 = 424,
  957. TooEarly_425 = 425,
  958. UpgradeRequired_426 = 426,
  959. PreconditionRequired_428 = 428,
  960. TooManyRequests_429 = 429,
  961. RequestHeaderFieldsTooLarge_431 = 431,
  962. UnavailableForLegalReasons_451 = 451,
  963. // Server error responses
  964. InternalServerError_500 = 500,
  965. NotImplemented_501 = 501,
  966. BadGateway_502 = 502,
  967. ServiceUnavailable_503 = 503,
  968. GatewayTimeout_504 = 504,
  969. HttpVersionNotSupported_505 = 505,
  970. VariantAlsoNegotiates_506 = 506,
  971. InsufficientStorage_507 = 507,
  972. LoopDetected_508 = 508,
  973. NotExtended_510 = 510,
  974. NetworkAuthenticationRequired_511 = 511,
  975. };
  976. namespace detail {
  977. // A multimap that keeps its entries in the order they were inserted.
  978. //
  979. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  980. // fields sharing a field name significant and forbids a proxy from reordering
  981. // them, and a query string's parameters are meaningful in the order the caller
  982. // wrote them. Neither standard container expresses it: std::unordered_multimap
  983. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  984. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  985. // key, which would drop control data such as Host behind whatever else the
  986. // message carries and alphabetise a query string.
  987. //
  988. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  989. // scan, which beats hashing for the handful of entries a message carries
  990. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  991. //
  992. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  993. // Params, whose parameter names are case-sensitive, not.
  994. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  995. public:
  996. using key_type = std::string;
  997. using mapped_type = Mapped;
  998. using value_type = std::pair<std::string, Mapped>;
  999. using size_type = std::size_t;
  1000. using difference_type = std::ptrdiff_t;
  1001. using reference = value_type &;
  1002. using const_reference = const value_type &;
  1003. private:
  1004. static size_type npos() { return static_cast<size_type>(-1); }
  1005. static bool keys_equal(const std::string &a, const std::string &b) {
  1006. return KeyEqual()(a, b);
  1007. }
  1008. // Iterating yields every entry in insertion order, but equal_range() and
  1009. // find() have to walk only the entries sharing one key, which are not
  1010. // adjacent. Both are the same iterator type: key_idx_ selects between the
  1011. // two traversals, and since equality compares only the position, an iterator
  1012. // restricted to one key still compares equal to end().
  1013. template <typename V> class iterator_t {
  1014. public:
  1015. using iterator_category = std::bidirectional_iterator_tag;
  1016. using value_type = insertion_ordered_multimap::value_type;
  1017. using difference_type = insertion_ordered_multimap::difference_type;
  1018. using pointer = V *;
  1019. using reference = V &;
  1020. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1021. template <typename U,
  1022. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1023. int>::type = 0>
  1024. iterator_t(const iterator_t<U> &rhs)
  1025. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1026. key_idx_(rhs.key_idx_) {}
  1027. reference operator*() const { return data_[idx_]; }
  1028. pointer operator->() const { return data_ + idx_; }
  1029. iterator_t &operator++() {
  1030. // Saturating, so that advancing past the last entry of a key stays at
  1031. // end() instead of running off the container.
  1032. if (idx_ >= size_) { return *this; }
  1033. ++idx_;
  1034. if (key_idx_ != npos()) {
  1035. while (idx_ < size_ && !matches(idx_)) {
  1036. ++idx_;
  1037. }
  1038. }
  1039. return *this;
  1040. }
  1041. iterator_t operator++(int) {
  1042. auto tmp = *this;
  1043. ++*this;
  1044. return tmp;
  1045. }
  1046. iterator_t &operator--() {
  1047. if (idx_ == 0) { return *this; }
  1048. --idx_;
  1049. if (key_idx_ != npos()) {
  1050. while (idx_ > 0 && !matches(idx_)) {
  1051. --idx_;
  1052. }
  1053. }
  1054. return *this;
  1055. }
  1056. iterator_t operator--(int) {
  1057. auto tmp = *this;
  1058. --*this;
  1059. return tmp;
  1060. }
  1061. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1062. return idx_ == rhs.idx_;
  1063. }
  1064. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1065. return idx_ != rhs.idx_;
  1066. }
  1067. private:
  1068. friend class insertion_ordered_multimap;
  1069. template <typename> friend class iterator_t;
  1070. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1071. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1072. bool matches(size_type i) const {
  1073. return keys_equal(data_[i].first, data_[key_idx_].first);
  1074. }
  1075. V *data_;
  1076. size_type idx_;
  1077. size_type size_;
  1078. size_type key_idx_;
  1079. };
  1080. public:
  1081. using iterator = iterator_t<value_type>;
  1082. using const_iterator = iterator_t<const value_type>;
  1083. insertion_ordered_multimap() = default;
  1084. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1085. : entries_(il) {}
  1086. template <typename InputIt>
  1087. insertion_ordered_multimap(InputIt first, InputIt last)
  1088. : entries_(first, last) {}
  1089. iterator begin() { return make_iter(0, npos()); }
  1090. iterator end() { return make_iter(entries_.size(), npos()); }
  1091. const_iterator begin() const { return make_citer(0, npos()); }
  1092. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1093. const_iterator cbegin() const { return begin(); }
  1094. const_iterator cend() const { return end(); }
  1095. bool empty() const { return entries_.empty(); }
  1096. size_type size() const { return entries_.size(); }
  1097. void clear() { entries_.clear(); }
  1098. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1099. iterator insert(const value_type &val) {
  1100. entries_.push_back(val);
  1101. return make_iter(entries_.size() - 1, npos());
  1102. }
  1103. iterator insert(value_type &&val) {
  1104. entries_.push_back(std::move(val));
  1105. return make_iter(entries_.size() - 1, npos());
  1106. }
  1107. template <typename... Args> iterator emplace(Args &&...args) {
  1108. entries_.emplace_back(std::forward<Args>(args)...);
  1109. return make_iter(entries_.size() - 1, npos());
  1110. }
  1111. // For entries that have to lead the message, such as the Host header field
  1112. // (RFC 9110 5.3 recommends sending control data first).
  1113. template <typename... Args> iterator emplace_front(Args &&...args) {
  1114. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1115. return make_iter(0, npos());
  1116. }
  1117. iterator find(const std::string &key) {
  1118. auto i = index_of(key);
  1119. return i == npos() ? end() : make_iter(i, i);
  1120. }
  1121. const_iterator find(const std::string &key) const {
  1122. auto i = index_of(key);
  1123. return i == npos() ? end() : make_citer(i, i);
  1124. }
  1125. size_type count(const std::string &key) const {
  1126. size_type n = 0;
  1127. for (const auto &entry : entries_) {
  1128. if (keys_equal(entry.first, key)) { n++; }
  1129. }
  1130. return n;
  1131. }
  1132. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1133. auto i = index_of(key);
  1134. return i == npos() ? std::make_pair(end(), end())
  1135. : std::make_pair(make_iter(i, i), end());
  1136. }
  1137. std::pair<const_iterator, const_iterator>
  1138. equal_range(const std::string &key) const {
  1139. auto i = index_of(key);
  1140. return i == npos() ? std::make_pair(end(), end())
  1141. : std::make_pair(make_citer(i, i), end());
  1142. }
  1143. size_type erase(const std::string &key) {
  1144. auto before = entries_.size();
  1145. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1146. [key](const value_type &entry) {
  1147. return keys_equal(entry.first, key);
  1148. }),
  1149. entries_.end());
  1150. return before - entries_.size();
  1151. }
  1152. iterator erase(const_iterator pos) {
  1153. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1154. return make_iter(pos.idx_, npos());
  1155. }
  1156. // Erases what iterating [first, last) would actually visit, so erasing an
  1157. // equal_range() removes only the entries with that key, not everything
  1158. // positioned between them.
  1159. iterator erase(const_iterator first, const_iterator last) {
  1160. auto from = first.idx_;
  1161. auto to = last.idx_;
  1162. if (from >= to) { return make_iter(from, npos()); }
  1163. auto begin_it = entries_.begin();
  1164. auto from_it = begin_it + static_cast<difference_type>(from);
  1165. auto to_it = begin_it + static_cast<difference_type>(to);
  1166. if (first.key_idx_ == npos()) {
  1167. entries_.erase(from_it, to_it);
  1168. } else {
  1169. auto key = entries_[first.key_idx_].first;
  1170. auto keep = from_it;
  1171. for (auto it = from_it; it != to_it; ++it) {
  1172. if (!keys_equal(it->first, key)) {
  1173. if (keep != it) { *keep = std::move(*it); }
  1174. ++keep;
  1175. }
  1176. }
  1177. if (keep != to_it) {
  1178. keep = std::move(to_it, entries_.end(), keep);
  1179. } else {
  1180. keep = entries_.end();
  1181. }
  1182. entries_.erase(keep, entries_.end());
  1183. }
  1184. return make_iter(from, npos());
  1185. }
  1186. friend bool operator==(const insertion_ordered_multimap &lhs,
  1187. const insertion_ordered_multimap &rhs) {
  1188. return lhs.entries_ == rhs.entries_;
  1189. }
  1190. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1191. const insertion_ordered_multimap &rhs) {
  1192. return !(lhs == rhs);
  1193. }
  1194. private:
  1195. size_type index_of(const std::string &key) const {
  1196. for (size_type i = 0; i < entries_.size(); i++) {
  1197. if (keys_equal(entries_[i].first, key)) { return i; }
  1198. }
  1199. return npos();
  1200. }
  1201. iterator make_iter(size_type idx, size_type key_idx) {
  1202. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1203. }
  1204. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1205. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1206. }
  1207. std::vector<value_type> entries_;
  1208. };
  1209. } // namespace detail
  1210. using Headers =
  1211. detail::insertion_ordered_multimap<std::string,
  1212. detail::case_ignore::equal_to>;
  1213. // Query parameter names are case-sensitive, unlike header field names.
  1214. using Params =
  1215. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1216. using Match = std::smatch;
  1217. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1218. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1219. /*
  1220. * detail: type-erased storage used by UserData.
  1221. * ABI-stable regardless of C++ standard — always uses this custom
  1222. * implementation instead of std::any.
  1223. */
  1224. namespace detail {
  1225. using any_type_id = const void *;
  1226. template <typename T> any_type_id any_typeid() noexcept {
  1227. static const char id = 0;
  1228. return &id;
  1229. }
  1230. struct any_storage {
  1231. virtual ~any_storage() = default;
  1232. virtual std::unique_ptr<any_storage> clone() const = 0;
  1233. virtual any_type_id type_id() const noexcept = 0;
  1234. };
  1235. template <typename T> struct any_value final : any_storage {
  1236. T value;
  1237. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1238. std::unique_ptr<any_storage> clone() const override {
  1239. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1240. }
  1241. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1242. };
  1243. } // namespace detail
  1244. class UserData {
  1245. public:
  1246. UserData() = default;
  1247. UserData(UserData &&) noexcept = default;
  1248. UserData &operator=(UserData &&) noexcept = default;
  1249. UserData(const UserData &o) {
  1250. for (const auto &e : o.entries_) {
  1251. if (e.second) { entries_[e.first] = e.second->clone(); }
  1252. }
  1253. }
  1254. UserData &operator=(const UserData &o) {
  1255. if (this != &o) {
  1256. entries_.clear();
  1257. for (const auto &e : o.entries_) {
  1258. if (e.second) { entries_[e.first] = e.second->clone(); }
  1259. }
  1260. }
  1261. return *this;
  1262. }
  1263. template <typename T> void set(const std::string &key, T &&value) {
  1264. using D = typename std::decay<T>::type;
  1265. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1266. }
  1267. template <typename T> T *get(const std::string &key) noexcept {
  1268. auto it = entries_.find(key);
  1269. if (it == entries_.end() || !it->second) { return nullptr; }
  1270. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1271. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1272. }
  1273. template <typename T> const T *get(const std::string &key) const noexcept {
  1274. auto it = entries_.find(key);
  1275. if (it == entries_.end() || !it->second) { return nullptr; }
  1276. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1277. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1278. }
  1279. bool has(const std::string &key) const noexcept {
  1280. return entries_.find(key) != entries_.end();
  1281. }
  1282. void erase(const std::string &key) { entries_.erase(key); }
  1283. void clear() noexcept { entries_.clear(); }
  1284. private:
  1285. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1286. entries_;
  1287. };
  1288. struct Response;
  1289. using ResponseHandler = std::function<bool(const Response &response)>;
  1290. struct FormData {
  1291. std::string name;
  1292. std::string content;
  1293. std::string filename;
  1294. std::string content_type;
  1295. Headers headers;
  1296. };
  1297. struct FormField {
  1298. std::string name;
  1299. std::string content;
  1300. Headers headers;
  1301. };
  1302. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1303. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1304. // should see the parts as they were sent. A std::multimap sorts by field name
  1305. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1306. // than the case-insensitive predicate Headers uses.
  1307. using FormFields =
  1308. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1309. using FormFiles =
  1310. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1311. struct MultipartFormData {
  1312. FormFields fields; // Text fields from multipart
  1313. FormFiles files; // Files from multipart
  1314. // Text field access
  1315. std::string get_field(const std::string &key, size_t id = 0) const;
  1316. std::vector<std::string> get_fields(const std::string &key) const;
  1317. bool has_field(const std::string &key) const;
  1318. size_t get_field_count(const std::string &key) const;
  1319. // File access
  1320. FormData get_file(const std::string &key, size_t id = 0) const;
  1321. std::vector<FormData> get_files(const std::string &key) const;
  1322. bool has_file(const std::string &key) const;
  1323. size_t get_file_count(const std::string &key) const;
  1324. };
  1325. struct UploadFormData {
  1326. std::string name;
  1327. std::string content;
  1328. std::string filename;
  1329. std::string content_type;
  1330. };
  1331. using UploadFormDataItems = std::vector<UploadFormData>;
  1332. class DataSink {
  1333. public:
  1334. DataSink() : os(&sb_), sb_(*this) {}
  1335. DataSink(const DataSink &) = delete;
  1336. DataSink &operator=(const DataSink &) = delete;
  1337. DataSink(DataSink &&) = delete;
  1338. DataSink &operator=(DataSink &&) = delete;
  1339. std::function<bool(const char *data, size_t data_len)> write;
  1340. // Only `write` is mandatory. The rest are defaulted so that a provider
  1341. // calling one on a writer that does not set it gets sensible behaviour
  1342. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1343. // `this` is safe: DataSink is neither copyable nor movable.
  1344. std::function<bool()> is_writable = []() { return true; };
  1345. std::function<void()> done = []() {};
  1346. std::function<void(const Headers &trailer)> done_with_trailer =
  1347. [this](const Headers & /*trailer*/) { done(); };
  1348. std::ostream os;
  1349. private:
  1350. class data_sink_streambuf final : public std::streambuf {
  1351. public:
  1352. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1353. protected:
  1354. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1355. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1356. return 0;
  1357. }
  1358. private:
  1359. DataSink &sink_;
  1360. };
  1361. data_sink_streambuf sb_;
  1362. };
  1363. using ContentProvider =
  1364. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1365. using ContentProviderWithoutLength =
  1366. std::function<bool(size_t offset, DataSink &sink)>;
  1367. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1368. struct FormDataProvider {
  1369. std::string name;
  1370. ContentProviderWithoutLength provider;
  1371. std::string filename;
  1372. std::string content_type;
  1373. };
  1374. using FormDataProviderItems = std::vector<FormDataProvider>;
  1375. inline FormDataProvider
  1376. make_file_provider(const std::string &name, const std::string &filepath,
  1377. const std::string &filename = std::string(),
  1378. const std::string &content_type = std::string()) {
  1379. FormDataProvider fdp;
  1380. fdp.name = name;
  1381. fdp.filename = filename.empty() ? filepath : filename;
  1382. fdp.content_type = content_type;
  1383. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1384. std::ifstream f(filepath, std::ios::binary);
  1385. if (!f) { return false; }
  1386. if (offset > 0) {
  1387. f.seekg(static_cast<std::streamoff>(offset));
  1388. if (!f.good()) {
  1389. sink.done();
  1390. return true;
  1391. }
  1392. }
  1393. char buf[8192];
  1394. f.read(buf, sizeof(buf));
  1395. auto n = static_cast<size_t>(f.gcount());
  1396. if (n > 0) { return sink.write(buf, n); }
  1397. sink.done(); // EOF
  1398. return true;
  1399. };
  1400. return fdp;
  1401. }
  1402. inline std::pair<size_t, ContentProvider>
  1403. make_file_body(const std::string &filepath) {
  1404. size_t size = 0;
  1405. {
  1406. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1407. if (!f) { return {0, ContentProvider{}}; }
  1408. size = static_cast<size_t>(f.tellg());
  1409. }
  1410. ContentProvider provider = [filepath](size_t offset, size_t length,
  1411. DataSink &sink) -> bool {
  1412. std::ifstream f(filepath, std::ios::binary);
  1413. if (!f) { return false; }
  1414. f.seekg(static_cast<std::streamoff>(offset));
  1415. if (!f.good()) { return false; }
  1416. char buf[8192];
  1417. while (length > 0) {
  1418. auto to_read = (std::min)(sizeof(buf), length);
  1419. f.read(buf, static_cast<std::streamsize>(to_read));
  1420. auto n = static_cast<size_t>(f.gcount());
  1421. // The file is shorter than the size make_file_body() measured, which the
  1422. // caller has already committed to as Content-Length. The body cannot be
  1423. // completed, so fail as every other error here does.
  1424. if (n == 0) { return false; }
  1425. if (!sink.write(buf, n)) { return false; }
  1426. length -= n;
  1427. }
  1428. return true;
  1429. };
  1430. return {size, std::move(provider)};
  1431. }
  1432. using ContentReceiverWithProgress = std::function<bool(
  1433. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1434. using ContentReceiver =
  1435. std::function<bool(const char *data, size_t data_length)>;
  1436. using FormDataHeader = std::function<bool(const FormData &file)>;
  1437. class ContentReader {
  1438. public:
  1439. using Reader = std::function<bool(ContentReceiver receiver)>;
  1440. using FormDataReader =
  1441. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1442. ContentReader(Reader reader, FormDataReader multipart_reader)
  1443. : reader_(std::move(reader)),
  1444. formdata_reader_(std::move(multipart_reader)) {}
  1445. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1446. return formdata_reader_(std::move(header), std::move(receiver));
  1447. }
  1448. bool operator()(ContentReceiver receiver) const {
  1449. return reader_(std::move(receiver));
  1450. }
  1451. Reader reader_;
  1452. FormDataReader formdata_reader_;
  1453. };
  1454. using Range = std::pair<ssize_t, ssize_t>;
  1455. using Ranges = std::vector<Range>;
  1456. #ifdef CPPHTTPLIB_SSL_ENABLED
  1457. // TLS abstraction layer - public type definitions and API
  1458. namespace tls {
  1459. // Opaque handles (defined as void* for abstraction)
  1460. using ctx_t = void *;
  1461. using session_t = void *;
  1462. using const_session_t = const void *; // For read-only session access
  1463. using cert_t = void *;
  1464. using ca_store_t = void *;
  1465. // TLS versions
  1466. enum class Version {
  1467. TLS1_2 = 0x0303,
  1468. TLS1_3 = 0x0304,
  1469. };
  1470. // Subject Alternative Names (SAN) entry types
  1471. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1472. // SAN entry structure
  1473. struct SanEntry {
  1474. SanType type;
  1475. std::string value;
  1476. };
  1477. // Verification context for certificate verification callback
  1478. struct VerifyContext {
  1479. session_t session; // TLS session handle
  1480. cert_t cert; // Current certificate being verified
  1481. int depth; // Certificate chain depth (0 = leaf)
  1482. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1483. long error_code; // Backend-specific error code (0 = no error)
  1484. const char *error_string; // Human-readable error description
  1485. // Certificate introspection methods
  1486. std::string subject_cn() const;
  1487. std::string issuer_name() const;
  1488. bool check_hostname(const char *hostname) const;
  1489. std::vector<SanEntry> sans() const;
  1490. bool validity(time_t &not_before, time_t &not_after) const;
  1491. std::string serial() const;
  1492. };
  1493. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1494. // TlsError codes for TLS operations (backend-independent)
  1495. enum class ErrorCode : int {
  1496. Success = 0,
  1497. WantRead, // Non-blocking: need to wait for read
  1498. WantWrite, // Non-blocking: need to wait for write
  1499. PeerClosed, // Peer closed the connection
  1500. Fatal, // Unrecoverable error
  1501. SyscallError, // System call error (check sys_errno)
  1502. CertVerifyFailed, // Certificate verification failed
  1503. HostnameMismatch, // Hostname verification failed
  1504. };
  1505. // TLS error information
  1506. struct TlsError {
  1507. ErrorCode code = ErrorCode::Fatal;
  1508. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1509. int sys_errno = 0; // errno when SyscallError
  1510. // Convert verification error code to human-readable string
  1511. static std::string verify_error_to_string(long error_code);
  1512. };
  1513. // RAII wrapper for peer certificate
  1514. class PeerCert {
  1515. public:
  1516. PeerCert();
  1517. PeerCert(PeerCert &&other) noexcept;
  1518. PeerCert &operator=(PeerCert &&other) noexcept;
  1519. ~PeerCert();
  1520. PeerCert(const PeerCert &) = delete;
  1521. PeerCert &operator=(const PeerCert &) = delete;
  1522. explicit operator bool() const;
  1523. std::string subject_cn() const;
  1524. std::string issuer_name() const;
  1525. bool check_hostname(const char *hostname) const;
  1526. std::vector<SanEntry> sans() const;
  1527. bool validity(time_t &not_before, time_t &not_after) const;
  1528. std::string serial() const;
  1529. private:
  1530. explicit PeerCert(cert_t cert);
  1531. cert_t cert_ = nullptr;
  1532. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1533. };
  1534. // Callback for TLS context setup (used by SSLServer constructor)
  1535. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1536. } // namespace tls
  1537. #endif
  1538. struct Request {
  1539. std::string method;
  1540. std::string path;
  1541. std::string matched_route;
  1542. Params params;
  1543. Headers headers;
  1544. Headers trailers;
  1545. std::string body;
  1546. std::string remote_addr;
  1547. int remote_port = -1;
  1548. std::string local_addr;
  1549. int local_port = -1;
  1550. // for server
  1551. std::string version;
  1552. std::string target;
  1553. MultipartFormData form;
  1554. Ranges ranges;
  1555. Match matches;
  1556. std::unordered_map<std::string, std::string> path_params;
  1557. std::function<bool()> is_connection_closed = []() { return true; };
  1558. // for client
  1559. std::vector<std::string> accept_content_types;
  1560. ResponseHandler response_handler;
  1561. ContentReceiverWithProgress content_receiver;
  1562. DownloadProgress download_progress;
  1563. UploadProgress upload_progress;
  1564. bool has_header(const std::string &key) const;
  1565. std::string get_header_value(const std::string &key, const char *def = "",
  1566. size_t id = 0) const;
  1567. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1568. size_t id = 0) const;
  1569. size_t get_header_value_count(const std::string &key) const;
  1570. void set_header(const std::string &key, const std::string &val);
  1571. bool has_trailer(const std::string &key) const;
  1572. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1573. size_t get_trailer_value_count(const std::string &key) const;
  1574. bool has_param(const std::string &key) const;
  1575. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1576. std::vector<std::string> get_param_values(const std::string &key) const;
  1577. size_t get_param_value_count(const std::string &key) const;
  1578. bool is_multipart_form_data() const;
  1579. // private members...
  1580. bool body_read_started_ = false;
  1581. bool body_consumed_ = false;
  1582. bool expect_100_continue_pending_ = false;
  1583. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1584. size_t content_length_ = 0;
  1585. ContentProvider content_provider_;
  1586. bool is_chunked_content_provider_ = false;
  1587. size_t authorization_count_ = 0;
  1588. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1589. (std::chrono::steady_clock::time_point::min)();
  1590. #ifdef CPPHTTPLIB_SSL_ENABLED
  1591. tls::const_session_t ssl = nullptr;
  1592. tls::PeerCert peer_cert() const;
  1593. std::string sni() const;
  1594. #endif
  1595. };
  1596. namespace detail {
  1597. // Declared up here, away from the rest of the compression helpers, because
  1598. // `Response` stores one.
  1599. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1600. } // namespace detail
  1601. struct Response {
  1602. std::string version;
  1603. int status = -1;
  1604. std::string reason;
  1605. Headers headers;
  1606. Headers trailers;
  1607. std::string body;
  1608. std::string location; // Redirect location
  1609. // User-defined context — set by pre-routing/pre-request handlers and read
  1610. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1611. UserData user_data;
  1612. bool has_header(const std::string &key) const;
  1613. std::string get_header_value(const std::string &key, const char *def = "",
  1614. size_t id = 0) const;
  1615. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1616. size_t id = 0) const;
  1617. size_t get_header_value_count(const std::string &key) const;
  1618. void set_header(const std::string &key, const std::string &val);
  1619. bool has_trailer(const std::string &key) const;
  1620. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1621. size_t get_trailer_value_count(const std::string &key) const;
  1622. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1623. void set_content(const char *s, size_t n, const std::string &content_type);
  1624. void set_content(const std::string &s, const std::string &content_type);
  1625. void set_content(std::string &&s, const std::string &content_type);
  1626. void set_content_provider(
  1627. size_t length, const std::string &content_type, ContentProvider provider,
  1628. ContentProviderResourceReleaser resource_releaser = nullptr);
  1629. void set_content_provider(
  1630. const std::string &content_type, ContentProviderWithoutLength provider,
  1631. ContentProviderResourceReleaser resource_releaser = nullptr);
  1632. void set_chunked_content_provider(
  1633. const std::string &content_type, ContentProviderWithoutLength provider,
  1634. ContentProviderResourceReleaser resource_releaser = nullptr);
  1635. void set_file_content(const std::string &path,
  1636. const std::string &content_type);
  1637. void set_file_content(const std::string &path);
  1638. Response() = default;
  1639. Response(const Response &) = default;
  1640. Response &operator=(const Response &) = default;
  1641. Response(Response &&) = default;
  1642. Response &operator=(Response &&) = default;
  1643. ~Response() {
  1644. if (content_provider_resource_releaser_) {
  1645. content_provider_resource_releaser_(content_provider_success_);
  1646. }
  1647. }
  1648. // private members...
  1649. size_t content_length_ = 0;
  1650. ContentProvider content_provider_;
  1651. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1652. bool is_chunked_content_provider_ = false;
  1653. bool is_file_content_provider_ = false;
  1654. bool content_provider_success_ = false;
  1655. std::string file_content_path_;
  1656. std::string file_content_content_type_;
  1657. // Content coding chosen for the response body, decided once so that the
  1658. // headers and the body cannot disagree: where the file is opened for a
  1659. // file-backed content provider (keeping the ETag honest), and in
  1660. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1661. // for every other kind of response.
  1662. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1663. };
  1664. enum class Error {
  1665. Success = 0,
  1666. Unknown,
  1667. Connection,
  1668. BindIPAddress,
  1669. Read,
  1670. Write,
  1671. ExceedRedirectCount,
  1672. Canceled,
  1673. SSLConnection,
  1674. SSLLoadingCerts,
  1675. SSLServerVerification,
  1676. SSLServerHostnameVerification,
  1677. UnsupportedMultipartBoundaryChars,
  1678. Compression,
  1679. ConnectionTimeout,
  1680. ProxyConnection,
  1681. ConnectionClosed,
  1682. Timeout,
  1683. ResourceExhaustion,
  1684. TooManyFormDataFiles,
  1685. ExceedMaxPayloadSize,
  1686. ExceedUriMaxLength,
  1687. ExceedMaxSocketDescriptorCount,
  1688. InvalidRequestLine,
  1689. InvalidHTTPMethod,
  1690. InvalidHTTPVersion,
  1691. InvalidHeaders,
  1692. MultipartParsing,
  1693. OpenFile,
  1694. Listen,
  1695. GetSockName,
  1696. UnsupportedAddressFamily,
  1697. HTTPParsing,
  1698. InvalidRangeHeader,
  1699. UnsupportedContentEncoding,
  1700. WebSocketHandshake,
  1701. UserCallbackException,
  1702. // For internal use only
  1703. SSLPeerCouldBeClosed_,
  1704. };
  1705. std::string to_string(Error error);
  1706. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1707. class Stream {
  1708. public:
  1709. virtual ~Stream() = default;
  1710. virtual bool is_readable() const = 0;
  1711. virtual bool wait_readable() const = 0;
  1712. virtual bool wait_writable() const = 0;
  1713. virtual bool is_peer_alive() const { return wait_writable(); }
  1714. virtual ssize_t read(char *ptr, size_t size) = 0;
  1715. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1716. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1717. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1718. virtual socket_t socket() const = 0;
  1719. virtual time_t duration() const = 0;
  1720. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1721. (void)sec;
  1722. (void)usec;
  1723. }
  1724. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1725. // each one. 0 lifts the bound.
  1726. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1727. // Lets a wait for data end early once `interrupted` returns true, so that
  1728. // another thread can stop a blocked read on every platform.
  1729. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1730. (void)interrupted;
  1731. }
  1732. // Bytes already pulled off the socket and sitting in this stream's own
  1733. // buffer. Exposing them lets a line reader scan for a terminator in one
  1734. // pass instead of asking for a byte at a time. A stream that does no
  1735. // buffering of its own reports none, and readers fall back to read().
  1736. virtual const char *buffered_data(size_t &size) const {
  1737. size = 0;
  1738. return nullptr;
  1739. }
  1740. // Discards `size` bytes previously returned by buffered_data().
  1741. virtual void consume_buffered(size_t size) { (void)size; }
  1742. ssize_t write(const char *ptr);
  1743. ssize_t write(const std::string &s);
  1744. Error get_error() const { return error_; }
  1745. protected:
  1746. Error error_ = Error::Success;
  1747. };
  1748. class TaskQueue {
  1749. public:
  1750. TaskQueue() = default;
  1751. virtual ~TaskQueue() = default;
  1752. virtual bool enqueue(std::function<void()> fn) = 0;
  1753. virtual void shutdown() = 0;
  1754. virtual void on_idle() {}
  1755. };
  1756. class ThreadPool final : public TaskQueue {
  1757. public:
  1758. explicit ThreadPool(
  1759. size_t n, size_t max_n = 0, size_t mqr = 0,
  1760. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1761. ThreadPool(const ThreadPool &) = delete;
  1762. ~ThreadPool() override = default;
  1763. bool enqueue(std::function<void()> fn) override;
  1764. void shutdown() override;
  1765. private:
  1766. void worker(bool is_dynamic);
  1767. void move_to_finished(std::thread::id id);
  1768. void cleanup_finished_threads();
  1769. size_t base_thread_count_;
  1770. size_t max_thread_count_;
  1771. size_t max_queued_requests_;
  1772. time_t idle_timeout_sec_;
  1773. size_t idle_thread_count_;
  1774. bool shutdown_;
  1775. std::list<std::function<void()>> jobs_;
  1776. std::vector<std::thread> threads_; // base threads
  1777. std::list<std::thread> dynamic_threads_; // dynamic threads
  1778. std::vector<std::thread>
  1779. finished_threads_; // exited dynamic threads awaiting join
  1780. std::condition_variable cond_;
  1781. std::mutex mutex_;
  1782. };
  1783. using Logger = std::function<void(const Request &, const Response &)>;
  1784. // Forward declaration for Error type
  1785. enum class Error;
  1786. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1787. using SocketOptions = std::function<void(socket_t sock)>;
  1788. void default_socket_options(socket_t sock);
  1789. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1790. const char *status_message(int status);
  1791. std::string to_string(Error error);
  1792. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1793. std::string get_bearer_token_auth(const Request &req);
  1794. namespace detail {
  1795. class MatcherBase {
  1796. public:
  1797. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1798. virtual ~MatcherBase() = default;
  1799. const std::string &pattern() const { return pattern_; }
  1800. // Match request path and populate its matches and
  1801. virtual bool match(Request &request) const = 0;
  1802. private:
  1803. std::string pattern_;
  1804. };
  1805. /**
  1806. * Captures parameters in request path and stores them in Request::path_params
  1807. *
  1808. * Capture name is a substring of a pattern from : to /.
  1809. * The rest of the pattern is matched against the request path directly
  1810. * Parameters are captured starting from the next character after
  1811. * the end of the last matched static pattern fragment until the next /.
  1812. *
  1813. * Example pattern:
  1814. * "/path/fragments/:capture/more/fragments/:second_capture"
  1815. * Static fragments:
  1816. * "/path/fragments/", "more/fragments/"
  1817. *
  1818. * Given the following request path:
  1819. * "/path/fragments/:1/more/fragments/:2"
  1820. * the resulting capture will be
  1821. * {{"capture", "1"}, {"second_capture", "2"}}
  1822. */
  1823. class PathParamsMatcher final : public MatcherBase {
  1824. public:
  1825. PathParamsMatcher(const std::string &pattern);
  1826. bool match(Request &request) const override;
  1827. private:
  1828. // Treat segment separators as the end of path parameter capture
  1829. // Does not need to handle query parameters as they are parsed before path
  1830. // matching
  1831. static constexpr char separator = '/';
  1832. // Contains static path fragments to match against, excluding the '/' after
  1833. // path params
  1834. // Fragments are separated by path params
  1835. std::vector<std::string> static_fragments_;
  1836. // Stores the names of the path parameters to be used as keys in the
  1837. // Request::path_params map
  1838. std::vector<std::string> param_names_;
  1839. };
  1840. /**
  1841. * Performs std::regex_match on request path
  1842. * and stores the result in Request::matches
  1843. *
  1844. * Note that regex match is performed directly on the whole request.
  1845. * This means that wildcard patterns may match multiple path segments with /:
  1846. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1847. */
  1848. class RegexMatcher final : public MatcherBase {
  1849. public:
  1850. RegexMatcher(const std::string &pattern)
  1851. : MatcherBase(pattern), regex_(pattern) {}
  1852. bool match(Request &request) const override;
  1853. private:
  1854. std::regex regex_;
  1855. };
  1856. int close_socket(socket_t sock) noexcept;
  1857. bool is_accept_resource_error();
  1858. bool is_accept_transient_error();
  1859. ssize_t write_headers(Stream &strm, const Headers &headers);
  1860. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1861. time_t usec);
  1862. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1863. const std::string &boundary);
  1864. ContentProvider
  1865. make_multipart_content_provider(const UploadFormDataItems &items,
  1866. const std::string &boundary);
  1867. } // namespace detail
  1868. bool is_valid_multipart_boundary(const std::string &boundary);
  1869. // Serializer for multipart/form-data request bodies. The boundary is owned
  1870. // by the writer so that per-part framing and the final terminator always
  1871. // agree. Field names and filenames are escaped following the WHATWG HTML
  1872. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1873. // in content types.
  1874. class MultipartFormDataWriter {
  1875. public:
  1876. MultipartFormDataWriter();
  1877. // precondition: is_valid_multipart_boundary(boundary)
  1878. explicit MultipartFormDataWriter(std::string boundary);
  1879. const std::string &boundary() const;
  1880. std::string content_type() const;
  1881. // In-memory items -> whole body (known length)
  1882. std::string serialize(const UploadFormDataItems &items) const;
  1883. size_t content_length(const UploadFormDataItems &items) const;
  1884. // Per-part framing for streaming via a content provider
  1885. std::string item_begin(const UploadFormData &item) const;
  1886. static std::string item_end();
  1887. std::string finish() const;
  1888. private:
  1889. std::string boundary_;
  1890. };
  1891. class Server {
  1892. public:
  1893. using Handler = std::function<void(const Request &, Response &)>;
  1894. using ExceptionHandler =
  1895. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1896. enum class HandlerResponse {
  1897. Handled,
  1898. Unhandled,
  1899. };
  1900. using HandlerWithResponse =
  1901. std::function<HandlerResponse(const Request &, Response &)>;
  1902. using HandlerWithContentReader = std::function<void(
  1903. const Request &, Response &, const ContentReader &content_reader)>;
  1904. using Expect100ContinueHandler =
  1905. std::function<int(const Request &, Response &)>;
  1906. using StartHandler = std::function<void()>;
  1907. using WebSocketHandler =
  1908. std::function<void(const Request &, ws::WebSocket &)>;
  1909. using SubProtocolSelector =
  1910. std::function<std::string(const std::vector<std::string> &protocols)>;
  1911. Server();
  1912. virtual ~Server();
  1913. virtual bool is_valid() const;
  1914. Server &Get(const std::string &pattern, Handler handler);
  1915. Server &Post(const std::string &pattern, Handler handler);
  1916. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1917. Server &Put(const std::string &pattern, Handler handler);
  1918. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1919. Server &Patch(const std::string &pattern, Handler handler);
  1920. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1921. Server &Delete(const std::string &pattern, Handler handler);
  1922. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1923. Server &Options(const std::string &pattern, Handler handler);
  1924. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1925. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1926. // server accept it; an unregistered method is still rejected with 400.
  1927. // `method` must be a valid HTTP method token and must not be one of the
  1928. // built-in methods, which have their own registration functions above. A
  1929. // rejected registration makes is_valid() return false, so listen() fails.
  1930. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1931. Handler handler);
  1932. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1933. HandlerWithContentReader handler);
  1934. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1935. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1936. SubProtocolSelector sub_protocol_selector);
  1937. bool set_base_dir(const std::string &dir,
  1938. const std::string &mount_point = std::string());
  1939. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1940. Headers headers = Headers());
  1941. bool remove_mount_point(const std::string &mount_point);
  1942. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1943. const std::string &mime);
  1944. Server &set_default_file_mimetype(const std::string &mime);
  1945. Server &set_file_request_handler(Handler handler);
  1946. template <class ErrorHandlerFunc>
  1947. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1948. return set_error_handler_core(
  1949. std::forward<ErrorHandlerFunc>(handler),
  1950. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1951. }
  1952. Server &set_exception_handler(ExceptionHandler handler);
  1953. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1954. Server &set_post_routing_handler(Handler handler);
  1955. Server &set_pre_request_handler(HandlerWithResponse handler);
  1956. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1957. Server &set_start_handler(StartHandler handler);
  1958. Server &set_logger(Logger logger);
  1959. Server &set_pre_compression_logger(Logger logger);
  1960. Server &set_error_logger(ErrorLogger error_logger);
  1961. Server &set_address_family(int family);
  1962. Server &set_tcp_nodelay(bool on);
  1963. Server &set_ipv6_v6only(bool on);
  1964. Server &set_socket_options(SocketOptions socket_options);
  1965. Server &set_default_headers(Headers headers);
  1966. Server &
  1967. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1968. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1969. Server &set_keep_alive_max_count(size_t count);
  1970. Server &set_keep_alive_timeout(time_t sec);
  1971. template <class Rep, class Period>
  1972. Server &
  1973. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1974. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1975. template <class Rep, class Period>
  1976. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1977. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1978. template <class Rep, class Period>
  1979. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1980. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1981. template <class Rep, class Period>
  1982. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1983. Server &set_payload_max_length(size_t length);
  1984. Server &set_compress(bool on);
  1985. Server &set_static_file_compression(bool on);
  1986. Server &set_static_file_compression_min_length(size_t length);
  1987. Server &set_static_file_compression_max_length(size_t length);
  1988. Server &set_websocket_ping_interval(time_t sec);
  1989. template <class Rep, class Period>
  1990. Server &set_websocket_ping_interval(
  1991. const std::chrono::duration<Rep, Period> &duration);
  1992. Server &set_websocket_max_missed_pongs(int count);
  1993. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1994. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1995. bool listen_after_bind();
  1996. bool listen(const std::string &host, int port, int socket_flags = 0);
  1997. bool is_running() const;
  1998. void wait_until_ready() const;
  1999. void stop() noexcept;
  2000. void decommission();
  2001. std::function<TaskQueue *(void)> new_task_queue;
  2002. protected:
  2003. bool process_request(Stream &strm, const std::string &remote_addr,
  2004. int remote_port, const std::string &local_addr,
  2005. int local_port, bool close_connection,
  2006. bool &connection_closed,
  2007. const std::function<void(Request &)> &setup_request,
  2008. bool *websocket_upgraded = nullptr);
  2009. // Runs the per-connection serving loop and stops an exception thrown by a
  2010. // user callback from escaping the worker thread.
  2011. //
  2012. // process_request() wraps only routing() and the hooks before a WebSocket
  2013. // upgrade in a try/catch. Content providers, the post-routing, error,
  2014. // logging and expect-100 handlers and WebSocket handlers all run outside
  2015. // it, and the task queue calls the job without a catch, so an exception
  2016. // from any of those would terminate the process.
  2017. //
  2018. // No 500 is possible here: by the time a content provider runs, the status
  2019. // line and headers are already on the wire. Report it through the error
  2020. // logger and drop the connection, which is what the peer observes either
  2021. // way. Other connections are unaffected.
  2022. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2023. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2024. return serve();
  2025. #else
  2026. try {
  2027. return serve();
  2028. } catch (...) {
  2029. // The error logger is a user callback too, so it must not be able to
  2030. // throw the guard back open.
  2031. try {
  2032. output_error_log(Error::UserCallbackException, nullptr);
  2033. } catch (...) {}
  2034. return false;
  2035. }
  2036. #endif
  2037. }
  2038. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2039. // stop() takes the listening socket away; listen() then waits for handlers
  2040. bool is_stopping() const { return svr_sock_ == INVALID_SOCKET; }
  2041. std::vector<std::string> trusted_proxies_;
  2042. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2043. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2044. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2045. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2046. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2047. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2048. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2049. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2050. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2051. bool compress_ = true;
  2052. bool static_file_compression_ = false;
  2053. size_t static_file_compression_min_length_ =
  2054. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2055. size_t static_file_compression_max_length_ =
  2056. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2057. time_t websocket_ping_interval_sec_ =
  2058. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2059. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2060. private:
  2061. using Handlers =
  2062. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2063. using HandlersForContentReader =
  2064. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2065. HandlerWithContentReader>>;
  2066. // Both handler tables for one custom method live in a single entry, so that
  2067. // routing() needs only one map lookup per request to reach either of them.
  2068. struct CustomHandlerEntry {
  2069. Handlers handlers;
  2070. HandlersForContentReader handlers_for_content_reader;
  2071. };
  2072. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2073. static std::unique_ptr<detail::MatcherBase>
  2074. make_matcher(const std::string &pattern);
  2075. static const std::set<std::string> &builtin_methods();
  2076. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2077. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2078. template <typename H>
  2079. Server &add_handler(
  2080. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2081. const std::string &pattern, H handler) {
  2082. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2083. return *this;
  2084. }
  2085. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2086. Server &set_error_handler_core(Handler handler, std::false_type);
  2087. socket_t create_server_socket(const std::string &host, int port,
  2088. int socket_flags,
  2089. SocketOptions socket_options) const;
  2090. int bind_internal(const std::string &host, int port, int socket_flags);
  2091. bool listen_internal();
  2092. bool routing(Request &req, Response &res, Stream &strm,
  2093. bool skip_pre_routing);
  2094. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2095. bool handle_exception(Request &req, Response &res);
  2096. #endif
  2097. bool handle_file_request(Request &req, Response &res);
  2098. bool check_if_not_modified(const Request &req, Response &res,
  2099. const std::string &etag, time_t mtime) const;
  2100. bool check_if_range(Request &req, const std::string &etag,
  2101. time_t mtime) const;
  2102. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2103. Stream &strm);
  2104. bool dispatch_request_for_content_reader(
  2105. Request &req, Response &res, ContentReader content_reader,
  2106. const HandlersForContentReader &handlers) const;
  2107. bool parse_request_line(const char *s, Request &req) const;
  2108. detail::EncodingType static_file_encoding(const Request &req,
  2109. const Response &res,
  2110. const std::string &content_type,
  2111. size_t length) const;
  2112. bool apply_static_file_compression(const Request &req, Response &res) const;
  2113. void apply_ranges(const Request &req, Response &res,
  2114. std::string &content_type, std::string &boundary) const;
  2115. bool write_response(Stream &strm, bool close_connection, Request &req,
  2116. Response &res);
  2117. bool write_response_with_content(Stream &strm, bool close_connection,
  2118. const Request &req, Response &res);
  2119. bool write_response_core(Stream &strm, bool close_connection,
  2120. const Request &req, Response &res,
  2121. bool need_apply_ranges);
  2122. bool write_content_with_provider(Stream &strm, const Request &req,
  2123. Response &res, const std::string &boundary,
  2124. const std::string &content_type);
  2125. bool read_content(Stream &strm, Request &req, Response &res);
  2126. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2127. Response &res,
  2128. ContentReceiver receiver,
  2129. FormDataHeader multipart_header,
  2130. ContentReceiver multipart_receiver);
  2131. bool read_content_core(Stream &strm, Request &req, Response &res,
  2132. ContentReceiver receiver,
  2133. FormDataHeader multipart_header,
  2134. ContentReceiver multipart_receiver) const;
  2135. virtual bool process_and_close_socket(socket_t sock);
  2136. void output_log(const Request &req, const Response &res) const;
  2137. void output_pre_compression_log(const Request &req,
  2138. const Response &res) const;
  2139. void output_error_log(const Error &err, const Request *req) const;
  2140. std::atomic<bool> is_running_{false};
  2141. std::atomic<bool> is_decommissioned{false};
  2142. // Set when CustomRoute() refuses a registration. Written before listen(),
  2143. // read by is_valid() on the same thread, so it needs no synchronization.
  2144. bool has_invalid_registration_ = false;
  2145. struct MountPointEntry {
  2146. std::string mount_point;
  2147. std::string base_dir;
  2148. std::string resolved_base_dir;
  2149. Headers headers;
  2150. };
  2151. std::vector<MountPointEntry> base_dirs_;
  2152. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2153. std::string default_file_mimetype_ = "application/octet-stream";
  2154. Handler file_request_handler_;
  2155. Handlers get_handlers_;
  2156. Handlers post_handlers_;
  2157. HandlersForContentReader post_handlers_for_content_reader_;
  2158. Handlers put_handlers_;
  2159. HandlersForContentReader put_handlers_for_content_reader_;
  2160. Handlers patch_handlers_;
  2161. HandlersForContentReader patch_handlers_for_content_reader_;
  2162. Handlers delete_handlers_;
  2163. HandlersForContentReader delete_handlers_for_content_reader_;
  2164. Handlers options_handlers_;
  2165. CustomHandlers custom_handlers_;
  2166. struct WebSocketHandlerEntry {
  2167. std::unique_ptr<detail::MatcherBase> matcher;
  2168. WebSocketHandler handler;
  2169. SubProtocolSelector sub_protocol_selector;
  2170. };
  2171. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2172. WebSocketHandlers websocket_handlers_;
  2173. HandlerWithResponse error_handler_;
  2174. ExceptionHandler exception_handler_;
  2175. HandlerWithResponse pre_routing_handler_;
  2176. Handler post_routing_handler_;
  2177. HandlerWithResponse pre_request_handler_;
  2178. Expect100ContinueHandler expect_100_continue_handler_;
  2179. StartHandler start_handler_;
  2180. mutable std::mutex logger_mutex_;
  2181. Logger logger_;
  2182. Logger pre_compression_logger_;
  2183. ErrorLogger error_logger_;
  2184. int address_family_ = AF_UNSPEC;
  2185. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2186. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2187. SocketOptions socket_options_ = default_socket_options;
  2188. Headers default_headers_;
  2189. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2190. detail::write_headers;
  2191. };
  2192. class Result {
  2193. public:
  2194. Result() = default;
  2195. Result(std::unique_ptr<Response> &&res, Error err,
  2196. Headers &&request_headers = Headers{})
  2197. : res_(std::move(res)), err_(err),
  2198. request_headers_(std::move(request_headers)) {}
  2199. // Response
  2200. operator bool() const { return res_ != nullptr; }
  2201. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2202. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2203. const Response &value() const { return *res_; }
  2204. Response &value() { return *res_; }
  2205. const Response &operator*() const { return *res_; }
  2206. Response &operator*() { return *res_; }
  2207. const Response *operator->() const { return res_.get(); }
  2208. Response *operator->() { return res_.get(); }
  2209. // Error
  2210. Error error() const { return err_; }
  2211. // Request Headers
  2212. bool has_request_header(const std::string &key) const;
  2213. std::string get_request_header_value(const std::string &key,
  2214. const char *def = "",
  2215. size_t id = 0) const;
  2216. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2217. size_t id = 0) const;
  2218. size_t get_request_header_value_count(const std::string &key) const;
  2219. private:
  2220. std::unique_ptr<Response> res_;
  2221. Error err_ = Error::Unknown;
  2222. Headers request_headers_;
  2223. #ifdef CPPHTTPLIB_SSL_ENABLED
  2224. public:
  2225. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2226. int ssl_error)
  2227. : res_(std::move(res)), err_(err),
  2228. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2229. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2230. int ssl_error, uint64_t ssl_backend_error)
  2231. : res_(std::move(res)), err_(err),
  2232. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2233. ssl_backend_error_(ssl_backend_error) {}
  2234. int ssl_error() const { return ssl_error_; }
  2235. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2236. private:
  2237. int ssl_error_ = 0;
  2238. uint64_t ssl_backend_error_ = 0;
  2239. #endif
  2240. };
  2241. struct ClientConnection {
  2242. socket_t sock = INVALID_SOCKET;
  2243. bool is_open() const { return sock != INVALID_SOCKET; }
  2244. ClientConnection() = default;
  2245. ~ClientConnection();
  2246. ClientConnection(const ClientConnection &) = delete;
  2247. ClientConnection &operator=(const ClientConnection &) = delete;
  2248. ClientConnection(ClientConnection &&other) noexcept
  2249. : sock(other.sock)
  2250. #ifdef CPPHTTPLIB_SSL_ENABLED
  2251. ,
  2252. session(other.session)
  2253. #endif
  2254. {
  2255. other.sock = INVALID_SOCKET;
  2256. #ifdef CPPHTTPLIB_SSL_ENABLED
  2257. other.session = nullptr;
  2258. #endif
  2259. }
  2260. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2261. if (this != &other) {
  2262. sock = other.sock;
  2263. other.sock = INVALID_SOCKET;
  2264. #ifdef CPPHTTPLIB_SSL_ENABLED
  2265. session = other.session;
  2266. other.session = nullptr;
  2267. #endif
  2268. }
  2269. return *this;
  2270. }
  2271. #ifdef CPPHTTPLIB_SSL_ENABLED
  2272. tls::session_t session = nullptr;
  2273. #endif
  2274. };
  2275. namespace detail {
  2276. struct ChunkedDecoder;
  2277. struct BodyReader {
  2278. Stream *stream = nullptr;
  2279. bool has_content_length = false;
  2280. size_t content_length = 0;
  2281. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2282. size_t bytes_read = 0;
  2283. bool chunked = false;
  2284. bool eof = false;
  2285. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2286. Error last_error = Error::Success;
  2287. ssize_t read(char *buf, size_t len);
  2288. bool has_error() const { return last_error != Error::Success; }
  2289. };
  2290. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2291. size_t len) {
  2292. (void)stream;
  2293. return br.read(buf, len);
  2294. }
  2295. class decompressor;
  2296. enum class NoProxyKind {
  2297. Wildcard, // "*"
  2298. HostnameSuffix, // "example.com" or ".example.com"
  2299. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2300. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2301. };
  2302. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2303. // Lets one CIDR matcher cover both families.
  2304. using IPBytes = std::array<uint8_t, 16>;
  2305. struct NoProxyEntry {
  2306. NoProxyKind kind = NoProxyKind::Wildcard;
  2307. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2308. IPBytes net{};
  2309. int prefix_bits = 0;
  2310. };
  2311. struct NormalizedTarget {
  2312. std::string hostname; // lowercase; brackets and trailing dot removed
  2313. bool is_ipv4 = false;
  2314. bool is_ipv6 = false;
  2315. IPBytes ip{};
  2316. };
  2317. } // namespace detail
  2318. class ClientImpl {
  2319. public:
  2320. explicit ClientImpl(const std::string &host);
  2321. explicit ClientImpl(const std::string &host, int port);
  2322. explicit ClientImpl(const std::string &host, int port,
  2323. const std::string &client_cert_path,
  2324. const std::string &client_key_path);
  2325. virtual ~ClientImpl();
  2326. virtual bool is_valid() const;
  2327. struct StreamHandle {
  2328. std::unique_ptr<Response> response;
  2329. Error error = Error::Success;
  2330. StreamHandle() = default;
  2331. StreamHandle(const StreamHandle &) = delete;
  2332. StreamHandle &operator=(const StreamHandle &) = delete;
  2333. StreamHandle(StreamHandle &&) = default;
  2334. StreamHandle &operator=(StreamHandle &&) = default;
  2335. ~StreamHandle() = default;
  2336. bool is_valid() const {
  2337. return response != nullptr && error == Error::Success;
  2338. }
  2339. ssize_t read(char *buf, size_t len);
  2340. void parse_trailers_if_needed();
  2341. Error get_read_error() const { return body_reader_.last_error; }
  2342. bool has_read_error() const { return body_reader_.has_error(); }
  2343. bool trailers_parsed_ = false;
  2344. private:
  2345. friend class ClientImpl;
  2346. friend class sse::SSEClient;
  2347. ssize_t read_with_decompression(char *buf, size_t len);
  2348. std::unique_ptr<ClientConnection> connection_;
  2349. std::unique_ptr<Stream> socket_stream_;
  2350. Stream *stream_ = nullptr;
  2351. detail::BodyReader body_reader_;
  2352. std::unique_ptr<detail::decompressor> decompressor_;
  2353. std::string decompress_buffer_;
  2354. size_t decompress_offset_ = 0;
  2355. size_t decompressed_bytes_read_ = 0;
  2356. };
  2357. // clang-format off
  2358. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2359. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2360. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2361. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2362. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2363. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2364. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2365. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2366. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2367. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2368. Result Head(const std::string &path);
  2369. Result Head(const std::string &path, const Headers &headers);
  2370. Result Post(const std::string &path);
  2371. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2372. Result Post(const std::string &path, const std::string &body, 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, UploadProgress progress = nullptr);
  2374. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2375. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2376. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2377. Result Post(const std::string &path, const Params &params);
  2378. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2379. Result Post(const std::string &path, const Headers &headers);
  2380. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2381. Result Post(const std::string &path, const Headers &headers, const std::string &body, 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, UploadProgress progress = nullptr);
  2383. 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);
  2384. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2385. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2386. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2387. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2388. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2389. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2390. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2391. Result Put(const std::string &path);
  2392. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2393. Result Put(const std::string &path, const std::string &body, 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, UploadProgress progress = nullptr);
  2395. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2396. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2397. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2398. Result Put(const std::string &path, const Params &params);
  2399. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2400. Result Put(const std::string &path, const Headers &headers);
  2401. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2402. Result Put(const std::string &path, const Headers &headers, const std::string &body, 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, UploadProgress progress = nullptr);
  2404. 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);
  2405. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2406. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2407. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2408. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2409. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2410. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2411. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2412. Result Patch(const std::string &path);
  2413. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2414. Result Patch(const std::string &path, const std::string &body, 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, UploadProgress progress = nullptr);
  2416. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2417. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2418. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2419. Result Patch(const std::string &path, const Params &params);
  2420. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2421. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2422. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2423. Result Patch(const std::string &path, const Headers &headers, const std::string &body, 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, UploadProgress progress = nullptr);
  2425. 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);
  2426. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2427. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2428. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2429. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2430. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2431. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2432. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2433. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2434. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2435. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2436. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2437. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2438. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2439. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2440. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2441. Result Options(const std::string &path);
  2442. Result Options(const std::string &path, const Headers &headers);
  2443. // clang-format on
  2444. // Streaming API: Open a stream for reading response body incrementally
  2445. // Socket ownership is transferred to StreamHandle for true streaming
  2446. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2447. StreamHandle open_stream(const std::string &method, const std::string &path,
  2448. const Params &params = {},
  2449. const Headers &headers = {},
  2450. const std::string &body = {},
  2451. const std::string &content_type = {});
  2452. bool send(Request &req, Response &res, Error &error);
  2453. Result send(const Request &req);
  2454. void stop();
  2455. std::string host() const;
  2456. int port() const;
  2457. size_t is_socket_open() const;
  2458. socket_t socket() const;
  2459. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2460. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2461. void
  2462. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2463. void
  2464. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2465. void set_default_headers(Headers headers);
  2466. void
  2467. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2468. void set_address_family(int family);
  2469. void set_tcp_nodelay(bool on);
  2470. void set_ipv6_v6only(bool on);
  2471. void set_socket_options(SocketOptions socket_options);
  2472. void set_connection_timeout(time_t sec, time_t usec = 0);
  2473. template <class Rep, class Period>
  2474. void
  2475. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2476. void set_read_timeout(time_t sec, time_t usec = 0);
  2477. template <class Rep, class Period>
  2478. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2479. void set_write_timeout(time_t sec, time_t usec = 0);
  2480. template <class Rep, class Period>
  2481. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2482. void set_max_timeout(time_t msec);
  2483. template <class Rep, class Period>
  2484. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2485. void set_basic_auth(const std::string &username, const std::string &password);
  2486. void set_bearer_token_auth(const std::string &token);
  2487. void set_keep_alive(bool on);
  2488. void set_follow_location(bool on);
  2489. void set_path_encode(bool on);
  2490. void set_compress(bool on);
  2491. void set_decompress(bool on);
  2492. void set_payload_max_length(size_t length);
  2493. void set_interface(const std::string &intf);
  2494. void set_proxy(const std::string &host, int port);
  2495. void set_proxy_basic_auth(const std::string &username,
  2496. const std::string &password);
  2497. void set_proxy_bearer_token_auth(const std::string &token);
  2498. void set_no_proxy(const std::vector<std::string> &patterns);
  2499. void set_logger(Logger logger);
  2500. void set_error_logger(ErrorLogger error_logger);
  2501. protected:
  2502. struct Socket {
  2503. socket_t sock = INVALID_SOCKET;
  2504. // For Mbed TLS compatibility: start_time for request timeout tracking
  2505. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2506. bool is_open() const { return sock != INVALID_SOCKET; }
  2507. #ifdef CPPHTTPLIB_SSL_ENABLED
  2508. tls::session_t ssl = nullptr;
  2509. #endif
  2510. };
  2511. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2512. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2513. virtual bool setup_proxy_connection(
  2514. Socket &socket,
  2515. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2516. Response &res, bool &success, Error &error);
  2517. bool is_proxy_enabled_for_host(const std::string &host) const;
  2518. // All of:
  2519. // shutdown_ssl
  2520. // shutdown_socket
  2521. // close_socket
  2522. // disconnect
  2523. // should ONLY be called on socket_ with socket_mutex_ locked, or on a
  2524. // connection being opened, and only when no other thread is using it.
  2525. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2526. void shutdown_socket(Socket &socket) const;
  2527. void close_socket(Socket &socket);
  2528. void disconnect(bool gracefully);
  2529. // Under socket_mutex_: whether the connection kept alive can take another
  2530. // request. One with anything to read, or one set up under TLS settings
  2531. // changed since, is closed instead.
  2532. bool socket_reusable();
  2533. // Makes socket_ ready for a request, with socket_mutex_ held by guard. A new
  2534. // connection is opened without the lock, so that stop() can end it.
  2535. bool
  2536. prepare_socket(std::unique_lock<std::mutex> &guard,
  2537. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2538. Response &res, bool &success, Error &error);
  2539. // TLS settings apply as a connection is set up, so a change makes the
  2540. // connection kept alive unfit for the next request.
  2541. void tls_settings_changed() { tls_settings_version_++; }
  2542. std::string make_request_target(const Request &req) const;
  2543. bool process_request(Stream &strm, Request &req, Response &res,
  2544. bool close_connection, Error &error);
  2545. bool write_content_with_provider(Stream &strm, const Request &req,
  2546. Error &error) const;
  2547. void output_log(const Request &req, const Response &res) const;
  2548. void output_error_log(const Error &err, const Request *req) const;
  2549. // Socket endpoint information
  2550. const std::string host_;
  2551. const int port_;
  2552. // Current open socket
  2553. Socket socket_;
  2554. mutable std::mutex socket_mutex_;
  2555. std::recursive_mutex request_mutex_;
  2556. // How many send() calls are running on this client, guarded by
  2557. // request_mutex_
  2558. size_t send_depth_ = 0;
  2559. // Also guarded by request_mutex_
  2560. size_t socket_tls_settings_version_ = 0;
  2561. // These are all protected under socket_mutex
  2562. size_t socket_requests_in_flight_ = 0;
  2563. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2564. bool socket_should_be_closed_when_request_is_done_ = false;
  2565. // Set by stop(), cleared as a send() or an open_stream() starts. Its waits
  2566. // poll it: shutdown() does not reach a connection being opened, nor wake a
  2567. // read on Windows.
  2568. std::atomic<bool> stop_requested_{false};
  2569. std::function<bool()> stop_interrupt() const {
  2570. return [this] { return stop_requested_.load(); };
  2571. }
  2572. std::atomic<size_t> tls_settings_version_{0};
  2573. // Hostname to connection target map. The value is an IP literal or another
  2574. // hostname; only the connection target changes, never the identity.
  2575. std::map<std::string, std::string> addr_map_;
  2576. // Hostname to CONNECT target map, used only through a proxy.
  2577. std::map<std::string, std::string> tunnel_addr_map_;
  2578. // Default headers
  2579. Headers default_headers_;
  2580. // Header writer
  2581. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2582. detail::write_headers;
  2583. // Settings
  2584. std::string client_cert_path_;
  2585. std::string client_key_path_;
  2586. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2587. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2588. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2589. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2590. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2591. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2592. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2593. std::string basic_auth_username_;
  2594. std::string basic_auth_password_;
  2595. std::string bearer_token_auth_token_;
  2596. bool keep_alive_ = false;
  2597. bool follow_location_ = false;
  2598. bool path_encode_ = true;
  2599. int address_family_ = AF_UNSPEC;
  2600. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2601. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2602. SocketOptions socket_options_ = nullptr;
  2603. bool compress_ = false;
  2604. bool decompress_ = true;
  2605. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2606. bool has_payload_max_length_ = false;
  2607. std::string interface_;
  2608. std::string proxy_host_;
  2609. int proxy_port_ = -1;
  2610. std::string proxy_basic_auth_username_;
  2611. std::string proxy_basic_auth_password_;
  2612. std::string proxy_bearer_token_auth_token_;
  2613. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2614. mutable detail::NormalizedTarget host_normalized_;
  2615. mutable bool host_normalized_valid_ = false;
  2616. mutable std::mutex logger_mutex_;
  2617. Logger logger_;
  2618. ErrorLogger error_logger_;
  2619. private:
  2620. bool send_(Request &req, Response &res, Error &error);
  2621. Result send_(Request &&req);
  2622. socket_t create_client_socket(Error &error) const;
  2623. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2624. bool skip_100_continue = true) const;
  2625. bool write_request(Stream &strm, Request &req, bool close_connection,
  2626. Error &error, bool skip_body, bool &rejected_locally);
  2627. bool write_request_body(Stream &strm, Request &req, Error &error);
  2628. void prepare_default_headers(Request &r, bool for_stream,
  2629. const std::string &ct);
  2630. bool redirect(Request &req, Response &res, Error &error);
  2631. bool create_redirect_client(const std::string &scheme,
  2632. const std::string &host, int port, Request &req,
  2633. Response &res, const std::string &path,
  2634. const std::string &location, Error &error);
  2635. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2636. bool handle_request(Stream &strm, Request &req, Response &res,
  2637. bool close_connection, Error &error);
  2638. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2639. Request &req, const char *body, size_t content_length,
  2640. ContentProvider content_provider,
  2641. ContentProviderWithoutLength content_provider_without_length,
  2642. const std::string &content_type, ContentReceiver content_receiver,
  2643. Error &error);
  2644. Result send_with_content_provider_and_receiver(
  2645. const std::string &method, const std::string &path,
  2646. const Headers &headers, const char *body, size_t content_length,
  2647. ContentProvider content_provider,
  2648. ContentProviderWithoutLength content_provider_without_length,
  2649. const std::string &content_type, ContentReceiver content_receiver,
  2650. UploadProgress progress);
  2651. ContentProviderWithoutLength get_multipart_content_provider(
  2652. const std::string &boundary, const UploadFormDataItems &items,
  2653. const FormDataProviderItems &provider_items) const;
  2654. virtual bool
  2655. process_socket(const Socket &socket,
  2656. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2657. std::function<bool(Stream &strm)> callback);
  2658. virtual bool is_ssl() const;
  2659. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2660. StreamHandle open_stream_(Request &req);
  2661. void add_credential_headers(Request &req);
  2662. std::string proxy_target_prefix() const;
  2663. #ifdef CPPHTTPLIB_SSL_ENABLED
  2664. public:
  2665. void set_digest_auth(const std::string &username,
  2666. const std::string &password);
  2667. void set_proxy_digest_auth(const std::string &username,
  2668. const std::string &password);
  2669. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2670. const std::string &ca_cert_dir_path = std::string());
  2671. void enable_server_certificate_verification(bool enabled);
  2672. void enable_server_hostname_verification(bool enabled);
  2673. void enable_system_ca(bool enabled);
  2674. protected:
  2675. std::string digest_auth_username_;
  2676. std::string digest_auth_password_;
  2677. std::string proxy_digest_auth_username_;
  2678. std::string proxy_digest_auth_password_;
  2679. std::string ca_cert_file_path_;
  2680. std::string ca_cert_dir_path_;
  2681. bool server_certificate_verification_ = true;
  2682. bool server_hostname_verification_ = true;
  2683. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2684. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2685. int last_ssl_error_ = 0;
  2686. uint64_t last_backend_error_ = 0;
  2687. #endif
  2688. };
  2689. namespace detail {
  2690. // Stands in for a client that Client could not make from its arguments, so a
  2691. // request fails rather than going through a null pointer.
  2692. class InvalidClientImpl final : public ClientImpl {
  2693. public:
  2694. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2695. bool is_valid() const override { return false; }
  2696. private:
  2697. bool create_and_connect_socket(Socket &, Error &error) override {
  2698. error = Error::Connection;
  2699. return false;
  2700. }
  2701. };
  2702. } // namespace detail
  2703. class Client {
  2704. public:
  2705. // Universal interface
  2706. explicit Client(const std::string &scheme_host_port);
  2707. explicit Client(const std::string &scheme_host_port,
  2708. const std::string &client_cert_path,
  2709. const std::string &client_key_path);
  2710. // HTTP only interface
  2711. explicit Client(const std::string &host, int port);
  2712. explicit Client(const std::string &host, int port,
  2713. const std::string &client_cert_path,
  2714. const std::string &client_key_path);
  2715. Client(Client &&) = default;
  2716. Client &operator=(Client &&) = default;
  2717. ~Client();
  2718. bool is_valid() const;
  2719. // clang-format off
  2720. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2721. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2722. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2723. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2724. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2725. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2726. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2727. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2728. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2729. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2730. Result Head(const std::string &path);
  2731. Result Head(const std::string &path, const Headers &headers);
  2732. Result Post(const std::string &path);
  2733. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2734. Result Post(const std::string &path, const std::string &body, 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, UploadProgress progress = nullptr);
  2736. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2737. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2738. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2739. Result Post(const std::string &path, const Params &params);
  2740. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2741. Result Post(const std::string &path, const Headers &headers);
  2742. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2743. Result Post(const std::string &path, const Headers &headers, const std::string &body, 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, UploadProgress progress = nullptr);
  2745. 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);
  2746. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2747. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2748. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2749. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2750. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2751. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2752. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2753. Result Put(const std::string &path);
  2754. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2755. Result Put(const std::string &path, const std::string &body, 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, UploadProgress progress = nullptr);
  2757. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2758. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2759. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2760. Result Put(const std::string &path, const Params &params);
  2761. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2762. Result Put(const std::string &path, const Headers &headers);
  2763. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2764. Result Put(const std::string &path, const Headers &headers, const std::string &body, 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, UploadProgress progress = nullptr);
  2766. 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);
  2767. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2768. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2769. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2770. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2771. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2772. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2773. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2774. Result Patch(const std::string &path);
  2775. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2776. Result Patch(const std::string &path, const std::string &body, 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, UploadProgress progress = nullptr);
  2778. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2779. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2780. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2781. Result Patch(const std::string &path, const Params &params);
  2782. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2783. Result Patch(const std::string &path, const Headers &headers);
  2784. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2785. Result Patch(const std::string &path, const Headers &headers, const std::string &body, 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, UploadProgress progress = nullptr);
  2787. 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);
  2788. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2789. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2790. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2791. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2792. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2793. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2794. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2795. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2796. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2797. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2798. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2799. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2800. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2801. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2802. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2803. Result Options(const std::string &path);
  2804. Result Options(const std::string &path, const Headers &headers);
  2805. // clang-format on
  2806. // Streaming API: Open a stream for reading response body incrementally
  2807. // Socket ownership is transferred to StreamHandle for true streaming
  2808. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2809. ClientImpl::StreamHandle open_stream(const std::string &method,
  2810. const std::string &path,
  2811. const Params &params = {},
  2812. const Headers &headers = {},
  2813. const std::string &body = {},
  2814. const std::string &content_type = {});
  2815. bool send(Request &req, Response &res, Error &error);
  2816. Result send(const Request &req);
  2817. void stop();
  2818. std::string host() const;
  2819. int port() const;
  2820. size_t is_socket_open() const;
  2821. socket_t socket() const;
  2822. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2823. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2824. void
  2825. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2826. void
  2827. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2828. void set_default_headers(Headers headers);
  2829. void
  2830. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2831. void set_address_family(int family);
  2832. void set_tcp_nodelay(bool on);
  2833. void set_socket_options(SocketOptions socket_options);
  2834. void set_connection_timeout(time_t sec, time_t usec = 0);
  2835. template <class Rep, class Period>
  2836. void
  2837. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2838. void set_read_timeout(time_t sec, time_t usec = 0);
  2839. template <class Rep, class Period>
  2840. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2841. void set_write_timeout(time_t sec, time_t usec = 0);
  2842. template <class Rep, class Period>
  2843. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2844. void set_max_timeout(time_t msec);
  2845. template <class Rep, class Period>
  2846. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2847. void set_basic_auth(const std::string &username, const std::string &password);
  2848. void set_bearer_token_auth(const std::string &token);
  2849. void set_keep_alive(bool on);
  2850. void set_follow_location(bool on);
  2851. void set_path_encode(bool on);
  2852. void set_compress(bool on);
  2853. void set_decompress(bool on);
  2854. void set_payload_max_length(size_t length);
  2855. void set_interface(const std::string &intf);
  2856. void set_proxy(const std::string &host, int port);
  2857. void set_proxy_basic_auth(const std::string &username,
  2858. const std::string &password);
  2859. void set_proxy_bearer_token_auth(const std::string &token);
  2860. void set_no_proxy(const std::vector<std::string> &patterns);
  2861. void set_logger(Logger logger);
  2862. void set_error_logger(ErrorLogger error_logger);
  2863. private:
  2864. std::unique_ptr<ClientImpl> cli_;
  2865. #ifdef CPPHTTPLIB_SSL_ENABLED
  2866. public:
  2867. void set_digest_auth(const std::string &username,
  2868. const std::string &password);
  2869. void set_proxy_digest_auth(const std::string &username,
  2870. const std::string &password);
  2871. void enable_server_certificate_verification(bool enabled);
  2872. void enable_server_hostname_verification(bool enabled);
  2873. void enable_system_ca(bool enabled);
  2874. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2875. const std::string &ca_cert_dir_path = std::string());
  2876. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2877. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2878. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2879. void set_session_verifier(
  2880. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2881. tls::ctx_t tls_context() const;
  2882. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2883. void enable_windows_certificate_verification(bool enabled);
  2884. #endif
  2885. private:
  2886. bool is_ssl_ = false;
  2887. #endif
  2888. };
  2889. #ifdef CPPHTTPLIB_SSL_ENABLED
  2890. class SSLServer : public Server {
  2891. public:
  2892. SSLServer(const char *cert_path, const char *private_key_path,
  2893. const char *client_ca_cert_file_path = nullptr,
  2894. const char *client_ca_cert_dir_path = nullptr,
  2895. const char *private_key_password = nullptr);
  2896. struct PemMemory {
  2897. const char *cert_pem;
  2898. size_t cert_pem_len;
  2899. const char *key_pem;
  2900. size_t key_pem_len;
  2901. const char *client_ca_pem;
  2902. size_t client_ca_pem_len;
  2903. const char *private_key_password;
  2904. };
  2905. explicit SSLServer(const PemMemory &pem);
  2906. // The callback receives the ctx_t handle which can be cast to the
  2907. // appropriate backend type (SSL_CTX* for OpenSSL,
  2908. // tls::impl::MbedTlsContext* for Mbed TLS)
  2909. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2910. ~SSLServer() override;
  2911. bool is_valid() const override;
  2912. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2913. const char *client_ca_pem = nullptr,
  2914. const char *password = nullptr);
  2915. tls::ctx_t tls_context() const { return ctx_; }
  2916. int ssl_last_error() const { return last_ssl_error_; }
  2917. private:
  2918. bool process_and_close_socket(socket_t sock) override;
  2919. tls::ctx_t ctx_ = nullptr;
  2920. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2921. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2922. // bounds, and new ones wait while it is pending so that they cannot keep it
  2923. // waiting.
  2924. std::mutex ctx_mutex_;
  2925. std::condition_variable ctx_cv_;
  2926. size_t handshakes_in_progress_ = 0;
  2927. size_t updates_pending_ = 0;
  2928. int last_ssl_error_ = 0;
  2929. };
  2930. class SSLClient final : public ClientImpl {
  2931. public:
  2932. explicit SSLClient(const std::string &host);
  2933. explicit SSLClient(const std::string &host, int port);
  2934. explicit SSLClient(const std::string &host, int port,
  2935. const std::string &client_cert_path,
  2936. const std::string &client_key_path,
  2937. const std::string &private_key_password = std::string());
  2938. struct PemMemory {
  2939. const char *cert_pem;
  2940. size_t cert_pem_len;
  2941. const char *key_pem;
  2942. size_t key_pem_len;
  2943. const char *private_key_password;
  2944. };
  2945. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2946. ~SSLClient() override;
  2947. bool is_valid() const override;
  2948. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2949. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2950. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2951. // Post-handshake session verifier (backend-independent)
  2952. void set_session_verifier(
  2953. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2954. tls::ctx_t tls_context() const { return ctx_; }
  2955. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2956. void enable_windows_certificate_verification(bool enabled);
  2957. #endif
  2958. private:
  2959. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2960. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2961. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2962. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2963. bool
  2964. process_socket(const Socket &socket,
  2965. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2966. std::function<bool(Stream &strm)> callback) override;
  2967. bool is_ssl() const override;
  2968. bool setup_proxy_connection(
  2969. Socket &socket,
  2970. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2971. Response &res, bool &success, Error &error) override;
  2972. bool connect_with_proxy(
  2973. Socket &sock,
  2974. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2975. Response &res, bool &success, Error &error);
  2976. bool initialize_ssl(Socket &socket, Error &error);
  2977. void init_ctx();
  2978. void reset_ctx_on_error();
  2979. bool load_certs();
  2980. tls::ctx_t ctx_ = nullptr;
  2981. std::mutex ctx_mutex_;
  2982. std::once_flag initialize_cert_;
  2983. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2984. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2985. bool ca_cert_store_set_ = false;
  2986. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2987. // no certificate, so that a CA that failed to come through fails
  2988. // verification instead of letting the system CAs in.
  2989. bool custom_ca_loaded_ = false;
  2990. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2991. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2992. // set_server_certificate_verifier() installed there.
  2993. tls::VerifyCallback server_certificate_verifier_;
  2994. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2995. bool enable_windows_cert_verification_ = true;
  2996. #endif
  2997. friend class ClientImpl;
  2998. };
  2999. #endif // CPPHTTPLIB_SSL_ENABLED
  3000. namespace detail {
  3001. template <typename T, typename U>
  3002. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  3003. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  3004. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  3005. duration - std::chrono::seconds(sec))
  3006. .count();
  3007. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  3008. }
  3009. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  3010. return N - 1;
  3011. }
  3012. inline bool is_numeric(const std::string &str) {
  3013. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  3014. }
  3015. // std::ranges::next(first, n, last) for C++11
  3016. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  3017. for (; n > 0 && first != last; --n) {
  3018. ++first;
  3019. }
  3020. return first;
  3021. }
  3022. inline size_t get_header_value_u64(const Headers &headers,
  3023. const std::string &key, size_t def,
  3024. size_t id, bool &is_invalid_value) {
  3025. is_invalid_value = false;
  3026. auto rng = headers.equal_range(key);
  3027. auto it = bounded_next(rng.first, id, rng.second);
  3028. if (it != rng.second) {
  3029. if (is_numeric(it->second)) {
  3030. // Parse at size_t width so an out-of-range Content-Length is reported
  3031. // rather than silently saturated/truncated (a value above 2^32 would
  3032. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  3033. // and return SIZE_MAX so the existing oversized-value guards reject it.
  3034. size_t val = 0;
  3035. const auto &s = it->second;
  3036. auto r = from_chars(s.data(), s.data() + s.size(), val);
  3037. if (r.ec == std::errc::result_out_of_range) {
  3038. is_invalid_value = true;
  3039. return (std::numeric_limits<size_t>::max)();
  3040. }
  3041. return val;
  3042. } else {
  3043. is_invalid_value = true;
  3044. }
  3045. }
  3046. return def;
  3047. }
  3048. inline size_t get_header_value_u64(const Headers &headers,
  3049. const std::string &key, size_t def,
  3050. size_t id) {
  3051. auto dummy = false;
  3052. return get_header_value_u64(headers, key, def, id, dummy);
  3053. }
  3054. } // namespace detail
  3055. template <class Rep, class Period>
  3056. inline Server &
  3057. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3058. detail::duration_to_sec_and_usec(
  3059. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3060. return *this;
  3061. }
  3062. template <class Rep, class Period>
  3063. inline Server &
  3064. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3065. detail::duration_to_sec_and_usec(
  3066. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3067. return *this;
  3068. }
  3069. template <class Rep, class Period>
  3070. inline Server &
  3071. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3072. detail::duration_to_sec_and_usec(
  3073. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3074. return *this;
  3075. }
  3076. template <class Rep, class Period>
  3077. inline void ClientImpl::set_connection_timeout(
  3078. const std::chrono::duration<Rep, Period> &duration) {
  3079. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3080. set_connection_timeout(sec, usec);
  3081. });
  3082. }
  3083. template <class Rep, class Period>
  3084. inline void ClientImpl::set_read_timeout(
  3085. const std::chrono::duration<Rep, Period> &duration) {
  3086. detail::duration_to_sec_and_usec(
  3087. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3088. }
  3089. template <class Rep, class Period>
  3090. inline void ClientImpl::set_write_timeout(
  3091. const std::chrono::duration<Rep, Period> &duration) {
  3092. detail::duration_to_sec_and_usec(
  3093. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3094. }
  3095. template <class Rep, class Period>
  3096. inline void ClientImpl::set_max_timeout(
  3097. const std::chrono::duration<Rep, Period> &duration) {
  3098. auto msec =
  3099. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3100. set_max_timeout(static_cast<time_t>(msec));
  3101. }
  3102. template <class Rep, class Period>
  3103. inline void Client::set_connection_timeout(
  3104. const std::chrono::duration<Rep, Period> &duration) {
  3105. cli_->set_connection_timeout(duration);
  3106. }
  3107. template <class Rep, class Period>
  3108. inline void
  3109. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3110. cli_->set_read_timeout(duration);
  3111. }
  3112. template <class Rep, class Period>
  3113. inline void
  3114. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3115. cli_->set_write_timeout(duration);
  3116. }
  3117. inline void Client::set_max_timeout(time_t msec) {
  3118. cli_->set_max_timeout(msec);
  3119. }
  3120. template <class Rep, class Period>
  3121. inline void
  3122. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3123. cli_->set_max_timeout(duration);
  3124. }
  3125. /*
  3126. * Forward declarations and types that will be part of the .h file if split into
  3127. * .h + .cc.
  3128. */
  3129. std::string hosted_at(const std::string &hostname);
  3130. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3131. // JavaScript-style URL encoding/decoding functions
  3132. std::string encode_uri_component(const std::string &value);
  3133. std::string encode_uri(const std::string &value);
  3134. std::string decode_uri_component(const std::string &value);
  3135. std::string decode_uri(const std::string &value);
  3136. // RFC 3986 compliant URL component encoding/decoding functions
  3137. std::string encode_path_component(const std::string &component);
  3138. std::string decode_path_component(const std::string &component);
  3139. std::string encode_query_component(const std::string &component,
  3140. bool space_as_plus = true);
  3141. std::string decode_query_component(const std::string &component,
  3142. bool plus_as_space = true);
  3143. std::string sanitize_filename(const std::string &filename);
  3144. std::string append_query_params(const std::string &path, const Params &params);
  3145. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3146. std::pair<std::string, std::string>
  3147. make_basic_authentication_header(const std::string &username,
  3148. const std::string &password,
  3149. bool is_proxy = false);
  3150. namespace detail {
  3151. #if defined(_WIN32)
  3152. inline std::wstring u8string_to_wstring(const char *s) {
  3153. if (!s) { return std::wstring(); }
  3154. auto len = static_cast<int>(strlen(s));
  3155. if (!len) { return std::wstring(); }
  3156. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3157. if (!wlen) { return std::wstring(); }
  3158. std::wstring ws;
  3159. ws.resize(wlen);
  3160. wlen = ::MultiByteToWideChar(
  3161. CP_UTF8, 0, s, len,
  3162. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3163. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3164. return ws;
  3165. }
  3166. #endif
  3167. struct FileStat {
  3168. FileStat(const std::string &path);
  3169. bool is_file() const;
  3170. bool is_dir() const;
  3171. time_t mtime() const;
  3172. size_t size() const;
  3173. private:
  3174. #if defined(_WIN32)
  3175. struct _stat st_;
  3176. #else
  3177. struct stat st_;
  3178. #endif
  3179. int ret_ = -1;
  3180. };
  3181. std::string make_host_and_port_string(const std::string &host, int port,
  3182. bool is_ssl);
  3183. template <typename T>
  3184. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3185. Error &error);
  3186. bool write_data(Stream &strm, const char *d, size_t l);
  3187. std::string trim_copy(const std::string &s);
  3188. void divide(
  3189. const char *data, std::size_t size, char d,
  3190. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3191. fn);
  3192. void divide(
  3193. const std::string &str, char d,
  3194. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3195. fn);
  3196. void split(const char *b, const char *e, char d,
  3197. std::function<void(const char *, const char *)> fn);
  3198. void split(const char *b, const char *e, char d, size_t m,
  3199. std::function<void(const char *, const char *)> fn);
  3200. bool split_find(const char *b, const char *e, char d,
  3201. std::function<bool(const char *, const char *)> fn);
  3202. bool has_header_token(const Headers &headers, const std::string &key,
  3203. const std::string &token);
  3204. std::string websocket_accept_key(const std::string &client_key);
  3205. bool is_websocket_upgrade(const Request &req);
  3206. bool process_client_socket(
  3207. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3208. time_t write_timeout_sec, time_t write_timeout_usec,
  3209. time_t max_timeout_msec,
  3210. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3211. std::function<bool(Stream &)> callback);
  3212. socket_t create_client_socket(
  3213. const std::string &host, const std::string &ip, int port,
  3214. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  3215. SocketOptions socket_options, time_t connection_timeout_sec,
  3216. time_t connection_timeout_usec, time_t read_timeout_sec,
  3217. time_t read_timeout_usec, time_t write_timeout_sec,
  3218. time_t write_timeout_usec, const std::string &intf, Error &error,
  3219. const std::function<bool()> &interrupted = nullptr);
  3220. const char *get_header_value(const Headers &headers, const std::string &key,
  3221. const char *def, size_t id);
  3222. std::string get_combined_header_value(const Headers &headers,
  3223. const std::string &key);
  3224. std::string params_to_query_str(const Params &params);
  3225. void parse_query_text(const char *data, std::size_t size, Params &params);
  3226. void parse_query_text(const std::string &s, Params &params);
  3227. bool parse_multipart_boundary(const std::string &content_type,
  3228. std::string &boundary);
  3229. bool parse_range_header(const std::string &s, Ranges &ranges);
  3230. bool parse_accept_header(const std::string &s,
  3231. std::vector<std::string> &content_types);
  3232. void parse_disposition_params(const std::string &s, Params &params);
  3233. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3234. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3235. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3236. EncodingType encoding_type(const Request &req, const Response &res,
  3237. const std::string &content_type);
  3238. EncodingType encoding_type(const Request &req, const Response &res);
  3239. class BufferStream final : public Stream {
  3240. public:
  3241. BufferStream() = default;
  3242. ~BufferStream() override = default;
  3243. bool is_readable() const override;
  3244. bool wait_readable() const override;
  3245. bool wait_writable() const override;
  3246. ssize_t read(char *ptr, size_t size) override;
  3247. ssize_t write(const char *ptr, size_t size) override;
  3248. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3249. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3250. socket_t socket() const override;
  3251. time_t duration() const override;
  3252. const std::string &get_buffer() const;
  3253. private:
  3254. std::string buffer;
  3255. size_t position = 0;
  3256. };
  3257. class compressor {
  3258. public:
  3259. virtual ~compressor() = default;
  3260. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3261. virtual bool compress(const char *data, size_t data_length, bool last,
  3262. Callback callback) = 0;
  3263. };
  3264. class decompressor {
  3265. public:
  3266. virtual ~decompressor() = default;
  3267. virtual bool is_valid() const = 0;
  3268. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3269. virtual bool decompress(const char *data, size_t data_length,
  3270. Callback callback) = 0;
  3271. };
  3272. class nocompressor final : public compressor {
  3273. public:
  3274. ~nocompressor() override = default;
  3275. bool compress(const char *data, size_t data_length, bool /*last*/,
  3276. Callback callback) override;
  3277. };
  3278. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3279. class gzip_compressor final : public compressor {
  3280. public:
  3281. gzip_compressor();
  3282. ~gzip_compressor() override;
  3283. bool compress(const char *data, size_t data_length, bool last,
  3284. Callback callback) override;
  3285. private:
  3286. bool is_valid_ = false;
  3287. z_stream strm_;
  3288. };
  3289. class gzip_decompressor final : public decompressor {
  3290. public:
  3291. gzip_decompressor();
  3292. ~gzip_decompressor() override;
  3293. bool is_valid() const override;
  3294. bool decompress(const char *data, size_t data_length,
  3295. Callback callback) override;
  3296. private:
  3297. bool is_valid_ = false;
  3298. z_stream strm_;
  3299. };
  3300. #endif
  3301. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3302. class brotli_compressor final : public compressor {
  3303. public:
  3304. brotli_compressor();
  3305. ~brotli_compressor();
  3306. bool compress(const char *data, size_t data_length, bool last,
  3307. Callback callback) override;
  3308. private:
  3309. BrotliEncoderState *state_ = nullptr;
  3310. };
  3311. class brotli_decompressor final : public decompressor {
  3312. public:
  3313. brotli_decompressor();
  3314. ~brotli_decompressor();
  3315. bool is_valid() const override;
  3316. bool decompress(const char *data, size_t data_length,
  3317. Callback callback) override;
  3318. private:
  3319. BrotliDecoderResult decoder_r;
  3320. BrotliDecoderState *decoder_s = nullptr;
  3321. };
  3322. #endif
  3323. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3324. class zstd_compressor : public compressor {
  3325. public:
  3326. zstd_compressor();
  3327. ~zstd_compressor();
  3328. bool compress(const char *data, size_t data_length, bool last,
  3329. Callback callback) override;
  3330. private:
  3331. ZSTD_CCtx *ctx_ = nullptr;
  3332. };
  3333. class zstd_decompressor : public decompressor {
  3334. public:
  3335. zstd_decompressor();
  3336. ~zstd_decompressor();
  3337. bool is_valid() const override;
  3338. bool decompress(const char *data, size_t data_length,
  3339. Callback callback) override;
  3340. private:
  3341. ZSTD_DCtx *ctx_ = nullptr;
  3342. };
  3343. #endif
  3344. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3345. // to store data. The call can set memory on stack for performance.
  3346. class stream_line_reader {
  3347. public:
  3348. stream_line_reader(Stream &strm, char *fixed_buffer,
  3349. size_t fixed_buffer_size);
  3350. const char *ptr() const;
  3351. size_t size() const;
  3352. bool end_with_crlf() const;
  3353. bool getline();
  3354. private:
  3355. void append(char c);
  3356. void append(const char *data, size_t size);
  3357. Stream &strm_;
  3358. char *fixed_buffer_;
  3359. const size_t fixed_buffer_size_;
  3360. size_t fixed_buffer_used_size_ = 0;
  3361. std::string growable_buffer_;
  3362. };
  3363. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3364. const Headers &src_headers);
  3365. struct ChunkedDecoder {
  3366. Stream &strm;
  3367. size_t chunk_remaining = 0;
  3368. bool finished = false;
  3369. char line_buf[64];
  3370. size_t last_chunk_total = 0;
  3371. size_t last_chunk_offset = 0;
  3372. size_t overhead = 0;
  3373. explicit ChunkedDecoder(Stream &s);
  3374. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3375. size_t &out_chunk_total);
  3376. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3377. };
  3378. // A regular file opened to be served: mapped on Windows, read with pread()
  3379. // elsewhere.
  3380. class mmap {
  3381. public:
  3382. mmap(const char *path);
  3383. ~mmap();
  3384. bool open(const char *path);
  3385. void close();
  3386. bool is_open() const;
  3387. size_t size() const;
  3388. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3389. // down to 0, if the file has shrunk since it was opened.
  3390. size_t read(size_t offset, char *buf, size_t len) const;
  3391. private:
  3392. #if defined(_WIN32)
  3393. HANDLE hFile_ = NULL;
  3394. HANDLE hMapping_ = NULL;
  3395. void *addr_ = nullptr;
  3396. bool is_open_empty_file = false;
  3397. #else
  3398. int fd_ = -1;
  3399. #endif
  3400. size_t size_ = 0;
  3401. };
  3402. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3403. namespace fields {
  3404. bool is_token_char(char c);
  3405. bool is_token(const std::string &s);
  3406. bool is_field_name(const std::string &s);
  3407. bool is_vchar(char c);
  3408. bool is_obs_text(char c);
  3409. bool is_field_vchar(char c);
  3410. bool is_field_content(const std::string &s);
  3411. bool is_field_value(const std::string &s);
  3412. bool is_field_valid(const std::string &name, const std::string &value);
  3413. bool is_request_target(const std::string &s);
  3414. bool is_host(const std::string &s);
  3415. } // namespace fields
  3416. } // namespace detail
  3417. /*
  3418. * TLS Abstraction Layer Declarations
  3419. */
  3420. #ifdef CPPHTTPLIB_SSL_ENABLED
  3421. // TLS abstraction layer - backend-specific type declarations
  3422. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3423. namespace tls {
  3424. namespace impl {
  3425. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3426. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3427. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3428. struct MbedTlsContext {
  3429. mbedtls_ssl_config conf;
  3430. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3431. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3432. mbedtls_entropy_context entropy;
  3433. mbedtls_ctr_drbg_context ctr_drbg;
  3434. #endif
  3435. mbedtls_x509_crt ca_chain;
  3436. mbedtls_x509_crt own_cert;
  3437. mbedtls_pk_context own_key;
  3438. bool is_server = false;
  3439. // Peer certificate required (set_verify_client()); a client defaults to true
  3440. bool verify_client = false;
  3441. // Set by tls::set_verify_callback().
  3442. VerifyCallback verify_callback;
  3443. MbedTlsContext();
  3444. ~MbedTlsContext();
  3445. MbedTlsContext(const MbedTlsContext &) = delete;
  3446. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3447. };
  3448. } // namespace impl
  3449. } // namespace tls
  3450. #endif
  3451. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3452. namespace tls {
  3453. namespace impl {
  3454. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3455. // This struct is accessible via tls::impl for use in SSL context
  3456. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3457. struct WolfSSLContext {
  3458. WOLFSSL_CTX *ctx = nullptr;
  3459. bool is_server = false;
  3460. // Peer certificate required (set_verify_client()); a client defaults to true
  3461. bool verify_client = false;
  3462. // Replaced under verify_callback_mutex()
  3463. std::shared_ptr<VerifyCallback> verify_callback;
  3464. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3465. WolfSSLContext();
  3466. ~WolfSSLContext();
  3467. WolfSSLContext(const WolfSSLContext &) = delete;
  3468. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3469. };
  3470. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3471. struct WolfSSLCAStore {
  3472. std::string pem_data;
  3473. };
  3474. } // namespace impl
  3475. } // namespace tls
  3476. #endif
  3477. #endif // CPPHTTPLIB_SSL_ENABLED
  3478. namespace stream {
  3479. class Result {
  3480. public:
  3481. Result();
  3482. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3483. Result(Result &&other) noexcept;
  3484. Result &operator=(Result &&other) noexcept;
  3485. Result(const Result &) = delete;
  3486. Result &operator=(const Result &) = delete;
  3487. // Response info
  3488. bool is_valid() const;
  3489. explicit operator bool() const;
  3490. int status() const;
  3491. const Headers &headers() const;
  3492. std::string get_header_value(const std::string &key,
  3493. const char *def = "") const;
  3494. bool has_header(const std::string &key) const;
  3495. Error error() const;
  3496. Error read_error() const;
  3497. bool has_read_error() const;
  3498. // Stream reading
  3499. bool next();
  3500. const char *data() const;
  3501. size_t size() const;
  3502. std::string read_all();
  3503. private:
  3504. ClientImpl::StreamHandle handle_;
  3505. std::string buffer_;
  3506. size_t current_size_ = 0;
  3507. size_t chunk_size_;
  3508. bool finished_ = false;
  3509. };
  3510. // GET
  3511. template <typename ClientType>
  3512. inline Result Get(ClientType &cli, const std::string &path,
  3513. size_t chunk_size = 8192) {
  3514. return Result{cli.open_stream("GET", path), chunk_size};
  3515. }
  3516. template <typename ClientType>
  3517. inline Result Get(ClientType &cli, const std::string &path,
  3518. const Headers &headers, size_t chunk_size = 8192) {
  3519. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3520. }
  3521. template <typename ClientType>
  3522. inline Result Get(ClientType &cli, const std::string &path,
  3523. const Params &params, size_t chunk_size = 8192) {
  3524. return Result{cli.open_stream("GET", path, params), chunk_size};
  3525. }
  3526. template <typename ClientType>
  3527. inline Result Get(ClientType &cli, const std::string &path,
  3528. const Params &params, const Headers &headers,
  3529. size_t chunk_size = 8192) {
  3530. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3531. }
  3532. // POST
  3533. template <typename ClientType>
  3534. inline Result Post(ClientType &cli, const std::string &path,
  3535. const std::string &body, const std::string &content_type,
  3536. size_t chunk_size = 8192) {
  3537. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3538. chunk_size};
  3539. }
  3540. template <typename ClientType>
  3541. inline Result Post(ClientType &cli, const std::string &path,
  3542. const Headers &headers, const std::string &body,
  3543. const std::string &content_type, size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3545. chunk_size};
  3546. }
  3547. template <typename ClientType>
  3548. inline Result Post(ClientType &cli, const std::string &path,
  3549. const Params &params, const std::string &body,
  3550. const std::string &content_type, size_t chunk_size = 8192) {
  3551. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3552. chunk_size};
  3553. }
  3554. template <typename ClientType>
  3555. inline Result Post(ClientType &cli, const std::string &path,
  3556. const Params &params, const Headers &headers,
  3557. const std::string &body, const std::string &content_type,
  3558. size_t chunk_size = 8192) {
  3559. return Result{
  3560. cli.open_stream("POST", path, params, headers, body, content_type),
  3561. chunk_size};
  3562. }
  3563. // PUT
  3564. template <typename ClientType>
  3565. inline Result Put(ClientType &cli, const std::string &path,
  3566. const std::string &body, const std::string &content_type,
  3567. size_t chunk_size = 8192) {
  3568. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3569. chunk_size};
  3570. }
  3571. template <typename ClientType>
  3572. inline Result Put(ClientType &cli, const std::string &path,
  3573. const Headers &headers, const std::string &body,
  3574. const std::string &content_type, size_t chunk_size = 8192) {
  3575. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3576. chunk_size};
  3577. }
  3578. template <typename ClientType>
  3579. inline Result Put(ClientType &cli, const std::string &path,
  3580. const Params &params, const std::string &body,
  3581. const std::string &content_type, size_t chunk_size = 8192) {
  3582. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3583. chunk_size};
  3584. }
  3585. template <typename ClientType>
  3586. inline Result Put(ClientType &cli, const std::string &path,
  3587. const Params &params, const Headers &headers,
  3588. const std::string &body, const std::string &content_type,
  3589. size_t chunk_size = 8192) {
  3590. return Result{
  3591. cli.open_stream("PUT", path, params, headers, body, content_type),
  3592. chunk_size};
  3593. }
  3594. // PATCH
  3595. template <typename ClientType>
  3596. inline Result Patch(ClientType &cli, const std::string &path,
  3597. const std::string &body, const std::string &content_type,
  3598. size_t chunk_size = 8192) {
  3599. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3600. chunk_size};
  3601. }
  3602. template <typename ClientType>
  3603. inline Result Patch(ClientType &cli, const std::string &path,
  3604. const Headers &headers, const std::string &body,
  3605. const std::string &content_type, size_t chunk_size = 8192) {
  3606. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3607. chunk_size};
  3608. }
  3609. template <typename ClientType>
  3610. inline Result Patch(ClientType &cli, const std::string &path,
  3611. const Params &params, const std::string &body,
  3612. const std::string &content_type, size_t chunk_size = 8192) {
  3613. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3614. chunk_size};
  3615. }
  3616. template <typename ClientType>
  3617. inline Result Patch(ClientType &cli, const std::string &path,
  3618. const Params &params, const Headers &headers,
  3619. const std::string &body, const std::string &content_type,
  3620. size_t chunk_size = 8192) {
  3621. return Result{
  3622. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3623. chunk_size};
  3624. }
  3625. // DELETE
  3626. template <typename ClientType>
  3627. inline Result Delete(ClientType &cli, const std::string &path,
  3628. size_t chunk_size = 8192) {
  3629. return Result{cli.open_stream("DELETE", path), chunk_size};
  3630. }
  3631. template <typename ClientType>
  3632. inline Result Delete(ClientType &cli, const std::string &path,
  3633. const Headers &headers, size_t chunk_size = 8192) {
  3634. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3635. }
  3636. template <typename ClientType>
  3637. inline Result Delete(ClientType &cli, const std::string &path,
  3638. const std::string &body, const std::string &content_type,
  3639. size_t chunk_size = 8192) {
  3640. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3641. chunk_size};
  3642. }
  3643. template <typename ClientType>
  3644. inline Result Delete(ClientType &cli, const std::string &path,
  3645. const Headers &headers, const std::string &body,
  3646. const std::string &content_type,
  3647. size_t chunk_size = 8192) {
  3648. return Result{
  3649. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3650. chunk_size};
  3651. }
  3652. template <typename ClientType>
  3653. inline Result Delete(ClientType &cli, const std::string &path,
  3654. const Params &params, size_t chunk_size = 8192) {
  3655. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3656. }
  3657. template <typename ClientType>
  3658. inline Result Delete(ClientType &cli, const std::string &path,
  3659. const Params &params, const Headers &headers,
  3660. size_t chunk_size = 8192) {
  3661. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3662. }
  3663. template <typename ClientType>
  3664. inline Result Delete(ClientType &cli, const std::string &path,
  3665. const Params &params, const std::string &body,
  3666. const std::string &content_type,
  3667. size_t chunk_size = 8192) {
  3668. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3669. chunk_size};
  3670. }
  3671. template <typename ClientType>
  3672. inline Result Delete(ClientType &cli, const std::string &path,
  3673. const Params &params, const Headers &headers,
  3674. const std::string &body, const std::string &content_type,
  3675. size_t chunk_size = 8192) {
  3676. return Result{
  3677. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3678. chunk_size};
  3679. }
  3680. // HEAD
  3681. template <typename ClientType>
  3682. inline Result Head(ClientType &cli, const std::string &path,
  3683. size_t chunk_size = 8192) {
  3684. return Result{cli.open_stream("HEAD", path), chunk_size};
  3685. }
  3686. template <typename ClientType>
  3687. inline Result Head(ClientType &cli, const std::string &path,
  3688. const Headers &headers, size_t chunk_size = 8192) {
  3689. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3690. }
  3691. template <typename ClientType>
  3692. inline Result Head(ClientType &cli, const std::string &path,
  3693. const Params &params, size_t chunk_size = 8192) {
  3694. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3695. }
  3696. template <typename ClientType>
  3697. inline Result Head(ClientType &cli, const std::string &path,
  3698. const Params &params, const Headers &headers,
  3699. size_t chunk_size = 8192) {
  3700. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3701. }
  3702. // OPTIONS
  3703. template <typename ClientType>
  3704. inline Result Options(ClientType &cli, const std::string &path,
  3705. size_t chunk_size = 8192) {
  3706. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3707. }
  3708. template <typename ClientType>
  3709. inline Result Options(ClientType &cli, const std::string &path,
  3710. const Headers &headers, size_t chunk_size = 8192) {
  3711. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3712. }
  3713. template <typename ClientType>
  3714. inline Result Options(ClientType &cli, const std::string &path,
  3715. const Params &params, size_t chunk_size = 8192) {
  3716. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3717. }
  3718. template <typename ClientType>
  3719. inline Result Options(ClientType &cli, const std::string &path,
  3720. const Params &params, const Headers &headers,
  3721. size_t chunk_size = 8192) {
  3722. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3723. }
  3724. } // namespace stream
  3725. namespace sse {
  3726. struct SSEMessage {
  3727. std::string event; // Event type (default: "message")
  3728. std::string data; // Event payload
  3729. std::string id; // Event ID for Last-Event-ID header
  3730. SSEMessage();
  3731. void clear();
  3732. };
  3733. class SSEClient {
  3734. public:
  3735. using MessageHandler = std::function<void(const SSEMessage &)>;
  3736. using ErrorHandler = std::function<void(Error)>;
  3737. using OpenHandler = std::function<void()>;
  3738. SSEClient(Client &client, const std::string &path);
  3739. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3740. ~SSEClient();
  3741. SSEClient(const SSEClient &) = delete;
  3742. SSEClient &operator=(const SSEClient &) = delete;
  3743. // Event handlers
  3744. SSEClient &on_message(MessageHandler handler);
  3745. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3746. SSEClient &on_open(OpenHandler handler);
  3747. SSEClient &on_error(ErrorHandler handler);
  3748. SSEClient &set_reconnect_interval(int ms);
  3749. SSEClient &set_max_reconnect_attempts(int n);
  3750. // Update headers (thread-safe)
  3751. SSEClient &set_headers(const Headers &headers);
  3752. // State accessors
  3753. bool is_connected() const;
  3754. std::string last_event_id() const;
  3755. // Blocking start - runs event loop with auto-reconnect
  3756. void start();
  3757. // Non-blocking start - runs in background thread
  3758. void start_async();
  3759. // Stop the client (thread-safe)
  3760. void stop();
  3761. private:
  3762. void run_event_loop();
  3763. void dispatch_event(const SSEMessage &msg);
  3764. bool should_reconnect(int count) const;
  3765. void wait_for_reconnect();
  3766. // Client and path
  3767. Client &client_;
  3768. std::string path_;
  3769. Headers headers_;
  3770. mutable std::mutex headers_mutex_;
  3771. // Callbacks
  3772. MessageHandler on_message_;
  3773. std::map<std::string, MessageHandler> event_handlers_;
  3774. OpenHandler on_open_;
  3775. ErrorHandler on_error_;
  3776. // Configuration
  3777. int reconnect_interval_ms_ = 3000;
  3778. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3779. // State
  3780. std::atomic<bool> running_{false};
  3781. std::atomic<bool> connected_{false};
  3782. // Written by the event loop, which start_async() runs on its own thread
  3783. std::string last_event_id_;
  3784. mutable std::mutex last_event_id_mutex_;
  3785. // Async support
  3786. std::thread async_thread_;
  3787. };
  3788. } // namespace sse
  3789. namespace detail {
  3790. // Interprets an event stream fed in chunks of any size
  3791. class SSEParser {
  3792. public:
  3793. using EventHandler = std::function<void(const sse::SSEMessage &msg)>;
  3794. using IdHandler = std::function<void(const std::string &id)>;
  3795. using RetryHandler = std::function<void(int retry_ms)>;
  3796. SSEParser(EventHandler on_event, IdHandler on_id, RetryHandler on_retry,
  3797. size_t max_event_length = CPPHTTPLIB_SSE_MAX_EVENT_LENGTH);
  3798. // Returns false once the line and the event still waiting for their end
  3799. // exceed max_event_length. 0 means no limit.
  3800. bool parse(const char *buf, size_t n);
  3801. private:
  3802. void parse_line(const std::string &line);
  3803. EventHandler on_event_;
  3804. IdHandler on_id_;
  3805. RetryHandler on_retry_;
  3806. size_t max_event_length_;
  3807. std::string buffer_;
  3808. sse::SSEMessage msg_;
  3809. bool has_data_ = false;
  3810. bool has_id_ = false;
  3811. bool first_line_ = true;
  3812. bool after_cr_ = false;
  3813. };
  3814. } // namespace detail
  3815. namespace ws {
  3816. class WebSocketClient;
  3817. enum class Opcode : uint8_t {
  3818. Continuation = 0x0,
  3819. Text = 0x1,
  3820. Binary = 0x2,
  3821. Close = 0x8,
  3822. Ping = 0x9,
  3823. Pong = 0xA,
  3824. };
  3825. enum class CloseStatus : uint16_t {
  3826. Normal = 1000,
  3827. GoingAway = 1001,
  3828. ProtocolError = 1002,
  3829. UnsupportedData = 1003,
  3830. NoStatus = 1005,
  3831. Abnormal = 1006,
  3832. InvalidPayload = 1007,
  3833. PolicyViolation = 1008,
  3834. MessageTooBig = 1009,
  3835. MandatoryExtension = 1010,
  3836. InternalError = 1011,
  3837. };
  3838. // Timeout is returned only when a read timeout was set and it elapsed before
  3839. // any byte of a frame arrived: nothing was consumed and the connection is
  3840. // still open, so the caller can send on it and read again. `msg` is left
  3841. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3842. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3843. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3844. // upgrade handshake fully succeeded. On failure error() identifies the
  3845. // failing layer; status()/headers() expose the server's upgrade response
  3846. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3847. // CONNECT when error() is ProxyConnection.
  3848. class Result {
  3849. public:
  3850. Result() = default;
  3851. Result(Error err, int status, Headers &&headers)
  3852. : err_(err), status_(status), headers_(std::move(headers)) {}
  3853. explicit operator bool() const { return err_ == Error::Success; }
  3854. Error error() const { return err_; }
  3855. // Upgrade response info
  3856. int status() const { return status_; }
  3857. const Headers &headers() const { return headers_; }
  3858. std::string get_header_value(const std::string &key,
  3859. const char *def = "") const {
  3860. return detail::get_header_value(headers_, key, def, 0);
  3861. }
  3862. bool has_header(const std::string &key) const {
  3863. return headers_.find(key) != headers_.end();
  3864. }
  3865. #ifdef CPPHTTPLIB_SSL_ENABLED
  3866. Result(Error err, int status, Headers &&headers, int ssl_error,
  3867. uint64_t ssl_backend_error)
  3868. : err_(err), status_(status), headers_(std::move(headers)),
  3869. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3870. int ssl_error() const { return ssl_error_; }
  3871. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3872. #endif
  3873. private:
  3874. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3875. int status_ = -1;
  3876. Headers headers_;
  3877. #ifdef CPPHTTPLIB_SSL_ENABLED
  3878. int ssl_error_ = 0;
  3879. uint64_t ssl_backend_error_ = 0;
  3880. #endif
  3881. };
  3882. namespace impl {
  3883. bool is_valid_utf8(const std::string &s);
  3884. // Three states: a frame, a failure (the connection cannot be read on), or a
  3885. // timeout with the stream still usable.
  3886. enum class FrameRead { Ok, Fail, Timeout };
  3887. // A frame read in as many calls as it takes. A timeout leaves what was read
  3888. // so far in place, and the next read() goes on from there, so the stream is
  3889. // usable after a timeout wherever in a frame it lands.
  3890. class FrameReader {
  3891. public:
  3892. FrameRead read(Stream &strm, Opcode &opcode, std::string &payload, bool &fin,
  3893. bool expect_masked, size_t max_len);
  3894. // Whether part of a frame has been read and the rest is still to come
  3895. bool begun() const { return have_ > 0; }
  3896. private:
  3897. void reset();
  3898. uint8_t head_[14] = {0}; // FIN + opcode, MASK + length, its extension, key
  3899. size_t have_ = 0; // bytes of the header read so far
  3900. size_t need_ = 2; // bytes of the header, once the second is read
  3901. bool sized_ = false; // the header is whole and its length checked
  3902. size_t len_ = 0; // the payload's length, once sized_
  3903. std::string payload_;
  3904. };
  3905. // A whole frame read in one go: a timeout before any of it came is reported,
  3906. // and one that cuts it short is a failure.
  3907. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3908. std::string &payload, bool &fin,
  3909. bool expect_masked, size_t max_len);
  3910. } // namespace impl
  3911. class WebSocket {
  3912. public:
  3913. WebSocket(const WebSocket &) = delete;
  3914. WebSocket &operator=(const WebSocket &) = delete;
  3915. ~WebSocket();
  3916. ReadResult read(std::string &msg);
  3917. bool send(const std::string &data);
  3918. bool send(const char *data, size_t len);
  3919. void close(CloseStatus status = CloseStatus::Normal,
  3920. const std::string &reason = "");
  3921. const Request &request() const;
  3922. bool is_open() const;
  3923. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3924. // A server handler owns its connection's timeout this way; a client sets it
  3925. // through WebSocketClient. Safe to call while another thread is in read().
  3926. // It lands anywhere, inside a message too: what was read of it is kept,
  3927. // and the next read() goes on from there.
  3928. //
  3929. // Only a timeout set here is reported as Timeout. The compile-time default
  3930. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3931. // than a request for control, so when it elapses read() returns Fail and
  3932. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3933. void set_read_timeout(time_t sec, time_t usec = 0);
  3934. template <class Rep, class Period>
  3935. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3936. private:
  3937. friend class httplib::Server;
  3938. friend class httplib::ws::WebSocketClient;
  3939. WebSocket(
  3940. Stream &strm, const Request &req, bool is_server,
  3941. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3942. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  3943. std::function<bool()> server_stopping = nullptr)
  3944. : strm_(strm), req_(req), is_server_(is_server),
  3945. ping_interval_sec_(ping_interval_sec),
  3946. max_missed_pongs_(max_missed_pongs),
  3947. server_stopping_(std::move(server_stopping)) {
  3948. interrupt_reads();
  3949. start_heartbeat();
  3950. }
  3951. WebSocket(
  3952. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3953. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3954. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  3955. std::function<bool()> server_stopping = nullptr)
  3956. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3957. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3958. max_missed_pongs_(max_missed_pongs),
  3959. server_stopping_(std::move(server_stopping)) {
  3960. interrupt_reads();
  3961. start_heartbeat();
  3962. }
  3963. void interrupt_reads();
  3964. bool server_stopping() const {
  3965. return server_stopping_ && server_stopping_();
  3966. }
  3967. void start_heartbeat();
  3968. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3969. Stream &strm_;
  3970. std::unique_ptr<Stream> owned_strm_;
  3971. Request req_;
  3972. bool is_server_;
  3973. time_t ping_interval_sec_;
  3974. int max_missed_pongs_;
  3975. int unacked_pings_ = 0;
  3976. std::atomic<bool> closed_{false};
  3977. // Set when the peer stopped answering pings, to end a read() waiting on it
  3978. std::atomic<bool> pong_timed_out_{false};
  3979. // A server connection's view of Server::stop(), which ends its read() too
  3980. std::function<bool()> server_stopping_;
  3981. // Set once the caller has bounded read() through set_read_timeout(). Until
  3982. // then the timeout in effect is the compile-time default, and elapsing it
  3983. // is a failure that closes the connection, not a Timeout.
  3984. std::atomic<bool> read_timeout_set_{false};
  3985. std::mutex write_mutex_;
  3986. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3987. // may do so: a frame is read until it has the whole declared length,
  3988. // across several read() calls when a timeout lands inside it (frames_
  3989. // below), so a second parser stealing bytes silently corrupts the message
  3990. // the first one is assembling.
  3991. std::mutex read_mutex_;
  3992. // What read() has of the frame and the message it has not finished, kept
  3993. // across a timeout. Guarded by read_mutex_.
  3994. impl::FrameReader frames_;
  3995. std::string message_;
  3996. ReadResult message_kind_ = Fail; // Text or Binary while one is assembled
  3997. std::thread ping_thread_;
  3998. std::mutex ping_mutex_;
  3999. std::condition_variable ping_cv_;
  4000. };
  4001. class WebSocketClient {
  4002. public:
  4003. explicit WebSocketClient(const std::string &scheme_host_port_path,
  4004. const Headers &headers = {});
  4005. ~WebSocketClient();
  4006. WebSocketClient(const WebSocketClient &) = delete;
  4007. WebSocketClient &operator=(const WebSocketClient &) = delete;
  4008. bool is_valid() const;
  4009. Result connect();
  4010. ReadResult read(std::string &msg);
  4011. bool send(const std::string &data);
  4012. bool send(const char *data, size_t len);
  4013. void close(CloseStatus status = CloseStatus::Normal,
  4014. const std::string &reason = "");
  4015. bool is_open() const;
  4016. const std::string &subprotocol() const;
  4017. void set_read_timeout(time_t sec, time_t usec = 0);
  4018. template <class Rep, class Period>
  4019. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  4020. void set_write_timeout(time_t sec, time_t usec = 0);
  4021. template <class Rep, class Period>
  4022. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  4023. void set_websocket_ping_interval(time_t sec);
  4024. void set_websocket_max_missed_pongs(int count);
  4025. void set_tcp_nodelay(bool on);
  4026. void set_address_family(int family);
  4027. void set_ipv6_v6only(bool on);
  4028. void set_socket_options(SocketOptions socket_options);
  4029. void set_connection_timeout(time_t sec, time_t usec = 0);
  4030. template <class Rep, class Period>
  4031. void
  4032. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  4033. void set_interface(const std::string &intf);
  4034. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  4035. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4036. void
  4037. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4038. void
  4039. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4040. void set_basic_auth(const std::string &username, const std::string &password);
  4041. void set_bearer_token_auth(const std::string &token);
  4042. void set_proxy(const std::string &host, int port);
  4043. void set_proxy_basic_auth(const std::string &username,
  4044. const std::string &password);
  4045. void set_proxy_bearer_token_auth(const std::string &token);
  4046. void set_no_proxy(const std::vector<std::string> &patterns);
  4047. #ifdef CPPHTTPLIB_SSL_ENABLED
  4048. struct PemMemory {
  4049. const char *cert_pem;
  4050. size_t cert_pem_len;
  4051. const char *key_pem;
  4052. size_t key_pem_len;
  4053. const char *private_key_password;
  4054. };
  4055. explicit WebSocketClient(const std::string &scheme_host_port_path,
  4056. const PemMemory &pem, const Headers &headers = {});
  4057. void set_ca_cert_path(const std::string &ca_cert_file_path,
  4058. const std::string &ca_cert_dir_path = std::string());
  4059. void set_ca_cert_store(tls::ca_store_t store);
  4060. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  4061. void enable_server_certificate_verification(bool enabled);
  4062. void enable_server_hostname_verification(bool enabled);
  4063. void enable_system_ca(bool enabled);
  4064. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  4065. void set_session_verifier(
  4066. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  4067. void set_proxy_digest_auth(const std::string &username,
  4068. const std::string &password);
  4069. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  4070. void enable_windows_certificate_verification(bool enabled);
  4071. #endif
  4072. #endif
  4073. private:
  4074. void shutdown_and_close();
  4075. std::pair<time_t, time_t> handshake_timeout() const;
  4076. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  4077. int &ssl_error, uint64_t &ssl_backend_error);
  4078. void prepare_default_headers(Request &req);
  4079. bool is_proxy_enabled() const;
  4080. bool create_and_connect_socket(Error &error);
  4081. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  4082. bool connect_with_proxy(Response &proxy_res, Error &error);
  4083. std::string host_;
  4084. int port_;
  4085. std::string path_;
  4086. Headers headers_;
  4087. std::string subprotocol_;
  4088. bool is_valid_ = false;
  4089. socket_t sock_ = INVALID_SOCKET;
  4090. std::unique_ptr<WebSocket> ws_;
  4091. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  4092. time_t read_timeout_usec_ = 0;
  4093. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  4094. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  4095. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  4096. time_t websocket_ping_interval_sec_ =
  4097. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  4098. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  4099. int address_family_ = AF_UNSPEC;
  4100. bool tcp_nodelay_ = CPPHTTPLIB_WEBSOCKET_TCP_NODELAY;
  4101. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  4102. SocketOptions socket_options_ = nullptr;
  4103. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  4104. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  4105. std::string interface_;
  4106. // Hostname to connection target map. The value is an IP literal or another
  4107. // hostname; only the connection target changes, never the identity.
  4108. std::map<std::string, std::string> addr_map_;
  4109. // Hostname to CONNECT target map, used only through a proxy.
  4110. std::map<std::string, std::string> tunnel_addr_map_;
  4111. std::string basic_auth_username_;
  4112. std::string basic_auth_password_;
  4113. std::string bearer_token_auth_token_;
  4114. std::string proxy_host_;
  4115. int proxy_port_ = -1;
  4116. std::string proxy_basic_auth_username_;
  4117. std::string proxy_basic_auth_password_;
  4118. std::string proxy_bearer_token_auth_token_;
  4119. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  4120. #ifdef CPPHTTPLIB_SSL_ENABLED
  4121. bool is_ssl_ = false;
  4122. tls::ctx_t tls_ctx_ = nullptr;
  4123. tls::session_t tls_session_ = nullptr;
  4124. std::string ca_cert_file_path_;
  4125. std::string ca_cert_dir_path_;
  4126. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  4127. // no certificate, so that a CA that failed to come through fails
  4128. // verification instead of letting the system CAs in.
  4129. bool custom_ca_loaded_ = false;
  4130. bool certs_loaded_ = false;
  4131. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  4132. bool server_certificate_verification_ = true;
  4133. bool server_hostname_verification_ = true;
  4134. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  4135. std::string proxy_digest_auth_username_;
  4136. std::string proxy_digest_auth_password_;
  4137. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  4138. bool enable_windows_cert_verification_ = true;
  4139. bool server_certificate_verifier_set_ = false;
  4140. #endif
  4141. #endif
  4142. };
  4143. template <class Rep, class Period>
  4144. inline void WebSocket::set_read_timeout(
  4145. const std::chrono::duration<Rep, Period> &duration) {
  4146. detail::duration_to_sec_and_usec(
  4147. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4148. }
  4149. template <class Rep, class Period>
  4150. inline void WebSocketClient::set_read_timeout(
  4151. const std::chrono::duration<Rep, Period> &duration) {
  4152. detail::duration_to_sec_and_usec(
  4153. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4154. }
  4155. template <class Rep, class Period>
  4156. inline void WebSocketClient::set_write_timeout(
  4157. const std::chrono::duration<Rep, Period> &duration) {
  4158. detail::duration_to_sec_and_usec(
  4159. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4160. }
  4161. template <class Rep, class Period>
  4162. inline void WebSocketClient::set_connection_timeout(
  4163. const std::chrono::duration<Rep, Period> &duration) {
  4164. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4165. set_connection_timeout(sec, usec);
  4166. });
  4167. }
  4168. } // namespace ws
  4169. namespace detail {
  4170. bool write_websocket_frame(Stream &strm, ws::Opcode opcode, const char *data,
  4171. size_t len, bool fin, bool mask);
  4172. } // namespace detail
  4173. // ----------------------------------------------------------------------------
  4174. /*
  4175. * Implementation that will be part of the .cc file if split into .h + .cc.
  4176. */
  4177. namespace stream {
  4178. // stream::Result implementations
  4179. inline Result::Result() : chunk_size_(8192) {}
  4180. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4181. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4182. inline Result::Result(Result &&other) noexcept
  4183. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4184. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4185. finished_(other.finished_) {
  4186. other.current_size_ = 0;
  4187. other.finished_ = true;
  4188. }
  4189. inline Result &Result::operator=(Result &&other) noexcept {
  4190. if (this != &other) {
  4191. handle_ = std::move(other.handle_);
  4192. buffer_ = std::move(other.buffer_);
  4193. current_size_ = other.current_size_;
  4194. chunk_size_ = other.chunk_size_;
  4195. finished_ = other.finished_;
  4196. other.current_size_ = 0;
  4197. other.finished_ = true;
  4198. }
  4199. return *this;
  4200. }
  4201. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4202. inline Result::operator bool() const { return is_valid(); }
  4203. inline int Result::status() const {
  4204. return handle_.response ? handle_.response->status : -1;
  4205. }
  4206. inline const Headers &Result::headers() const {
  4207. static const Headers empty_headers;
  4208. return handle_.response ? handle_.response->headers : empty_headers;
  4209. }
  4210. inline std::string Result::get_header_value(const std::string &key,
  4211. const char *def) const {
  4212. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4213. }
  4214. inline bool Result::has_header(const std::string &key) const {
  4215. return handle_.response ? handle_.response->has_header(key) : false;
  4216. }
  4217. inline Error Result::error() const { return handle_.error; }
  4218. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4219. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4220. inline bool Result::next() {
  4221. if (!handle_.is_valid() || finished_) { return false; }
  4222. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4223. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4224. if (n > 0) {
  4225. current_size_ = static_cast<size_t>(n);
  4226. return true;
  4227. }
  4228. current_size_ = 0;
  4229. finished_ = true;
  4230. return false;
  4231. }
  4232. inline const char *Result::data() const { return buffer_.data(); }
  4233. inline size_t Result::size() const { return current_size_; }
  4234. inline std::string Result::read_all() {
  4235. std::string result;
  4236. while (next()) {
  4237. result.append(data(), size());
  4238. }
  4239. return result;
  4240. }
  4241. } // namespace stream
  4242. namespace detail {
  4243. inline SSEParser::SSEParser(EventHandler on_event, IdHandler on_id,
  4244. RetryHandler on_retry, size_t max_event_length)
  4245. : on_event_(std::move(on_event)), on_id_(std::move(on_id)),
  4246. on_retry_(std::move(on_retry)), max_event_length_(max_event_length) {}
  4247. inline bool SSEParser::parse(const char *buf, size_t n) {
  4248. // What is left in the buffer has no line ending
  4249. auto search_pos = buffer_.size();
  4250. buffer_.append(buf, n);
  4251. // A line ends with \r\n, \n or \r per the SSE spec
  4252. size_t line_start = 0;
  4253. size_t eol_pos;
  4254. while ((eol_pos = buffer_.find_first_of("\r\n", search_pos)) !=
  4255. std::string::npos) {
  4256. auto line = buffer_.substr(line_start, eol_pos - line_start);
  4257. line_start = eol_pos + 1;
  4258. search_pos = line_start;
  4259. // The \n of a \r\n may arrive in a later chunk than its \r
  4260. auto is_lf_of_crlf = after_cr_ && line.empty() && buffer_[eol_pos] == '\n';
  4261. after_cr_ = buffer_[eol_pos] == '\r';
  4262. if (is_lf_of_crlf) { continue; }
  4263. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4264. if (first_line_) {
  4265. first_line_ = false;
  4266. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4267. }
  4268. parse_line(line);
  4269. }
  4270. // Keep unprocessed data in buffer
  4271. buffer_.erase(0, line_start);
  4272. return max_event_length_ == 0 ||
  4273. buffer_.size() + msg_.data.size() <= max_event_length_;
  4274. }
  4275. inline void SSEParser::parse_line(const std::string &line) {
  4276. // Blank line signals end of event
  4277. if (line.empty()) {
  4278. // The id counts for Last-Event-ID even for an event that has no data. An
  4279. // empty id clears it.
  4280. if (has_id_ && on_id_) { on_id_(msg_.id); }
  4281. // An event without a data field is not dispatched
  4282. if (has_data_ && on_event_) { on_event_(msg_); }
  4283. msg_.clear();
  4284. has_data_ = false;
  4285. has_id_ = false;
  4286. return;
  4287. }
  4288. // Lines starting with ':' are comments (ignored)
  4289. if (line[0] == ':') { return; }
  4290. // Find the colon separator
  4291. auto colon_pos = line.find(':');
  4292. auto field = line.substr(0, colon_pos);
  4293. std::string value;
  4294. // Value starts after colon, skip optional single space
  4295. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4296. auto value_start = colon_pos + 1;
  4297. if (line[value_start] == ' ') { value_start++; }
  4298. value = line.substr(value_start);
  4299. }
  4300. // Handle known fields
  4301. if (field == "event") {
  4302. // An empty event type is dispatched as "message" per the SSE spec
  4303. msg_.event = value.empty() ? std::string("message") : std::move(value);
  4304. } else if (field == "data") {
  4305. // Multiple data lines are concatenated with newlines
  4306. if (has_data_) { msg_.data += "\n"; }
  4307. msg_.data += value;
  4308. has_data_ = true;
  4309. } else if (field == "id") {
  4310. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4311. // valid (clears the last event ID)
  4312. if (fields::is_field_value(value)) {
  4313. msg_.id = value;
  4314. has_id_ = true;
  4315. }
  4316. } else if (field == "retry") {
  4317. // Parse retry interval in milliseconds
  4318. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4319. if (is_numeric(value)) {
  4320. int v = 0;
  4321. auto res = from_chars(value.data(), value.data() + value.size(), v);
  4322. if (res.ec == std::errc{} && on_retry_) { on_retry_(v); }
  4323. }
  4324. }
  4325. // Unknown fields are ignored per SSE spec
  4326. }
  4327. } // namespace detail
  4328. namespace sse {
  4329. // SSEMessage implementations
  4330. inline SSEMessage::SSEMessage() : event("message") {}
  4331. inline void SSEMessage::clear() {
  4332. event = "message";
  4333. data.clear();
  4334. id.clear();
  4335. }
  4336. // SSEClient implementations
  4337. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4338. : client_(client), path_(path) {}
  4339. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4340. const Headers &headers)
  4341. : client_(client), path_(path), headers_(headers) {}
  4342. inline SSEClient::~SSEClient() { stop(); }
  4343. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4344. on_message_ = std::move(handler);
  4345. return *this;
  4346. }
  4347. inline SSEClient &SSEClient::on_event(const std::string &type,
  4348. MessageHandler handler) {
  4349. event_handlers_[type] = std::move(handler);
  4350. return *this;
  4351. }
  4352. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4353. on_open_ = std::move(handler);
  4354. return *this;
  4355. }
  4356. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4357. on_error_ = std::move(handler);
  4358. return *this;
  4359. }
  4360. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4361. reconnect_interval_ms_ = ms;
  4362. return *this;
  4363. }
  4364. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4365. max_reconnect_attempts_ = n;
  4366. return *this;
  4367. }
  4368. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4369. std::lock_guard<std::mutex> lock(headers_mutex_);
  4370. headers_ = headers;
  4371. return *this;
  4372. }
  4373. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4374. inline std::string SSEClient::last_event_id() const {
  4375. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4376. return last_event_id_;
  4377. }
  4378. inline void SSEClient::start() {
  4379. running_.store(true);
  4380. run_event_loop();
  4381. }
  4382. inline void SSEClient::start_async() {
  4383. running_.store(true);
  4384. async_thread_ = std::thread([this]() { run_event_loop(); });
  4385. }
  4386. inline void SSEClient::stop() {
  4387. running_.store(false);
  4388. client_.stop(); // Cancel any pending operations
  4389. if (async_thread_.joinable()) { async_thread_.join(); }
  4390. }
  4391. inline void SSEClient::run_event_loop() {
  4392. auto reconnect_count = 0;
  4393. while (running_.load()) {
  4394. // Build headers, including Last-Event-ID if we have one
  4395. Headers request_headers;
  4396. {
  4397. std::lock_guard<std::mutex> lock(headers_mutex_);
  4398. request_headers = headers_;
  4399. }
  4400. if (!last_event_id_.empty()) {
  4401. request_headers.emplace("Last-Event-ID", last_event_id_);
  4402. }
  4403. // Open streaming connection. An event stream has no end, so each event is
  4404. // bounded instead of the whole body.
  4405. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4406. handle.body_reader_.payload_max_length = 0;
  4407. // stop() ends a read that is waiting for the next event
  4408. if (handle.stream_) {
  4409. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4410. }
  4411. stream::Result result{std::move(handle)};
  4412. // Connection error handling
  4413. if (!result) {
  4414. connected_.store(false);
  4415. if (on_error_) { on_error_(result.error()); }
  4416. if (!should_reconnect(reconnect_count)) { break; }
  4417. wait_for_reconnect();
  4418. reconnect_count++;
  4419. continue;
  4420. }
  4421. if (result.status() != StatusCode::OK_200) {
  4422. connected_.store(false);
  4423. if (on_error_) { on_error_(Error::Connection); }
  4424. // For certain errors, don't reconnect.
  4425. // Note: 401 is intentionally absent so that handlers can refresh
  4426. // credentials via set_headers() and let the client reconnect.
  4427. if (result.status() == StatusCode::NoContent_204 ||
  4428. result.status() == StatusCode::NotFound_404 ||
  4429. result.status() == StatusCode::Forbidden_403) {
  4430. break;
  4431. }
  4432. if (!should_reconnect(reconnect_count)) { break; }
  4433. wait_for_reconnect();
  4434. reconnect_count++;
  4435. continue;
  4436. }
  4437. // Connection successful
  4438. connected_.store(true);
  4439. reconnect_count = 0;
  4440. if (on_open_) { on_open_(); }
  4441. // Event receiving loop
  4442. detail::SSEParser parser(
  4443. [this](const SSEMessage &msg) { dispatch_event(msg); },
  4444. [this](const std::string &id) {
  4445. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4446. last_event_id_ = id;
  4447. },
  4448. [this](int retry_ms) { reconnect_interval_ms_ = retry_ms; });
  4449. auto event_too_long = false;
  4450. while (running_.load() && result.next()) {
  4451. if (!parser.parse(result.data(), result.size())) {
  4452. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4453. event_too_long = true;
  4454. break;
  4455. }
  4456. }
  4457. // Connection ended
  4458. connected_.store(false);
  4459. // Reconnecting would only get the same event again
  4460. if (!running_.load() || event_too_long) { break; }
  4461. // Check for read errors
  4462. if (result.has_read_error()) {
  4463. if (on_error_) { on_error_(result.read_error()); }
  4464. }
  4465. if (!should_reconnect(reconnect_count)) { break; }
  4466. wait_for_reconnect();
  4467. reconnect_count++;
  4468. }
  4469. connected_.store(false);
  4470. }
  4471. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4472. // Check for specific event type handler first
  4473. auto it = event_handlers_.find(msg.event);
  4474. if (it != event_handlers_.end()) {
  4475. it->second(msg);
  4476. return;
  4477. }
  4478. // Fall back to generic message handler
  4479. if (on_message_) { on_message_(msg); }
  4480. }
  4481. inline bool SSEClient::should_reconnect(int count) const {
  4482. if (!running_.load()) { return false; }
  4483. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4484. return count < max_reconnect_attempts_;
  4485. }
  4486. inline void SSEClient::wait_for_reconnect() {
  4487. // Use small increments to check running_ flag frequently.
  4488. // Always wait at least one increment, so that a zero interval (e.g.
  4489. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4490. const auto step_ms = 100;
  4491. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4492. auto waited = 0;
  4493. while (running_.load() && waited < interval_ms) {
  4494. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4495. waited += step_ms;
  4496. }
  4497. }
  4498. } // namespace sse
  4499. #ifdef CPPHTTPLIB_SSL_ENABLED
  4500. /*
  4501. * TLS abstraction layer - internal function declarations
  4502. * These are implementation details and not part of the public API.
  4503. */
  4504. namespace tls {
  4505. // Client context
  4506. ctx_t create_client_context();
  4507. void free_context(ctx_t ctx);
  4508. bool set_min_version(ctx_t ctx, Version version);
  4509. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4510. bool load_ca_file(ctx_t ctx, const char *file_path);
  4511. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4512. bool load_system_certs(ctx_t ctx);
  4513. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4514. const char *password);
  4515. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4516. const char *key_path, const char *password);
  4517. // Server context
  4518. ctx_t create_server_context();
  4519. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4520. const char *password);
  4521. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4522. const char *key_path, const char *password);
  4523. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4524. void set_verify_client(ctx_t ctx, bool require);
  4525. // Session management
  4526. session_t create_session(ctx_t ctx, socket_t sock);
  4527. void free_session(session_t session);
  4528. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4529. // Handshake (non-blocking capable)
  4530. TlsError connect(session_t session);
  4531. TlsError accept(session_t session);
  4532. // Handshake with timeout (blocking until timeout, or until interrupted)
  4533. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4534. time_t timeout_usec, TlsError *err,
  4535. const std::function<bool()> &interrupted = nullptr);
  4536. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4537. time_t timeout_usec, TlsError *err);
  4538. // I/O (non-blocking capable)
  4539. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4540. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4541. int pending(const_session_t session);
  4542. void shutdown(session_t session, bool graceful);
  4543. // Connection state
  4544. bool is_peer_closed(session_t session, socket_t sock);
  4545. // Certificate verification
  4546. cert_t get_peer_cert(const_session_t session);
  4547. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4548. // do not use them after free_session(), as with get_peer_cert().
  4549. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4550. void free_cert(cert_t cert);
  4551. // Matches the host against the subjectAltName entries only, never the Common
  4552. // Name (RFC 9525).
  4553. bool verify_hostname(cert_t cert, const char *hostname);
  4554. uint64_t hostname_mismatch_code();
  4555. long get_verify_result(const_session_t session);
  4556. // Certificate introspection
  4557. std::string get_cert_subject_cn(cert_t cert);
  4558. std::string get_cert_issuer_name(cert_t cert);
  4559. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4560. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4561. std::string get_cert_serial(cert_t cert);
  4562. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4563. const char *get_sni(const_session_t session);
  4564. // CA store management
  4565. ca_store_t create_ca_store(const char *pem, size_t len);
  4566. void free_ca_store(ca_store_t store);
  4567. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4568. // Free each with free_cert(), and do not use them once the context's CA
  4569. // certificates change.
  4570. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4571. std::vector<std::string> get_ca_names(ctx_t ctx);
  4572. // Dynamic certificate update (for servers)
  4573. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4574. const char *password);
  4575. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4576. // Certificate verification callback
  4577. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4578. long get_verify_error(const_session_t session);
  4579. std::string verify_error_string(long error_code);
  4580. // TlsError information
  4581. uint64_t peek_error();
  4582. uint64_t get_error();
  4583. std::string error_string(uint64_t code);
  4584. } // namespace tls
  4585. #endif // CPPHTTPLIB_SSL_ENABLED
  4586. /*
  4587. * Group 1: detail namespace - Non-SSL utilities
  4588. */
  4589. namespace detail {
  4590. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4591. const void *optval, socklen_t optlen) {
  4592. return setsockopt(sock, level, optname,
  4593. #ifdef _WIN32
  4594. reinterpret_cast<const char *>(optval),
  4595. #else
  4596. optval,
  4597. #endif
  4598. optlen) == 0;
  4599. }
  4600. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4601. time_t sec, time_t usec) {
  4602. #ifdef _WIN32
  4603. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4604. #else
  4605. timeval timeout;
  4606. timeout.tv_sec = static_cast<long>(sec);
  4607. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4608. #endif
  4609. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4610. }
  4611. inline bool is_hex(char c, int &v) {
  4612. if (is_ascii_digit(c)) {
  4613. v = c - '0';
  4614. return true;
  4615. } else if ('A' <= c && c <= 'F') {
  4616. v = c - 'A' + 10;
  4617. return true;
  4618. } else if ('a' <= c && c <= 'f') {
  4619. v = c - 'a' + 10;
  4620. return true;
  4621. }
  4622. return false;
  4623. }
  4624. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4625. int &val) {
  4626. if (i >= s.size()) { return false; }
  4627. val = 0;
  4628. for (; cnt; i++, cnt--) {
  4629. if (!s[i]) { return false; }
  4630. auto v = 0;
  4631. if (is_hex(s[i], v)) {
  4632. val = val * 16 + v;
  4633. } else {
  4634. return false;
  4635. }
  4636. }
  4637. return true;
  4638. }
  4639. inline std::string from_i_to_hex(size_t n) {
  4640. static const auto charset = "0123456789abcdef";
  4641. std::string ret;
  4642. do {
  4643. ret = charset[n & 15] + ret;
  4644. n >>= 4;
  4645. } while (n > 0);
  4646. return ret;
  4647. }
  4648. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4649. // builds and trips -Wtautological-type-limit-compare.
  4650. inline bool fits_in_size_t(uint64_t n) {
  4651. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4652. }
  4653. inline std::string compute_etag(const FileStat &fs,
  4654. const std::string &suffix = std::string()) {
  4655. if (!fs.is_file()) { return std::string(); }
  4656. // If mtime cannot be determined (negative value indicates an error
  4657. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4658. // value like 0 could collide with a real file that legitimately has
  4659. // mtime == 0 (epoch) and lead to misleading validators.
  4660. auto mtime_raw = fs.mtime();
  4661. if (mtime_raw < 0) { return std::string(); }
  4662. auto mtime = static_cast<size_t>(mtime_raw);
  4663. auto size = fs.size();
  4664. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4665. from_i_to_hex(size) + suffix + "\"";
  4666. }
  4667. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4668. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4669. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4670. inline std::string file_mtime_to_http_date(time_t mtime) {
  4671. if (mtime < 0) { return std::string(); }
  4672. struct tm tm_buf;
  4673. #ifdef _WIN32
  4674. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4675. #else
  4676. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4677. #endif
  4678. char buf[64];
  4679. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4680. return std::string();
  4681. }
  4682. return std::string(buf);
  4683. }
  4684. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4685. inline time_t parse_http_date(const std::string &date_str) {
  4686. struct tm tm_buf;
  4687. // Create a classic locale object once for all parsing attempts
  4688. const std::locale classic_locale = std::locale::classic();
  4689. // Try to parse using std::get_time (C++11, cross-platform)
  4690. auto try_parse = [&](const char *fmt) -> bool {
  4691. std::istringstream ss(date_str);
  4692. ss.imbue(classic_locale);
  4693. memset(&tm_buf, 0, sizeof(tm_buf));
  4694. ss >> std::get_time(&tm_buf, fmt);
  4695. return !ss.fail();
  4696. };
  4697. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4698. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4699. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4700. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4701. // asctime format: "Sun Nov 6 08:49:37 1994"
  4702. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4703. return static_cast<time_t>(-1);
  4704. }
  4705. }
  4706. }
  4707. #ifdef _WIN32
  4708. return _mkgmtime(&tm_buf);
  4709. #elif defined _AIX
  4710. return mktime(&tm_buf);
  4711. #else
  4712. return timegm(&tm_buf);
  4713. #endif
  4714. }
  4715. inline bool is_weak_etag(const std::string &s) {
  4716. // Check if the string is a weak ETag (starts with 'W/"')
  4717. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4718. }
  4719. inline bool is_strong_etag(const std::string &s) {
  4720. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4721. // chars)
  4722. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4723. }
  4724. inline size_t to_utf8(int code, char *buff) {
  4725. if (code < 0x0080) {
  4726. buff[0] = static_cast<char>(code & 0x7F);
  4727. return 1;
  4728. } else if (code < 0x0800) {
  4729. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4730. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4731. return 2;
  4732. } else if (code < 0xD800) {
  4733. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4734. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4735. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4736. return 3;
  4737. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4738. return 0;
  4739. } else if (code < 0x10000) {
  4740. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4741. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4742. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4743. return 3;
  4744. } else if (code < 0x110000) {
  4745. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4746. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4747. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4748. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4749. return 4;
  4750. }
  4751. // NOTREACHED
  4752. return 0;
  4753. }
  4754. } // namespace detail
  4755. namespace ws {
  4756. namespace impl {
  4757. inline bool is_valid_utf8(const std::string &s) {
  4758. size_t i = 0;
  4759. auto n = s.size();
  4760. while (i < n) {
  4761. auto c = static_cast<unsigned char>(s[i]);
  4762. size_t len;
  4763. uint32_t cp;
  4764. if (c < 0x80) {
  4765. i++;
  4766. continue;
  4767. } else if ((c & 0xE0) == 0xC0) {
  4768. len = 2;
  4769. cp = c & 0x1F;
  4770. } else if ((c & 0xF0) == 0xE0) {
  4771. len = 3;
  4772. cp = c & 0x0F;
  4773. } else if ((c & 0xF8) == 0xF0) {
  4774. len = 4;
  4775. cp = c & 0x07;
  4776. } else {
  4777. return false;
  4778. }
  4779. if (i + len > n) { return false; }
  4780. for (size_t j = 1; j < len; j++) {
  4781. auto b = static_cast<unsigned char>(s[i + j]);
  4782. if ((b & 0xC0) != 0x80) { return false; }
  4783. cp = (cp << 6) | (b & 0x3F);
  4784. }
  4785. // Overlong encoding check
  4786. if (len == 2 && cp < 0x80) { return false; }
  4787. if (len == 3 && cp < 0x800) { return false; }
  4788. if (len == 4 && cp < 0x10000) { return false; }
  4789. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4790. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4791. if (cp > 0x10FFFF) { return false; }
  4792. i += len;
  4793. }
  4794. return true;
  4795. }
  4796. } // namespace impl
  4797. } // namespace ws
  4798. namespace detail {
  4799. // NOTE: This code came up with the following stackoverflow post:
  4800. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4801. inline std::string base64_encode(const std::string &in) {
  4802. static const auto lookup =
  4803. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4804. std::string out;
  4805. out.reserve(in.size());
  4806. // Unsigned: the accumulator is never masked, so with a signed int the
  4807. // `val << 8` below overflows once enough bytes are folded in (undefined
  4808. // behaviour before C++20). Only the low bits are ever emitted, so the
  4809. // wrap-around of an unsigned accumulator does not affect the output.
  4810. uint32_t val = 0;
  4811. auto valb = -6;
  4812. for (auto c : in) {
  4813. val = (val << 8) + static_cast<uint8_t>(c);
  4814. valb += 8;
  4815. while (valb >= 0) {
  4816. out.push_back(lookup[(val >> valb) & 0x3F]);
  4817. valb -= 6;
  4818. }
  4819. }
  4820. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4821. while (out.size() % 4) {
  4822. out.push_back('=');
  4823. }
  4824. return out;
  4825. }
  4826. inline std::string sha1(const std::string &input) {
  4827. // RFC 3174 SHA-1 implementation
  4828. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4829. return (x << n) | (x >> (32 - n));
  4830. };
  4831. uint32_t h0 = 0x67452301;
  4832. uint32_t h1 = 0xEFCDAB89;
  4833. uint32_t h2 = 0x98BADCFE;
  4834. uint32_t h3 = 0x10325476;
  4835. uint32_t h4 = 0xC3D2E1F0;
  4836. // Pre-processing: adding padding bits
  4837. std::string msg = input;
  4838. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4839. msg.push_back(static_cast<char>(0x80u));
  4840. while (msg.size() % 64 != 56) {
  4841. msg.push_back(0);
  4842. }
  4843. // Append original length in bits as 64-bit big-endian
  4844. for (int i = 56; i >= 0; i -= 8) {
  4845. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4846. }
  4847. // Process each 512-bit chunk
  4848. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4849. uint32_t w[80];
  4850. for (size_t i = 0; i < 16; i++) {
  4851. w[i] =
  4852. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4853. << 24) |
  4854. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4855. << 16) |
  4856. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4857. << 8) |
  4858. (static_cast<uint32_t>(
  4859. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4860. }
  4861. for (int i = 16; i < 80; i++) {
  4862. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4863. }
  4864. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4865. for (int i = 0; i < 80; i++) {
  4866. uint32_t f, k;
  4867. if (i < 20) {
  4868. f = (b & c) | ((~b) & d);
  4869. k = 0x5A827999;
  4870. } else if (i < 40) {
  4871. f = b ^ c ^ d;
  4872. k = 0x6ED9EBA1;
  4873. } else if (i < 60) {
  4874. f = (b & c) | (b & d) | (c & d);
  4875. k = 0x8F1BBCDC;
  4876. } else {
  4877. f = b ^ c ^ d;
  4878. k = 0xCA62C1D6;
  4879. }
  4880. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4881. e = d;
  4882. d = c;
  4883. c = left_rotate(b, 30);
  4884. b = a;
  4885. a = temp;
  4886. }
  4887. h0 += a;
  4888. h1 += b;
  4889. h2 += c;
  4890. h3 += d;
  4891. h4 += e;
  4892. }
  4893. // Produce the final hash as a 20-byte binary string
  4894. std::string hash(20, '\0');
  4895. for (size_t i = 0; i < 4; i++) {
  4896. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4897. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4898. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4899. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4900. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4901. }
  4902. return hash;
  4903. }
  4904. inline std::string websocket_accept_key(const std::string &client_key) {
  4905. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4906. return base64_encode(sha1(client_key + magic));
  4907. }
  4908. inline bool is_websocket_upgrade(const Request &req) {
  4909. if (req.method != "GET") { return false; }
  4910. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4911. // list of protocols and asks recipients to match each name
  4912. // case-insensitively, so look for the token rather than compare the whole
  4913. // field value.
  4914. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4915. // Check Connection: Upgrade
  4916. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4917. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4918. // RFC 6455 Section 4.2.1
  4919. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4920. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4921. return false;
  4922. }
  4923. static const std::string b64chars =
  4924. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4925. for (size_t i = 0; i < 22; i++) {
  4926. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4927. }
  4928. // Check Sec-WebSocket-Version: 13
  4929. auto version = req.get_header_value("Sec-WebSocket-Version");
  4930. if (version != "13") { return false; }
  4931. return true;
  4932. }
  4933. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4934. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4935. thread_local std::random_device rd;
  4936. size_t filled = 0;
  4937. while (filled < n) {
  4938. auto v = rd();
  4939. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4940. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4941. }
  4942. }
  4943. }
  4944. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4945. const char *data, size_t len, bool fin,
  4946. bool mask) {
  4947. // The header (FIN + opcode, MASK + length, the extended length, the mask
  4948. // key: 14 bytes at most) goes out in one write with the payload's first
  4949. // chunk, so that under TCP_NODELAY a small frame is one segment, not three.
  4950. uint8_t header[14];
  4951. size_t header_len = 0;
  4952. header[header_len++] = static_cast<uint8_t>(
  4953. (fin ? 0x80 : 0x00) | (static_cast<uint8_t>(opcode) & 0x0F));
  4954. uint8_t mask_bit = mask ? 0x80 : 0x00;
  4955. if (len < 126) {
  4956. header[header_len++] = static_cast<uint8_t>(len) | mask_bit;
  4957. } else if (len <= 0xFFFF) {
  4958. header[header_len++] = 126 | mask_bit;
  4959. header[header_len++] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4960. header[header_len++] = static_cast<uint8_t>(len & 0xFF);
  4961. } else {
  4962. header[header_len++] = 127 | mask_bit;
  4963. for (int i = 7; i >= 0; i--) {
  4964. header[header_len++] =
  4965. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4966. }
  4967. }
  4968. uint8_t mask_key[4] = {0};
  4969. if (mask) {
  4970. fill_random_bytes(mask_key, sizeof(mask_key));
  4971. std::copy(mask_key, mask_key + 4, header + header_len);
  4972. header_len += 4;
  4973. }
  4974. // `n` bytes of the payload from `offset`, masked if they are to be, at `out`
  4975. auto put = [&](char *out, size_t offset, size_t n) {
  4976. for (size_t i = 0; i < n; i++) {
  4977. out[i] = mask ? data[offset + i] ^
  4978. static_cast<char>(mask_key[(offset + i) % 4])
  4979. : data[offset + i];
  4980. }
  4981. };
  4982. const size_t chunk_size = 4096;
  4983. size_t first = (std::min)(len, chunk_size);
  4984. std::vector<char> buf(header_len + first);
  4985. std::copy(header, header + header_len, buf.begin());
  4986. put(buf.data() + header_len, 0, first);
  4987. if (!write_data(strm, buf.data(), buf.size())) { return false; }
  4988. // The rest, masked a chunk at a time, or else as it is
  4989. if (!mask) {
  4990. return first == len || write_data(strm, data + first, len - first);
  4991. }
  4992. for (size_t offset = first; offset < len; offset += chunk_size) {
  4993. size_t n = (std::min)(chunk_size, len - offset);
  4994. put(buf.data(), offset, n);
  4995. if (!write_data(strm, buf.data(), n)) { return false; }
  4996. }
  4997. return true;
  4998. }
  4999. } // namespace detail
  5000. namespace ws {
  5001. namespace impl {
  5002. inline void FrameReader::reset() {
  5003. have_ = 0;
  5004. need_ = 2;
  5005. sized_ = false;
  5006. len_ = 0;
  5007. payload_.clear();
  5008. }
  5009. // Stream::read may return less than asked for -- it hands back whatever its
  5010. // buffer already holds -- so each part of the frame is read in a loop, a byte
  5011. // at a time if that is how it comes. (When read() fails it always records why,
  5012. // so the error belongs to this call and not to an earlier one.)
  5013. inline FrameRead FrameReader::read(Stream &strm, Opcode &opcode,
  5014. std::string &payload, bool &fin,
  5015. bool expect_masked, size_t max_len) {
  5016. // A timeout keeps what was read; anything else ends the frame
  5017. auto stopped = [&]() {
  5018. if (strm.get_error() == Error::Timeout) { return FrameRead::Timeout; }
  5019. reset();
  5020. return FrameRead::Fail;
  5021. };
  5022. auto fail = [&]() {
  5023. reset();
  5024. return FrameRead::Fail;
  5025. };
  5026. while (have_ < need_) {
  5027. auto n = strm.read(reinterpret_cast<char *>(head_) + have_, need_ - have_);
  5028. if (n <= 0) { return stopped(); }
  5029. have_ += static_cast<size_t>(n);
  5030. if (have_ < 2 || need_ > 2) { continue; }
  5031. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  5032. if (head_[0] & 0x70) { return fail(); }
  5033. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  5034. // MUST have a payload length of 125 bytes or less
  5035. auto len7 = head_[1] & 0x7F;
  5036. if ((head_[0] & 0x08) && (!(head_[0] & 0x80) || len7 > 125)) {
  5037. return fail();
  5038. }
  5039. auto masked = (head_[1] & 0x80) != 0;
  5040. if (masked != expect_masked) { return fail(); }
  5041. // The extended length and the mask key follow
  5042. need_ = 2 + (len7 == 126 ? 2 : len7 == 127 ? 8 : 0) + (masked ? 4 : 0);
  5043. }
  5044. if (!sized_) {
  5045. uint64_t len = head_[1] & 0x7F;
  5046. if (len == 126) {
  5047. len = (static_cast<uint64_t>(head_[2]) << 8) | head_[3];
  5048. } else if (len == 127) {
  5049. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  5050. if (head_[2] & 0x80) { return fail(); }
  5051. len = 0;
  5052. for (size_t i = 2; i < 10; i++) {
  5053. len = (len << 8) | head_[i];
  5054. }
  5055. }
  5056. // A max_len of 0 means no limit, as payload_max_length does, and a length
  5057. // size_t cannot hold (32-bit builds) is refused either way.
  5058. if ((max_len > 0 && len > max_len) || !detail::fits_in_size_t(len)) {
  5059. return fail();
  5060. }
  5061. len_ = static_cast<size_t>(len);
  5062. sized_ = true;
  5063. }
  5064. // Grow the payload only as it arrives, since a header alone can announce
  5065. // max_len bytes that never come.
  5066. while (payload_.size() < len_) {
  5067. auto offset = payload_.size();
  5068. auto n = (std::min)(len_ - offset, CPPHTTPLIB_RECV_BUFSIZ);
  5069. payload_.resize(offset + n);
  5070. auto got = strm.read(&payload_[offset], n);
  5071. if (got <= 0) {
  5072. payload_.resize(offset);
  5073. return stopped();
  5074. }
  5075. payload_.resize(offset + static_cast<size_t>(got));
  5076. }
  5077. if (head_[1] & 0x80) {
  5078. const auto *mask_key = head_ + need_ - 4;
  5079. for (size_t i = 0; i < payload_.size(); i++) {
  5080. payload_[i] ^= static_cast<char>(mask_key[i % 4]);
  5081. }
  5082. }
  5083. fin = (head_[0] & 0x80) != 0;
  5084. opcode = static_cast<Opcode>(head_[0] & 0x0F);
  5085. payload = std::move(payload_);
  5086. reset();
  5087. return FrameRead::Ok;
  5088. }
  5089. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  5090. std::string &payload, bool &fin,
  5091. bool expect_masked, size_t max_len) {
  5092. FrameReader reader;
  5093. auto r = reader.read(strm, opcode, payload, fin, expect_masked, max_len);
  5094. return r == FrameRead::Timeout && reader.begun() ? FrameRead::Fail : r;
  5095. }
  5096. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  5097. // be sent followed by a UTF-8 reason.
  5098. inline bool is_valid_close_payload(const std::string &payload) {
  5099. if (payload.empty()) { return true; }
  5100. if (payload.size() < 2) { return false; }
  5101. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  5102. static_cast<uint8_t>(payload[1]);
  5103. auto may_be_sent = (1000 <= code && code <= 1003) ||
  5104. (1007 <= code && code <= 1014) ||
  5105. (3000 <= code && code <= 4999);
  5106. return may_be_sent && is_valid_utf8(payload.substr(2));
  5107. }
  5108. } // namespace impl
  5109. } // namespace ws
  5110. namespace detail {
  5111. // A path a mount point serves: absolute, with no empty segment except a
  5112. // trailing '/', no segment ending in '.' or a space (which covers "." and
  5113. // ".." and names Windows trims into another file's name) and, on Windows, no
  5114. // ':' (which names an NTFS stream, so "a.txt::$DATA" is a.txt), so the file
  5115. // served is the one that req.path names to the handlers that ran before it.
  5116. inline bool is_valid_path(const std::string &path) {
  5117. if (path.empty() || path[0] != '/') { return false; }
  5118. auto beg = size_t{1};
  5119. for (auto i = beg; i <= path.size(); i++) {
  5120. if (i < path.size() && path[i] != '/') {
  5121. if (path[i] == '\0' || path[i] == '\\') { return false; }
  5122. #ifdef _WIN32
  5123. if (path[i] == ':') { return false; }
  5124. #endif
  5125. continue;
  5126. }
  5127. auto len = i - beg;
  5128. if ((len == 0 && i < path.size()) ||
  5129. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5130. return false;
  5131. }
  5132. beg = i + 1;
  5133. }
  5134. return true;
  5135. }
  5136. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5137. #if defined(_WIN32)
  5138. // Resolve junctions and symlinks, as realpath() does
  5139. auto wpath = u8string_to_wstring(path);
  5140. if (wpath.empty()) { return false; }
  5141. CREATEFILE2_EXTENDED_PARAMETERS params{};
  5142. params.dwSize = sizeof(params);
  5143. params.dwFileFlags = FILE_FLAG_BACKUP_SEMANTICS; // Needed to open a directory
  5144. auto h = ::CreateFile2(wpath.c_str(), 0,
  5145. FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
  5146. OPEN_EXISTING, &params);
  5147. if (h == INVALID_HANDLE_VALUE) { return false; }
  5148. auto guard = scope_exit([&]() { ::CloseHandle(h); });
  5149. std::wstring wbuf(MAX_PATH, L'\0');
  5150. auto len = ::GetFinalPathNameByHandleW(
  5151. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5152. if (len >= wbuf.size()) {
  5153. wbuf.resize(len);
  5154. len = ::GetFinalPathNameByHandleW(
  5155. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5156. }
  5157. if (len == 0 || len >= wbuf.size()) { return false; }
  5158. auto n = ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5159. nullptr, 0, nullptr, nullptr);
  5160. if (n <= 0) { return false; }
  5161. resolved.assign(static_cast<size_t>(n), '\0');
  5162. ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5163. &resolved[0], n, nullptr, nullptr);
  5164. #elif defined(PATH_MAX)
  5165. char buf[PATH_MAX];
  5166. if (realpath(path, buf) == nullptr) { return false; }
  5167. resolved = buf;
  5168. #else
  5169. auto buf = realpath(path, nullptr);
  5170. auto guard = scope_exit([&]() { std::free(buf); });
  5171. if (buf == nullptr) { return false; }
  5172. resolved = buf;
  5173. #endif
  5174. return true;
  5175. }
  5176. inline bool is_path_within_base(const std::string &resolved_path,
  5177. const std::string &resolved_base) {
  5178. #if defined(_WIN32)
  5179. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5180. resolved_base.size()) == 0;
  5181. #else
  5182. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5183. resolved_base.size()) == 0;
  5184. #endif
  5185. }
  5186. inline FileStat::FileStat(const std::string &path) {
  5187. #if defined(_WIN32)
  5188. auto wpath = u8string_to_wstring(path.c_str());
  5189. ret_ = _wstat(wpath.c_str(), &st_);
  5190. #else
  5191. ret_ = stat(path.c_str(), &st_);
  5192. #endif
  5193. }
  5194. inline bool FileStat::is_file() const {
  5195. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5196. }
  5197. inline bool FileStat::is_dir() const {
  5198. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5199. }
  5200. inline time_t FileStat::mtime() const {
  5201. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5202. : static_cast<time_t>(-1);
  5203. }
  5204. inline size_t FileStat::size() const {
  5205. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5206. }
  5207. inline std::string encode_path(const std::string &s) {
  5208. std::string result;
  5209. result.reserve(s.size());
  5210. for (size_t i = 0; s[i]; i++) {
  5211. switch (s[i]) {
  5212. case ' ': result += "%20"; break;
  5213. case '+': result += "%2B"; break;
  5214. case '\'': result += "%27"; break;
  5215. case ',': result += "%2C"; break;
  5216. // case ':': result += "%3A"; break; // ok? probably...
  5217. case ';': result += "%3B"; break;
  5218. default:
  5219. auto c = static_cast<uint8_t>(s[i]);
  5220. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5221. // in a request-target as-is.
  5222. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5223. result += '%';
  5224. char hex[4];
  5225. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5226. assert(len == 2);
  5227. result.append(hex, static_cast<size_t>(len));
  5228. } else {
  5229. result += s[i];
  5230. }
  5231. break;
  5232. }
  5233. }
  5234. return result;
  5235. }
  5236. inline std::string file_extension(const std::string &path) {
  5237. auto i = path.size();
  5238. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5239. i--;
  5240. }
  5241. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5242. return std::string();
  5243. }
  5244. return path.substr(i);
  5245. }
  5246. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5247. template <typename T>
  5248. inline bool parse_header(const char *beg, const char *end, T fn);
  5249. template <typename T>
  5250. inline bool parse_header(const char *beg, const char *end, T fn) {
  5251. // Skip trailing spaces and tabs.
  5252. while (beg < end && is_space_or_tab(end[-1])) {
  5253. end--;
  5254. }
  5255. auto p = beg;
  5256. while (p < end && *p != ':') {
  5257. p++;
  5258. }
  5259. auto name = std::string(beg, p);
  5260. if (!detail::fields::is_field_name(name)) { return false; }
  5261. if (p == end) { return false; }
  5262. auto key_end = p;
  5263. if (*p++ != ':') { return false; }
  5264. while (p < end && is_space_or_tab(*p)) {
  5265. p++;
  5266. }
  5267. if (p <= end) {
  5268. auto key_len = key_end - beg;
  5269. if (!key_len) { return false; }
  5270. auto key = std::string(beg, key_end);
  5271. auto val = std::string(p, end);
  5272. if (!detail::fields::is_field_value(val)) { return false; }
  5273. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5274. // percent-decoded by the recipient. Applications that need to interpret a
  5275. // value as a URI component should call httplib::decode_uri_component()
  5276. // (or decode_path_component()) explicitly.
  5277. fn(key, val);
  5278. return true;
  5279. }
  5280. return false;
  5281. }
  5282. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5283. const Headers &src_headers) {
  5284. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5285. // transfer coding is complete when a chunk with a chunk-size of zero is
  5286. // received, possibly followed by a trailer section, and finally terminated by
  5287. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5288. //
  5289. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5290. // doesn't care for the existence of the final CRLF. In other words, it seems
  5291. // to be ok whether the final CRLF exists or not in the chunked data.
  5292. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5293. //
  5294. // According to the reference code in RFC 9112, cpp-httplib now allows
  5295. // chunked transfer coding data without the final CRLF.
  5296. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5297. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5298. "transfer-encoding",
  5299. "content-length",
  5300. "host",
  5301. "authorization",
  5302. "www-authenticate",
  5303. "proxy-authenticate",
  5304. "proxy-authorization",
  5305. "cookie",
  5306. "set-cookie",
  5307. "cache-control",
  5308. "expect",
  5309. "max-forwards",
  5310. "pragma",
  5311. "range",
  5312. "te",
  5313. "age",
  5314. "expires",
  5315. "date",
  5316. "location",
  5317. "retry-after",
  5318. "vary",
  5319. "warning",
  5320. "content-encoding",
  5321. "content-type",
  5322. "content-range",
  5323. "trailer"};
  5324. case_ignore::unordered_set<std::string> declared_trailers;
  5325. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5326. if (!trailer_header.empty()) {
  5327. // split() trims each token and skips empty ones, so the name arrives ready
  5328. // to look up.
  5329. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5330. ',', [&](const char *b, const char *e) {
  5331. // A legitimate message declares only a handful of trailers. Cap the
  5332. // set so a peer cannot grow it without bound: an oversized set only
  5333. // arises from an attempt to force many colliding names into
  5334. // quadratic lookups (case_ignore::hash is unkeyed).
  5335. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5336. return;
  5337. }
  5338. std::string key(b, e);
  5339. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5340. declared_trailers.insert(key);
  5341. }
  5342. });
  5343. }
  5344. size_t trailer_header_count = 0;
  5345. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5346. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5347. // Count every received trailer field, not only the declared ones stored in
  5348. // dest, so undeclared fields cannot keep this loop running past the limit.
  5349. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5350. constexpr auto line_terminator_len = 2;
  5351. auto line_beg = line_reader.ptr();
  5352. auto line_end =
  5353. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5354. if (!parse_header(line_beg, line_end,
  5355. [&](const std::string &key, const std::string &val) {
  5356. if (declared_trailers.find(key) !=
  5357. declared_trailers.end()) {
  5358. dest.emplace(key, val);
  5359. }
  5360. })) {
  5361. return false;
  5362. }
  5363. trailer_header_count++;
  5364. if (!line_reader.getline()) { return false; }
  5365. }
  5366. return true;
  5367. }
  5368. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5369. size_t right) {
  5370. while (b + left < e && is_space_or_tab(b[left])) {
  5371. left++;
  5372. }
  5373. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5374. right--;
  5375. }
  5376. return std::make_pair(left, right);
  5377. }
  5378. inline std::string trim_copy(const std::string &s) {
  5379. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5380. return s.substr(r.first, r.second - r.first);
  5381. }
  5382. inline std::string trim_double_quotes_copy(const std::string &s) {
  5383. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5384. return s.substr(1, s.size() - 2);
  5385. }
  5386. return s;
  5387. }
  5388. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5389. // here, as browsers send any other backslash, such as one in a Windows path,
  5390. // as it is.
  5391. inline std::string unquote_param(const std::string &s) {
  5392. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5393. std::string out;
  5394. for (size_t i = 1; i + 1 < s.size(); i++) {
  5395. if (s[i] == '\\' && i + 2 < s.size() &&
  5396. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5397. i++;
  5398. }
  5399. out += s[i];
  5400. }
  5401. return out;
  5402. }
  5403. inline void
  5404. divide(const char *data, std::size_t size, char d,
  5405. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5406. fn) {
  5407. const auto it = std::find(data, data + size, d);
  5408. const auto found = static_cast<std::size_t>(it != data + size);
  5409. const auto lhs_data = data;
  5410. const auto lhs_size = static_cast<std::size_t>(it - data);
  5411. const auto rhs_data = it + found;
  5412. const auto rhs_size = size - lhs_size - found;
  5413. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5414. }
  5415. inline void
  5416. divide(const std::string &str, char d,
  5417. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5418. fn) {
  5419. divide(str.data(), str.size(), d, std::move(fn));
  5420. }
  5421. inline void split(const char *b, const char *e, char d,
  5422. std::function<void(const char *, const char *)> fn) {
  5423. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5424. }
  5425. inline void split(const char *b, const char *e, char d, size_t m,
  5426. std::function<void(const char *, const char *)> fn) {
  5427. size_t i = 0;
  5428. size_t beg = 0;
  5429. size_t count = 1;
  5430. while (e ? (b + i < e) : (b[i] != '\0')) {
  5431. if (b[i] == d && count < m) {
  5432. auto r = trim(b, e, beg, i);
  5433. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5434. beg = i + 1;
  5435. count++;
  5436. }
  5437. i++;
  5438. }
  5439. if (i) {
  5440. auto r = trim(b, e, beg, i);
  5441. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5442. }
  5443. }
  5444. // Same contract as split(), except that a delimiter inside a quoted-string is
  5445. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5446. // quoted-string, and ';' and '=' are legal characters inside one.
  5447. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5448. std::function<void(const char *, const char *)> fn) {
  5449. size_t i = 0;
  5450. size_t beg = 0;
  5451. size_t count = 1;
  5452. auto in_quotes = false;
  5453. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5454. while (has(i)) {
  5455. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5456. // A quoted-pair, whose second character does not end the string.
  5457. i++;
  5458. } else if (b[i] == '"') {
  5459. in_quotes = !in_quotes;
  5460. } else if (b[i] == d && !in_quotes && count < m) {
  5461. auto r = trim(b, e, beg, i);
  5462. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5463. beg = i + 1;
  5464. count++;
  5465. }
  5466. i++;
  5467. }
  5468. if (i) {
  5469. auto r = trim(b, e, beg, i);
  5470. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5471. }
  5472. }
  5473. inline void split_unquoted(const char *b, const char *e, char d,
  5474. std::function<void(const char *, const char *)> fn) {
  5475. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5476. std::move(fn));
  5477. }
  5478. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5479. // key a token, so the first '=' is the separator even when the value is a
  5480. // quoted-string carrying more of them.
  5481. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5482. std::string &val) {
  5483. divide(
  5484. b, static_cast<std::size_t>(e - b), '=',
  5485. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5486. const auto kr = trim(kb, kb + klen, 0, klen);
  5487. key.assign(kb + kr.first, kb + kr.second);
  5488. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5489. val.assign(vb + vr.first, vb + vr.second);
  5490. });
  5491. }
  5492. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5493. std::function<bool(const char *, const char *)> fn) {
  5494. size_t i = 0;
  5495. size_t beg = 0;
  5496. size_t count = 1;
  5497. while (e ? (b + i < e) : (b[i] != '\0')) {
  5498. if (b[i] == d && count < m) {
  5499. auto r = trim(b, e, beg, i);
  5500. if (r.first < r.second) {
  5501. auto found = fn(&b[r.first], &b[r.second]);
  5502. if (found) { return true; }
  5503. }
  5504. beg = i + 1;
  5505. count++;
  5506. }
  5507. i++;
  5508. }
  5509. if (i) {
  5510. auto r = trim(b, e, beg, i);
  5511. if (r.first < r.second) {
  5512. auto found = fn(&b[r.first], &b[r.second]);
  5513. if (found) { return true; }
  5514. }
  5515. }
  5516. return false;
  5517. }
  5518. inline bool split_find(const char *b, const char *e, char d,
  5519. std::function<bool(const char *, const char *)> fn) {
  5520. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5521. std::move(fn));
  5522. }
  5523. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5524. size_t fixed_buffer_size)
  5525. : strm_(strm), fixed_buffer_(fixed_buffer),
  5526. fixed_buffer_size_(fixed_buffer_size) {}
  5527. inline const char *stream_line_reader::ptr() const {
  5528. if (growable_buffer_.empty()) {
  5529. return fixed_buffer_;
  5530. } else {
  5531. return growable_buffer_.data();
  5532. }
  5533. }
  5534. inline size_t stream_line_reader::size() const {
  5535. if (growable_buffer_.empty()) {
  5536. return fixed_buffer_used_size_;
  5537. } else {
  5538. return growable_buffer_.size();
  5539. }
  5540. }
  5541. inline bool stream_line_reader::end_with_crlf() const {
  5542. auto end = ptr() + size();
  5543. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5544. }
  5545. inline bool stream_line_reader::getline() {
  5546. fixed_buffer_used_size_ = 0;
  5547. growable_buffer_.clear();
  5548. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5549. char prev_byte = 0;
  5550. #endif
  5551. for (size_t i = 0;; i++) {
  5552. // Fast path: whatever the stream has already buffered can be scanned for
  5553. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5554. // call, a bounds check and a one-byte copy per character of the request.
  5555. size_t buffered_size = 0;
  5556. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5557. auto take = buffered_size;
  5558. auto terminated = false;
  5559. for (size_t at = 0; at < buffered_size;) {
  5560. auto nl = static_cast<const char *>(
  5561. memchr(buffered + at, '\n', buffered_size - at));
  5562. if (!nl) { break; }
  5563. auto pos = static_cast<size_t>(nl - buffered);
  5564. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5565. take = pos + 1;
  5566. terminated = true;
  5567. break;
  5568. #else
  5569. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5570. // be the last byte of an earlier chunk, hence prev_byte.
  5571. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5572. take = pos + 1;
  5573. terminated = true;
  5574. break;
  5575. }
  5576. at = pos + 1;
  5577. #endif
  5578. }
  5579. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5580. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5581. prev_byte = buffered[take - 1];
  5582. #endif
  5583. append(buffered, take);
  5584. strm_.consume_buffered(take);
  5585. i += take;
  5586. if (terminated) { return true; }
  5587. continue;
  5588. }
  5589. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5590. // Treat exceptionally long lines as an error to
  5591. // prevent infinite loops/memory exhaustion
  5592. return false;
  5593. }
  5594. char byte;
  5595. auto n = strm_.read(&byte, 1);
  5596. if (n < 0) {
  5597. return false;
  5598. } else if (n == 0) {
  5599. if (i == 0) {
  5600. return false;
  5601. } else {
  5602. break;
  5603. }
  5604. }
  5605. append(byte);
  5606. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5607. if (byte == '\n') { break; }
  5608. #else
  5609. if (prev_byte == '\r' && byte == '\n') { break; }
  5610. prev_byte = byte;
  5611. #endif
  5612. }
  5613. return true;
  5614. }
  5615. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5616. inline void stream_line_reader::append(const char *data, size_t size) {
  5617. // Once the line has outgrown the fixed buffer everything must keep going to
  5618. // the growable one, even if a later chunk would have fit. Without the
  5619. // emptiness check a short append after a long one would land in the fixed
  5620. // buffer, which ptr() and size() no longer look at, and be lost.
  5621. if (growable_buffer_.empty() &&
  5622. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5623. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5624. fixed_buffer_used_size_ += size;
  5625. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5626. } else {
  5627. // Unlike the per-character overload, this can be the very first append of
  5628. // the line, so the fixed buffer may hold nothing and carry no terminator
  5629. // yet. assign() takes an explicit length and does not need one.
  5630. if (growable_buffer_.empty()) {
  5631. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5632. }
  5633. growable_buffer_.append(data, size);
  5634. }
  5635. }
  5636. inline mmap::mmap(const char *path) { open(path); }
  5637. inline mmap::~mmap() { close(); }
  5638. inline bool mmap::open(const char *path) {
  5639. close();
  5640. #if defined(_WIN32)
  5641. auto wpath = u8string_to_wstring(path);
  5642. if (wpath.empty()) { return false; }
  5643. hFile_ =
  5644. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5645. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5646. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5647. LARGE_INTEGER size{};
  5648. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5649. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5650. // See:
  5651. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5652. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5653. size_ = static_cast<size_t>(size.QuadPart);
  5654. hMapping_ =
  5655. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5656. // Special treatment for an empty file...
  5657. if (hMapping_ == NULL && size_ == 0) {
  5658. close();
  5659. is_open_empty_file = true;
  5660. return true;
  5661. }
  5662. if (hMapping_ == NULL) {
  5663. close();
  5664. return false;
  5665. }
  5666. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5667. if (addr_ == nullptr) {
  5668. close();
  5669. return false;
  5670. }
  5671. #else
  5672. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5673. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5674. if (fd_ == -1) { return false; }
  5675. // Only a regular file has a size to serve, unlike a directory or a device.
  5676. struct stat sb;
  5677. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5678. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5679. close();
  5680. return false;
  5681. }
  5682. size_ = static_cast<size_t>(sb.st_size);
  5683. #endif
  5684. return true;
  5685. }
  5686. inline bool mmap::is_open() const {
  5687. #if defined(_WIN32)
  5688. return is_open_empty_file ? true : addr_ != nullptr;
  5689. #else
  5690. return fd_ != -1;
  5691. #endif
  5692. }
  5693. inline size_t mmap::size() const { return size_; }
  5694. inline void mmap::close() {
  5695. #if defined(_WIN32)
  5696. if (addr_) {
  5697. ::UnmapViewOfFile(addr_);
  5698. addr_ = nullptr;
  5699. }
  5700. if (hMapping_) {
  5701. ::CloseHandle(hMapping_);
  5702. hMapping_ = NULL;
  5703. }
  5704. if (hFile_ != INVALID_HANDLE_VALUE) {
  5705. ::CloseHandle(hFile_);
  5706. hFile_ = INVALID_HANDLE_VALUE;
  5707. }
  5708. is_open_empty_file = false;
  5709. #else
  5710. if (fd_ != -1) {
  5711. ::close(fd_);
  5712. fd_ = -1;
  5713. }
  5714. #endif
  5715. size_ = 0;
  5716. }
  5717. inline int close_socket(socket_t sock) noexcept {
  5718. #ifdef _WIN32
  5719. return closesocket(sock);
  5720. #else
  5721. return close(sock);
  5722. #endif
  5723. }
  5724. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5725. ssize_t res = 0;
  5726. while (true) {
  5727. res = fn();
  5728. if (res < 0 && errno == EINTR) {
  5729. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5730. continue;
  5731. }
  5732. break;
  5733. }
  5734. return res;
  5735. }
  5736. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5737. if (offset >= size_) { return 0; }
  5738. len = (std::min)(len, size_ - offset);
  5739. #if defined(_WIN32)
  5740. // Windows does not let a mapped file be truncated.
  5741. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5742. return len;
  5743. #else
  5744. auto n = handle_EINTR(
  5745. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5746. return n > 0 ? static_cast<size_t>(n) : 0;
  5747. #endif
  5748. }
  5749. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5750. return handle_EINTR([&]() {
  5751. return recv(sock,
  5752. #ifdef _WIN32
  5753. static_cast<char *>(ptr), static_cast<int>(size),
  5754. #else
  5755. ptr, size,
  5756. #endif
  5757. flags);
  5758. });
  5759. }
  5760. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5761. int flags) {
  5762. return handle_EINTR([&]() {
  5763. return send(sock,
  5764. #ifdef _WIN32
  5765. static_cast<const char *>(ptr), static_cast<int>(size),
  5766. #else
  5767. ptr, size,
  5768. #endif
  5769. flags);
  5770. });
  5771. }
  5772. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5773. #ifdef _WIN32
  5774. return ::WSAPoll(fds, nfds, timeout);
  5775. #else
  5776. return ::poll(fds, nfds, timeout);
  5777. #endif
  5778. }
  5779. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5780. time_t usec) {
  5781. struct pollfd pfd;
  5782. pfd.fd = sock;
  5783. pfd.events = events;
  5784. pfd.revents = 0;
  5785. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5786. // "return immediately", which callers here rely on to probe a socket.
  5787. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5788. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5789. }
  5790. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5791. return select_impl(sock, POLLIN, sec, usec);
  5792. }
  5793. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5794. return select_impl(sock, POLLOUT, sec, usec);
  5795. }
  5796. // The point sec and usec from now, for select_until(). A negative sec, or one
  5797. // past what the clock reaches, never comes.
  5798. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5799. time_t usec) {
  5800. auto now = std::chrono::steady_clock::now();
  5801. auto never = (std::chrono::steady_clock::time_point::max)();
  5802. if (sec < 0 ||
  5803. sec >= std::chrono::duration_cast<std::chrono::seconds>(never - now)
  5804. .count()) {
  5805. return never;
  5806. }
  5807. return now + std::chrono::seconds(sec) + std::chrono::microseconds(usec);
  5808. }
  5809. // Waits only for the time left until deadline, so that all the waits of one
  5810. // TLS handshake come out of a single timeout. With interrupted, it waits in
  5811. // slices and gives up once interrupted() returns true, as a local shutdown()
  5812. // would not wake the wait on Windows.
  5813. inline ssize_t
  5814. select_until(socket_t sock, short events,
  5815. std::chrono::steady_clock::time_point deadline,
  5816. const std::function<bool()> &interrupted = nullptr) {
  5817. if (!interrupted) {
  5818. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5819. return select_impl(sock, events, -1, 0);
  5820. }
  5821. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5822. deadline - std::chrono::steady_clock::now())
  5823. .count();
  5824. if (left <= 0) { return 0; }
  5825. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5826. static_cast<time_t>(left % 1000000));
  5827. }
  5828. const auto slice = std::chrono::microseconds(100000);
  5829. while (!interrupted()) {
  5830. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5831. deadline - std::chrono::steady_clock::now());
  5832. auto last = left < slice;
  5833. // poll() takes whole milliseconds, so round the last wait up to keep it
  5834. // from ending before the deadline.
  5835. auto wait_usec = last ? (std::max)((left.count() + 999) / 1000 * 1000,
  5836. static_cast<decltype(left.count())>(0))
  5837. : slice.count();
  5838. auto ret = select_impl(sock, events, 0, static_cast<time_t>(wait_usec));
  5839. if (ret != 0 || last) { return ret; }
  5840. }
  5841. return 0;
  5842. }
  5843. // select_impl(), but waits in slices and gives up once interrupted() returns
  5844. // true
  5845. inline ssize_t select_interruptible(socket_t sock, short events, time_t sec,
  5846. time_t usec,
  5847. const std::function<bool()> &interrupted) {
  5848. if (!interrupted) { return select_impl(sock, events, sec, usec); }
  5849. return select_until(sock, events, deadline_after(sec, usec), interrupted);
  5850. }
  5851. inline ssize_t
  5852. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5853. const std::function<bool()> &interrupted) {
  5854. return select_interruptible(sock, POLLIN, sec, usec, interrupted);
  5855. }
  5856. // Waits for a connect in progress, which ends as Error::Canceled once
  5857. // interrupted() returns true
  5858. inline Error
  5859. wait_until_socket_is_ready(socket_t sock, time_t sec, time_t usec,
  5860. const std::function<bool()> &interrupted = nullptr) {
  5861. auto ret =
  5862. select_interruptible(sock, POLLIN | POLLOUT, sec, usec, interrupted);
  5863. if (ret == 0) {
  5864. return interrupted && interrupted() ? Error::Canceled
  5865. : Error::ConnectionTimeout;
  5866. }
  5867. if (ret < 0) { return Error::Connection; }
  5868. // A failed connect reports its error here, whatever events poll() returned
  5869. auto error = 0;
  5870. socklen_t len = sizeof(error);
  5871. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5872. reinterpret_cast<char *>(&error), &len);
  5873. return res >= 0 && !error ? Error::Success : Error::Connection;
  5874. }
  5875. inline bool is_socket_alive(socket_t sock) {
  5876. const auto val = detail::select_read(sock, 0, 0);
  5877. if (val == 0) {
  5878. return true;
  5879. } else if (val < 0 && errno == EBADF) {
  5880. return false;
  5881. }
  5882. char buf[1];
  5883. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5884. }
  5885. class SocketStream final : public Stream {
  5886. public:
  5887. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5888. time_t write_timeout_sec, time_t write_timeout_usec,
  5889. time_t max_timeout_msec = 0,
  5890. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5891. (std::chrono::steady_clock::time_point::min)());
  5892. ~SocketStream() override;
  5893. bool is_readable() const override;
  5894. bool wait_readable() const override;
  5895. bool wait_writable() const override;
  5896. bool is_peer_alive() const override;
  5897. ssize_t read(char *ptr, size_t size) override;
  5898. ssize_t write(const char *ptr, size_t size) override;
  5899. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5900. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5901. socket_t socket() const override;
  5902. time_t duration() const override;
  5903. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5904. void set_max_timeout(time_t msec) override;
  5905. void set_read_interrupt(std::function<bool()> interrupted) override;
  5906. const char *buffered_data(size_t &size) const override;
  5907. void consume_buffered(size_t size) override;
  5908. // The caller has just seen this socket become readable. Lets the next read
  5909. // skip its own readiness wait, which would otherwise ask the kernel a
  5910. // question that was answered a moment ago. Consumed by that read.
  5911. void set_readable_hint() { readable_hint_ = true; }
  5912. private:
  5913. bool ensure_readable();
  5914. socket_t sock_;
  5915. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5916. // thread while a read is in flight -- that is the point of it, for a caller
  5917. // holding one connection and wanting control back to send on it.
  5918. std::atomic<time_t> read_timeout_sec_;
  5919. std::atomic<time_t> read_timeout_usec_;
  5920. time_t write_timeout_sec_;
  5921. time_t write_timeout_usec_;
  5922. time_t max_timeout_msec_;
  5923. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5924. std::function<bool()> read_interrupted_;
  5925. std::vector<char> read_buff_;
  5926. size_t read_buff_off_ = 0;
  5927. size_t read_buff_content_size_ = 0;
  5928. bool readable_hint_ = false;
  5929. static const size_t read_buff_size_ = 1024l * 4;
  5930. };
  5931. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5932. time_t keep_alive_timeout_sec) {
  5933. using namespace std::chrono;
  5934. const auto interval_usec =
  5935. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5936. // Avoid expensive `steady_clock::now()` call for the first time
  5937. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5938. const auto start = steady_clock::now() - microseconds{interval_usec};
  5939. const auto timeout = seconds{keep_alive_timeout_sec};
  5940. while (true) {
  5941. if (svr_sock == INVALID_SOCKET) {
  5942. break; // Server socket is closed
  5943. }
  5944. auto val = select_read(sock, 0, interval_usec);
  5945. if (val < 0) {
  5946. break; // Ssocket error
  5947. } else if (val == 0) {
  5948. if (steady_clock::now() - start > timeout) {
  5949. break; // Timeout
  5950. }
  5951. } else {
  5952. return true; // Ready for read
  5953. }
  5954. }
  5955. return false;
  5956. }
  5957. // `has_buffered_request` reports whether the connection's stream already holds
  5958. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5959. // 9.3.2), so reading one request can pull the start of the next one into the
  5960. // stream's buffer; that request must be served without waiting for the socket
  5961. // to become readable again, since its bytes are no longer on the socket.
  5962. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5963. template <typename P, typename T>
  5964. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5965. socket_t sock,
  5966. size_t keep_alive_max_count,
  5967. time_t keep_alive_timeout_sec,
  5968. P has_buffered_request, T callback) {
  5969. auto ret = false;
  5970. // A keep_alive_max_count of 0 sets no limit.
  5971. for (size_t served = 0;
  5972. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5973. auto socket_readable = false;
  5974. if (!has_buffered_request()) {
  5975. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5976. socket_readable = true;
  5977. }
  5978. auto close_connection = served + 1 == keep_alive_max_count;
  5979. auto connection_closed = false;
  5980. ret = callback(socket_readable, close_connection, connection_closed);
  5981. if (!ret || connection_closed) { break; }
  5982. }
  5983. return ret;
  5984. }
  5985. template <typename T>
  5986. inline bool
  5987. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5988. size_t keep_alive_max_count,
  5989. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5990. time_t read_timeout_usec, time_t write_timeout_sec,
  5991. time_t write_timeout_usec, T callback) {
  5992. // One stream per connection: its read buffer can already hold the start of
  5993. // the next, pipelined request.
  5994. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5995. write_timeout_sec, write_timeout_usec);
  5996. return process_server_socket_core(
  5997. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5998. [&]() { return strm.is_readable(); },
  5999. [&](bool socket_readable, bool close_connection,
  6000. bool &connection_closed) {
  6001. if (socket_readable) { strm.set_readable_hint(); }
  6002. return callback(strm, close_connection, connection_closed);
  6003. });
  6004. }
  6005. inline bool process_client_socket(
  6006. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  6007. time_t write_timeout_sec, time_t write_timeout_usec,
  6008. time_t max_timeout_msec,
  6009. std::chrono::time_point<std::chrono::steady_clock> start_time,
  6010. std::function<bool(Stream &)> callback) {
  6011. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  6012. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  6013. start_time);
  6014. return callback(strm);
  6015. }
  6016. inline int shutdown_socket(socket_t sock) noexcept {
  6017. #ifdef _WIN32
  6018. return shutdown(sock, SD_BOTH);
  6019. #else
  6020. return shutdown(sock, SHUT_RDWR);
  6021. #endif
  6022. }
  6023. // Half-closes the write side and drains any in-flight/queued bytes before
  6024. // the final shutdown+close. Closing with unread data in the receive queue
  6025. // (or bytes arriving after the receive side is closed) makes the stack send
  6026. // an abortive RST instead of a graceful FIN, which can make the peer see the
  6027. // response as a failed read even though it was fully written.
  6028. inline void drain_and_close_socket(socket_t sock) noexcept {
  6029. #ifdef _WIN32
  6030. shutdown(sock, SD_SEND);
  6031. #else
  6032. shutdown(sock, SHUT_WR);
  6033. #endif
  6034. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6035. size_t total = 0;
  6036. const auto deadline = std::chrono::steady_clock::now() +
  6037. std::chrono::milliseconds(100); // bound #1
  6038. while (total < size_t(1024u * 1024u)) { // bound #2
  6039. const auto remaining =
  6040. std::chrono::duration_cast<std::chrono::microseconds>(
  6041. deadline - std::chrono::steady_clock::now())
  6042. .count();
  6043. if (remaining <= 0) { break; }
  6044. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  6045. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  6046. if (n <= 0) { break; }
  6047. total += static_cast<size_t>(n);
  6048. }
  6049. shutdown_socket(sock);
  6050. close_socket(sock);
  6051. }
  6052. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  6053. if (s.size() > 1 && s[0] == '\0') {
  6054. auto ret = s;
  6055. ret[0] = '@';
  6056. return ret;
  6057. }
  6058. return s;
  6059. }
  6060. inline std::string
  6061. unescape_abstract_namespace_unix_domain(const std::string &s) {
  6062. if (s.size() > 1 && s[0] == '@') {
  6063. auto ret = s;
  6064. ret[0] = '\0';
  6065. return ret;
  6066. }
  6067. return s;
  6068. }
  6069. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  6070. const struct addrinfo *hints,
  6071. struct addrinfo **res, time_t timeout_sec) {
  6072. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  6073. if (timeout_sec <= 0) {
  6074. // No timeout specified, use standard getaddrinfo
  6075. return getaddrinfo(node, service, hints, res);
  6076. }
  6077. #ifdef _WIN32
  6078. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  6079. OVERLAPPED overlapped = {};
  6080. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  6081. if (!event) { return EAI_FAIL; }
  6082. overlapped.hEvent = event;
  6083. PADDRINFOEXW result_addrinfo = nullptr;
  6084. HANDLE cancel_handle = nullptr;
  6085. ADDRINFOEXW hints_ex = {};
  6086. if (hints) {
  6087. hints_ex.ai_flags = hints->ai_flags;
  6088. hints_ex.ai_family = hints->ai_family;
  6089. hints_ex.ai_socktype = hints->ai_socktype;
  6090. hints_ex.ai_protocol = hints->ai_protocol;
  6091. }
  6092. auto wnode = u8string_to_wstring(node);
  6093. auto wservice = u8string_to_wstring(service);
  6094. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  6095. hints ? &hints_ex : nullptr, &result_addrinfo,
  6096. nullptr, &overlapped, nullptr, &cancel_handle);
  6097. if (ret == WSA_IO_PENDING) {
  6098. auto wait_result =
  6099. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  6100. if (wait_result == WAIT_TIMEOUT) {
  6101. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  6102. ::CloseHandle(event);
  6103. return EAI_AGAIN;
  6104. }
  6105. DWORD bytes_returned;
  6106. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  6107. &bytes_returned, FALSE)) {
  6108. ::CloseHandle(event);
  6109. return ::WSAGetLastError();
  6110. }
  6111. }
  6112. ::CloseHandle(event);
  6113. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  6114. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  6115. return 0;
  6116. }
  6117. return ret;
  6118. #elif TARGET_OS_MAC && defined(__clang__)
  6119. if (!node) { return EAI_NONAME; }
  6120. // macOS implementation using CFHost API for asynchronous DNS resolution
  6121. CFStringRef hostname_ref = CFStringCreateWithCString(
  6122. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  6123. if (!hostname_ref) { return EAI_MEMORY; }
  6124. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  6125. CFRelease(hostname_ref);
  6126. if (!host_ref) { return EAI_MEMORY; }
  6127. // Set up context for callback
  6128. struct CFHostContext {
  6129. bool completed = false;
  6130. bool success = false;
  6131. CFArrayRef addresses = nullptr;
  6132. std::mutex mutex;
  6133. std::condition_variable cv;
  6134. } context;
  6135. CFHostClientContext client_context;
  6136. memset(&client_context, 0, sizeof(client_context));
  6137. client_context.info = &context;
  6138. // Set callback
  6139. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  6140. const CFStreamError *error, void *info) {
  6141. auto ctx = static_cast<CFHostContext *>(info);
  6142. std::lock_guard<std::mutex> lock(ctx->mutex);
  6143. if (error && error->error != 0) {
  6144. ctx->success = false;
  6145. } else {
  6146. Boolean hasBeenResolved;
  6147. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6148. if (ctx->addresses && hasBeenResolved) {
  6149. CFRetain(ctx->addresses);
  6150. ctx->success = true;
  6151. } else {
  6152. ctx->success = false;
  6153. }
  6154. }
  6155. ctx->completed = true;
  6156. ctx->cv.notify_one();
  6157. };
  6158. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6159. CFRelease(host_ref);
  6160. return EAI_SYSTEM;
  6161. }
  6162. // Schedule on run loop
  6163. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6164. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6165. // Start resolution
  6166. CFStreamError stream_error;
  6167. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6168. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6169. CFRelease(host_ref);
  6170. return EAI_FAIL;
  6171. }
  6172. // Wait for completion with timeout
  6173. auto timeout_time =
  6174. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6175. bool timed_out = false;
  6176. {
  6177. std::unique_lock<std::mutex> lock(context.mutex);
  6178. while (!context.completed) {
  6179. auto now = std::chrono::steady_clock::now();
  6180. if (now >= timeout_time) {
  6181. timed_out = true;
  6182. break;
  6183. }
  6184. // Run the runloop for a short time
  6185. lock.unlock();
  6186. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6187. lock.lock();
  6188. }
  6189. }
  6190. // Clean up
  6191. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6192. CFHostSetClient(host_ref, nullptr, nullptr);
  6193. if (timed_out || !context.completed) {
  6194. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6195. CFRelease(host_ref);
  6196. return EAI_AGAIN;
  6197. }
  6198. if (!context.success || !context.addresses) {
  6199. CFRelease(host_ref);
  6200. return EAI_NODATA;
  6201. }
  6202. // Convert CFArray to addrinfo
  6203. CFIndex count = CFArrayGetCount(context.addresses);
  6204. if (count == 0) {
  6205. CFRelease(context.addresses);
  6206. CFRelease(host_ref);
  6207. return EAI_NODATA;
  6208. }
  6209. struct addrinfo *result_addrinfo = nullptr;
  6210. struct addrinfo **current = &result_addrinfo;
  6211. for (CFIndex i = 0; i < count; i++) {
  6212. CFDataRef addr_data =
  6213. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6214. if (!addr_data) continue;
  6215. const struct sockaddr *sockaddr_ptr =
  6216. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6217. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6218. // Allocate addrinfo structure
  6219. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6220. if (!*current) {
  6221. freeaddrinfo(result_addrinfo);
  6222. CFRelease(context.addresses);
  6223. CFRelease(host_ref);
  6224. return EAI_MEMORY;
  6225. }
  6226. memset(*current, 0, sizeof(struct addrinfo));
  6227. // Set up addrinfo fields
  6228. (*current)->ai_family = sockaddr_ptr->sa_family;
  6229. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6230. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6231. (*current)->ai_addrlen = sockaddr_len;
  6232. // Copy sockaddr
  6233. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6234. if (!(*current)->ai_addr) {
  6235. freeaddrinfo(result_addrinfo);
  6236. CFRelease(context.addresses);
  6237. CFRelease(host_ref);
  6238. return EAI_MEMORY;
  6239. }
  6240. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6241. // Set port if service is specified
  6242. if (service && *service) {
  6243. int port = 0;
  6244. if (parse_port(service, strlen(service), port)) {
  6245. if (sockaddr_ptr->sa_family == AF_INET) {
  6246. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6247. ->sin_port = htons(static_cast<uint16_t>(port));
  6248. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6249. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6250. ->sin6_port = htons(static_cast<uint16_t>(port));
  6251. }
  6252. }
  6253. }
  6254. current = &((*current)->ai_next);
  6255. }
  6256. CFRelease(context.addresses);
  6257. CFRelease(host_ref);
  6258. *res = result_addrinfo;
  6259. return 0;
  6260. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6261. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6262. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6263. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6264. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6265. // the resolver worker still references the stack-local gaicb. The cancel
  6266. // path therefore waits (gai_suspend with no timeout) for the worker to
  6267. // actually finish before letting the stack frame go. The trade-off is that
  6268. // a wedged DNS server can hold this thread for the system resolver timeout
  6269. // (~30s by default) past the caller's connection timeout.
  6270. struct gaicb request{};
  6271. struct gaicb *requests[1] = {&request};
  6272. struct sigevent sevp{};
  6273. struct timespec timeout{timeout_sec, 0};
  6274. request.ar_name = node;
  6275. request.ar_service = service;
  6276. request.ar_request = hints;
  6277. sevp.sigev_notify = SIGEV_NONE;
  6278. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6279. if (rc != 0) { return rc; }
  6280. auto cleanup = scope_exit([&] {
  6281. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6282. });
  6283. int wait_result = gai_suspend(requests, 1, &timeout);
  6284. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6285. int gai_result = gai_error(&request);
  6286. if (gai_result == 0) {
  6287. *res = request.ar_result;
  6288. request.ar_result = nullptr;
  6289. return 0;
  6290. }
  6291. return gai_result;
  6292. }
  6293. gai_cancel(&request);
  6294. while (gai_error(&request) == EAI_INPROGRESS) {
  6295. gai_suspend(requests, 1, nullptr);
  6296. }
  6297. return wait_result;
  6298. #else
  6299. // Fallback implementation using thread-based timeout for other Unix systems.
  6300. struct GetAddrInfoState {
  6301. ~GetAddrInfoState() {
  6302. if (info) { freeaddrinfo(info); }
  6303. }
  6304. std::mutex mutex;
  6305. std::condition_variable result_cv;
  6306. bool completed = false;
  6307. int result = EAI_SYSTEM;
  6308. std::string node;
  6309. std::string service;
  6310. struct addrinfo hints;
  6311. struct addrinfo *info = nullptr;
  6312. };
  6313. // Allocate on the heap, so the resolver thread can keep using the data.
  6314. auto state = std::make_shared<GetAddrInfoState>();
  6315. if (node) { state->node = node; }
  6316. state->service = service;
  6317. state->hints = *hints;
  6318. std::thread resolve_thread([state]() {
  6319. auto thread_result =
  6320. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6321. &state->info);
  6322. std::lock_guard<std::mutex> lock(state->mutex);
  6323. state->result = thread_result;
  6324. state->completed = true;
  6325. state->result_cv.notify_one();
  6326. });
  6327. // Wait for completion or timeout
  6328. std::unique_lock<std::mutex> lock(state->mutex);
  6329. auto finished =
  6330. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6331. [&] { return state->completed; });
  6332. if (finished) {
  6333. // Operation completed within timeout
  6334. resolve_thread.join();
  6335. *res = state->info;
  6336. state->info = nullptr; // Pass ownership to caller
  6337. return state->result;
  6338. } else {
  6339. // Timeout occurred
  6340. resolve_thread.detach(); // Let the thread finish in background
  6341. return EAI_AGAIN; // Return timeout error
  6342. }
  6343. #endif
  6344. #else
  6345. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6346. return getaddrinfo(node, service, hints, res);
  6347. #endif
  6348. }
  6349. template <typename BindOrConnect>
  6350. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6351. int address_family, int socket_flags, bool tcp_nodelay,
  6352. bool ipv6_v6only, SocketOptions socket_options,
  6353. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6354. // Get address info
  6355. const char *node = nullptr;
  6356. struct addrinfo hints;
  6357. struct addrinfo *result;
  6358. memset(&hints, 0, sizeof(struct addrinfo));
  6359. hints.ai_socktype = SOCK_STREAM;
  6360. hints.ai_protocol = IPPROTO_IP;
  6361. if (!ip.empty()) {
  6362. node = ip.c_str();
  6363. // Ask getaddrinfo to convert IP in c-string to address
  6364. hints.ai_family = AF_UNSPEC;
  6365. hints.ai_flags = AI_NUMERICHOST;
  6366. } else {
  6367. if (!host.empty()) { node = host.c_str(); }
  6368. hints.ai_family = address_family;
  6369. hints.ai_flags = socket_flags;
  6370. }
  6371. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6372. if (hints.ai_family == AF_UNIX) {
  6373. const auto addrlen = host.length();
  6374. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6375. #ifdef SOCK_CLOEXEC
  6376. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6377. hints.ai_protocol);
  6378. #else
  6379. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6380. #endif
  6381. if (sock != INVALID_SOCKET) {
  6382. sockaddr_un addr{};
  6383. addr.sun_family = AF_UNIX;
  6384. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6385. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6386. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6387. hints.ai_addrlen = static_cast<socklen_t>(
  6388. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6389. #ifndef SOCK_CLOEXEC
  6390. #ifndef _WIN32
  6391. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6392. #endif
  6393. #endif
  6394. if (socket_options) { socket_options(sock); }
  6395. #ifdef _WIN32
  6396. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6397. // remove the option.
  6398. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6399. #endif
  6400. bool dummy;
  6401. if (!bind_or_connect(sock, hints, dummy)) {
  6402. close_socket(sock);
  6403. sock = INVALID_SOCKET;
  6404. }
  6405. }
  6406. return sock;
  6407. }
  6408. #endif
  6409. auto service = std::to_string(port);
  6410. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6411. timeout_sec)) {
  6412. #if defined __linux__ && !defined __ANDROID__
  6413. res_init();
  6414. #endif
  6415. return INVALID_SOCKET;
  6416. }
  6417. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6418. for (auto rp = result; rp; rp = rp->ai_next) {
  6419. // Create a socket
  6420. #ifdef _WIN32
  6421. auto sock =
  6422. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6423. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6424. /**
  6425. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6426. * and above the socket creation fails on older Windows Systems.
  6427. *
  6428. * Let's try to create a socket the old way in this case.
  6429. *
  6430. * Reference:
  6431. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6432. *
  6433. * WSA_FLAG_NO_HANDLE_INHERIT:
  6434. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6435. * SP1, and later
  6436. *
  6437. */
  6438. if (sock == INVALID_SOCKET) {
  6439. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6440. }
  6441. #else
  6442. #ifdef SOCK_CLOEXEC
  6443. auto sock =
  6444. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6445. #else
  6446. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6447. #endif
  6448. #endif
  6449. if (sock == INVALID_SOCKET) { continue; }
  6450. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6451. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6452. close_socket(sock);
  6453. continue;
  6454. }
  6455. #endif
  6456. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6457. if (rp->ai_family == AF_INET6) {
  6458. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6459. }
  6460. if (socket_options) { socket_options(sock); }
  6461. // bind or connect
  6462. auto quit = false;
  6463. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6464. close_socket(sock);
  6465. if (quit) { break; }
  6466. }
  6467. return INVALID_SOCKET;
  6468. }
  6469. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6470. #ifdef _WIN32
  6471. auto flags = nonblocking ? 1UL : 0UL;
  6472. ioctlsocket(sock, FIONBIO, &flags);
  6473. #else
  6474. auto flags = fcntl(sock, F_GETFL, 0);
  6475. fcntl(sock, F_SETFL,
  6476. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6477. #endif
  6478. }
  6479. inline bool is_connection_error() {
  6480. #ifdef _WIN32
  6481. return WSAGetLastError() != WSAEWOULDBLOCK;
  6482. #else
  6483. return errno != EINPROGRESS;
  6484. #endif
  6485. }
  6486. // accept() failed because the process or the network stack is temporarily out
  6487. // of resources. The listening socket is still usable, so back off briefly and
  6488. // try again.
  6489. inline bool is_accept_resource_error() {
  6490. #ifdef _WIN32
  6491. auto err = WSAGetLastError();
  6492. return err == WSAEMFILE || err == WSAENOBUFS;
  6493. #else
  6494. auto err = errno;
  6495. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6496. #endif
  6497. }
  6498. // accept() failed for a reason that says nothing about the listening socket:
  6499. // the pending connection went away before it could be accepted, or the call
  6500. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6501. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6502. // connection that way.
  6503. inline bool is_accept_transient_error() {
  6504. #ifdef _WIN32
  6505. auto err = WSAGetLastError();
  6506. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6507. err == WSAECONNABORTED;
  6508. #else
  6509. auto err = errno;
  6510. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6511. err == ECONNABORTED;
  6512. #endif
  6513. }
  6514. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6515. struct addrinfo hints;
  6516. struct addrinfo *result;
  6517. memset(&hints, 0, sizeof(struct addrinfo));
  6518. hints.ai_family = AF_UNSPEC;
  6519. hints.ai_socktype = SOCK_STREAM;
  6520. hints.ai_protocol = 0;
  6521. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6522. return false;
  6523. }
  6524. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6525. auto ret = false;
  6526. for (auto rp = result; rp; rp = rp->ai_next) {
  6527. const auto &ai = *rp;
  6528. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6529. ret = true;
  6530. break;
  6531. }
  6532. }
  6533. return ret;
  6534. }
  6535. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6536. #define USE_IF2IP
  6537. #endif
  6538. #ifdef USE_IF2IP
  6539. inline std::string if2ip(int address_family, const std::string &ifn) {
  6540. struct ifaddrs *ifap;
  6541. getifaddrs(&ifap);
  6542. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6543. std::string addr_candidate;
  6544. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6545. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6546. (AF_UNSPEC == address_family ||
  6547. ifa->ifa_addr->sa_family == address_family)) {
  6548. if (ifa->ifa_addr->sa_family == AF_INET) {
  6549. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6550. char buf[INET_ADDRSTRLEN];
  6551. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6552. return std::string(buf, INET_ADDRSTRLEN);
  6553. }
  6554. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6555. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6556. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6557. char buf[INET6_ADDRSTRLEN] = {};
  6558. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6559. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6560. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6561. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6562. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6563. } else {
  6564. return std::string(buf, INET6_ADDRSTRLEN);
  6565. }
  6566. }
  6567. }
  6568. }
  6569. }
  6570. }
  6571. return addr_candidate;
  6572. }
  6573. #endif
  6574. inline socket_t
  6575. create_client_socket(const std::string &host, const std::string &ip, int port,
  6576. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6577. SocketOptions socket_options,
  6578. time_t connection_timeout_sec,
  6579. time_t connection_timeout_usec, time_t read_timeout_sec,
  6580. time_t read_timeout_usec, time_t write_timeout_sec,
  6581. time_t write_timeout_usec, const std::string &intf,
  6582. Error &error, const std::function<bool()> &interrupted) {
  6583. auto sock = create_socket(
  6584. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6585. std::move(socket_options),
  6586. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6587. if (!intf.empty()) {
  6588. #ifdef USE_IF2IP
  6589. auto ip_from_if = if2ip(address_family, intf);
  6590. if (ip_from_if.empty()) { ip_from_if = intf; }
  6591. if (!bind_ip_address(sock2, ip_from_if)) {
  6592. error = Error::BindIPAddress;
  6593. return false;
  6594. }
  6595. #endif
  6596. }
  6597. set_nonblocking(sock2, true);
  6598. auto ret =
  6599. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6600. if (ret < 0) {
  6601. if (is_connection_error()) {
  6602. error = Error::Connection;
  6603. return false;
  6604. }
  6605. error =
  6606. wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6607. connection_timeout_usec, interrupted);
  6608. if (error != Error::Success) {
  6609. if (error == Error::ConnectionTimeout || error == Error::Canceled) {
  6610. quit = true;
  6611. }
  6612. return false;
  6613. }
  6614. }
  6615. set_nonblocking(sock2, false);
  6616. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6617. read_timeout_usec);
  6618. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6619. write_timeout_usec);
  6620. error = Error::Success;
  6621. return true;
  6622. },
  6623. connection_timeout_sec); // Pass DNS timeout
  6624. if (sock != INVALID_SOCKET) {
  6625. error = Error::Success;
  6626. } else {
  6627. if (error == Error::Success) { error = Error::Connection; }
  6628. }
  6629. return sock;
  6630. }
  6631. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6632. socklen_t addr_len, std::string &ip, int &port) {
  6633. if (addr.ss_family == AF_INET) {
  6634. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6635. } else if (addr.ss_family == AF_INET6) {
  6636. port =
  6637. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6638. } else {
  6639. return false;
  6640. }
  6641. std::array<char, NI_MAXHOST> ipstr{};
  6642. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6643. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6644. 0, NI_NUMERICHOST)) {
  6645. return false;
  6646. }
  6647. ip = ipstr.data();
  6648. return true;
  6649. }
  6650. inline void get_local_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 (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6654. &addr_len)) {
  6655. get_ip_and_port(addr, addr_len, ip, port);
  6656. }
  6657. }
  6658. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6659. struct sockaddr_storage addr;
  6660. socklen_t addr_len = sizeof(addr);
  6661. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6662. &addr_len)) {
  6663. #ifndef _WIN32
  6664. if (addr.ss_family == AF_UNIX) {
  6665. #if defined(__linux__)
  6666. struct ucred ucred;
  6667. socklen_t len = sizeof(ucred);
  6668. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6669. port = ucred.pid;
  6670. }
  6671. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6672. pid_t pid;
  6673. socklen_t len = sizeof(pid);
  6674. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6675. port = pid;
  6676. }
  6677. #endif
  6678. return;
  6679. }
  6680. #endif
  6681. get_ip_and_port(addr, addr_len, ip, port);
  6682. }
  6683. }
  6684. inline std::string
  6685. find_content_type(const std::string &path,
  6686. const std::map<std::string, std::string> &user_data,
  6687. const std::string &default_content_type) {
  6688. // Extensions are matched regardless of case, as web servers do
  6689. auto ext = case_ignore::to_lower(file_extension(path));
  6690. auto it = user_data.find(ext);
  6691. if (it != user_data.end()) { return it->second; }
  6692. static const struct {
  6693. const char *ext;
  6694. const char *type;
  6695. } types[] = {
  6696. {"css", "text/css"},
  6697. {"csv", "text/csv"},
  6698. {"htm", "text/html"},
  6699. {"html", "text/html"},
  6700. {"js", "text/javascript"},
  6701. {"mjs", "text/javascript"},
  6702. {"txt", "text/plain"},
  6703. {"vtt", "text/vtt"},
  6704. {"apng", "image/apng"},
  6705. {"avif", "image/avif"},
  6706. {"bmp", "image/bmp"},
  6707. {"gif", "image/gif"},
  6708. {"png", "image/png"},
  6709. {"svg", "image/svg+xml"},
  6710. {"webp", "image/webp"},
  6711. {"ico", "image/x-icon"},
  6712. {"tif", "image/tiff"},
  6713. {"tiff", "image/tiff"},
  6714. {"jpg", "image/jpeg"},
  6715. {"jpeg", "image/jpeg"},
  6716. {"mp4", "video/mp4"},
  6717. {"mpeg", "video/mpeg"},
  6718. {"webm", "video/webm"},
  6719. {"mp3", "audio/mp3"},
  6720. {"mpga", "audio/mpeg"},
  6721. {"weba", "audio/webm"},
  6722. {"wav", "audio/wave"},
  6723. {"otf", "font/otf"},
  6724. {"ttf", "font/ttf"},
  6725. {"woff", "font/woff"},
  6726. {"woff2", "font/woff2"},
  6727. {"7z", "application/x-7z-compressed"},
  6728. {"atom", "application/atom+xml"},
  6729. {"pdf", "application/pdf"},
  6730. {"json", "application/json"},
  6731. {"rss", "application/rss+xml"},
  6732. {"tar", "application/x-tar"},
  6733. {"xht", "application/xhtml+xml"},
  6734. {"xhtml", "application/xhtml+xml"},
  6735. {"xslt", "application/xslt+xml"},
  6736. {"xml", "application/xml"},
  6737. {"gz", "application/gzip"},
  6738. {"zip", "application/zip"},
  6739. {"wasm", "application/wasm"},
  6740. };
  6741. for (const auto &t : types) {
  6742. if (ext == t.ext) { return t.type; }
  6743. }
  6744. return default_content_type;
  6745. }
  6746. inline std::string
  6747. extract_media_type(const std::string &content_type,
  6748. std::map<std::string, std::string> *params = nullptr) {
  6749. // Extract type/subtype from Content-Type value (RFC 2045)
  6750. // e.g. "application/json; charset=utf-8" -> "application/json"
  6751. auto media_type = content_type;
  6752. auto semicolon_pos = media_type.find(';');
  6753. if (semicolon_pos != std::string::npos) {
  6754. auto param_str = media_type.substr(semicolon_pos + 1);
  6755. media_type = media_type.substr(0, semicolon_pos);
  6756. if (params) {
  6757. // Parse parameters: key=value pairs separated by ';'
  6758. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6759. [&](const char *b, const char *e) {
  6760. std::string key;
  6761. std::string val;
  6762. divide_param_pair(b, e, key, val);
  6763. // Parameter names are case-insensitive (RFC 9110
  6764. // §5.6.6)
  6765. if (!key.empty()) {
  6766. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6767. unquote_param(val));
  6768. }
  6769. });
  6770. }
  6771. }
  6772. // Trim whitespace from media type
  6773. return trim_copy(media_type);
  6774. }
  6775. inline bool can_compress_content_type(const std::string &content_type) {
  6776. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6777. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6778. static const char *const compressible[] = {
  6779. "image/svg+xml",
  6780. "application/javascript",
  6781. "application/x-javascript",
  6782. "application/json",
  6783. "application/ld+json",
  6784. "application/xml",
  6785. "application/xhtml+xml",
  6786. "application/rss+xml",
  6787. "application/atom+xml",
  6788. "application/xslt+xml",
  6789. "application/protobuf",
  6790. };
  6791. for (auto type : compressible) {
  6792. if (mime_type == type) { return true; }
  6793. }
  6794. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6795. }
  6796. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6797. double &quality) {
  6798. quality = 1.0;
  6799. token.clear();
  6800. // Split on first ';': left = token name, right = parameters
  6801. const char *params_b = nullptr;
  6802. std::size_t params_len = 0;
  6803. divide(
  6804. b, static_cast<std::size_t>(e - b), ';',
  6805. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6806. auto r = trim(lb, lb + llen, 0, llen);
  6807. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6808. params_b = rb;
  6809. params_len = rlen;
  6810. });
  6811. if (token.empty()) { return false; }
  6812. if (params_len == 0) { return true; }
  6813. // Scan parameters for q= (stops on first match)
  6814. bool invalid = false;
  6815. split_find(params_b, params_b + params_len, ';',
  6816. (std::numeric_limits<size_t>::max)(),
  6817. [&](const char *pb, const char *pe) -> bool {
  6818. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6819. auto len = static_cast<size_t>(pe - pb);
  6820. if (len < 2) { return false; }
  6821. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6822. return false;
  6823. }
  6824. // Trim the value portion
  6825. auto r = trim(pb, pe, 2, len);
  6826. if (r.first >= r.second) {
  6827. invalid = true;
  6828. return true;
  6829. }
  6830. double v = 0.0;
  6831. auto res = from_chars(pb + r.first, pb + r.second, v);
  6832. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6833. v < 0.0 || v > 1.0) {
  6834. invalid = true;
  6835. return true;
  6836. }
  6837. quality = v;
  6838. return true;
  6839. });
  6840. return !invalid;
  6841. }
  6842. inline EncodingType encoding_type(const Request &req,
  6843. const std::string &content_type) {
  6844. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6845. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6846. if (s.empty()) { return EncodingType::None; }
  6847. // Single-pass: iterate tokens and track the best supported encoding.
  6848. // Server preference breaks ties (br > gzip > zstd).
  6849. EncodingType best = EncodingType::None;
  6850. double best_q = 0.0; // q=0 means "not acceptable"
  6851. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6852. auto priority = [](EncodingType t) -> int {
  6853. switch (t) {
  6854. case EncodingType::Brotli: return 0;
  6855. case EncodingType::Gzip: return 1;
  6856. case EncodingType::Zstd: return 2;
  6857. default: return 3;
  6858. }
  6859. };
  6860. std::string name;
  6861. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6862. double quality = 1.0;
  6863. if (!parse_quality(b, e, name, quality)) { return; }
  6864. if (quality <= 0.0) { return; }
  6865. EncodingType type = EncodingType::None;
  6866. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6867. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6868. #endif
  6869. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6870. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6871. type = EncodingType::Gzip;
  6872. }
  6873. #endif
  6874. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6875. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6876. type = EncodingType::Zstd;
  6877. }
  6878. #endif
  6879. if (type == EncodingType::None) { return; }
  6880. // Higher q-value wins; for equal q, server preference breaks ties
  6881. if (quality > best_q ||
  6882. (quality == best_q && priority(type) < priority(best))) {
  6883. best_q = quality;
  6884. best = type;
  6885. }
  6886. });
  6887. return best;
  6888. }
  6889. // `content_type` is taken separately because a file-backed response has not
  6890. // been given one yet when its coding has to be decided.
  6891. inline EncodingType encoding_type(const Request &req, const Response &res,
  6892. const std::string &content_type) {
  6893. // The response already names a content coding of its own: a handler serving
  6894. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6895. // point whose headers name the coding its files are stored in. Applying one
  6896. // on top of that would double-encode the body and append a second
  6897. // `Content-Encoding` field line.
  6898. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6899. return encoding_type(req, content_type);
  6900. }
  6901. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6902. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6903. }
  6904. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6905. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6906. if (type == EncodingType::Gzip) {
  6907. return detail::make_unique<gzip_compressor>();
  6908. }
  6909. #endif
  6910. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6911. if (type == EncodingType::Brotli) {
  6912. return detail::make_unique<brotli_compressor>();
  6913. }
  6914. #endif
  6915. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6916. if (type == EncodingType::Zstd) {
  6917. return detail::make_unique<zstd_compressor>();
  6918. }
  6919. #endif
  6920. (void)type;
  6921. return nullptr;
  6922. }
  6923. inline const char *encoding_name(EncodingType type) {
  6924. switch (type) {
  6925. case EncodingType::Gzip: return "gzip";
  6926. case EncodingType::Brotli: return "br";
  6927. case EncodingType::Zstd: return "zstd";
  6928. default: return "";
  6929. }
  6930. }
  6931. inline bool nocompressor::compress(const char *data, size_t data_length,
  6932. bool /*last*/, Callback callback) {
  6933. if (!data_length) { return true; }
  6934. return callback(data, data_length);
  6935. }
  6936. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6937. inline gzip_compressor::gzip_compressor() {
  6938. std::memset(&strm_, 0, sizeof(strm_));
  6939. strm_.zalloc = Z_NULL;
  6940. strm_.zfree = Z_NULL;
  6941. strm_.opaque = Z_NULL;
  6942. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6943. Z_DEFAULT_STRATEGY) == Z_OK;
  6944. }
  6945. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6946. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6947. bool last, Callback callback) {
  6948. assert(is_valid_);
  6949. do {
  6950. constexpr size_t max_avail_in =
  6951. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6952. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6953. (std::min)(data_length, max_avail_in));
  6954. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6955. data_length -= strm_.avail_in;
  6956. data += strm_.avail_in;
  6957. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6958. auto ret = Z_OK;
  6959. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6960. do {
  6961. strm_.avail_out = static_cast<uInt>(buff.size());
  6962. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6963. ret = deflate(&strm_, flush);
  6964. if (ret == Z_STREAM_ERROR) { return false; }
  6965. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6966. return false;
  6967. }
  6968. } while (strm_.avail_out == 0);
  6969. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6970. (flush == Z_NO_FLUSH && ret == Z_OK));
  6971. assert(strm_.avail_in == 0);
  6972. } while (data_length > 0);
  6973. return true;
  6974. }
  6975. inline gzip_decompressor::gzip_decompressor() {
  6976. std::memset(&strm_, 0, sizeof(strm_));
  6977. strm_.zalloc = Z_NULL;
  6978. strm_.zfree = Z_NULL;
  6979. strm_.opaque = Z_NULL;
  6980. // 15 is the value of wbits, which should be at the maximum possible value
  6981. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6982. // that the stream type should be automatically detected either gzip or
  6983. // deflate.
  6984. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6985. }
  6986. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6987. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6988. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6989. Callback callback) {
  6990. assert(is_valid_);
  6991. auto ret = Z_OK;
  6992. do {
  6993. constexpr size_t max_avail_in =
  6994. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6995. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6996. (std::min)(data_length, max_avail_in));
  6997. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6998. data_length -= strm_.avail_in;
  6999. data += strm_.avail_in;
  7000. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7001. while (strm_.avail_in > 0 && ret == Z_OK) {
  7002. strm_.avail_out = static_cast<uInt>(buff.size());
  7003. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  7004. ret = inflate(&strm_, Z_NO_FLUSH);
  7005. assert(ret != Z_STREAM_ERROR);
  7006. switch (ret) {
  7007. case Z_NEED_DICT:
  7008. case Z_DATA_ERROR:
  7009. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  7010. }
  7011. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  7012. return false;
  7013. }
  7014. }
  7015. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  7016. } while (data_length > 0);
  7017. return true;
  7018. }
  7019. #endif
  7020. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7021. inline brotli_compressor::brotli_compressor() {
  7022. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  7023. }
  7024. inline brotli_compressor::~brotli_compressor() {
  7025. BrotliEncoderDestroyInstance(state_);
  7026. }
  7027. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  7028. bool last, Callback callback) {
  7029. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7030. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  7031. auto available_in = data_length;
  7032. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7033. for (;;) {
  7034. if (last) {
  7035. if (BrotliEncoderIsFinished(state_)) { break; }
  7036. } else {
  7037. if (!available_in) { break; }
  7038. }
  7039. auto available_out = buff.size();
  7040. auto next_out = buff.data();
  7041. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  7042. &available_out, &next_out, nullptr)) {
  7043. return false;
  7044. }
  7045. auto output_bytes = buff.size() - available_out;
  7046. if (output_bytes) {
  7047. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  7048. }
  7049. }
  7050. return true;
  7051. }
  7052. inline brotli_decompressor::brotli_decompressor() {
  7053. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  7054. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  7055. : BROTLI_DECODER_RESULT_ERROR;
  7056. }
  7057. inline brotli_decompressor::~brotli_decompressor() {
  7058. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  7059. }
  7060. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  7061. inline bool brotli_decompressor::decompress(const char *data,
  7062. size_t data_length,
  7063. Callback callback) {
  7064. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7065. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  7066. return 0;
  7067. }
  7068. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7069. size_t avail_in = data_length;
  7070. size_t total_out;
  7071. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  7072. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7073. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  7074. char *next_out = buff.data();
  7075. size_t avail_out = buff.size();
  7076. decoder_r = BrotliDecoderDecompressStream(
  7077. decoder_s, &avail_in, &next_in, &avail_out,
  7078. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  7079. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  7080. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  7081. }
  7082. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7083. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  7084. }
  7085. #endif
  7086. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7087. inline zstd_compressor::zstd_compressor() {
  7088. ctx_ = ZSTD_createCCtx();
  7089. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  7090. }
  7091. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  7092. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  7093. bool last, Callback callback) {
  7094. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7095. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  7096. ZSTD_inBuffer input = {data, data_length, 0};
  7097. bool finished;
  7098. do {
  7099. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7100. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  7101. if (ZSTD_isError(remaining)) { return false; }
  7102. if (!callback(buff.data(), output.pos)) { return false; }
  7103. finished = last ? (remaining == 0) : (input.pos == input.size);
  7104. } while (!finished);
  7105. return true;
  7106. }
  7107. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  7108. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  7109. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  7110. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  7111. Callback callback) {
  7112. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7113. ZSTD_inBuffer input = {data, data_length, 0};
  7114. while (input.pos < input.size) {
  7115. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7116. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  7117. if (ZSTD_isError(remaining)) { return false; }
  7118. if (!callback(buff.data(), output.pos)) { return false; }
  7119. }
  7120. return true;
  7121. }
  7122. #endif
  7123. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  7124. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  7125. // unknown coding, and its payload would be handed back still compressed.
  7126. inline bool is_zlib_encoding(const std::string &encoding) {
  7127. return case_ignore::equal(encoding, "gzip") ||
  7128. case_ignore::equal(encoding, "deflate");
  7129. }
  7130. inline bool is_brotli_encoding(const std::string &encoding) {
  7131. return case_ignore::equal(encoding, "br");
  7132. }
  7133. inline bool is_zstd_encoding(const std::string &encoding) {
  7134. return case_ignore::equal(encoding, "zstd");
  7135. }
  7136. // Returns true if the content coding is one cpp-httplib is able to decompress
  7137. // when the corresponding support is compiled in.
  7138. inline bool is_known_content_encoding(const std::string &encoding) {
  7139. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  7140. is_zstd_encoding(encoding);
  7141. }
  7142. inline std::unique_ptr<decompressor>
  7143. create_decompressor(const std::string &encoding) {
  7144. std::unique_ptr<decompressor> decompressor;
  7145. if (is_zlib_encoding(encoding)) {
  7146. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7147. decompressor = detail::make_unique<gzip_decompressor>();
  7148. #endif
  7149. } else if (is_brotli_encoding(encoding)) {
  7150. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7151. decompressor = detail::make_unique<brotli_decompressor>();
  7152. #endif
  7153. } else if (is_zstd_encoding(encoding)) {
  7154. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7155. decompressor = detail::make_unique<zstd_decompressor>();
  7156. #endif
  7157. }
  7158. return decompressor;
  7159. }
  7160. // Returns the best available compressor and its Content-Encoding name.
  7161. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7162. inline std::pair<std::unique_ptr<compressor>, const char *>
  7163. create_compressor() {
  7164. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7165. return {detail::make_unique<brotli_compressor>(), "br"};
  7166. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7167. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7168. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7169. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7170. #else
  7171. return {nullptr, nullptr};
  7172. #endif
  7173. }
  7174. inline bool is_prohibited_header_name(const std::string &name) {
  7175. // Field names are case-insensitive (RFC 9110 §5.1)
  7176. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7177. case_ignore::equal(name, "REMOTE_PORT") ||
  7178. case_ignore::equal(name, "LOCAL_ADDR") ||
  7179. case_ignore::equal(name, "LOCAL_PORT");
  7180. }
  7181. inline bool has_header(const Headers &headers, const std::string &key) {
  7182. if (is_prohibited_header_name(key)) { return false; }
  7183. return headers.find(key) != headers.end();
  7184. }
  7185. inline const char *get_header_value(const Headers &headers,
  7186. const std::string &key, const char *def,
  7187. size_t id) {
  7188. if (is_prohibited_header_name(key)) {
  7189. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7190. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7191. throw std::invalid_argument(msg);
  7192. #else
  7193. return "";
  7194. #endif
  7195. }
  7196. auto rng = headers.equal_range(key);
  7197. auto it = bounded_next(rng.first, id, rng.second);
  7198. if (it != rng.second) { return it->second.c_str(); }
  7199. return def;
  7200. }
  7201. inline size_t get_header_value_count(const Headers &headers,
  7202. const std::string &key) {
  7203. return headers.count(key);
  7204. }
  7205. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7206. // list may be sent as several field lines, and the combined field value is
  7207. // those values joined by commas in the order they were received. Callers that
  7208. // parse such a list must work on the combined value; reading only the first
  7209. // occurrence silently drops whatever the later field lines carry.
  7210. inline std::string get_combined_header_value(const Headers &headers,
  7211. const std::string &key) {
  7212. std::string combined;
  7213. auto rng = headers.equal_range(key);
  7214. for (auto it = rng.first; it != rng.second; ++it) {
  7215. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7216. // elements, so an empty field line must not contribute a bare comma to the
  7217. // combined value.
  7218. if (it->second.empty()) { continue; }
  7219. if (!combined.empty()) { combined += ", "; }
  7220. combined += it->second;
  7221. }
  7222. return combined;
  7223. }
  7224. inline bool has_header_token(const Headers &headers, const std::string &key,
  7225. const std::string &token) {
  7226. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7227. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7228. // several lines. Match complete tokens rather than searching the raw value,
  7229. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7230. auto rng = headers.equal_range(key);
  7231. for (auto it = rng.first; it != rng.second; ++it) {
  7232. const auto &value = it->second;
  7233. if (split_find(value.data(), value.data() + value.size(), ',',
  7234. [&](const char *b, const char *e) {
  7235. return case_ignore::equal(std::string(b, e), token);
  7236. })) {
  7237. return true;
  7238. }
  7239. }
  7240. return false;
  7241. }
  7242. template <typename Map>
  7243. inline typename Map::mapped_type
  7244. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7245. auto rng = m.equal_range(key);
  7246. auto it = bounded_next(rng.first, id, rng.second);
  7247. if (it != rng.second) { return it->second; }
  7248. return typename Map::mapped_type();
  7249. }
  7250. inline void set_header(Headers &headers, const std::string &key,
  7251. const std::string &val) {
  7252. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7253. }
  7254. // Drops the fields set_header() would refuse, from headers an application can
  7255. // fill directly: CR/LF in one would split the message.
  7256. inline void erase_invalid_fields(Headers &headers) {
  7257. for (auto it = headers.begin(); it != headers.end();) {
  7258. if (fields::is_field_valid(it->first, it->second)) {
  7259. ++it;
  7260. } else {
  7261. it = headers.erase(it);
  7262. }
  7263. }
  7264. }
  7265. inline bool read_headers(Stream &strm, Headers &headers) {
  7266. const auto bufsiz = 2048;
  7267. char buf[bufsiz];
  7268. stream_line_reader line_reader(strm, buf, bufsiz);
  7269. size_t header_count = 0;
  7270. for (;;) {
  7271. if (!line_reader.getline()) { return false; }
  7272. // Check if the line ends with CRLF.
  7273. auto line_terminator_len = 2;
  7274. if (line_reader.end_with_crlf()) {
  7275. // Blank line indicates end of headers.
  7276. if (line_reader.size() == 2) { break; }
  7277. } else {
  7278. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7279. // Blank line indicates end of headers.
  7280. if (line_reader.size() == 1) { break; }
  7281. line_terminator_len = 1;
  7282. #else
  7283. continue; // Skip invalid line.
  7284. #endif
  7285. }
  7286. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7287. // Check header count limit
  7288. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7289. // Exclude line terminator
  7290. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7291. if (!parse_header(line_reader.ptr(), end,
  7292. [&](const std::string &key, const std::string &val) {
  7293. headers.emplace(key, val);
  7294. })) {
  7295. return false;
  7296. }
  7297. header_count++;
  7298. }
  7299. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7300. // headers that have different values to prevent request smuggling.
  7301. auto cl_range = headers.equal_range("Content-Length");
  7302. if (cl_range.first != cl_range.second) {
  7303. const auto &first_val = cl_range.first->second;
  7304. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7305. if (it->second != first_val) { return false; }
  7306. }
  7307. }
  7308. return true;
  7309. }
  7310. // Parsed by hand: std::regex_match recurses once per character of the reason
  7311. // phrase, which a server can make as long as a whole line.
  7312. inline bool parse_status_line(const char *line, std::string &version,
  7313. int &status, std::string &reason) {
  7314. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7315. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7316. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7317. !is_ascii_digit(line[11])) {
  7318. return false;
  7319. }
  7320. auto p = line + 12;
  7321. auto reason_begin = p;
  7322. if (*p == ' ') {
  7323. reason_begin = ++p;
  7324. p += std::strcspn(p, "\r\n");
  7325. }
  7326. auto reason_end = p;
  7327. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7328. if (*p == '\r') { p++; }
  7329. #else
  7330. if (*p++ != '\r') { return false; }
  7331. #endif
  7332. if (*p++ != '\n' || *p != '\0') { return false; }
  7333. version.assign(line, 8);
  7334. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7335. reason.assign(reason_begin, reason_end);
  7336. return true;
  7337. }
  7338. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7339. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7340. struct WebSocketUpgradeResponse {
  7341. Error error = Error::Success;
  7342. int status = -1;
  7343. Headers headers;
  7344. std::string selected_subprotocol;
  7345. };
  7346. // Reads a response's status line and headers, leaving any body unread. An
  7347. // unparsable status line is no stream error; it just leaves `status` as is.
  7348. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7349. const auto bufsiz = 2048;
  7350. char buf[bufsiz];
  7351. stream_line_reader line_reader(strm, buf, bufsiz);
  7352. if (!line_reader.getline()) { return false; }
  7353. std::string version;
  7354. std::string reason;
  7355. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7356. return true;
  7357. }
  7358. return read_headers(strm, headers);
  7359. }
  7360. inline bool
  7361. read_websocket_upgrade_response(Stream &strm,
  7362. const std::string &expected_accept,
  7363. const std::string &offered_subprotocols,
  7364. WebSocketUpgradeResponse &upgrade) {
  7365. // The headers of a rejection are kept so the caller can see why the server
  7366. // refused the upgrade.
  7367. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7368. upgrade.error = Error::Read;
  7369. return false;
  7370. }
  7371. const auto &headers = upgrade.headers;
  7372. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7373. upgrade.error = Error::WebSocketHandshake;
  7374. return false;
  7375. }
  7376. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7377. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7378. upgrade.error = Error::WebSocketHandshake;
  7379. return false;
  7380. }
  7381. // Verify Connection: Upgrade
  7382. if (!has_header_token(headers, "Connection", "upgrade")) {
  7383. upgrade.error = Error::WebSocketHandshake;
  7384. return false;
  7385. }
  7386. // Verify Sec-WebSocket-Accept header value
  7387. auto it = headers.find("Sec-WebSocket-Accept");
  7388. if (it == headers.end() || it->second != expected_accept) {
  7389. upgrade.error = Error::WebSocketHandshake;
  7390. return false;
  7391. }
  7392. // Extract negotiated subprotocol
  7393. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7394. if (proto_it != headers.end()) {
  7395. upgrade.selected_subprotocol = proto_it->second;
  7396. }
  7397. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7398. if (!upgrade.selected_subprotocol.empty()) {
  7399. auto was_offered = false;
  7400. split(offered_subprotocols.data(),
  7401. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7402. [&](const char *b, const char *e) {
  7403. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7404. was_offered = true;
  7405. }
  7406. });
  7407. if (!was_offered) {
  7408. upgrade.error = Error::WebSocketHandshake;
  7409. return false;
  7410. }
  7411. }
  7412. return true;
  7413. }
  7414. enum class ReadContentResult {
  7415. Success, // Successfully read the content
  7416. PayloadTooLarge, // The content exceeds the specified payload limit
  7417. Error // An error occurred while reading the content
  7418. };
  7419. inline ReadContentResult read_content_with_length(
  7420. Stream &strm, size_t len, DownloadProgress progress,
  7421. ContentReceiverWithProgress out,
  7422. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7423. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7424. detail::BodyReader br;
  7425. br.stream = &strm;
  7426. br.has_content_length = true;
  7427. br.content_length = len;
  7428. br.payload_max_length = payload_max_length;
  7429. br.chunked = false;
  7430. br.bytes_read = 0;
  7431. br.last_error = Error::Success;
  7432. size_t r = 0;
  7433. while (r < len) {
  7434. auto read_len = static_cast<size_t>(len - r);
  7435. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7436. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7437. if (n <= 0) {
  7438. // Check if it was a payload size error
  7439. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7440. return ReadContentResult::PayloadTooLarge;
  7441. }
  7442. return ReadContentResult::Error;
  7443. }
  7444. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7445. return ReadContentResult::Error;
  7446. }
  7447. r += static_cast<size_t>(n);
  7448. if (progress) {
  7449. if (!progress(r, len)) { return ReadContentResult::Error; }
  7450. }
  7451. }
  7452. return ReadContentResult::Success;
  7453. }
  7454. inline ReadContentResult
  7455. read_content_without_length(Stream &strm, size_t payload_max_length,
  7456. ContentReceiverWithProgress out) {
  7457. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7458. size_t r = 0;
  7459. for (;;) {
  7460. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7461. if (n == 0) { return ReadContentResult::Success; }
  7462. if (n < 0) { return ReadContentResult::Error; }
  7463. // Check if adding this data would exceed the payload limit
  7464. if (payload_max_length > 0 &&
  7465. (r > payload_max_length ||
  7466. payload_max_length - r < static_cast<size_t>(n))) {
  7467. return ReadContentResult::PayloadTooLarge;
  7468. }
  7469. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7470. return ReadContentResult::Error;
  7471. }
  7472. r += static_cast<size_t>(n);
  7473. }
  7474. return ReadContentResult::Success;
  7475. }
  7476. template <typename T>
  7477. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7478. size_t payload_max_length,
  7479. ContentReceiverWithProgress out) {
  7480. detail::ChunkedDecoder dec(strm);
  7481. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7482. size_t total_len = 0;
  7483. for (;;) {
  7484. size_t chunk_offset = 0;
  7485. size_t chunk_total = 0;
  7486. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7487. if (n < 0) { return ReadContentResult::Error; }
  7488. if (n == 0) {
  7489. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7490. return ReadContentResult::Error;
  7491. }
  7492. return ReadContentResult::Success;
  7493. }
  7494. if (payload_max_length > 0 &&
  7495. (total_len > payload_max_length ||
  7496. payload_max_length - total_len < static_cast<size_t>(n))) {
  7497. return ReadContentResult::PayloadTooLarge;
  7498. }
  7499. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7500. return ReadContentResult::Error;
  7501. }
  7502. total_len += static_cast<size_t>(n);
  7503. }
  7504. }
  7505. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7506. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7507. // is the final transfer coding. A single field value may list several
  7508. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7509. // several Transfer-Encoding lines, which combine into one comma-separated
  7510. // list in the order the lines were received. Headers preserves that order,
  7511. // so the final coding is the last token of the last line. Match it
  7512. // case-insensitively rather than comparing the whole value against
  7513. // "chunked".
  7514. //
  7515. // Security: reading a chunked message as unframed leaves its body in the
  7516. // socket, where a keep-alive connection parses it as a smuggled request.
  7517. // Server::process_request() answers 400 and closes when the final coding is
  7518. // not chunked, so a request whose framing cannot be determined never
  7519. // reaches the "no body" path.
  7520. auto rng = headers.equal_range("Transfer-Encoding");
  7521. if (rng.first == rng.second) { return false; }
  7522. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7523. // combined list ending in nothing rather than inheriting the line before it.
  7524. std::string last_coding;
  7525. for (auto it = rng.first; it != rng.second; ++it) {
  7526. const auto &value = it->second;
  7527. last_coding.clear();
  7528. split(value.data(), value.data() + value.size(), ',',
  7529. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7530. }
  7531. return case_ignore::equal(last_coding, "chunked");
  7532. }
  7533. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7534. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7535. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7536. return msg.has_header("Transfer-Encoding") &&
  7537. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7538. }
  7539. inline bool has_conflicting_content_length(const Headers &headers) {
  7540. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7541. // Content-Length is framed ambiguously. The body readers here delimit it by
  7542. // the transfer coding and drop Content-Length, while an intermediary may do
  7543. // the reverse, so the two disagree on where the body ends and a reused
  7544. // connection is desynchronised (request/response smuggling). Content-Length:
  7545. // 0 is tolerated for compatibility with existing peers.
  7546. return has_header(headers, "Transfer-Encoding") &&
  7547. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7548. }
  7549. template <typename T, typename U>
  7550. bool prepare_content_receiver(T &x, int &status,
  7551. ContentReceiverWithProgress receiver,
  7552. bool decompress, size_t payload_max_length,
  7553. bool &exceed_payload_max_length, U callback) {
  7554. if (decompress) {
  7555. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7556. std::unique_ptr<decompressor> decompressor;
  7557. if (!encoding.empty()) {
  7558. // A coding we know about but were not built with is an error. An
  7559. // unrecognized coding (including "identity") is left alone and the
  7560. // payload is passed through as-is, since some servers misuse the header,
  7561. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7562. decompressor = detail::create_decompressor(encoding);
  7563. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7564. status = StatusCode::UnsupportedMediaType_415;
  7565. return false;
  7566. }
  7567. }
  7568. if (decompressor) {
  7569. if (decompressor->is_valid()) {
  7570. size_t decompressed_size = 0;
  7571. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7572. size_t off, size_t len) {
  7573. return decompressor->decompress(
  7574. buf, n, [&](const char *buf2, size_t n2) {
  7575. // Guard against zip-bomb: check
  7576. // decompressed size against limit.
  7577. if (payload_max_length > 0 &&
  7578. (decompressed_size >= payload_max_length ||
  7579. n2 > payload_max_length - decompressed_size)) {
  7580. exceed_payload_max_length = true;
  7581. return false;
  7582. }
  7583. decompressed_size += n2;
  7584. return receiver(buf2, n2, off, len);
  7585. });
  7586. };
  7587. return callback(std::move(out));
  7588. } else {
  7589. status = StatusCode::InternalServerError_500;
  7590. return false;
  7591. }
  7592. }
  7593. }
  7594. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7595. size_t len) {
  7596. return receiver(buf, n, off, len);
  7597. };
  7598. return callback(std::move(out));
  7599. }
  7600. template <typename T>
  7601. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7602. DownloadProgress progress,
  7603. ContentReceiverWithProgress receiver, bool decompress) {
  7604. bool exceed_payload_max_length = false;
  7605. return prepare_content_receiver(
  7606. x, status, std::move(receiver), decompress, payload_max_length,
  7607. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7608. auto ret = true;
  7609. // Note: exceed_payload_max_length may also be set by the decompressor
  7610. // wrapper in prepare_content_receiver when the decompressed payload
  7611. // size exceeds the limit.
  7612. if (is_chunked_transfer_encoding(x.headers)) {
  7613. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7614. if (result == ReadContentResult::Success) {
  7615. ret = true;
  7616. } else if (result == ReadContentResult::PayloadTooLarge) {
  7617. exceed_payload_max_length = true;
  7618. ret = false;
  7619. } else {
  7620. ret = false;
  7621. }
  7622. } else if (!has_header(x.headers, "Content-Length")) {
  7623. auto result =
  7624. read_content_without_length(strm, payload_max_length, out);
  7625. if (result == ReadContentResult::Success) {
  7626. ret = true;
  7627. } else if (result == ReadContentResult::PayloadTooLarge) {
  7628. exceed_payload_max_length = true;
  7629. ret = false;
  7630. } else {
  7631. ret = false;
  7632. }
  7633. } else {
  7634. auto is_invalid_value = false;
  7635. auto len = get_header_value_u64(x.headers, "Content-Length",
  7636. (std::numeric_limits<size_t>::max)(),
  7637. 0, is_invalid_value);
  7638. if (is_invalid_value) {
  7639. ret = false;
  7640. } else if (len > 0) {
  7641. auto result = read_content_with_length(
  7642. strm, len, std::move(progress), out, payload_max_length);
  7643. ret = (result == ReadContentResult::Success);
  7644. if (result == ReadContentResult::PayloadTooLarge) {
  7645. exceed_payload_max_length = true;
  7646. }
  7647. }
  7648. }
  7649. if (!ret) {
  7650. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7651. : StatusCode::BadRequest_400;
  7652. }
  7653. return ret;
  7654. });
  7655. }
  7656. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7657. const std::string &path) {
  7658. // Neither the method nor the request target may carry CR/LF, SP or other
  7659. // control octets; otherwise a value smuggled into either splits the request
  7660. // line and injects headers or a whole request.
  7661. if (!fields::is_token(method)) { return -1; }
  7662. if (!fields::is_request_target(path)) { return -1; }
  7663. std::string s = method;
  7664. s += ' ';
  7665. s += path;
  7666. s += " HTTP/1.1\r\n";
  7667. return strm.write(s.data(), s.size());
  7668. }
  7669. inline ssize_t write_response_line(Stream &strm, int status) {
  7670. std::string s = "HTTP/1.1 ";
  7671. s += std::to_string(status);
  7672. s += ' ';
  7673. s += httplib::status_message(status);
  7674. s += "\r\n";
  7675. return strm.write(s.data(), s.size());
  7676. }
  7677. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7678. ssize_t write_len = 0;
  7679. for (const auto &x : headers) {
  7680. std::string s;
  7681. s = x.first;
  7682. s += ": ";
  7683. s += x.second;
  7684. s += "\r\n";
  7685. auto len = strm.write(s.data(), s.size());
  7686. if (len < 0) { return len; }
  7687. write_len += len;
  7688. }
  7689. auto len = strm.write("\r\n");
  7690. if (len < 0) { return len; }
  7691. write_len += len;
  7692. return write_len;
  7693. }
  7694. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7695. size_t offset = 0;
  7696. while (offset < l) {
  7697. auto length = strm.write(d + offset, l - offset);
  7698. if (length < 0) { return false; }
  7699. offset += static_cast<size_t>(length);
  7700. }
  7701. return true;
  7702. }
  7703. template <typename T>
  7704. inline bool write_content_with_progress(Stream &strm,
  7705. const ContentProvider &content_provider,
  7706. size_t offset, size_t length,
  7707. T is_shutting_down,
  7708. const UploadProgress &upload_progress,
  7709. Error &error) {
  7710. size_t end_offset = offset + length;
  7711. size_t start_offset = offset;
  7712. auto ok = true;
  7713. auto finished = false;
  7714. DataSink data_sink;
  7715. data_sink.write = [&](const char *d, size_t l) -> bool {
  7716. if (ok) {
  7717. // Bytes past `length` would follow the framed body, where the peer reads
  7718. // them as the next message. Write only what fits and fail the rest.
  7719. if (l > end_offset - offset) {
  7720. l = end_offset - offset;
  7721. ok = false;
  7722. }
  7723. if (write_data(strm, d, l)) {
  7724. offset += l;
  7725. if (upload_progress && length > 0) {
  7726. size_t current_written = offset - start_offset;
  7727. if (!upload_progress(current_written, length)) {
  7728. ok = false;
  7729. return false;
  7730. }
  7731. }
  7732. } else {
  7733. ok = false;
  7734. }
  7735. }
  7736. return ok;
  7737. };
  7738. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7739. // The body is framed by `length`, so a provider that reports itself done
  7740. // early has truncated it. Record that and let the short-body check below
  7741. // fail the write, rather than calling the provider again forever.
  7742. data_sink.done = [&]() { finished = true; };
  7743. while (offset < end_offset && !finished && !is_shutting_down()) {
  7744. auto last_offset = offset;
  7745. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7746. error = Error::Write;
  7747. return false;
  7748. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7749. error = Error::Canceled;
  7750. return false;
  7751. } else if (!ok) {
  7752. error = Error::Write;
  7753. return false;
  7754. }
  7755. // A provider that reports success without writing anything and without
  7756. // reporting itself done gets handed the same offset and length again on
  7757. // the next pass, so it would spin here for as long as the peer stays
  7758. // connected. Treat making no progress as a short body, like done() early.
  7759. if (!finished && offset == last_offset) {
  7760. error = Error::Write;
  7761. return false;
  7762. }
  7763. }
  7764. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7765. error = Error::Write;
  7766. return false;
  7767. }
  7768. error = Error::Success;
  7769. return true;
  7770. }
  7771. template <typename T>
  7772. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7773. size_t offset, size_t length, T is_shutting_down,
  7774. Error &error) {
  7775. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7776. is_shutting_down, nullptr, error);
  7777. }
  7778. template <typename T>
  7779. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7780. size_t offset, size_t length,
  7781. const T &is_shutting_down) {
  7782. auto error = Error::Success;
  7783. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7784. error);
  7785. }
  7786. template <typename T>
  7787. inline bool
  7788. write_content_without_length(Stream &strm,
  7789. const ContentProvider &content_provider,
  7790. const T &is_shutting_down) {
  7791. size_t offset = 0;
  7792. auto data_available = true;
  7793. auto ok = true;
  7794. DataSink data_sink;
  7795. data_sink.write = [&](const char *d, size_t l) -> bool {
  7796. if (ok) {
  7797. offset += l;
  7798. if (!write_data(strm, d, l)) { ok = false; }
  7799. }
  7800. return ok;
  7801. };
  7802. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7803. data_sink.done = [&](void) { data_available = false; };
  7804. while (data_available && !is_shutting_down()) {
  7805. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7806. return false;
  7807. } else if (!content_provider(offset, 0, data_sink)) {
  7808. return false;
  7809. } else if (!ok) {
  7810. return false;
  7811. }
  7812. }
  7813. return !data_available; // true only if done() was called, false if shutting
  7814. // down
  7815. }
  7816. // Runs a known-length content provider to completion and compresses what it
  7817. // writes into `out`, chunk by chunk, without holding the identity form.
  7818. inline bool compress_content_provider(const ContentProvider &content_provider,
  7819. size_t length, compressor &cmp,
  7820. std::string &out) {
  7821. size_t offset = 0;
  7822. auto ok = true;
  7823. auto finished = false;
  7824. DataSink data_sink;
  7825. auto append = [&](const char *data, size_t data_len) {
  7826. out.append(data, data_len);
  7827. return true;
  7828. };
  7829. data_sink.write = [&](const char *d, size_t l) -> bool {
  7830. if (!ok) { return false; }
  7831. offset += l;
  7832. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7833. return ok;
  7834. };
  7835. // The body is framed by `length`, so a provider that reports itself done
  7836. // early has truncated it; the short-body check below turns that into a
  7837. // failure rather than calling the provider again forever.
  7838. data_sink.done = [&]() { finished = true; };
  7839. while (offset < length && !finished) {
  7840. auto prev_offset = offset;
  7841. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7842. return false;
  7843. }
  7844. // No Stream to block on here, so a provider that keeps returning true
  7845. // without writing would spin. Treat a pass that made no progress as a
  7846. // failure.
  7847. if (offset == prev_offset) { return false; }
  7848. }
  7849. if (offset != length) { return false; }
  7850. return cmp.compress(nullptr, 0, true, append);
  7851. }
  7852. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7853. // and the file flag, so recording them has to come after; keeping all of it
  7854. // here means a third file-serving path cannot get that order wrong.
  7855. inline void set_file_content_provider(Response &res,
  7856. const std::shared_ptr<mmap> &m,
  7857. const std::string &content_type,
  7858. EncodingType encoding) {
  7859. // One read and one write move up to this much of the file at a time.
  7860. auto buf = std::make_shared<std::vector<char>>(
  7861. (std::min)(m->size(), size_t(256 * 1024)));
  7862. res.set_content_provider(
  7863. m->size(), content_type,
  7864. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7865. // Never read past the file, which ends the response early if it has
  7866. // shrunk since it was opened.
  7867. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7868. if (n == 0) { return false; }
  7869. sink.write(buf->data(), n);
  7870. return true;
  7871. });
  7872. res.is_file_content_provider_ = true;
  7873. res.content_coding_ = encoding;
  7874. }
  7875. template <typename T, typename U>
  7876. inline bool
  7877. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7878. const T &is_shutting_down, U &compressor, Error &error) {
  7879. size_t offset = 0;
  7880. auto data_available = true;
  7881. auto ok = true;
  7882. DataSink data_sink;
  7883. data_sink.write = [&](const char *d, size_t l) -> bool {
  7884. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7885. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7886. // zero-length chunk is the terminator, so it must not be emitted here.
  7887. if (ok && l > 0) {
  7888. offset += l;
  7889. std::string payload;
  7890. if (compressor.compress(d, l, false,
  7891. [&](const char *data, size_t data_len) {
  7892. payload.append(data, data_len);
  7893. return true;
  7894. })) {
  7895. if (!payload.empty()) {
  7896. // Emit chunked response header and footer for each chunk
  7897. auto chunk =
  7898. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7899. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7900. }
  7901. } else {
  7902. ok = false;
  7903. }
  7904. }
  7905. return ok;
  7906. };
  7907. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7908. auto done_with_trailer = [&](const Headers *trailer) {
  7909. if (!ok) { return; }
  7910. data_available = false;
  7911. std::string payload;
  7912. if (!compressor.compress(nullptr, 0, true,
  7913. [&](const char *data, size_t data_len) {
  7914. payload.append(data, data_len);
  7915. return true;
  7916. })) {
  7917. ok = false;
  7918. return;
  7919. }
  7920. if (!payload.empty()) {
  7921. // Emit chunked response header and footer for each chunk
  7922. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7923. if (!write_data(strm, chunk.data(), chunk.size())) {
  7924. ok = false;
  7925. return;
  7926. }
  7927. }
  7928. constexpr const char done_marker[] = "0\r\n";
  7929. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7930. // Trailer
  7931. if (trailer) {
  7932. for (const auto &kv : *trailer) {
  7933. // Skip fields with invalid names or values to prevent response
  7934. // splitting via CR/LF injection, matching set_header().
  7935. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7936. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7937. if (!write_data(strm, field_line.data(), field_line.size())) {
  7938. ok = false;
  7939. }
  7940. }
  7941. }
  7942. constexpr const char crlf[] = "\r\n";
  7943. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7944. };
  7945. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7946. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7947. done_with_trailer(&trailer);
  7948. };
  7949. while (data_available && !is_shutting_down()) {
  7950. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7951. error = Error::Write;
  7952. return false;
  7953. } else if (!content_provider(offset, 0, data_sink)) {
  7954. error = Error::Canceled;
  7955. return false;
  7956. } else if (!ok) {
  7957. error = Error::Write;
  7958. return false;
  7959. }
  7960. }
  7961. if (data_available) { // exited due to is_shutting_down(), not done()
  7962. error = Error::Write;
  7963. return false;
  7964. }
  7965. error = Error::Success;
  7966. return true;
  7967. }
  7968. template <typename T, typename U>
  7969. inline bool write_content_chunked(Stream &strm,
  7970. const ContentProvider &content_provider,
  7971. const T &is_shutting_down, U &compressor) {
  7972. auto error = Error::Success;
  7973. return write_content_chunked(strm, content_provider, is_shutting_down,
  7974. compressor, error);
  7975. }
  7976. template <typename T>
  7977. inline bool redirect(T &cli, Request &req, Response &res,
  7978. const std::string &path, const std::string &location,
  7979. Error &error) {
  7980. Request new_req = req;
  7981. new_req.path = path;
  7982. new_req.params.clear();
  7983. new_req.redirect_count_ -= 1;
  7984. if (res.status == StatusCode::SeeOther_303 &&
  7985. (req.method != "GET" && req.method != "HEAD")) {
  7986. new_req.method = "GET";
  7987. new_req.body.clear();
  7988. new_req.headers.clear();
  7989. new_req.content_length_ = 0;
  7990. new_req.content_provider_ = nullptr;
  7991. new_req.is_chunked_content_provider_ = false;
  7992. }
  7993. Response new_res;
  7994. auto ret = cli.send(new_req, new_res, error);
  7995. if (ret) {
  7996. req = std::move(new_req);
  7997. res = std::move(new_res);
  7998. if (res.location.empty()) { res.location = location; }
  7999. }
  8000. return ret;
  8001. }
  8002. inline std::string params_to_query_str(const Params &params) {
  8003. std::string query;
  8004. for (auto it = params.begin(); it != params.end(); ++it) {
  8005. if (it != params.begin()) { query += '&'; }
  8006. query += encode_query_component(it->first);
  8007. query += '=';
  8008. query += encode_query_component(it->second);
  8009. }
  8010. return query;
  8011. }
  8012. // Splits one "key=value" span of a query string at its first '='. A span with
  8013. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  8014. // "?flag" keeps its name.
  8015. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  8016. std::string &val) {
  8017. divide(b, static_cast<std::size_t>(e - b), '=',
  8018. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  8019. std::size_t rhs_size) {
  8020. key.assign(lhs_data, lhs_size);
  8021. val.assign(rhs_data, rhs_size);
  8022. });
  8023. }
  8024. inline void parse_query_text(const char *data, std::size_t size,
  8025. Params &params) {
  8026. std::set<std::string> cache;
  8027. split(data, data + size, '&', [&](const char *b, const char *e) {
  8028. std::string kv(b, e);
  8029. if (cache.find(kv) != cache.end()) { return; }
  8030. cache.insert(std::move(kv));
  8031. std::string key;
  8032. std::string val;
  8033. divide_query_pair(b, e, key, val);
  8034. if (!key.empty()) {
  8035. params.emplace(decode_query_component(key), decode_query_component(val));
  8036. }
  8037. });
  8038. }
  8039. inline void parse_query_text(const std::string &s, Params &params) {
  8040. parse_query_text(s.data(), s.size(), params);
  8041. }
  8042. // Normalize a query string by decoding and re-encoding each key/value pair
  8043. // while preserving the original parameter order. This avoids double-encoding
  8044. // and ensures consistent encoding. It works on the raw string rather than
  8045. // parsing into Params and re-serializing, because that round trip cannot
  8046. // reproduce the input: params_to_query_str() always emits '=', so a bare
  8047. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  8048. // duplicated pairs.
  8049. inline std::string normalize_query_string(const std::string &query) {
  8050. std::string result;
  8051. split(query.data(), query.data() + query.size(), '&',
  8052. [&](const char *b, const char *e) {
  8053. std::string key;
  8054. std::string val;
  8055. divide_query_pair(b, e, key, val);
  8056. if (!key.empty()) {
  8057. auto dec_key = decode_query_component(key);
  8058. auto dec_val = decode_query_component(val);
  8059. if (!result.empty()) { result += '&'; }
  8060. result += encode_query_component(dec_key);
  8061. if (!val.empty() || std::find(b, e, '=') != e) {
  8062. result += '=';
  8063. result += encode_query_component(dec_val);
  8064. }
  8065. }
  8066. });
  8067. return result;
  8068. }
  8069. // The query of a client's path: what follows '?', up to the fragment.
  8070. inline std::string query_of(const std::string &path) {
  8071. auto fragment_pos = path.find('#');
  8072. auto query_pos = path.find('?');
  8073. return query_pos < fragment_pos
  8074. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  8075. : std::string();
  8076. }
  8077. // Build the request target that goes on the wire from a caller-supplied path.
  8078. // Shared by the buffered send path and the streaming API so that both put the
  8079. // same bytes in the request line for the same input.
  8080. inline std::string encode_request_target(const std::string &uri,
  8081. bool path_encode) {
  8082. // The fragment stays with the client (RFC 9110 §7.1).
  8083. auto target = uri.substr(0, uri.find('#'));
  8084. // `substr(0, npos)` yields the whole string, which is what the no-query
  8085. // case needs.
  8086. auto query_pos = target.find('?');
  8087. auto path_part = target.substr(0, query_pos);
  8088. std::string query_part;
  8089. if (query_pos != std::string::npos) {
  8090. query_part = target.substr(query_pos + 1);
  8091. }
  8092. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  8093. if (!query_part.empty()) {
  8094. // When path encoding is disabled the caller has supplied an already-encoded
  8095. // target and expects the exact bytes to be sent on the wire, so skip
  8096. // normalization for the query too. Normalizing would decode-then-re-encode
  8097. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  8098. // which a strict RFC 3986 server decodes back as `+`, not a space).
  8099. if (path_encode) {
  8100. auto normalized = normalize_query_string(query_part);
  8101. if (!normalized.empty()) {
  8102. result += '?';
  8103. result += normalized;
  8104. }
  8105. } else {
  8106. result += '?';
  8107. result += query_part;
  8108. }
  8109. }
  8110. return result;
  8111. }
  8112. inline bool parse_multipart_boundary(const std::string &content_type,
  8113. std::string &boundary) {
  8114. std::map<std::string, std::string> params;
  8115. extract_media_type(content_type, &params);
  8116. auto it = params.find("boundary");
  8117. if (it == params.end()) { return false; }
  8118. boundary = it->second;
  8119. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  8120. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  8121. // bytes costs a nearly full comparison at nearly every position: the
  8122. // boundary's length multiplies the worst-case cost of scanning a body.
  8123. return !boundary.empty() && boundary.size() <= 70;
  8124. }
  8125. inline void parse_disposition_params(const std::string &s, Params &params) {
  8126. std::set<std::string> cache;
  8127. split_unquoted(
  8128. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  8129. std::string kv(b, e);
  8130. if (cache.find(kv) != cache.end()) { return; }
  8131. cache.insert(kv);
  8132. std::string key;
  8133. std::string val;
  8134. divide_param_pair(b, e, key, val);
  8135. if (!key.empty()) {
  8136. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  8137. }
  8138. });
  8139. }
  8140. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8141. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  8142. #else
  8143. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  8144. #endif
  8145. auto is_valid = [](const std::string &str) {
  8146. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  8147. };
  8148. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8149. const auto pos = static_cast<size_t>(6);
  8150. const auto len = static_cast<size_t>(s.size() - 6);
  8151. auto all_valid_ranges = true;
  8152. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8153. if (!all_valid_ranges) { return; }
  8154. const auto it = std::find(b, e, '-');
  8155. if (it == e) {
  8156. all_valid_ranges = false;
  8157. return;
  8158. }
  8159. const auto lhs = std::string(b, it);
  8160. const auto rhs = std::string(it + 1, e);
  8161. if (!is_valid(lhs) || !is_valid(rhs)) {
  8162. all_valid_ranges = false;
  8163. return;
  8164. }
  8165. ssize_t first = -1;
  8166. if (!lhs.empty()) {
  8167. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8168. // would turn the range into a suffix range.
  8169. auto res =
  8170. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8171. if (res.ec != std::errc{}) {
  8172. all_valid_ranges = false;
  8173. return;
  8174. }
  8175. }
  8176. ssize_t last = -1;
  8177. if (!rhs.empty()) {
  8178. // An overflowing last-byte-pos is past any content length, so keeping
  8179. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8180. ssize_t v;
  8181. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8182. if (res.ec == std::errc{}) { last = v; }
  8183. }
  8184. if ((first == -1 && last == -1) ||
  8185. (first != -1 && last != -1 && first > last)) {
  8186. all_valid_ranges = false;
  8187. return;
  8188. }
  8189. ranges.emplace_back(first, last);
  8190. });
  8191. return all_valid_ranges && !ranges.empty();
  8192. }
  8193. return false;
  8194. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8195. }
  8196. #else
  8197. } catch (...) { return false; }
  8198. #endif
  8199. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8200. inline std::string remove_quoted_strings(const std::string &s) {
  8201. std::string out;
  8202. auto in_quotes = false;
  8203. for (size_t i = 0; i < s.size(); i++) {
  8204. if (s[i] == '"') {
  8205. in_quotes = !in_quotes;
  8206. } else if (!in_quotes) {
  8207. out += s[i];
  8208. } else if (s[i] == '\\') {
  8209. i++;
  8210. }
  8211. }
  8212. return out;
  8213. }
  8214. inline bool parse_accept_header(const std::string &s,
  8215. std::vector<std::string> &content_types) {
  8216. // Parameter values are not used here, so a quoted-string is dropped rather
  8217. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8218. if (s.find('"') != std::string::npos) {
  8219. return parse_accept_header(remove_quoted_strings(s), content_types);
  8220. }
  8221. content_types.clear();
  8222. // Empty string is considered valid (no preference)
  8223. if (s.empty()) { return true; }
  8224. struct AcceptEntry {
  8225. std::string media_type;
  8226. double quality;
  8227. int order;
  8228. };
  8229. std::vector<AcceptEntry> entries;
  8230. int order = 0;
  8231. bool has_invalid_entry = false;
  8232. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8233. // has to parse and ignore empty list elements, so a leading, trailing or
  8234. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8235. // split() skips them, and the header length limit bounds how many a sender
  8236. // can send, so ignoring all of them cannot be used as a denial-of-service
  8237. // vector.
  8238. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8239. std::string entry(b, e);
  8240. entry = trim_copy(entry);
  8241. AcceptEntry accept_entry;
  8242. accept_entry.order = order++;
  8243. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8244. accept_entry.media_type, accept_entry.quality)) {
  8245. has_invalid_entry = true;
  8246. return;
  8247. }
  8248. // Remove additional parameters from media type
  8249. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8250. // Basic validation of media type format
  8251. if (accept_entry.media_type.empty()) {
  8252. has_invalid_entry = true;
  8253. return;
  8254. }
  8255. // Check for basic media type format (should contain '/' or be '*')
  8256. if (accept_entry.media_type != "*" &&
  8257. accept_entry.media_type.find('/') == std::string::npos) {
  8258. has_invalid_entry = true;
  8259. return;
  8260. }
  8261. entries.push_back(std::move(accept_entry));
  8262. });
  8263. // Return false if any invalid entry was found
  8264. if (has_invalid_entry) { return false; }
  8265. // Sort by quality (descending), then by original order (ascending)
  8266. std::sort(entries.begin(), entries.end(),
  8267. [](const AcceptEntry &a, const AcceptEntry &b) {
  8268. if (a.quality != b.quality) {
  8269. return a.quality > b.quality; // Higher quality first
  8270. }
  8271. return a.order < b.order; // Earlier order first for same quality
  8272. });
  8273. // Extract sorted media types
  8274. content_types.reserve(entries.size());
  8275. for (auto &entry : entries) {
  8276. content_types.push_back(std::move(entry.media_type));
  8277. }
  8278. return true;
  8279. }
  8280. class FormDataParser {
  8281. public:
  8282. FormDataParser() = default;
  8283. void set_boundary(std::string &&boundary) {
  8284. boundary_ = std::move(boundary);
  8285. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8286. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8287. }
  8288. bool is_valid() const { return is_valid_; }
  8289. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8290. const ContentReceiver &content_callback) {
  8291. // Once the close delimiter has been seen the rest of the body is epilogue
  8292. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8293. // spread across reads is not copied in only to be erased right away.
  8294. if (state_ == 5) { return true; }
  8295. buf_append(buf, n);
  8296. while (buf_size() > 0) {
  8297. switch (state_) {
  8298. case 0: { // Initial boundary
  8299. auto pos = buf_find(dash_boundary_crlf_);
  8300. if (pos == buf_size()) {
  8301. // Not found yet: keep only a possible partial boundary at the tail so
  8302. // that a body which never contains the boundary cannot grow the
  8303. // buffer (and get rescanned from the start) without bound.
  8304. auto keep = dash_boundary_crlf_.size() - 1;
  8305. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8306. return true;
  8307. }
  8308. buf_erase(pos + dash_boundary_crlf_.size());
  8309. state_ = 1;
  8310. break;
  8311. }
  8312. case 1: { // New entry
  8313. clear_file_info();
  8314. header_searched_ = 0;
  8315. state_ = 2;
  8316. break;
  8317. }
  8318. case 2: { // Headers
  8319. // Resume where the last call stopped looking, so that a line arriving
  8320. // a few bytes at a time is not searched from its start each time.
  8321. auto pos = buf_find(crlf_, header_searched_);
  8322. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8323. while (pos < buf_size()) {
  8324. // Empty line
  8325. if (pos == 0) {
  8326. if (!header_callback(file_)) {
  8327. is_valid_ = false;
  8328. return false;
  8329. }
  8330. buf_erase(crlf_.size());
  8331. state_ = 3;
  8332. break;
  8333. }
  8334. // Check header count limit
  8335. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8336. is_valid_ = false;
  8337. return false;
  8338. }
  8339. header_count_++;
  8340. const auto header = buf_head(pos);
  8341. if (!parse_header(header.data(), header.data() + header.size(),
  8342. [&](const std::string &, const std::string &) {})) {
  8343. is_valid_ = false;
  8344. return false;
  8345. }
  8346. // Parse and emplace space trimmed headers into a map
  8347. if (!parse_header(
  8348. header.data(), header.data() + header.size(),
  8349. [&](const std::string &key, const std::string &val) {
  8350. file_.headers.emplace(key, val);
  8351. })) {
  8352. is_valid_ = false;
  8353. return false;
  8354. }
  8355. constexpr const char header_content_type[] = "Content-Type:";
  8356. if (start_with_case_ignore(header, header_content_type)) {
  8357. file_.content_type =
  8358. trim_copy(header.substr(str_len(header_content_type)));
  8359. } else {
  8360. std::string disposition_params;
  8361. if (parse_content_disposition(header, disposition_params)) {
  8362. Params params;
  8363. parse_disposition_params(disposition_params, params);
  8364. auto it = params.find("name");
  8365. if (it != params.end()) {
  8366. file_.name = it->second;
  8367. } else {
  8368. is_valid_ = false;
  8369. return false;
  8370. }
  8371. it = params.find("filename");
  8372. if (it != params.end()) { file_.filename = it->second; }
  8373. it = params.find("filename*");
  8374. if (it != params.end()) {
  8375. // RFC 5987: only UTF-8 encoding is allowed
  8376. const auto &val = it->second;
  8377. constexpr const char utf8_prefix[] = "UTF-8''";
  8378. constexpr size_t prefix_len = str_len(utf8_prefix);
  8379. if (val.size() > prefix_len &&
  8380. start_with_case_ignore(val, utf8_prefix)) {
  8381. file_.filename = decode_path_component(
  8382. val.substr(prefix_len)); // override...
  8383. } else {
  8384. is_valid_ = false;
  8385. return false;
  8386. }
  8387. }
  8388. }
  8389. }
  8390. buf_erase(pos + crlf_.size());
  8391. pos = buf_find(crlf_);
  8392. }
  8393. if (state_ != 3) {
  8394. // The CR of the CRLF may be the last byte so far.
  8395. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8396. return true;
  8397. }
  8398. break;
  8399. }
  8400. case 3: { // Body
  8401. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8402. auto pos = buf_find(crlf_dash_boundary_);
  8403. if (pos < buf_size()) {
  8404. if (!content_callback(buf_data(), pos)) {
  8405. is_valid_ = false;
  8406. return false;
  8407. }
  8408. buf_erase(pos + crlf_dash_boundary_.size());
  8409. state_ = 4;
  8410. } else {
  8411. auto len = buf_size() - crlf_dash_boundary_.size();
  8412. if (len > 0) {
  8413. if (!content_callback(buf_data(), len)) {
  8414. is_valid_ = false;
  8415. return false;
  8416. }
  8417. buf_erase(len);
  8418. }
  8419. return true;
  8420. }
  8421. break;
  8422. }
  8423. case 4: { // Boundary
  8424. if (crlf_.size() > buf_size()) { return true; }
  8425. if (buf_start_with(crlf_)) {
  8426. buf_erase(crlf_.size());
  8427. state_ = 1;
  8428. } else if (buf_start_with(dash_)) {
  8429. buf_erase(dash_.size());
  8430. is_valid_ = true;
  8431. state_ = 5;
  8432. } else {
  8433. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8434. // accepted after a boundary; RFC 2046 allows transport-padding in
  8435. // between, but this parser has never supported it. Either way the
  8436. // body is already destined to be rejected, so fail now instead of
  8437. // buffering the rest of it. Both are two bytes, so the check above
  8438. // already guarantees enough buffered data to decide.
  8439. is_valid_ = false;
  8440. return false;
  8441. }
  8442. break;
  8443. }
  8444. case 5: { // Epilogue
  8445. buf_erase(buf_size());
  8446. break;
  8447. }
  8448. }
  8449. }
  8450. return true;
  8451. }
  8452. private:
  8453. void clear_file_info() {
  8454. file_.name.clear();
  8455. file_.filename.clear();
  8456. file_.content_type.clear();
  8457. file_.headers.clear();
  8458. header_count_ = 0;
  8459. }
  8460. bool start_with_case_ignore(const std::string &a, const char *b,
  8461. size_t offset = 0) const {
  8462. const auto b_len = strlen(b);
  8463. if (a.size() < offset + b_len) { return false; }
  8464. for (size_t i = 0; i < b_len; i++) {
  8465. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8466. return false;
  8467. }
  8468. }
  8469. return true;
  8470. }
  8471. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8472. // Returns true if header matches, with the params portion in `params_out`.
  8473. bool parse_content_disposition(const std::string &header,
  8474. std::string &params_out) const {
  8475. constexpr const char prefix[] = "Content-Disposition:";
  8476. constexpr size_t prefix_len = str_len(prefix);
  8477. if (!start_with_case_ignore(header, prefix)) { return false; }
  8478. // Skip whitespace after "Content-Disposition:"
  8479. auto pos = prefix_len;
  8480. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8481. pos++;
  8482. }
  8483. // Match "form-data;" (case-insensitive)
  8484. constexpr const char form_data[] = "form-data;";
  8485. constexpr size_t form_data_len = str_len(form_data);
  8486. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8487. pos += form_data_len;
  8488. // Skip whitespace after "form-data;"
  8489. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8490. pos++;
  8491. }
  8492. params_out = header.substr(pos);
  8493. return true;
  8494. }
  8495. const std::string dash_ = "--";
  8496. const std::string crlf_ = "\r\n";
  8497. std::string boundary_;
  8498. std::string dash_boundary_crlf_;
  8499. std::string crlf_dash_boundary_;
  8500. size_t state_ = 0;
  8501. bool is_valid_ = false;
  8502. FormData file_;
  8503. size_t header_count_ = 0;
  8504. size_t header_searched_ = 0;
  8505. // Buffer
  8506. bool start_with(const std::string &a, size_t spos, size_t epos,
  8507. const std::string &b) const {
  8508. if (epos - spos < b.size()) { return false; }
  8509. for (size_t i = 0; i < b.size(); i++) {
  8510. if (a[i + spos] != b[i]) { return false; }
  8511. }
  8512. return true;
  8513. }
  8514. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8515. const char *buf_data() const { return &buf_[buf_spos_]; }
  8516. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8517. bool buf_start_with(const std::string &s) const {
  8518. return start_with(buf_, buf_spos_, buf_epos_, s);
  8519. }
  8520. size_t buf_find(const std::string &s, size_t from = 0) const {
  8521. auto c = s.front();
  8522. size_t off = buf_spos_ + from;
  8523. while (off < buf_epos_) {
  8524. auto pos = off;
  8525. while (true) {
  8526. if (pos == buf_epos_) { return buf_size(); }
  8527. if (buf_[pos] == c) { break; }
  8528. pos++;
  8529. }
  8530. auto remaining_size = buf_epos_ - pos;
  8531. if (s.size() > remaining_size) { return buf_size(); }
  8532. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8533. off = pos + 1;
  8534. }
  8535. return buf_size();
  8536. }
  8537. void buf_append(const char *data, size_t n) {
  8538. auto remaining_size = buf_size();
  8539. if (remaining_size > 0 && buf_spos_ > 0) {
  8540. for (size_t i = 0; i < remaining_size; i++) {
  8541. buf_[i] = buf_[buf_spos_ + i];
  8542. }
  8543. }
  8544. buf_spos_ = 0;
  8545. buf_epos_ = remaining_size;
  8546. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8547. for (size_t i = 0; i < n; i++) {
  8548. buf_[buf_epos_ + i] = data[i];
  8549. }
  8550. buf_epos_ += n;
  8551. }
  8552. void buf_erase(size_t size) { buf_spos_ += size; }
  8553. std::string buf_;
  8554. size_t buf_spos_ = 0;
  8555. size_t buf_epos_ = 0;
  8556. };
  8557. inline std::string random_string(size_t length) {
  8558. constexpr const char data[] =
  8559. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8560. std::string result(length, '\0');
  8561. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8562. for (auto &c : result) {
  8563. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8564. }
  8565. return result;
  8566. }
  8567. inline std::string make_multipart_data_boundary() {
  8568. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8569. }
  8570. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8571. auto valid = true;
  8572. for (size_t i = 0; i < boundary.size(); i++) {
  8573. auto c = boundary[i];
  8574. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8575. valid = false;
  8576. break;
  8577. }
  8578. }
  8579. return valid;
  8580. }
  8581. // Escape a multipart field name/filename following the WHATWG HTML standard
  8582. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8583. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8584. // With quoted = false, only CR and LF are escaped; this is for header values
  8585. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8586. inline std::string escape_multipart_field(const std::string &s,
  8587. bool quoted = true) {
  8588. std::string result;
  8589. result.reserve(s.size());
  8590. for (auto c : s) {
  8591. switch (c) {
  8592. case '"':
  8593. if (quoted) {
  8594. result += "%22";
  8595. } else {
  8596. result += c;
  8597. }
  8598. break;
  8599. case '\\':
  8600. // A lone backslash would escape the character after it (RFC 9110
  8601. // 5.6.4).
  8602. if (quoted) { result += '\\'; }
  8603. result += c;
  8604. break;
  8605. case '\r': result += "%0D"; break;
  8606. case '\n': result += "%0A"; break;
  8607. default: result += c; break;
  8608. }
  8609. }
  8610. return result;
  8611. }
  8612. template <typename T>
  8613. inline std::string
  8614. serialize_multipart_formdata_item_begin(const T &item,
  8615. const std::string &boundary) {
  8616. std::string body = "--" + boundary + "\r\n";
  8617. body += "Content-Disposition: form-data; name=\"" +
  8618. escape_multipart_field(item.name) + "\"";
  8619. if (!item.filename.empty()) {
  8620. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8621. }
  8622. body += "\r\n";
  8623. if (!item.content_type.empty()) {
  8624. body +=
  8625. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8626. "\r\n";
  8627. }
  8628. body += "\r\n";
  8629. return body;
  8630. }
  8631. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8632. inline std::string
  8633. serialize_multipart_formdata_finish(const std::string &boundary) {
  8634. return "--" + boundary + "--\r\n";
  8635. }
  8636. inline std::string
  8637. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8638. return "multipart/form-data; boundary=" + boundary;
  8639. }
  8640. inline std::string
  8641. serialize_multipart_formdata(const UploadFormDataItems &items,
  8642. const std::string &boundary, bool finish = true) {
  8643. std::string body;
  8644. for (const auto &item : items) {
  8645. body += serialize_multipart_formdata_item_begin(item, boundary);
  8646. body += item.content + serialize_multipart_formdata_item_end();
  8647. }
  8648. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8649. return body;
  8650. }
  8651. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8652. const std::string &boundary) {
  8653. size_t total = 0;
  8654. for (const auto &item : items) {
  8655. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8656. total += item.content.size();
  8657. total += serialize_multipart_formdata_item_end().size();
  8658. }
  8659. total += serialize_multipart_formdata_finish(boundary).size();
  8660. return total;
  8661. }
  8662. struct MultipartSegment {
  8663. const char *data;
  8664. size_t size;
  8665. };
  8666. // NOTE: items must outlive the returned ContentProvider
  8667. // (safe for synchronous use inside Post/Put/Patch)
  8668. inline ContentProvider
  8669. make_multipart_content_provider(const UploadFormDataItems &items,
  8670. const std::string &boundary) {
  8671. // Own the per-item header strings and the finish string
  8672. std::vector<std::string> owned;
  8673. owned.reserve(items.size() + 1);
  8674. for (const auto &item : items)
  8675. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8676. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8677. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8678. std::vector<MultipartSegment> segs;
  8679. segs.reserve(items.size() * 3 + 1);
  8680. static const char crlf[] = "\r\n";
  8681. for (size_t i = 0; i < items.size(); i++) {
  8682. segs.push_back({owned[i].data(), owned[i].size()});
  8683. segs.push_back({items[i].content.data(), items[i].content.size()});
  8684. segs.push_back({crlf, 2});
  8685. }
  8686. segs.push_back({owned.back().data(), owned.back().size()});
  8687. struct MultipartState {
  8688. std::vector<std::string> owned;
  8689. std::vector<MultipartSegment> segs;
  8690. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8691. };
  8692. auto state = std::make_shared<MultipartState>();
  8693. state->owned = std::move(owned);
  8694. // `segs` holds raw pointers into owned strings; std::string move preserves
  8695. // the data pointer, so these pointers remain valid after the move above.
  8696. state->segs = std::move(segs);
  8697. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8698. // Buffer multiple small segments into fewer, larger writes to avoid
  8699. // excessive TCP packets when there are many form data items (#2410)
  8700. auto &buf = state->buf;
  8701. auto buf_size = buf.size();
  8702. size_t buf_len = 0;
  8703. size_t remaining = length;
  8704. // Find the first segment containing 'offset'
  8705. size_t pos = 0;
  8706. size_t seg_idx = 0;
  8707. for (; seg_idx < state->segs.size(); seg_idx++) {
  8708. const auto &seg = state->segs[seg_idx];
  8709. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8710. pos += seg.size;
  8711. }
  8712. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8713. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8714. const auto &seg = state->segs[seg_idx];
  8715. size_t available = seg.size - seg_offset;
  8716. size_t to_copy = (std::min)(available, remaining);
  8717. const char *src = seg.data + seg_offset;
  8718. seg_offset = 0; // only the first segment has a non-zero offset
  8719. while (to_copy > 0) {
  8720. size_t space = buf_size - buf_len;
  8721. size_t chunk = (std::min)(to_copy, space);
  8722. std::memcpy(buf.data() + buf_len, src, chunk);
  8723. buf_len += chunk;
  8724. src += chunk;
  8725. to_copy -= chunk;
  8726. remaining -= chunk;
  8727. if (buf_len == buf_size) {
  8728. if (!sink.write(buf.data(), buf_len)) { return false; }
  8729. buf_len = 0;
  8730. }
  8731. }
  8732. }
  8733. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8734. return true;
  8735. };
  8736. }
  8737. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8738. if (ranges.size() <= 1) return;
  8739. // Sort ranges by start position
  8740. std::sort(ranges.begin(), ranges.end(),
  8741. [](const Range &a, const Range &b) { return a.first < b.first; });
  8742. Ranges coalesced;
  8743. coalesced.reserve(ranges.size());
  8744. for (auto &r : ranges) {
  8745. auto first_pos = r.first;
  8746. auto last_pos = r.second;
  8747. // Handle special cases like in range_error
  8748. if (first_pos == -1 && last_pos == -1) {
  8749. first_pos = 0;
  8750. last_pos = static_cast<ssize_t>(content_length);
  8751. }
  8752. if (first_pos == -1) {
  8753. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8754. last_pos = static_cast<ssize_t>(content_length) - 1;
  8755. }
  8756. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8757. last_pos = static_cast<ssize_t>(content_length) - 1;
  8758. }
  8759. // Skip invalid ranges
  8760. if (!(0 <= first_pos && first_pos <= last_pos &&
  8761. last_pos < static_cast<ssize_t>(content_length))) {
  8762. continue;
  8763. }
  8764. // Coalesce with previous range if overlapping or adjacent (but not
  8765. // identical)
  8766. if (!coalesced.empty()) {
  8767. auto &prev = coalesced.back();
  8768. // Check if current range overlaps or is adjacent to previous range
  8769. // but don't coalesce identical ranges (allow duplicates)
  8770. if (first_pos <= prev.second + 1 &&
  8771. !(first_pos == prev.first && last_pos == prev.second)) {
  8772. // Extend the previous range
  8773. prev.second = (std::max)(prev.second, last_pos);
  8774. continue;
  8775. }
  8776. }
  8777. // Add new range
  8778. coalesced.emplace_back(first_pos, last_pos);
  8779. }
  8780. ranges = std::move(coalesced);
  8781. }
  8782. inline bool range_error(Request &req, Response &res) {
  8783. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8784. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8785. req.ranges.clear();
  8786. if (res.status == StatusCode::PartialContent_206) {
  8787. res.status = StatusCode::OK_200;
  8788. }
  8789. return false;
  8790. }
  8791. ssize_t content_len = static_cast<ssize_t>(
  8792. res.content_length_ ? res.content_length_ : res.body.size());
  8793. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8794. size_t overwrapping_count = 0;
  8795. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8796. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8797. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8798. // Too many ranges
  8799. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8800. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8801. return true;
  8802. }
  8803. for (auto &r : req.ranges) {
  8804. auto &first_pos = r.first;
  8805. auto &last_pos = r.second;
  8806. if (first_pos == -1 && last_pos == -1) {
  8807. first_pos = 0;
  8808. last_pos = content_len;
  8809. }
  8810. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8811. // selects the entire representation.
  8812. if (first_pos == -1) {
  8813. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8814. last_pos = content_len - 1;
  8815. }
  8816. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8817. // A client can limit the number of bytes requested without knowing the
  8818. // size of the selected representation. If the last-pos value is absent,
  8819. // or if the value is greater than or equal to the current length of the
  8820. // representation data, the byte range is interpreted as the remainder of
  8821. // the representation (i.e., the server replaces the value of last-pos
  8822. // with a value that is one less than the current length of the selected
  8823. // representation).
  8824. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8825. if (last_pos == -1 || last_pos >= content_len) {
  8826. last_pos = content_len - 1;
  8827. }
  8828. // Range must be within content length
  8829. if (!(0 <= first_pos && first_pos <= last_pos &&
  8830. last_pos <= content_len - 1)) {
  8831. return true;
  8832. }
  8833. // Request must not have more than two overlapping ranges
  8834. for (const auto &processed_range : processed_ranges) {
  8835. if (!(last_pos < processed_range.first ||
  8836. first_pos > processed_range.second)) {
  8837. overwrapping_count++;
  8838. if (overwrapping_count > 2) { return true; }
  8839. break; // Only count once per range
  8840. }
  8841. }
  8842. processed_ranges.emplace_back(first_pos, last_pos);
  8843. }
  8844. // After validation, coalesce overlapping ranges as per RFC 9110
  8845. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8846. }
  8847. return false;
  8848. }
  8849. inline std::pair<size_t, size_t>
  8850. get_range_offset_and_length(Range r, size_t content_length) {
  8851. assert(r.first != -1 && r.second != -1);
  8852. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8853. assert(r.first <= r.second &&
  8854. r.second < static_cast<ssize_t>(content_length));
  8855. (void)(content_length);
  8856. return std::make_pair(static_cast<size_t>(r.first),
  8857. static_cast<size_t>(r.second - r.first) + 1);
  8858. }
  8859. inline std::string make_content_range_header_field(
  8860. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8861. auto st = offset_and_length.first;
  8862. auto ed = st + offset_and_length.second - 1;
  8863. std::string field = "bytes ";
  8864. field += std::to_string(st);
  8865. field += '-';
  8866. field += std::to_string(ed);
  8867. field += '/';
  8868. field += std::to_string(content_length);
  8869. return field;
  8870. }
  8871. template <typename SToken, typename CToken, typename Content>
  8872. bool process_multipart_ranges_data(const Request &req,
  8873. const std::string &boundary,
  8874. const std::string &content_type,
  8875. size_t content_length, SToken stoken,
  8876. CToken ctoken, Content content) {
  8877. for (size_t i = 0; i < req.ranges.size(); i++) {
  8878. ctoken("--");
  8879. stoken(boundary);
  8880. ctoken("\r\n");
  8881. if (!content_type.empty()) {
  8882. ctoken("Content-Type: ");
  8883. stoken(content_type);
  8884. ctoken("\r\n");
  8885. }
  8886. auto offset_and_length =
  8887. get_range_offset_and_length(req.ranges[i], content_length);
  8888. ctoken("Content-Range: ");
  8889. stoken(make_content_range_header_field(offset_and_length, content_length));
  8890. ctoken("\r\n");
  8891. ctoken("\r\n");
  8892. if (!content(offset_and_length.first, offset_and_length.second)) {
  8893. return false;
  8894. }
  8895. ctoken("\r\n");
  8896. }
  8897. ctoken("--");
  8898. stoken(boundary);
  8899. ctoken("--");
  8900. return true;
  8901. }
  8902. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8903. const std::string &boundary,
  8904. const std::string &content_type,
  8905. size_t content_length,
  8906. std::string &data) {
  8907. process_multipart_ranges_data(
  8908. req, boundary, content_type, content_length,
  8909. [&](const std::string &token) { data += token; },
  8910. [&](const std::string &token) { data += token; },
  8911. [&](size_t offset, size_t length) {
  8912. assert(offset + length <= content_length);
  8913. data += res.body.substr(offset, length);
  8914. return true;
  8915. });
  8916. }
  8917. inline size_t get_multipart_ranges_data_length(const Request &req,
  8918. const std::string &boundary,
  8919. const std::string &content_type,
  8920. size_t content_length) {
  8921. size_t data_length = 0;
  8922. process_multipart_ranges_data(
  8923. req, boundary, content_type, content_length,
  8924. [&](const std::string &token) { data_length += token.size(); },
  8925. [&](const std::string &token) { data_length += token.size(); },
  8926. [&](size_t /*offset*/, size_t length) {
  8927. data_length += length;
  8928. return true;
  8929. });
  8930. return data_length;
  8931. }
  8932. template <typename T>
  8933. inline bool
  8934. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8935. const std::string &boundary,
  8936. const std::string &content_type,
  8937. size_t content_length, const T &is_shutting_down) {
  8938. return process_multipart_ranges_data(
  8939. req, boundary, content_type, content_length,
  8940. [&](const std::string &token) { strm.write(token); },
  8941. [&](const std::string &token) { strm.write(token); },
  8942. [&](size_t offset, size_t length) {
  8943. return write_content(strm, res.content_provider_, offset, length,
  8944. is_shutting_down);
  8945. });
  8946. }
  8947. inline bool has_framed_body(const Request &req) {
  8948. return is_chunked_transfer_encoding(req.headers) ||
  8949. req.get_header_value_u64("Content-Length") > 0;
  8950. }
  8951. inline bool expect_content(const Request &req) {
  8952. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8953. req.method == "DELETE") {
  8954. return true;
  8955. }
  8956. return has_framed_body(req);
  8957. }
  8958. #ifdef _WIN32
  8959. class WSInit {
  8960. public:
  8961. WSInit() {
  8962. WSADATA wsaData;
  8963. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8964. }
  8965. ~WSInit() {
  8966. if (is_valid_) WSACleanup();
  8967. }
  8968. bool is_valid_ = false;
  8969. };
  8970. static WSInit wsinit_;
  8971. #endif
  8972. inline std::string unescape_quoted_pairs(const std::string &s) {
  8973. std::string out;
  8974. out.reserve(s.size());
  8975. for (size_t i = 0; i < s.size(); i++) {
  8976. if (s[i] == '\\' && i + 1 < s.size()) {
  8977. out += s[++i];
  8978. } else {
  8979. out += s[i];
  8980. }
  8981. }
  8982. return out;
  8983. }
  8984. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8985. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8986. // quoted-pair, so the recipient recovers the original value.
  8987. inline std::string escape_quoted_pairs(const std::string &s) {
  8988. std::string out;
  8989. out.reserve(s.size());
  8990. for (auto c : s) {
  8991. if (c == '\\' || c == '"') { out += '\\'; }
  8992. out += c;
  8993. }
  8994. return out;
  8995. }
  8996. // RFC 9110 Section 11.6.1 defines a challenge list as
  8997. // WWW-Authenticate = #challenge
  8998. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8999. // auth-param = token BWS "=" BWS ( token / quoted-string )
  9000. // so a server may offer several schemes, each with its own comma-separated
  9001. // auth-param list, in either order and either as separate field lines or
  9002. // packed into one. Splitting on every comma would break apart a challenge's
  9003. // own param list; splitting only on the first space would miss a Digest
  9004. // challenge that isn't first. Split on commas that aren't inside a
  9005. // quoted-string instead (split_unquoted), then track which scheme each
  9006. // resulting segment belongs to: a segment whose text before "=" contains
  9007. // whitespace (or that has no "=" at all) starts a new challenge named by its
  9008. // leading token.
  9009. inline bool parse_www_authenticate(const Response &res,
  9010. std::map<std::string, std::string> &auth,
  9011. bool is_proxy) {
  9012. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  9013. auto combined = get_combined_header_value(res.headers, auth_key);
  9014. if (combined.empty()) { return false; }
  9015. auto found_digest = false;
  9016. auto in_digest_challenge = false;
  9017. split_unquoted(
  9018. combined.data(), combined.data() + combined.size(), ',',
  9019. [&](const char *b, const char *e) {
  9020. std::string segment(b, e);
  9021. auto eq_pos = segment.find('=');
  9022. // BWS is allowed on both sides of "=", so the text naming the key (or,
  9023. // for the first segment of a challenge, "<scheme> <key>") must be
  9024. // trimmed before its boundaries are inspected.
  9025. auto key_part = trim_copy(
  9026. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  9027. auto space_pos = key_part.find_last_of(" \t");
  9028. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  9029. // "<scheme>[ <key>]" starts a new challenge.
  9030. auto scheme_end =
  9031. space_pos == std::string::npos ? key_part.size() : space_pos;
  9032. // RFC 7616 Section 3.7: a server may offer more than one Digest
  9033. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  9034. // from one challenge is never paired with another's algorithm.
  9035. in_digest_challenge =
  9036. !found_digest &&
  9037. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  9038. if (in_digest_challenge) { found_digest = true; }
  9039. if (space_pos == std::string::npos) {
  9040. // Bare scheme (or a token68), no auth-param on this segment.
  9041. return;
  9042. }
  9043. key_part = key_part.substr(space_pos + 1);
  9044. }
  9045. if (!in_digest_challenge) { return; }
  9046. auto val = trim_copy(segment.substr(eq_pos + 1));
  9047. auto unquoted = trim_double_quotes_copy(val);
  9048. if (unquoted.size() != val.size()) {
  9049. unquoted = unescape_quoted_pairs(unquoted);
  9050. }
  9051. auth[std::move(key_part)] = std::move(unquoted);
  9052. });
  9053. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  9054. // make_digest_authentication_header() dereferences both unconditionally, so
  9055. // a challenge missing either can't produce a usable Authorization header.
  9056. // Treat it the same as no Digest challenge at all.
  9057. return found_digest && auth.find("realm") != auth.end() &&
  9058. auth.find("nonce") != auth.end();
  9059. }
  9060. class ContentProviderAdapter {
  9061. public:
  9062. explicit ContentProviderAdapter(
  9063. ContentProviderWithoutLength &&content_provider)
  9064. : content_provider_(std::move(content_provider)) {}
  9065. bool operator()(size_t offset, size_t, DataSink &sink) {
  9066. return content_provider_(offset, sink);
  9067. }
  9068. private:
  9069. ContentProviderWithoutLength content_provider_;
  9070. };
  9071. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  9072. namespace fields {
  9073. inline bool is_token_char(char c) {
  9074. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  9075. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  9076. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  9077. }
  9078. inline bool is_token(const std::string &s) {
  9079. if (s.empty()) { return false; }
  9080. for (auto c : s) {
  9081. if (!is_token_char(c)) { return false; }
  9082. }
  9083. return true;
  9084. }
  9085. inline bool is_field_name(const std::string &s) { return is_token(s); }
  9086. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  9087. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  9088. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  9089. inline bool is_field_content(const std::string &s) {
  9090. if (s.empty()) { return true; }
  9091. if (s.size() == 1) {
  9092. return is_field_vchar(s[0]);
  9093. } else if (s.size() == 2) {
  9094. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  9095. } else {
  9096. size_t i = 0;
  9097. if (!is_field_vchar(s[i])) { return false; }
  9098. i++;
  9099. while (i < s.size() - 1) {
  9100. auto c = s[i++];
  9101. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  9102. } else {
  9103. return false;
  9104. }
  9105. }
  9106. return is_field_vchar(s[i]);
  9107. }
  9108. }
  9109. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  9110. inline bool is_field_valid(const std::string &name, const std::string &value) {
  9111. return is_field_name(name) && is_field_value(value);
  9112. }
  9113. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  9114. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  9115. inline bool is_request_target(const std::string &s) {
  9116. return std::all_of(s.begin(), s.end(), is_field_vchar);
  9117. }
  9118. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  9119. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  9120. inline bool is_host(const std::string &s) {
  9121. return std::all_of(s.begin(), s.end(), [](char c) {
  9122. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  9123. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9124. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9125. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  9126. });
  9127. }
  9128. } // namespace fields
  9129. // Built in memory first, like ClientImpl::write_request, so a rejected header
  9130. // never leaves a partial request on the wire.
  9131. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  9132. BufferStream bstrm;
  9133. if (write_request_line(bstrm, req.method, req.path) < 0) {
  9134. error = Error::Write;
  9135. return false;
  9136. }
  9137. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  9138. return false;
  9139. }
  9140. const auto &data = bstrm.get_buffer();
  9141. if (!write_data(strm, data.data(), data.size())) {
  9142. error = Error::Write;
  9143. return false;
  9144. }
  9145. return true;
  9146. }
  9147. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9148. WebSocketUpgradeResponse &upgrade) {
  9149. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9150. std::string key_bytes(16, '\0');
  9151. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9152. key_bytes.size());
  9153. auto client_key = base64_encode(key_bytes);
  9154. req.headers.erase("Upgrade");
  9155. req.headers.erase("Connection");
  9156. req.headers.erase("Sec-WebSocket-Key");
  9157. req.headers.erase("Sec-WebSocket-Version");
  9158. req.headers.emplace("Upgrade", "websocket");
  9159. req.headers.emplace("Connection", "Upgrade");
  9160. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9161. req.headers.emplace("Sec-WebSocket-Version", "13");
  9162. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9163. // Verify 101 response and Sec-WebSocket-Accept header
  9164. auto expected_accept = websocket_accept_key(client_key);
  9165. auto offered_subprotocols =
  9166. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9167. return read_websocket_upgrade_response(strm, expected_accept,
  9168. offered_subprotocols, upgrade);
  9169. }
  9170. inline bool is_ip_address(const std::string &host) {
  9171. struct in_addr addr4;
  9172. struct in6_addr addr6;
  9173. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9174. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9175. }
  9176. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9177. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9178. // else, including an address with a zone ID, is returned as it is.
  9179. inline std::string canonical_ip(const std::string &addr) {
  9180. struct in6_addr addr6;
  9181. if (addr.find('%') != std::string::npos ||
  9182. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9183. return addr;
  9184. }
  9185. char buf[INET6_ADDRSTRLEN];
  9186. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9187. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9188. : addr;
  9189. }
  9190. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9191. }
  9192. // `trusted_proxies` holds canonical_ip() spellings.
  9193. inline bool is_trusted_proxy(const std::string &addr,
  9194. const std::vector<std::string> &trusted_proxies) {
  9195. if (trusted_proxies.empty()) { return false; }
  9196. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9197. canonical_ip(addr)) != trusted_proxies.end();
  9198. }
  9199. // Resolve where a client should connect for `host`, honoring a user-supplied
  9200. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9201. // supplying the Host header and SNI; only the connection target changes.
  9202. //
  9203. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9204. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9205. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9206. // absent or empty mapping leaves `host` as the connection target; without the
  9207. // empty check the value would reach getaddrinfo as a null node and silently
  9208. // resolve to loopback.
  9209. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9210. const std::string &host, std::string &connect_host,
  9211. std::string &ip) {
  9212. connect_host = host;
  9213. ip.clear();
  9214. auto it = addr_map.find(host);
  9215. if (it == addr_map.end() || it->second.empty()) { return; }
  9216. if (is_ip_address(it->second)) {
  9217. ip = it->second;
  9218. } else {
  9219. connect_host = it->second;
  9220. }
  9221. }
  9222. } // namespace detail
  9223. /*
  9224. * Group 2: detail namespace - SSL common utilities
  9225. */
  9226. #ifdef CPPHTTPLIB_SSL_ENABLED
  9227. namespace detail {
  9228. class SSLSocketStream final : public Stream {
  9229. public:
  9230. SSLSocketStream(
  9231. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9232. time_t read_timeout_usec, time_t write_timeout_sec,
  9233. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9234. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9235. (std::chrono::steady_clock::time_point::min)());
  9236. ~SSLSocketStream() override;
  9237. bool is_readable() const override;
  9238. bool wait_readable() const override;
  9239. bool wait_writable() const override;
  9240. bool is_peer_alive() const override;
  9241. ssize_t read(char *ptr, size_t size) override;
  9242. ssize_t write(const char *ptr, size_t size) override;
  9243. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9244. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9245. socket_t socket() const override;
  9246. time_t duration() const override;
  9247. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9248. void set_max_timeout(time_t msec) override;
  9249. void set_read_interrupt(std::function<bool()> interrupted) override;
  9250. // See SocketStream::set_readable_hint().
  9251. void set_readable_hint() { readable_hint_ = true; }
  9252. // The error from the last read() or write() that failed in the TLS layer,
  9253. // with code Success if none did
  9254. const tls::TlsError &tls_error() const { return tls_error_; }
  9255. private:
  9256. bool ensure_readable();
  9257. socket_t sock_;
  9258. tls::session_t session_;
  9259. time_t read_timeout_sec_;
  9260. time_t read_timeout_usec_;
  9261. time_t write_timeout_sec_;
  9262. time_t write_timeout_usec_;
  9263. time_t max_timeout_msec_;
  9264. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9265. std::function<bool()> read_interrupted_;
  9266. bool readable_hint_ = false;
  9267. tls::TlsError tls_error_;
  9268. };
  9269. // A TLS stream for WebSocket connections, where the receive path and the
  9270. // send path (application send() plus the heartbeat ping thread) run on
  9271. // different threads. A single TLS session must never be entered
  9272. // concurrently, so every call into the session is serialized by one mutex.
  9273. //
  9274. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9275. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9276. // call under the lock, then waits for readiness with select() outside the
  9277. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9278. // blocked waiting for data never stalls a concurrent sender.
  9279. //
  9280. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9281. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9282. class WebSocketSSLStream final : public Stream {
  9283. public:
  9284. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9285. time_t read_timeout_sec, time_t read_timeout_usec,
  9286. time_t write_timeout_sec, time_t write_timeout_usec);
  9287. ~WebSocketSSLStream() override;
  9288. bool is_readable() const override;
  9289. bool wait_readable() const override;
  9290. bool wait_writable() const override;
  9291. ssize_t read(char *ptr, size_t size) override;
  9292. ssize_t write(const char *ptr, size_t size) override;
  9293. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9294. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9295. socket_t socket() const override;
  9296. time_t duration() const override;
  9297. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9298. void set_max_timeout(time_t msec) override;
  9299. void set_read_interrupt(std::function<bool()> interrupted) override;
  9300. private:
  9301. mutable std::mutex session_mutex_;
  9302. socket_t sock_;
  9303. tls::session_t session_;
  9304. // May change while another thread is in wait_readable(); write timeouts don't
  9305. std::atomic<time_t> read_timeout_sec_;
  9306. std::atomic<time_t> read_timeout_usec_;
  9307. time_t write_timeout_sec_;
  9308. time_t write_timeout_usec_;
  9309. std::atomic<time_t> max_timeout_msec_{0};
  9310. std::atomic<std::chrono::steady_clock::rep> start_time_;
  9311. std::function<bool()> read_interrupted_;
  9312. };
  9313. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9314. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9315. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9316. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9317. unsigned int hash_length = 0;
  9318. unsigned char hash[EVP_MAX_MD_SIZE];
  9319. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9320. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9321. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9322. std::stringstream ss;
  9323. for (auto i = 0u; i < hash_length; ++i) {
  9324. ss << std::hex << std::setw(2) << std::setfill('0')
  9325. << static_cast<unsigned int>(hash[i]);
  9326. }
  9327. return ss.str();
  9328. }
  9329. inline std::string MD5(const std::string &s) {
  9330. return message_digest(s, EVP_md5());
  9331. }
  9332. inline std::string SHA_256(const std::string &s) {
  9333. return message_digest(s, EVP_sha256());
  9334. }
  9335. inline std::string SHA_512(const std::string &s) {
  9336. return message_digest(s, EVP_sha512());
  9337. }
  9338. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9339. namespace {
  9340. template <size_t N>
  9341. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9342. std::stringstream ss;
  9343. for (size_t i = 0; i < N; ++i) {
  9344. ss << std::hex << std::setw(2) << std::setfill('0')
  9345. << static_cast<unsigned int>(hash[i]);
  9346. }
  9347. return ss.str();
  9348. }
  9349. } // namespace
  9350. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9351. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9352. // initialized once. PSA state is process-global; do not free it.
  9353. inline bool ensure_mbedtls_psa_crypto() {
  9354. static std::once_flag once;
  9355. static bool ok = false;
  9356. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9357. return ok;
  9358. }
  9359. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9360. unsigned char *out, size_t out_size) {
  9361. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9362. size_t olen = 0;
  9363. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9364. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9365. olen == out_size;
  9366. }
  9367. #endif
  9368. inline std::string MD5(const std::string &s) {
  9369. unsigned char hash[16];
  9370. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9371. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9372. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9373. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9374. hash);
  9375. #else
  9376. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9377. hash);
  9378. #endif
  9379. return hash_to_hex(hash);
  9380. }
  9381. inline std::string SHA_256(const std::string &s) {
  9382. unsigned char hash[32];
  9383. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9384. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9385. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9386. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9387. hash, 0);
  9388. #else
  9389. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9390. s.size(), hash, 0);
  9391. #endif
  9392. return hash_to_hex(hash);
  9393. }
  9394. inline std::string SHA_512(const std::string &s) {
  9395. unsigned char hash[64];
  9396. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9397. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9398. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9399. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9400. hash, 0);
  9401. #else
  9402. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9403. s.size(), hash, 0);
  9404. #endif
  9405. return hash_to_hex(hash);
  9406. }
  9407. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9408. namespace {
  9409. template <size_t N>
  9410. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9411. std::stringstream ss;
  9412. for (size_t i = 0; i < N; ++i) {
  9413. ss << std::hex << std::setw(2) << std::setfill('0')
  9414. << static_cast<unsigned int>(hash[i]);
  9415. }
  9416. return ss.str();
  9417. }
  9418. } // namespace
  9419. inline std::string MD5(const std::string &s) {
  9420. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9421. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9422. static_cast<word32>(s.size()), hash);
  9423. return hash_to_hex(hash);
  9424. }
  9425. inline std::string SHA_256(const std::string &s) {
  9426. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9427. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9428. static_cast<word32>(s.size()), hash);
  9429. return hash_to_hex(hash);
  9430. }
  9431. inline std::string SHA_512(const std::string &s) {
  9432. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9433. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9434. static_cast<word32>(s.size()), hash);
  9435. return hash_to_hex(hash);
  9436. }
  9437. #endif
  9438. template <typename T>
  9439. inline bool process_server_socket_ssl(
  9440. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9441. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9442. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9443. time_t write_timeout_usec, T callback) {
  9444. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9445. // of a pipelined request, which keep_alive() cannot see on the socket.
  9446. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9447. write_timeout_sec, write_timeout_usec);
  9448. return process_server_socket_core(
  9449. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9450. [&]() { return strm.is_readable(); },
  9451. [&](bool socket_readable, bool close_connection,
  9452. bool &connection_closed) {
  9453. if (socket_readable) { strm.set_readable_hint(); }
  9454. return callback(strm, close_connection, connection_closed);
  9455. });
  9456. }
  9457. template <typename T>
  9458. inline bool process_client_socket_ssl(
  9459. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9460. time_t read_timeout_usec, time_t write_timeout_sec,
  9461. time_t write_timeout_usec, time_t max_timeout_msec,
  9462. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9463. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9464. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9465. start_time);
  9466. return callback(strm);
  9467. }
  9468. // `uri` is req's request-target in origin form, as curl sends it, also when
  9469. // the request line carries the absolute form for a proxy.
  9470. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9471. const Request &req, const std::string &uri,
  9472. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9473. const std::string &cnonce, const std::string &username,
  9474. const std::string &password, bool is_proxy = false) {
  9475. std::string nc;
  9476. {
  9477. std::stringstream ss;
  9478. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9479. nc = ss.str();
  9480. }
  9481. std::string qop;
  9482. if (auth.find("qop") != auth.end()) {
  9483. qop = auth.at("qop");
  9484. if (qop.find("auth-int") != std::string::npos) {
  9485. qop = "auth-int";
  9486. } else if (qop.find("auth") != std::string::npos) {
  9487. qop = "auth";
  9488. } else {
  9489. qop.clear();
  9490. }
  9491. }
  9492. std::string algo = "MD5";
  9493. if (auth.find("algorithm") != auth.end()) {
  9494. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9495. // not a token would otherwise be emitted verbatim and could carry commas
  9496. // or quotes that inject further auth-params into the header below.
  9497. const auto &a = auth.at("algorithm");
  9498. if (fields::is_token(a)) { algo = a; }
  9499. }
  9500. std::string response;
  9501. {
  9502. auto H = algo == "SHA-256" ? detail::SHA_256
  9503. : algo == "SHA-512" ? detail::SHA_512
  9504. : detail::MD5;
  9505. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9506. auto A2 = req.method + ":" + uri;
  9507. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9508. if (qop.empty()) {
  9509. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9510. } else {
  9511. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9512. ":" + qop + ":" + H(A2));
  9513. }
  9514. }
  9515. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9516. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9517. // close the string early. realm, nonce and opaque come straight from the
  9518. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9519. // without this a crafted challenge injects extra auth-params into the header.
  9520. auto field =
  9521. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9522. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9523. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9524. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9525. "\", algorithm=" + algo +
  9526. (qop.empty() ? ", response=\""
  9527. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9528. "\", response=\"") +
  9529. response + "\"" +
  9530. (opaque.empty()
  9531. ? ""
  9532. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9533. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9534. return std::make_pair(key, field);
  9535. }
  9536. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9537. // backend accepts the same names.
  9538. inline bool match_hostname(const std::string &pattern,
  9539. const std::string &hostname) {
  9540. // A trailing dot on the host is ignored
  9541. auto host = hostname;
  9542. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9543. // Exact match (case-insensitive)
  9544. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9545. // Split both pattern and hostname into components by '.', keeping any empty
  9546. // one, which no name may have
  9547. auto labels = [](const std::string &s) {
  9548. std::vector<std::string> v;
  9549. size_t b = 0;
  9550. while (true) {
  9551. auto e = s.find('.', b);
  9552. v.push_back(s.substr(b, e - b));
  9553. if (e == std::string::npos) { return v; }
  9554. b = e + 1;
  9555. }
  9556. };
  9557. auto pattern_components = labels(pattern);
  9558. auto host_components = labels(host);
  9559. auto has_empty_label = [](const std::vector<std::string> &v) {
  9560. return std::any_of(v.begin(), v.end(),
  9561. [](const std::string &l) { return l.empty(); });
  9562. };
  9563. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9564. return false;
  9565. }
  9566. // Component count must match
  9567. if (host_components.size() != pattern_components.size()) { return false; }
  9568. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9569. // and an IDNA label may not have one
  9570. const auto &leftmost = pattern_components.front();
  9571. if (leftmost.find('*') != std::string::npos &&
  9572. (pattern_components.size() < 3 ||
  9573. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9574. return false;
  9575. }
  9576. // Compare each component with wildcard support
  9577. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9578. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9579. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9580. auto itr = pattern_components.begin();
  9581. for (const auto &h : host_components) {
  9582. auto &p = *itr;
  9583. auto is_leftmost = itr == pattern_components.begin();
  9584. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9585. bool partial_match = false;
  9586. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9587. const auto prefix_length = p.size() - 1;
  9588. if (prefix_length == 0) {
  9589. partial_match = true;
  9590. } else if (h.size() >= prefix_length) {
  9591. partial_match =
  9592. std::equal(p.begin(),
  9593. p.begin() + static_cast<std::string::difference_type>(
  9594. prefix_length),
  9595. h.begin(), [](const char ca, const char cb) {
  9596. return detail::case_ignore::to_lower(ca) ==
  9597. detail::case_ignore::to_lower(cb);
  9598. });
  9599. }
  9600. }
  9601. if (!partial_match) { return false; }
  9602. }
  9603. ++itr;
  9604. }
  9605. return true;
  9606. }
  9607. #ifdef _WIN32
  9608. // Verify certificate using Windows CertGetCertificateChain API.
  9609. // This provides real-time certificate validation with Windows Update
  9610. // integration, independent of the TLS backend.
  9611. inline bool verify_cert_with_windows_schannel(
  9612. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9613. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9614. if (der_cert.empty()) { return false; }
  9615. out_error = 0;
  9616. // Create Windows certificate context from DER data
  9617. auto cert_context = CertCreateCertificateContext(
  9618. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9619. static_cast<DWORD>(der_cert.size()));
  9620. if (!cert_context) {
  9621. out_error = GetLastError();
  9622. return false;
  9623. }
  9624. auto cert_guard =
  9625. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9626. // Give CryptoAPI the certificates the server sent. Without them it follows
  9627. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9628. std::vector<tls::cert_t> peer_certs;
  9629. tls::get_peer_certs(session, peer_certs);
  9630. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9631. auto store_guard = scope_exit([&] {
  9632. for (auto cert : peer_certs) {
  9633. tls::free_cert(cert);
  9634. }
  9635. if (store) { CertCloseStore(store, 0); }
  9636. });
  9637. for (auto cert : peer_certs) {
  9638. std::vector<unsigned char> der;
  9639. if (store && tls::get_cert_der(cert, der)) {
  9640. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9641. static_cast<DWORD>(der.size()),
  9642. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9643. }
  9644. }
  9645. // Setup chain parameters
  9646. CERT_CHAIN_PARA chain_para = {};
  9647. chain_para.cbSize = sizeof(chain_para);
  9648. // Require the server authentication usage along the chain, which also
  9649. // rejects roots that Windows trusts only for other purposes.
  9650. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9651. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9652. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9653. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9654. // Build certificate chain with revocation checking
  9655. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9656. auto chain_result = CertGetCertificateChain(
  9657. nullptr, cert_context, nullptr, store, &chain_para,
  9658. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9659. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9660. nullptr, &chain_context);
  9661. if (!chain_result || !chain_context) {
  9662. out_error = GetLastError();
  9663. return false;
  9664. }
  9665. auto chain_guard =
  9666. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9667. // Verify SSL policy
  9668. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9669. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9670. #ifdef AUTHTYPE_SERVER
  9671. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9672. #endif
  9673. std::wstring whost;
  9674. if (verify_hostname) {
  9675. whost = u8string_to_wstring(hostname.c_str());
  9676. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9677. }
  9678. CERT_CHAIN_POLICY_PARA policy_para = {};
  9679. policy_para.cbSize = sizeof(policy_para);
  9680. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9681. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9682. #else
  9683. policy_para.dwFlags = 0;
  9684. #endif
  9685. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9686. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9687. policy_status.cbSize = sizeof(policy_status);
  9688. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9689. &policy_para, &policy_status)) {
  9690. out_error = GetLastError();
  9691. return false;
  9692. }
  9693. if (policy_status.dwError != 0) {
  9694. out_error = policy_status.dwError;
  9695. return false;
  9696. }
  9697. return true;
  9698. }
  9699. #endif // _WIN32
  9700. // Loads CA file/dir configuration and applies the system CA policy to a
  9701. // client TLS context. PEM data and native stores are applied to the context
  9702. // directly at set time; has_custom_store reflects them for the Auto policy
  9703. // decision.
  9704. inline bool load_client_ca_config(tls::ctx_t ctx,
  9705. const std::string &ca_cert_file_path,
  9706. const std::string &ca_cert_dir_path,
  9707. bool has_custom_store, SystemCAMode mode,
  9708. uint64_t &backend_error) {
  9709. auto ret = true;
  9710. if (!ca_cert_file_path.empty()) {
  9711. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9712. backend_error = tls::get_error();
  9713. ret = false;
  9714. }
  9715. } else if (!ca_cert_dir_path.empty()) {
  9716. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9717. backend_error = tls::get_error();
  9718. ret = false;
  9719. }
  9720. }
  9721. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9722. !ca_cert_dir_path.empty() || has_custom_store;
  9723. if (mode == SystemCAMode::Enabled ||
  9724. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9725. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9726. }
  9727. return ret;
  9728. }
  9729. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9730. // Schannel is skipped when a custom CA is specified, as the Windows
  9731. // certificate store would not know about it, and when system CA trust is
  9732. // explicitly disabled.
  9733. inline bool use_windows_cert_verification(bool enabled,
  9734. const std::string &ca_cert_file_path,
  9735. const std::string &ca_cert_dir_path,
  9736. bool has_custom_store,
  9737. SystemCAMode mode) {
  9738. return enabled && mode != SystemCAMode::Disabled &&
  9739. ca_cert_file_path.empty() && ca_cert_dir_path.empty() &&
  9740. !has_custom_store;
  9741. }
  9742. #endif
  9743. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9744. // loaded into another context.
  9745. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9746. std::string pem;
  9747. std::vector<tls::cert_t> certs;
  9748. tls::get_ca_certs(ctx, certs);
  9749. for (auto cert : certs) {
  9750. std::vector<unsigned char> der;
  9751. if (tls::get_cert_der(cert, der)) {
  9752. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9753. pem += "-----BEGIN CERTIFICATE-----\n";
  9754. for (size_t i = 0; i < b64.size(); i += 64) {
  9755. pem += b64.substr(i, 64);
  9756. pem += '\n';
  9757. }
  9758. pem += "-----END CERTIFICATE-----\n";
  9759. }
  9760. tls::free_cert(cert);
  9761. }
  9762. return pem;
  9763. }
  9764. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9765. // copied to buf, or pem itself when len is 0.
  9766. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9767. if (!pem || len == 0) { return pem; }
  9768. buf.assign(pem, len);
  9769. return buf.c_str();
  9770. }
  9771. // The parts of session setup that only SSLClient needs, plus the handful
  9772. // WebSocketClient also exposes; everything else takes the defaults, which is
  9773. // what keeps the two clients on one implementation.
  9774. struct ClientTlsSessionOptions {
  9775. // Both SSLClient and WebSocketClient expose this independently of
  9776. // certificate verification.
  9777. bool server_hostname_verification = true;
  9778. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9779. // When set, ends the handshake as a timeout does once it returns true
  9780. std::function<bool()> interrupted;
  9781. // When non-null, guards session creation against concurrent use of the
  9782. // context. A WebSocketClient is not safe to use from several threads to
  9783. // begin with, so it passes nothing.
  9784. std::mutex *ctx_mutex = nullptr;
  9785. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9786. // See use_windows_cert_verification().
  9787. bool windows_cert_verification = false;
  9788. // A server certificate verifier works on the backend's chain verification,
  9789. // so the backend keeps deciding and Schannel only adds its own check.
  9790. bool server_certificate_verifier_set = false;
  9791. #endif
  9792. };
  9793. // Filled in on failure for callers that report error details.
  9794. struct ClientTlsSessionError {
  9795. Error error = Error::Success;
  9796. int ssl_error = 0;
  9797. uint64_t backend_error = 0;
  9798. };
  9799. // Establishes a client TLS session on an already connected socket. On failure
  9800. // the session is left for the caller to free: SSLClient frees it right away,
  9801. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9802. inline bool setup_client_tls_session(
  9803. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9804. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9805. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9806. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9807. using namespace tls;
  9808. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9809. if (out_error) {
  9810. out_error->error = error;
  9811. out_error->ssl_error = ssl_error;
  9812. out_error->backend_error = backend_error;
  9813. }
  9814. return false;
  9815. };
  9816. // A TLS failure, whose verification codes name the Error too
  9817. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9818. auto error = Error::SSLConnection;
  9819. if (code == ErrorCode::CertVerifyFailed) {
  9820. error = Error::SSLServerVerification;
  9821. } else if (code == ErrorCode::HostnameMismatch) {
  9822. error = Error::SSLServerHostnameVerification;
  9823. }
  9824. return fail(error, static_cast<int>(code), backend_error);
  9825. };
  9826. if (!ctx) {
  9827. session = nullptr;
  9828. return fail(Error::SSLConnection, 0, 0);
  9829. }
  9830. // With Windows verification on and no server certificate verifier set,
  9831. // Schannel is the only chain verifier. The backend's trust store is a
  9832. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9833. // demand, so the backend's verdict is not used.
  9834. auto windows_verifies_chain = false;
  9835. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9836. windows_verifies_chain = options.windows_cert_verification &&
  9837. !options.server_certificate_verifier_set;
  9838. #endif
  9839. // The chain, and a host name, are verified during the handshake, so that a
  9840. // server failing them never gets to see a client certificate. Unless
  9841. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9842. // identity is checked after the handshake by verify_hostname().
  9843. auto verify_in_handshake =
  9844. server_certificate_verification && !windows_verifies_chain;
  9845. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9846. // A session verifier may accept a certificate the built-in check rejects,
  9847. // and runs only after the handshake
  9848. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9849. #endif
  9850. {
  9851. std::unique_lock<std::mutex> guard;
  9852. if (options.ctx_mutex) {
  9853. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9854. }
  9855. // The mode is set on the context, so under the same lock
  9856. set_verify_client(ctx, verify_in_handshake);
  9857. session = create_session(ctx, sock);
  9858. }
  9859. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9860. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9861. // their identity is checked post-handshake below instead.
  9862. if (!is_ip_address(host)) {
  9863. if (!set_sni(session, host.c_str(),
  9864. verify_in_handshake && options.server_hostname_verification)) {
  9865. return fail(Error::SSLConnection, 0, get_error());
  9866. }
  9867. }
  9868. TlsError tls_err;
  9869. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec, &tls_err,
  9870. options.interrupted)) {
  9871. return fail_tls(tls_err.code, tls_err.backend_code);
  9872. }
  9873. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9874. if (options.session_verifier) {
  9875. verification_status = options.session_verifier(session);
  9876. }
  9877. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9878. return fail(Error::SSLServerVerification, 0, get_error());
  9879. }
  9880. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9881. server_certificate_verification) {
  9882. if (!windows_verifies_chain) {
  9883. auto verify_result = get_verify_result(session);
  9884. if (verify_result != 0) {
  9885. return fail_tls(ErrorCode::CertVerifyFailed,
  9886. static_cast<uint64_t>(verify_result));
  9887. }
  9888. }
  9889. auto server_cert = get_peer_cert(session);
  9890. if (!server_cert) {
  9891. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9892. }
  9893. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9894. // Identity check against the peer certificate, post-handshake for all
  9895. // backends. For IP hosts this is the only identity verification, since no
  9896. // hostname is bound during the handshake.
  9897. if (options.server_hostname_verification) {
  9898. if (!verify_hostname(server_cert, host.c_str())) {
  9899. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9900. }
  9901. }
  9902. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9903. // Windows Schannel verification, which lets Windows fetch missing roots
  9904. // and intermediates on demand. It must not be skipped: unless a server
  9905. // certificate verifier is set, it is the only chain check.
  9906. if (options.windows_cert_verification) {
  9907. std::vector<unsigned char> der;
  9908. uint64_t wincrypt_error = 0;
  9909. if (!get_cert_der(server_cert, der) ||
  9910. !verify_cert_with_windows_schannel(
  9911. der, host, options.server_hostname_verification, wincrypt_error,
  9912. session)) {
  9913. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9914. }
  9915. }
  9916. #endif
  9917. }
  9918. return true;
  9919. }
  9920. } // namespace detail
  9921. #endif // CPPHTTPLIB_SSL_ENABLED
  9922. /*
  9923. * Group 3: httplib namespace - Non-SSL public API implementations
  9924. */
  9925. inline void default_socket_options(socket_t sock) {
  9926. set_socket_opt(sock, SOL_SOCKET,
  9927. #ifdef SO_REUSEPORT
  9928. SO_REUSEPORT,
  9929. #else
  9930. SO_REUSEADDR,
  9931. #endif
  9932. 1);
  9933. }
  9934. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9935. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9936. sizeof(optval));
  9937. }
  9938. inline std::string get_bearer_token_auth(const Request &req) {
  9939. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9940. // than the prefix carries no token.
  9941. constexpr const char bearer_prefix[] = "Bearer ";
  9942. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9943. auto value = req.get_header_value("Authorization");
  9944. if (value.size() >= bearer_prefix_len &&
  9945. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9946. bearer_prefix)) {
  9947. return value.substr(bearer_prefix_len);
  9948. }
  9949. return "";
  9950. }
  9951. inline const char *status_message(int status) {
  9952. switch (status) {
  9953. case StatusCode::Continue_100: return "Continue";
  9954. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9955. case StatusCode::Processing_102: return "Processing";
  9956. case StatusCode::EarlyHints_103: return "Early Hints";
  9957. case StatusCode::OK_200: return "OK";
  9958. case StatusCode::Created_201: return "Created";
  9959. case StatusCode::Accepted_202: return "Accepted";
  9960. case StatusCode::NonAuthoritativeInformation_203:
  9961. return "Non-Authoritative Information";
  9962. case StatusCode::NoContent_204: return "No Content";
  9963. case StatusCode::ResetContent_205: return "Reset Content";
  9964. case StatusCode::PartialContent_206: return "Partial Content";
  9965. case StatusCode::MultiStatus_207: return "Multi-Status";
  9966. case StatusCode::AlreadyReported_208: return "Already Reported";
  9967. case StatusCode::IMUsed_226: return "IM Used";
  9968. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9969. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9970. case StatusCode::Found_302: return "Found";
  9971. case StatusCode::SeeOther_303: return "See Other";
  9972. case StatusCode::NotModified_304: return "Not Modified";
  9973. case StatusCode::UseProxy_305: return "Use Proxy";
  9974. case StatusCode::unused_306: return "unused";
  9975. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9976. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9977. case StatusCode::BadRequest_400: return "Bad Request";
  9978. case StatusCode::Unauthorized_401: return "Unauthorized";
  9979. case StatusCode::PaymentRequired_402: return "Payment Required";
  9980. case StatusCode::Forbidden_403: return "Forbidden";
  9981. case StatusCode::NotFound_404: return "Not Found";
  9982. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9983. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9984. case StatusCode::ProxyAuthenticationRequired_407:
  9985. return "Proxy Authentication Required";
  9986. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9987. case StatusCode::Conflict_409: return "Conflict";
  9988. case StatusCode::Gone_410: return "Gone";
  9989. case StatusCode::LengthRequired_411: return "Length Required";
  9990. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9991. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9992. case StatusCode::UriTooLong_414: return "URI Too Long";
  9993. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9994. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9995. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9996. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9997. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9998. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9999. case StatusCode::Locked_423: return "Locked";
  10000. case StatusCode::FailedDependency_424: return "Failed Dependency";
  10001. case StatusCode::TooEarly_425: return "Too Early";
  10002. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  10003. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  10004. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  10005. case StatusCode::RequestHeaderFieldsTooLarge_431:
  10006. return "Request Header Fields Too Large";
  10007. case StatusCode::UnavailableForLegalReasons_451:
  10008. return "Unavailable For Legal Reasons";
  10009. case StatusCode::NotImplemented_501: return "Not Implemented";
  10010. case StatusCode::BadGateway_502: return "Bad Gateway";
  10011. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  10012. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  10013. case StatusCode::HttpVersionNotSupported_505:
  10014. return "HTTP Version Not Supported";
  10015. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  10016. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  10017. case StatusCode::LoopDetected_508: return "Loop Detected";
  10018. case StatusCode::NotExtended_510: return "Not Extended";
  10019. case StatusCode::NetworkAuthenticationRequired_511:
  10020. return "Network Authentication Required";
  10021. default:
  10022. case StatusCode::InternalServerError_500: return "Internal Server Error";
  10023. }
  10024. }
  10025. inline std::string to_string(const Error error) {
  10026. switch (error) {
  10027. case Error::Success: return "Success (no error)";
  10028. case Error::Unknown: return "Unknown";
  10029. case Error::Connection: return "Could not establish connection";
  10030. case Error::BindIPAddress: return "Failed to bind IP address";
  10031. case Error::Read: return "Failed to read connection";
  10032. case Error::Write: return "Failed to write connection";
  10033. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  10034. case Error::Canceled: return "Connection handling canceled";
  10035. case Error::SSLConnection: return "SSL connection failed";
  10036. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  10037. case Error::SSLServerVerification: return "SSL server verification failed";
  10038. case Error::SSLServerHostnameVerification:
  10039. return "SSL server hostname verification failed";
  10040. case Error::UnsupportedMultipartBoundaryChars:
  10041. return "Unsupported HTTP multipart boundary characters";
  10042. case Error::Compression: return "Compression failed";
  10043. case Error::ConnectionTimeout: return "Connection timed out";
  10044. case Error::ProxyConnection: return "Proxy connection failed";
  10045. case Error::ConnectionClosed: return "Connection closed by server";
  10046. case Error::Timeout: return "Read timeout";
  10047. case Error::ResourceExhaustion: return "Resource exhaustion";
  10048. case Error::TooManyFormDataFiles: return "Too many form data files";
  10049. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  10050. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  10051. case Error::ExceedMaxSocketDescriptorCount:
  10052. return "Exceeded maximum socket descriptor count";
  10053. case Error::InvalidRequestLine: return "Invalid request line";
  10054. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  10055. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  10056. case Error::InvalidHeaders: return "Invalid headers";
  10057. case Error::MultipartParsing: return "Multipart parsing failed";
  10058. case Error::OpenFile: return "Failed to open file";
  10059. case Error::Listen: return "Failed to listen on socket";
  10060. case Error::GetSockName: return "Failed to get socket name";
  10061. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  10062. case Error::HTTPParsing: return "HTTP parsing failed";
  10063. case Error::InvalidRangeHeader: return "Invalid Range header";
  10064. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  10065. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  10066. case Error::UserCallbackException: return "User callback threw an exception";
  10067. default: break;
  10068. }
  10069. return "Invalid";
  10070. }
  10071. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  10072. os << to_string(obj);
  10073. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  10074. return os;
  10075. }
  10076. inline std::string hosted_at(const std::string &hostname) {
  10077. std::vector<std::string> addrs;
  10078. hosted_at(hostname, addrs);
  10079. if (addrs.empty()) { return std::string(); }
  10080. return addrs[0];
  10081. }
  10082. inline void hosted_at(const std::string &hostname,
  10083. std::vector<std::string> &addrs) {
  10084. struct addrinfo hints;
  10085. struct addrinfo *result;
  10086. memset(&hints, 0, sizeof(struct addrinfo));
  10087. hints.ai_family = AF_UNSPEC;
  10088. hints.ai_socktype = SOCK_STREAM;
  10089. hints.ai_protocol = 0;
  10090. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  10091. &result, 0)) {
  10092. #if defined __linux__ && !defined __ANDROID__
  10093. res_init();
  10094. #endif
  10095. return;
  10096. }
  10097. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  10098. for (auto rp = result; rp; rp = rp->ai_next) {
  10099. const auto &addr =
  10100. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  10101. std::string ip;
  10102. auto dummy = -1;
  10103. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  10104. dummy)) {
  10105. addrs.emplace_back(std::move(ip));
  10106. }
  10107. }
  10108. }
  10109. inline std::string encode_uri_component(const std::string &value) {
  10110. std::ostringstream escaped;
  10111. escaped.fill('0');
  10112. escaped << std::hex;
  10113. for (auto c : value) {
  10114. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10115. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  10116. escaped << c;
  10117. } else {
  10118. escaped << std::uppercase;
  10119. escaped << '%' << std::setw(2)
  10120. << static_cast<int>(static_cast<unsigned char>(c));
  10121. escaped << std::nouppercase;
  10122. }
  10123. }
  10124. return escaped.str();
  10125. }
  10126. inline std::string encode_uri(const std::string &value) {
  10127. std::ostringstream escaped;
  10128. escaped.fill('0');
  10129. escaped << std::hex;
  10130. for (auto c : value) {
  10131. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10132. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  10133. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  10134. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  10135. escaped << c;
  10136. } else {
  10137. escaped << std::uppercase;
  10138. escaped << '%' << std::setw(2)
  10139. << static_cast<int>(static_cast<unsigned char>(c));
  10140. escaped << std::nouppercase;
  10141. }
  10142. }
  10143. return escaped.str();
  10144. }
  10145. inline std::string decode_uri_component(const std::string &value) {
  10146. std::string result;
  10147. for (size_t i = 0; i < value.size(); i++) {
  10148. if (value[i] == '%' && i + 2 < value.size()) {
  10149. auto val = 0;
  10150. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10151. result += static_cast<char>(val);
  10152. i += 2;
  10153. } else {
  10154. result += value[i];
  10155. }
  10156. } else {
  10157. result += value[i];
  10158. }
  10159. }
  10160. return result;
  10161. }
  10162. inline std::string decode_uri(const std::string &value) {
  10163. std::string result;
  10164. for (size_t i = 0; i < value.size(); i++) {
  10165. if (value[i] == '%' && i + 2 < value.size()) {
  10166. auto val = 0;
  10167. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10168. auto c = static_cast<char>(val);
  10169. // Keep escapes of the reserved characters that encode_uri leaves
  10170. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10171. // delimiter is not promoted into a real one (as with JS decodeURI).
  10172. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10173. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10174. c == '#') {
  10175. result += value[i];
  10176. result += value[i + 1];
  10177. result += value[i + 2];
  10178. } else {
  10179. result += c;
  10180. }
  10181. i += 2;
  10182. } else {
  10183. result += value[i];
  10184. }
  10185. } else {
  10186. result += value[i];
  10187. }
  10188. }
  10189. return result;
  10190. }
  10191. inline std::string encode_path_component(const std::string &component) {
  10192. std::string result;
  10193. result.reserve(component.size() * 3);
  10194. for (size_t i = 0; i < component.size(); i++) {
  10195. auto c = static_cast<unsigned char>(component[i]);
  10196. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10197. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10198. c == '_' || c == '~') {
  10199. result += static_cast<char>(c);
  10200. }
  10201. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10202. // "," / ";" / "="
  10203. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10204. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10205. c == '=') {
  10206. result += static_cast<char>(c);
  10207. }
  10208. // Colon is allowed in path segments except first segment
  10209. else if (c == ':') {
  10210. result += static_cast<char>(c);
  10211. }
  10212. // @ is allowed in path
  10213. else if (c == '@') {
  10214. result += static_cast<char>(c);
  10215. } else {
  10216. result += '%';
  10217. char hex[3];
  10218. snprintf(hex, sizeof(hex), "%02X", c);
  10219. result.append(hex, 2);
  10220. }
  10221. }
  10222. return result;
  10223. }
  10224. inline std::string decode_path_component(const std::string &component) {
  10225. std::string result;
  10226. result.reserve(component.size());
  10227. for (size_t i = 0; i < component.size(); i++) {
  10228. if (component[i] == '%' && i + 1 < component.size()) {
  10229. if (component[i + 1] == 'u') {
  10230. // Unicode %uXXXX encoding
  10231. auto val = 0;
  10232. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10233. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10234. char buff[4];
  10235. size_t len = 0;
  10236. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10237. (len = detail::to_utf8(val, buff)) > 0) {
  10238. result.append(buff, len);
  10239. i += 5; // 'u0000'
  10240. } else {
  10241. // Not 4 hex digits, or a surrogate, which is no character: the
  10242. // escape is kept as it is rather than joining its neighbours
  10243. result += component[i];
  10244. }
  10245. } else {
  10246. // Standard %XX encoding
  10247. auto val = 0;
  10248. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10249. // 2 digits hex codes
  10250. result += static_cast<char>(val);
  10251. i += 2; // 'XX'
  10252. } else {
  10253. result += component[i];
  10254. }
  10255. }
  10256. } else {
  10257. result += component[i];
  10258. }
  10259. }
  10260. return result;
  10261. }
  10262. inline std::string encode_query_component(const std::string &component,
  10263. bool space_as_plus) {
  10264. std::string result;
  10265. result.reserve(component.size() * 3);
  10266. for (size_t i = 0; i < component.size(); i++) {
  10267. auto c = static_cast<unsigned char>(component[i]);
  10268. // Unreserved characters per RFC 3986
  10269. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10270. c == '_' || c == '~') {
  10271. result += static_cast<char>(c);
  10272. }
  10273. // Space handling
  10274. else if (c == ' ') {
  10275. if (space_as_plus) {
  10276. result += '+';
  10277. } else {
  10278. result += "%20";
  10279. }
  10280. }
  10281. // Plus sign handling
  10282. else if (c == '+') {
  10283. if (space_as_plus) {
  10284. result += "%2B";
  10285. } else {
  10286. result += static_cast<char>(c);
  10287. }
  10288. }
  10289. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10290. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10291. c == '*' || c == ',' || c == ';') {
  10292. result += static_cast<char>(c);
  10293. }
  10294. // Colon and @ are allowed in query
  10295. else if (c == ':' || c == '@') {
  10296. result += static_cast<char>(c);
  10297. }
  10298. // Forward slash is allowed in query values
  10299. else if (c == '/') {
  10300. result += static_cast<char>(c);
  10301. }
  10302. // Question mark is allowed in query values (after first ?)
  10303. else if (c == '?') {
  10304. result += static_cast<char>(c);
  10305. } else {
  10306. result += '%';
  10307. char hex[3];
  10308. snprintf(hex, sizeof(hex), "%02X", c);
  10309. result.append(hex, 2);
  10310. }
  10311. }
  10312. return result;
  10313. }
  10314. inline std::string decode_query_component(const std::string &component,
  10315. bool plus_as_space) {
  10316. std::string result;
  10317. result.reserve(component.size());
  10318. for (size_t i = 0; i < component.size(); i++) {
  10319. if (component[i] == '%' && i + 2 < component.size()) {
  10320. auto val = 0;
  10321. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10322. result += static_cast<char>(val);
  10323. i += 2;
  10324. } else {
  10325. result += component[i];
  10326. }
  10327. } else if (component[i] == '+' && plus_as_space) {
  10328. result += ' '; // + becomes space in form-urlencoded
  10329. } else {
  10330. result += component[i];
  10331. }
  10332. }
  10333. return result;
  10334. }
  10335. inline std::string sanitize_filename(const std::string &filename) {
  10336. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10337. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10338. #ifdef _WIN32
  10339. auto pos = filename.find_last_of("/\\:");
  10340. #else
  10341. auto pos = filename.find_last_of("/\\");
  10342. #endif
  10343. auto result =
  10344. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10345. // Strip null bytes
  10346. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10347. // Trim whitespace
  10348. {
  10349. auto start = result.find_first_not_of(" \t");
  10350. auto end = result.find_last_not_of(" \t");
  10351. result = (start == std::string::npos)
  10352. ? ""
  10353. : result.substr(start, end - start + 1);
  10354. }
  10355. // Reject . and ..
  10356. if (result == "." || result == "..") { return ""; }
  10357. return result;
  10358. }
  10359. inline std::string append_query_params(const std::string &path,
  10360. const Params &params) {
  10361. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10362. auto fragment_pos = path.find('#');
  10363. auto path_with_query = path.substr(0, fragment_pos);
  10364. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10365. path_with_query += detail::params_to_query_str(params);
  10366. if (fragment_pos != std::string::npos) {
  10367. path_with_query.append(path, fragment_pos, std::string::npos);
  10368. }
  10369. return path_with_query;
  10370. }
  10371. // Header utilities
  10372. inline std::pair<std::string, std::string>
  10373. make_range_header(const Ranges &ranges) {
  10374. std::string field = "bytes=";
  10375. auto i = 0;
  10376. for (const auto &r : ranges) {
  10377. if (i != 0) { field += ", "; }
  10378. if (r.first != -1) { field += std::to_string(r.first); }
  10379. field += '-';
  10380. if (r.second != -1) { field += std::to_string(r.second); }
  10381. i++;
  10382. }
  10383. return std::make_pair("Range", std::move(field));
  10384. }
  10385. inline std::pair<std::string, std::string>
  10386. make_basic_authentication_header(const std::string &username,
  10387. const std::string &password, bool is_proxy) {
  10388. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10389. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10390. return std::make_pair(key, std::move(field));
  10391. }
  10392. inline std::pair<std::string, std::string>
  10393. make_bearer_token_authentication_header(const std::string &token,
  10394. bool is_proxy = false) {
  10395. auto field = "Bearer " + token;
  10396. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10397. return std::make_pair(key, std::move(field));
  10398. }
  10399. namespace detail {
  10400. // Basic auth when a username or password is set, otherwise a bearer token,
  10401. // unless the request already carries the header.
  10402. inline void add_authorization_header(Request &req, const std::string &username,
  10403. const std::string &password,
  10404. const std::string &token, bool is_proxy) {
  10405. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10406. return;
  10407. }
  10408. if (!username.empty() || !password.empty()) {
  10409. req.headers.insert(
  10410. make_basic_authentication_header(username, password, is_proxy));
  10411. } else if (!token.empty()) {
  10412. req.headers.insert(
  10413. make_bearer_token_authentication_header(token, is_proxy));
  10414. }
  10415. }
  10416. } // namespace detail
  10417. // Request implementation
  10418. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10419. size_t id) const {
  10420. return detail::get_header_value_u64(headers, key, def, id);
  10421. }
  10422. inline bool Request::has_header(const std::string &key) const {
  10423. return detail::has_header(headers, key);
  10424. }
  10425. inline std::string Request::get_header_value(const std::string &key,
  10426. const char *def, size_t id) const {
  10427. return detail::get_header_value(headers, key, def, id);
  10428. }
  10429. inline size_t Request::get_header_value_count(const std::string &key) const {
  10430. return detail::get_header_value_count(headers, key);
  10431. }
  10432. inline void Request::set_header(const std::string &key,
  10433. const std::string &val) {
  10434. detail::set_header(headers, key, val);
  10435. }
  10436. inline bool Request::has_trailer(const std::string &key) const {
  10437. return trailers.find(key) != trailers.end();
  10438. }
  10439. inline std::string Request::get_trailer_value(const std::string &key,
  10440. size_t id) const {
  10441. return detail::get_multimap_value(trailers, key, id);
  10442. }
  10443. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10444. return trailers.count(key);
  10445. }
  10446. inline bool Request::has_param(const std::string &key) const {
  10447. return params.find(key) != params.end();
  10448. }
  10449. inline std::string Request::get_param_value(const std::string &key,
  10450. size_t id) const {
  10451. return detail::get_multimap_value(params, key, id);
  10452. }
  10453. inline std::vector<std::string>
  10454. Request::get_param_values(const std::string &key) const {
  10455. auto rng = params.equal_range(key);
  10456. std::vector<std::string> values;
  10457. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10458. for (auto it = rng.first; it != rng.second; ++it) {
  10459. values.push_back(it->second);
  10460. }
  10461. return values;
  10462. }
  10463. inline size_t Request::get_param_value_count(const std::string &key) const {
  10464. return params.count(key);
  10465. }
  10466. inline bool Request::is_multipart_form_data() const {
  10467. const auto &content_type = get_header_value("Content-Type");
  10468. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10469. "multipart/form-data");
  10470. }
  10471. // Multipart FormData implementation
  10472. inline std::string MultipartFormData::get_field(const std::string &key,
  10473. size_t id) const {
  10474. auto rng = fields.equal_range(key);
  10475. auto it = detail::bounded_next(rng.first, id, rng.second);
  10476. if (it != rng.second) { return it->second.content; }
  10477. return std::string();
  10478. }
  10479. inline std::vector<std::string>
  10480. MultipartFormData::get_fields(const std::string &key) const {
  10481. std::vector<std::string> values;
  10482. auto rng = fields.equal_range(key);
  10483. for (auto it = rng.first; it != rng.second; it++) {
  10484. values.push_back(it->second.content);
  10485. }
  10486. return values;
  10487. }
  10488. inline bool MultipartFormData::has_field(const std::string &key) const {
  10489. return fields.find(key) != fields.end();
  10490. }
  10491. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10492. return fields.count(key);
  10493. }
  10494. inline FormData MultipartFormData::get_file(const std::string &key,
  10495. size_t id) const {
  10496. return detail::get_multimap_value(files, key, id);
  10497. }
  10498. inline std::vector<FormData>
  10499. MultipartFormData::get_files(const std::string &key) const {
  10500. std::vector<FormData> values;
  10501. auto rng = files.equal_range(key);
  10502. for (auto it = rng.first; it != rng.second; it++) {
  10503. values.push_back(it->second);
  10504. }
  10505. return values;
  10506. }
  10507. inline bool MultipartFormData::has_file(const std::string &key) const {
  10508. return files.find(key) != files.end();
  10509. }
  10510. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10511. return files.count(key);
  10512. }
  10513. // Multipart FormData writer implementation
  10514. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10515. return detail::is_multipart_boundary_chars_valid(boundary);
  10516. }
  10517. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10518. : boundary_(detail::make_multipart_data_boundary()) {}
  10519. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10520. : boundary_(std::move(boundary)) {}
  10521. inline const std::string &MultipartFormDataWriter::boundary() const {
  10522. return boundary_;
  10523. }
  10524. inline std::string MultipartFormDataWriter::content_type() const {
  10525. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10526. }
  10527. inline std::string
  10528. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10529. return detail::serialize_multipart_formdata(items, boundary_);
  10530. }
  10531. inline size_t MultipartFormDataWriter::content_length(
  10532. const UploadFormDataItems &items) const {
  10533. return detail::get_multipart_content_length(items, boundary_);
  10534. }
  10535. inline std::string
  10536. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10537. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10538. }
  10539. inline std::string MultipartFormDataWriter::item_end() {
  10540. return detail::serialize_multipart_formdata_item_end();
  10541. }
  10542. inline std::string MultipartFormDataWriter::finish() const {
  10543. return detail::serialize_multipart_formdata_finish(boundary_);
  10544. }
  10545. // Response implementation
  10546. namespace detail {
  10547. // A response has one content source: `body`, a content provider, or a file.
  10548. // Each content setter calls this so that the one called last wins.
  10549. inline void clear_content_provider(Response &res) {
  10550. auto releaser = std::move(res.content_provider_resource_releaser_);
  10551. auto success = res.content_provider_success_;
  10552. res.content_length_ = 0;
  10553. res.content_provider_ = nullptr;
  10554. res.content_provider_resource_releaser_ = nullptr;
  10555. res.is_chunked_content_provider_ = false;
  10556. res.is_file_content_provider_ = false;
  10557. res.content_provider_success_ = false;
  10558. res.content_coding_ = EncodingType::None;
  10559. res.file_content_path_.clear();
  10560. res.file_content_content_type_.clear();
  10561. if (releaser) { releaser(success); }
  10562. }
  10563. inline void clear_content(Response &res) {
  10564. res.body.clear();
  10565. clear_content_provider(res);
  10566. }
  10567. // The Content-Type of the old content goes with it.
  10568. inline void set_content_type(Response &res, const std::string &content_type) {
  10569. res.headers.erase("Content-Type");
  10570. res.set_header("Content-Type", content_type);
  10571. }
  10572. // `body` is public, so it can be assigned directly after a provider or a file
  10573. // was set. It came last, so it wins.
  10574. inline void prefer_assigned_body(Response &res) {
  10575. if (!res.body.empty() &&
  10576. (res.content_provider_ || !res.file_content_path_.empty())) {
  10577. clear_content_provider(res);
  10578. }
  10579. }
  10580. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10581. inline bool body_allowed_for_status(int status) {
  10582. return status >= 200 && status != StatusCode::NoContent_204 &&
  10583. status != StatusCode::NotModified_304;
  10584. }
  10585. // Only a 206 response is served as a partial representation. range_error()
  10586. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10587. // status would start from an unchecked offset.
  10588. inline bool is_partial_content(const Request &req, const Response &res) {
  10589. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10590. }
  10591. // Sets the Content-Length or Transfer-Encoding framing the body that
  10592. // Server::write_response_core() writes, or closes the connection after a body
  10593. // that has neither. Only the library sets them: one from a handler would go
  10594. // out next to it, or describe some other body.
  10595. inline void set_framing_headers(const Request &req, Response &res,
  10596. const std::string &boundary,
  10597. const std::string &content_type) {
  10598. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10599. auto head_length = req.method == "HEAD"
  10600. ? res.get_header_value("Content-Length")
  10601. : std::string();
  10602. res.headers.erase("Content-Length");
  10603. res.headers.erase("Transfer-Encoding");
  10604. if (!body_allowed_for_status(res.status)) { return; }
  10605. if (res.content_provider_) {
  10606. if (res.content_length_ == 0) {
  10607. if (res.is_chunked_content_provider_) {
  10608. res.set_header("Transfer-Encoding", "chunked");
  10609. } else if (req.method != "HEAD") {
  10610. // RFC 9112 6.3: a body with neither ends where the connection does.
  10611. res.headers.erase("Keep-Alive");
  10612. if (!has_header_token(res.headers, "Connection", "close")) {
  10613. res.set_header("Connection", "close");
  10614. }
  10615. }
  10616. return;
  10617. }
  10618. // The part Server::write_content_with_provider() writes.
  10619. auto length = res.content_length_;
  10620. if (is_partial_content(req, res)) {
  10621. length = req.ranges.size() == 1
  10622. ? get_range_offset_and_length(req.ranges[0], length).second
  10623. : get_multipart_ranges_data_length(req, boundary,
  10624. content_type, length);
  10625. }
  10626. res.set_header("Content-Length", std::to_string(length));
  10627. } else if (!res.body.empty()) {
  10628. res.set_header("Content-Length", std::to_string(res.body.size()));
  10629. } else {
  10630. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10631. }
  10632. }
  10633. } // namespace detail
  10634. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10635. size_t id) const {
  10636. return detail::get_header_value_u64(headers, key, def, id);
  10637. }
  10638. inline bool Response::has_header(const std::string &key) const {
  10639. return headers.find(key) != headers.end();
  10640. }
  10641. inline std::string Response::get_header_value(const std::string &key,
  10642. const char *def,
  10643. size_t id) const {
  10644. return detail::get_header_value(headers, key, def, id);
  10645. }
  10646. inline size_t Response::get_header_value_count(const std::string &key) const {
  10647. return detail::get_header_value_count(headers, key);
  10648. }
  10649. inline void Response::set_header(const std::string &key,
  10650. const std::string &val) {
  10651. detail::set_header(headers, key, val);
  10652. }
  10653. inline bool Response::has_trailer(const std::string &key) const {
  10654. return trailers.find(key) != trailers.end();
  10655. }
  10656. inline std::string Response::get_trailer_value(const std::string &key,
  10657. size_t id) const {
  10658. return detail::get_multimap_value(trailers, key, id);
  10659. }
  10660. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10661. return trailers.count(key);
  10662. }
  10663. inline void Response::set_redirect(const std::string &url, int stat) {
  10664. if (detail::fields::is_field_value(url)) {
  10665. set_header("Location", url);
  10666. if (300 <= stat && stat < 400) {
  10667. this->status = stat;
  10668. } else {
  10669. this->status = StatusCode::Found_302;
  10670. }
  10671. }
  10672. }
  10673. inline void Response::set_content(const char *s, size_t n,
  10674. const std::string &content_type) {
  10675. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10676. detail::clear_content_provider(*this);
  10677. detail::set_content_type(*this, content_type);
  10678. }
  10679. inline void Response::set_content(const std::string &s,
  10680. const std::string &content_type) {
  10681. set_content(s.data(), s.size(), content_type);
  10682. }
  10683. inline void Response::set_content(std::string &&s,
  10684. const std::string &content_type) {
  10685. body = std::move(s);
  10686. detail::clear_content_provider(*this);
  10687. detail::set_content_type(*this, content_type);
  10688. }
  10689. inline void Response::set_content_provider(
  10690. size_t in_length, const std::string &content_type, ContentProvider provider,
  10691. ContentProviderResourceReleaser resource_releaser) {
  10692. detail::clear_content(*this);
  10693. detail::set_content_type(*this, content_type);
  10694. content_length_ = in_length;
  10695. if (in_length > 0) { content_provider_ = std::move(provider); }
  10696. content_provider_resource_releaser_ = std::move(resource_releaser);
  10697. }
  10698. inline void Response::set_content_provider(
  10699. const std::string &content_type, ContentProviderWithoutLength provider,
  10700. ContentProviderResourceReleaser resource_releaser) {
  10701. detail::clear_content(*this);
  10702. detail::set_content_type(*this, content_type);
  10703. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10704. content_provider_resource_releaser_ = std::move(resource_releaser);
  10705. }
  10706. inline void Response::set_chunked_content_provider(
  10707. const std::string &content_type, ContentProviderWithoutLength provider,
  10708. ContentProviderResourceReleaser resource_releaser) {
  10709. set_content_provider(content_type, std::move(provider),
  10710. std::move(resource_releaser));
  10711. is_chunked_content_provider_ = true;
  10712. }
  10713. inline void Response::set_file_content(const std::string &path,
  10714. const std::string &content_type) {
  10715. detail::clear_content(*this);
  10716. headers.erase("Content-Type");
  10717. file_content_path_ = path;
  10718. file_content_content_type_ = content_type;
  10719. }
  10720. inline void Response::set_file_content(const std::string &path) {
  10721. set_file_content(path, std::string());
  10722. }
  10723. // Result implementation
  10724. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10725. size_t def,
  10726. size_t id) const {
  10727. return detail::get_header_value_u64(request_headers_, key, def, id);
  10728. }
  10729. inline bool Result::has_request_header(const std::string &key) const {
  10730. return request_headers_.find(key) != request_headers_.end();
  10731. }
  10732. inline std::string Result::get_request_header_value(const std::string &key,
  10733. const char *def,
  10734. size_t id) const {
  10735. return detail::get_header_value(request_headers_, key, def, id);
  10736. }
  10737. inline size_t
  10738. Result::get_request_header_value_count(const std::string &key) const {
  10739. return request_headers_.count(key);
  10740. }
  10741. // Stream implementation
  10742. inline ssize_t Stream::write(const char *ptr) {
  10743. return write(ptr, strlen(ptr));
  10744. }
  10745. inline ssize_t Stream::write(const std::string &s) {
  10746. return write(s.data(), s.size());
  10747. }
  10748. // BodyReader implementation
  10749. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10750. if (!stream) {
  10751. last_error = Error::Connection;
  10752. return -1;
  10753. }
  10754. if (eof) { return 0; }
  10755. if (!chunked) {
  10756. // Content-Length based reading
  10757. if (has_content_length && bytes_read >= content_length) {
  10758. eof = true;
  10759. return 0;
  10760. }
  10761. auto to_read = len;
  10762. if (has_content_length) {
  10763. auto remaining = content_length - bytes_read;
  10764. to_read = (std::min)(len, remaining);
  10765. }
  10766. auto n = stream->read(buf, to_read);
  10767. // Without Content-Length the body ends when the connection closes
  10768. // (RFC 9112 §6.3); with one, an EOF here came too early
  10769. if (n < 0 || (n == 0 && has_content_length)) {
  10770. last_error = stream->get_error();
  10771. if (last_error == Error::Success) { last_error = Error::Read; }
  10772. }
  10773. if (n <= 0) {
  10774. eof = true;
  10775. return n;
  10776. }
  10777. bytes_read += static_cast<size_t>(n);
  10778. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10779. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10780. last_error = Error::ExceedMaxPayloadSize;
  10781. eof = true;
  10782. return -1;
  10783. }
  10784. return n;
  10785. }
  10786. // Chunked transfer encoding: delegate to shared decoder instance.
  10787. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10788. size_t chunk_offset = 0;
  10789. size_t chunk_total = 0;
  10790. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10791. if (n < 0) {
  10792. last_error = stream->get_error();
  10793. if (last_error == Error::Success) { last_error = Error::Read; }
  10794. eof = true;
  10795. return n;
  10796. }
  10797. if (n == 0) {
  10798. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10799. eof = true;
  10800. return 0;
  10801. }
  10802. bytes_read += static_cast<size_t>(n);
  10803. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10804. last_error = Error::ExceedMaxPayloadSize;
  10805. eof = true;
  10806. return -1;
  10807. }
  10808. return n;
  10809. }
  10810. // ThreadPool implementation
  10811. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10812. time_t idle_timeout_sec)
  10813. : base_thread_count_(n), max_queued_requests_(mqr),
  10814. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10815. shutdown_(false) {
  10816. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10817. if (max_n != 0 && max_n < n) {
  10818. std::string msg = "max_threads must be >= base_threads";
  10819. throw std::invalid_argument(msg);
  10820. }
  10821. #endif
  10822. max_thread_count_ = max_n == 0 ? n : max_n;
  10823. threads_.reserve(base_thread_count_);
  10824. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10825. try {
  10826. #endif
  10827. for (size_t i = 0; i < base_thread_count_; i++) {
  10828. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10829. }
  10830. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10831. } catch (...) {
  10832. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10833. // signal the workers we already spawned to exit and join them so the
  10834. // vector destructor does not see joinable threads (which would call
  10835. // std::terminate). Then rethrow so the caller learns of the failure.
  10836. {
  10837. std::unique_lock<std::mutex> lock(mutex_);
  10838. shutdown_ = true;
  10839. }
  10840. cond_.notify_all();
  10841. for (auto &t : threads_) {
  10842. if (t.joinable()) { t.join(); }
  10843. }
  10844. throw;
  10845. }
  10846. #endif
  10847. }
  10848. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10849. {
  10850. std::unique_lock<std::mutex> lock(mutex_);
  10851. if (shutdown_) { return false; }
  10852. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10853. return false;
  10854. }
  10855. jobs_.push_back(std::move(fn));
  10856. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10857. if (jobs_.size() > idle_thread_count_ &&
  10858. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10859. cleanup_finished_threads();
  10860. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10861. try {
  10862. #endif
  10863. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10864. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10865. } catch (const std::system_error &) {
  10866. // No thread budget left: keep the job queued for an existing worker
  10867. // instead of letting the exception escape the accept loop.
  10868. }
  10869. #endif
  10870. }
  10871. }
  10872. cond_.notify_one();
  10873. return true;
  10874. }
  10875. inline void ThreadPool::shutdown() {
  10876. {
  10877. std::unique_lock<std::mutex> lock(mutex_);
  10878. shutdown_ = true;
  10879. }
  10880. cond_.notify_all();
  10881. for (auto &t : threads_) {
  10882. if (t.joinable()) { t.join(); }
  10883. }
  10884. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10885. // with worker threads that call move_to_finished() concurrently.
  10886. std::list<std::thread> remaining_dynamic;
  10887. {
  10888. std::unique_lock<std::mutex> lock(mutex_);
  10889. remaining_dynamic = std::move(dynamic_threads_);
  10890. }
  10891. for (auto &t : remaining_dynamic) {
  10892. if (t.joinable()) { t.join(); }
  10893. }
  10894. std::unique_lock<std::mutex> lock(mutex_);
  10895. cleanup_finished_threads();
  10896. }
  10897. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10898. // Must be called with mutex_ held
  10899. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10900. if (it->get_id() == id) {
  10901. finished_threads_.push_back(std::move(*it));
  10902. dynamic_threads_.erase(it);
  10903. return;
  10904. }
  10905. }
  10906. }
  10907. inline void ThreadPool::cleanup_finished_threads() {
  10908. // Must be called with mutex_ held
  10909. for (auto &t : finished_threads_) {
  10910. if (t.joinable()) { t.join(); }
  10911. }
  10912. finished_threads_.clear();
  10913. }
  10914. inline void ThreadPool::worker(bool is_dynamic) {
  10915. for (;;) {
  10916. std::function<void()> fn;
  10917. {
  10918. std::unique_lock<std::mutex> lock(mutex_);
  10919. idle_thread_count_++;
  10920. if (is_dynamic) {
  10921. auto has_work =
  10922. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10923. [&] { return !jobs_.empty() || shutdown_; });
  10924. if (!has_work) {
  10925. // Timed out with no work - exit this dynamic thread
  10926. idle_thread_count_--;
  10927. move_to_finished(std::this_thread::get_id());
  10928. break;
  10929. }
  10930. } else {
  10931. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10932. }
  10933. idle_thread_count_--;
  10934. if (shutdown_ && jobs_.empty()) { break; }
  10935. fn = std::move(jobs_.front());
  10936. jobs_.pop_front();
  10937. }
  10938. assert(true == static_cast<bool>(fn));
  10939. fn();
  10940. }
  10941. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10942. !defined(LIBRESSL_VERSION_NUMBER)
  10943. OPENSSL_thread_stop();
  10944. #endif
  10945. }
  10946. /*
  10947. * Group 1 (continued): detail namespace - Stream implementations
  10948. */
  10949. namespace detail {
  10950. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10951. time_t timeout_sec, time_t timeout_usec,
  10952. time_t &actual_timeout_sec,
  10953. time_t &actual_timeout_usec) {
  10954. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10955. auto actual_timeout_msec =
  10956. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10957. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10958. actual_timeout_sec = actual_timeout_msec / 1000;
  10959. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10960. }
  10961. // Socket stream implementation
  10962. inline SocketStream::SocketStream(
  10963. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10964. time_t write_timeout_sec, time_t write_timeout_usec,
  10965. time_t max_timeout_msec,
  10966. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10967. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10968. read_timeout_usec_(read_timeout_usec),
  10969. write_timeout_sec_(write_timeout_sec),
  10970. write_timeout_usec_(write_timeout_usec),
  10971. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10972. read_buff_(read_buff_size_, 0) {}
  10973. inline SocketStream::~SocketStream() = default;
  10974. inline bool SocketStream::is_readable() const {
  10975. return read_buff_off_ < read_buff_content_size_;
  10976. }
  10977. inline bool SocketStream::wait_readable() const {
  10978. if (max_timeout_msec_ <= 0) {
  10979. return select_read_interruptible(sock_, read_timeout_sec_,
  10980. read_timeout_usec_, read_interrupted_) > 0;
  10981. }
  10982. time_t read_timeout_sec;
  10983. time_t read_timeout_usec;
  10984. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10985. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10986. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10987. read_interrupted_) > 0;
  10988. }
  10989. inline bool SocketStream::wait_writable() const {
  10990. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10991. }
  10992. inline bool SocketStream::ensure_readable() {
  10993. if (readable_hint_) {
  10994. readable_hint_ = false;
  10995. return true;
  10996. }
  10997. return wait_readable();
  10998. }
  10999. inline const char *SocketStream::buffered_data(size_t &size) const {
  11000. size = read_buff_content_size_ - read_buff_off_;
  11001. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  11002. }
  11003. inline void SocketStream::consume_buffered(size_t size) {
  11004. assert(size <= read_buff_content_size_ - read_buff_off_);
  11005. read_buff_off_ += size;
  11006. }
  11007. inline bool SocketStream::is_peer_alive() const {
  11008. return detail::is_socket_alive(sock_);
  11009. }
  11010. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  11011. #ifdef _WIN32
  11012. size =
  11013. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11014. #else
  11015. size = (std::min)(size,
  11016. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  11017. #endif
  11018. if (read_buff_off_ < read_buff_content_size_) {
  11019. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  11020. if (size <= remaining_size) {
  11021. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  11022. read_buff_off_ += size;
  11023. return static_cast<ssize_t>(size);
  11024. } else {
  11025. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  11026. read_buff_off_ += remaining_size;
  11027. return static_cast<ssize_t>(remaining_size);
  11028. }
  11029. }
  11030. if (!ensure_readable()) {
  11031. error_ = Error::Timeout;
  11032. return -1;
  11033. }
  11034. read_buff_off_ = 0;
  11035. read_buff_content_size_ = 0;
  11036. if (size < read_buff_size_) {
  11037. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  11038. CPPHTTPLIB_RECV_FLAGS);
  11039. if (n <= 0) {
  11040. if (n == 0) {
  11041. error_ = Error::ConnectionClosed;
  11042. } else {
  11043. error_ = Error::Read;
  11044. }
  11045. return n;
  11046. } else if (n <= static_cast<ssize_t>(size)) {
  11047. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  11048. return n;
  11049. } else {
  11050. memcpy(ptr, read_buff_.data(), size);
  11051. read_buff_off_ = size;
  11052. read_buff_content_size_ = static_cast<size_t>(n);
  11053. return static_cast<ssize_t>(size);
  11054. }
  11055. } else {
  11056. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  11057. if (n <= 0) {
  11058. if (n == 0) {
  11059. error_ = Error::ConnectionClosed;
  11060. } else {
  11061. error_ = Error::Read;
  11062. }
  11063. }
  11064. return n;
  11065. }
  11066. }
  11067. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  11068. if (!wait_writable()) { return -1; }
  11069. // Winsock's send() takes an int length, even on 64-bit Windows
  11070. #ifdef _WIN32
  11071. size =
  11072. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11073. #endif
  11074. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  11075. }
  11076. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  11077. int &port) const {
  11078. return detail::get_remote_ip_and_port(sock_, ip, port);
  11079. }
  11080. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  11081. int &port) const {
  11082. return detail::get_local_ip_and_port(sock_, ip, port);
  11083. }
  11084. inline socket_t SocketStream::socket() const { return sock_; }
  11085. inline time_t SocketStream::duration() const {
  11086. return static_cast<time_t>(
  11087. std::chrono::duration_cast<std::chrono::milliseconds>(
  11088. std::chrono::steady_clock::now() - start_time_)
  11089. .count());
  11090. }
  11091. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  11092. read_timeout_sec_ = sec;
  11093. read_timeout_usec_ = usec;
  11094. }
  11095. inline void SocketStream::set_max_timeout(time_t msec) {
  11096. max_timeout_msec_ = msec;
  11097. start_time_ = std::chrono::steady_clock::now();
  11098. }
  11099. inline void
  11100. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11101. read_interrupted_ = std::move(interrupted);
  11102. }
  11103. // Buffer stream implementation
  11104. inline bool BufferStream::is_readable() const { return true; }
  11105. inline bool BufferStream::wait_readable() const { return true; }
  11106. inline bool BufferStream::wait_writable() const { return true; }
  11107. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  11108. #if defined(_MSC_VER) && _MSC_VER < 1910
  11109. auto len_read = buffer._Copy_s(ptr, size, size, position);
  11110. #else
  11111. auto len_read = buffer.copy(ptr, size, position);
  11112. #endif
  11113. position += static_cast<size_t>(len_read);
  11114. return static_cast<ssize_t>(len_read);
  11115. }
  11116. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  11117. buffer.append(ptr, size);
  11118. return static_cast<ssize_t>(size);
  11119. }
  11120. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  11121. int & /*port*/) const {}
  11122. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  11123. int & /*port*/) const {}
  11124. inline socket_t BufferStream::socket() const { return 0; }
  11125. inline time_t BufferStream::duration() const { return 0; }
  11126. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  11127. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  11128. : MatcherBase(pattern) {
  11129. constexpr const char marker[] = "/:";
  11130. // One past the last ending position of a path param substring
  11131. std::size_t last_param_end = 0;
  11132. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11133. // Needed to ensure that parameter names are unique during matcher
  11134. // construction
  11135. // If exceptions are disabled, only last duplicate path
  11136. // parameter will be set
  11137. std::unordered_set<std::string> param_name_set;
  11138. #endif
  11139. while (true) {
  11140. const auto marker_pos = pattern.find(
  11141. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  11142. if (marker_pos == std::string::npos) { break; }
  11143. static_fragments_.push_back(
  11144. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  11145. const auto param_name_start = marker_pos + str_len(marker);
  11146. auto sep_pos = pattern.find(separator, param_name_start);
  11147. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  11148. auto param_name =
  11149. pattern.substr(param_name_start, sep_pos - param_name_start);
  11150. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11151. if (param_name_set.find(param_name) != param_name_set.cend()) {
  11152. std::string msg = "Encountered path parameter '" + param_name +
  11153. "' multiple times in route pattern '" + pattern + "'.";
  11154. throw std::invalid_argument(msg);
  11155. }
  11156. #endif
  11157. param_names_.push_back(std::move(param_name));
  11158. last_param_end = sep_pos + 1;
  11159. }
  11160. if (last_param_end < pattern.length()) {
  11161. static_fragments_.push_back(pattern.substr(last_param_end));
  11162. }
  11163. }
  11164. inline bool PathParamsMatcher::match(Request &request) const {
  11165. request.matches = std::smatch();
  11166. request.path_params.clear();
  11167. // A pattern without parameters is just a literal path to compare against
  11168. if (param_names_.empty()) { return request.path == pattern(); }
  11169. request.path_params.reserve(param_names_.size());
  11170. // One past the position at which the path matched the pattern last time
  11171. std::size_t starting_pos = 0;
  11172. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11173. const auto &fragment = static_fragments_[i];
  11174. if (starting_pos + fragment.length() > request.path.length()) {
  11175. return false;
  11176. }
  11177. // Avoid unnecessary allocation by using strncmp instead of substr +
  11178. // comparison
  11179. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11180. fragment.length()) != 0) {
  11181. return false;
  11182. }
  11183. starting_pos += fragment.length();
  11184. // Should only happen when we have a static fragment after a param
  11185. // Example: '/users/:id/subscriptions'
  11186. // The 'subscriptions' fragment here does not have a corresponding param
  11187. if (i >= param_names_.size()) { continue; }
  11188. auto sep_pos = request.path.find(separator, starting_pos);
  11189. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11190. const auto &param_name = param_names_[i];
  11191. request.path_params.emplace(
  11192. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11193. // Mark everything up to '/' as matched
  11194. starting_pos = sep_pos + 1;
  11195. }
  11196. // Returns false if the path is longer than the pattern
  11197. return starting_pos >= request.path.length();
  11198. }
  11199. inline bool RegexMatcher::match(Request &request) const {
  11200. request.path_params.clear();
  11201. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11202. // a non-match rather than risking a stack overflow in std::regex_match.
  11203. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11204. return false;
  11205. }
  11206. return std::regex_match(request.path, request.matches, regex_);
  11207. }
  11208. // Enclose IPv6 address in brackets if needed
  11209. inline std::string prepare_host_string(const std::string &host) {
  11210. // Enclose IPv6 address in brackets (but not if already enclosed)
  11211. if (host.find(':') == std::string::npos ||
  11212. (!host.empty() && host[0] == '[')) {
  11213. // IPv4, hostname, or already bracketed IPv6
  11214. return host;
  11215. } else {
  11216. // IPv6 address without brackets
  11217. return "[" + host + "]";
  11218. }
  11219. }
  11220. inline std::string make_host_and_port_string(const std::string &host, int port,
  11221. bool is_ssl) {
  11222. auto result = prepare_host_string(host);
  11223. // Append port if not default
  11224. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11225. ; // do nothing
  11226. } else {
  11227. result += ":" + std::to_string(port);
  11228. }
  11229. return result;
  11230. }
  11231. // Create "host:port" string always including port number (for CONNECT method)
  11232. inline std::string
  11233. make_host_and_port_string_always_port(const std::string &host, int port) {
  11234. return prepare_host_string(host) + ":" + std::to_string(port);
  11235. }
  11236. // Where a client connects for `host`, as one string: the mapped address or
  11237. // name, or `host` itself.
  11238. inline std::string
  11239. addr_map_target(const std::map<std::string, std::string> &addr_map,
  11240. const std::string &host) {
  11241. std::string connect_host;
  11242. std::string ip;
  11243. apply_addr_map(addr_map, host, connect_host, ip);
  11244. return ip.empty() ? connect_host : ip;
  11245. }
  11246. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11247. inline std::string
  11248. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11249. const std::string &host, int port) {
  11250. return make_host_and_port_string_always_port(addr_map_target(addr_map, host),
  11251. port);
  11252. }
  11253. // Value for the Host header a client sends when the caller supplied none.
  11254. // Only the value: callers decide where in their header list it goes.
  11255. inline std::string make_default_host_header_value(const std::string &host,
  11256. int port, bool is_ssl,
  11257. int address_family) {
  11258. if (address_family == AF_UNIX) { return "localhost"; }
  11259. return make_host_and_port_string(host, port, is_ssl);
  11260. }
  11261. inline void add_default_user_agent_header(Request &req) {
  11262. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11263. if (!req.has_header("User-Agent")) {
  11264. req.set_header("User-Agent",
  11265. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11266. }
  11267. #else
  11268. (void)req;
  11269. #endif
  11270. }
  11271. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11272. NormalizedTarget normalize_target(const std::string &host);
  11273. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11274. bool host_matches_no_proxy(const NormalizedTarget &target,
  11275. const std::vector<NoProxyEntry> &entries);
  11276. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11277. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11278. if (prefix_bits == 0) { return true; }
  11279. int full_bytes = prefix_bits / 8;
  11280. int rem_bits = prefix_bits % 8;
  11281. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11282. static_cast<size_t>(full_bytes)) != 0) {
  11283. return false;
  11284. }
  11285. if (rem_bits == 0) { return true; }
  11286. auto i = static_cast<size_t>(full_bytes);
  11287. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11288. return (ip[i] & mask) == (net[i] & mask);
  11289. }
  11290. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11291. if (token.empty()) { return false; }
  11292. if (token == "*") {
  11293. out.kind = NoProxyKind::Wildcard;
  11294. return true;
  11295. }
  11296. auto slash = token.find('/');
  11297. std::string addr_part =
  11298. (slash == std::string::npos) ? token : token.substr(0, slash);
  11299. std::string prefix_part =
  11300. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11301. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11302. // don't silently treat it as a /32 (or /128).
  11303. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11304. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11305. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11306. // when brackets are present.
  11307. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11308. addr_part.back() == ']';
  11309. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11310. if (!bracketed) {
  11311. struct in_addr v4;
  11312. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11313. int prefix = 32;
  11314. if (!prefix_part.empty() &&
  11315. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11316. prefix)) {
  11317. return false;
  11318. }
  11319. out.kind = NoProxyKind::IPv4Cidr;
  11320. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11321. out.prefix_bits = prefix;
  11322. return true;
  11323. }
  11324. }
  11325. struct in6_addr v6;
  11326. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11327. int prefix = 128;
  11328. if (!prefix_part.empty() &&
  11329. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11330. prefix)) {
  11331. return false;
  11332. }
  11333. out.kind = NoProxyKind::IPv6Cidr;
  11334. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11335. out.prefix_bits = prefix;
  11336. return true;
  11337. }
  11338. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11339. // the entry is malformed — don't fall through to the hostname branch.
  11340. if (bracketed) { return false; }
  11341. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11342. if (slash != std::string::npos) { return false; }
  11343. // Port-specific entries (host:port) are not supported.
  11344. if (token.find(':') != std::string::npos) { return false; }
  11345. std::string hostname = case_ignore::to_lower(token);
  11346. while (!hostname.empty() && hostname.front() == '.') {
  11347. hostname.erase(hostname.begin());
  11348. }
  11349. while (!hostname.empty() && hostname.back() == '.') {
  11350. hostname.pop_back();
  11351. }
  11352. if (hostname.empty()) { return false; }
  11353. out.kind = NoProxyKind::HostnameSuffix;
  11354. out.hostname_pattern = std::move(hostname);
  11355. return true;
  11356. }
  11357. inline std::vector<NoProxyEntry>
  11358. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11359. std::vector<NoProxyEntry> entries;
  11360. entries.reserve(patterns.size());
  11361. for (const auto &p : patterns) {
  11362. auto trimmed = trim_copy(p);
  11363. if (trimmed.empty()) { continue; }
  11364. NoProxyEntry entry;
  11365. if (parse_no_proxy_entry(trimmed, entry)) {
  11366. entries.push_back(std::move(entry));
  11367. }
  11368. }
  11369. return entries;
  11370. }
  11371. inline NormalizedTarget normalize_target(const std::string &host) {
  11372. NormalizedTarget t;
  11373. std::string h = host;
  11374. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11375. h = h.substr(1, h.size() - 2);
  11376. }
  11377. // Strip a single trailing dot so "example.com." canonicalizes to
  11378. // "example.com".
  11379. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11380. t.hostname = case_ignore::to_lower(h);
  11381. if (!t.hostname.empty()) {
  11382. struct in_addr v4;
  11383. struct in6_addr v6;
  11384. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11385. t.is_ipv4 = true;
  11386. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11387. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11388. t.is_ipv6 = true;
  11389. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11390. }
  11391. }
  11392. return t;
  11393. }
  11394. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11395. const std::vector<NoProxyEntry> &entries) {
  11396. if (target.hostname.empty()) { return false; }
  11397. for (const auto &e : entries) {
  11398. switch (e.kind) {
  11399. case NoProxyKind::Wildcard: return true;
  11400. case NoProxyKind::IPv4Cidr:
  11401. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11402. return true;
  11403. }
  11404. break;
  11405. case NoProxyKind::IPv6Cidr:
  11406. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11407. return true;
  11408. }
  11409. break;
  11410. case NoProxyKind::HostnameSuffix:
  11411. if (target.is_ipv4 || target.is_ipv6) { break; }
  11412. if (target.hostname == e.hostname_pattern) { return true; }
  11413. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11414. // an entry of "example.com".
  11415. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11416. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11417. if (target.hostname[offset - 1] == '.' &&
  11418. target.hostname.compare(offset, e.hostname_pattern.size(),
  11419. e.hostname_pattern) == 0) {
  11420. return true;
  11421. }
  11422. }
  11423. break;
  11424. }
  11425. }
  11426. return false;
  11427. }
  11428. template <typename T>
  11429. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11430. T header_writer, Error &error) {
  11431. for (const auto &h : headers) {
  11432. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11433. error = Error::InvalidHeaders;
  11434. return false;
  11435. }
  11436. }
  11437. if (header_writer(strm, headers) <= 0) {
  11438. error = Error::Write;
  11439. return false;
  11440. }
  11441. return true;
  11442. }
  11443. } // namespace detail
  11444. /*
  11445. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11446. */
  11447. #ifdef CPPHTTPLIB_SSL_ENABLED
  11448. namespace detail {
  11449. // SSL socket stream implementation
  11450. inline SSLSocketStream::SSLSocketStream(
  11451. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11452. time_t read_timeout_usec, time_t write_timeout_sec,
  11453. time_t write_timeout_usec, time_t max_timeout_msec,
  11454. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11455. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11456. read_timeout_usec_(read_timeout_usec),
  11457. write_timeout_sec_(write_timeout_sec),
  11458. write_timeout_usec_(write_timeout_usec),
  11459. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11460. tls_error_.code = tls::ErrorCode::Success;
  11461. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11462. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11463. // Note: create_session() also clears this, but SSLClient currently
  11464. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11465. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11466. // SSL session was created.
  11467. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11468. #endif
  11469. }
  11470. inline SSLSocketStream::~SSLSocketStream() = default;
  11471. inline bool SSLSocketStream::is_readable() const {
  11472. return tls::pending(session_) > 0;
  11473. }
  11474. inline bool SSLSocketStream::wait_readable() const {
  11475. if (max_timeout_msec_ <= 0) {
  11476. return select_read_interruptible(sock_, read_timeout_sec_,
  11477. read_timeout_usec_, read_interrupted_) > 0;
  11478. }
  11479. time_t read_timeout_sec;
  11480. time_t read_timeout_usec;
  11481. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11482. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11483. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11484. read_interrupted_) > 0;
  11485. }
  11486. inline bool SSLSocketStream::wait_writable() const {
  11487. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11488. !tls::is_peer_closed(session_, sock_);
  11489. }
  11490. inline bool SSLSocketStream::ensure_readable() {
  11491. if (readable_hint_) {
  11492. readable_hint_ = false;
  11493. return true;
  11494. }
  11495. return wait_readable();
  11496. }
  11497. inline bool SSLSocketStream::is_peer_alive() const {
  11498. return !tls::is_peer_closed(session_, sock_);
  11499. }
  11500. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11501. if (tls::pending(session_) > 0) {
  11502. tls::TlsError err;
  11503. auto ret = tls::read(session_, ptr, size, err);
  11504. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11505. error_ = Error::ConnectionClosed;
  11506. } else if (ret < 0) {
  11507. tls_error_ = err;
  11508. }
  11509. return ret;
  11510. } else if (ensure_readable()) {
  11511. tls::TlsError err;
  11512. auto ret = tls::read(session_, ptr, size, err);
  11513. if (ret < 0) {
  11514. auto n = 1000;
  11515. #ifdef _WIN32
  11516. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11517. (err.code == tls::ErrorCode::SyscallError &&
  11518. WSAGetLastError() == WSAETIMEDOUT))) {
  11519. #else
  11520. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11521. #endif
  11522. if (tls::pending(session_) > 0) {
  11523. ret = tls::read(session_, ptr, size, err);
  11524. if (ret >= 0) { return ret; }
  11525. break;
  11526. } else if (wait_readable()) {
  11527. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11528. ret = tls::read(session_, ptr, size, err);
  11529. if (ret >= 0) { return ret; }
  11530. } else {
  11531. break;
  11532. }
  11533. }
  11534. assert(ret < 0);
  11535. tls_error_ = err;
  11536. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11537. error_ = Error::ConnectionClosed;
  11538. }
  11539. return ret;
  11540. } else {
  11541. error_ = Error::Timeout;
  11542. return -1;
  11543. }
  11544. }
  11545. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11546. if (wait_writable()) {
  11547. auto handle_size =
  11548. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11549. tls::TlsError err;
  11550. auto ret = tls::write(session_, ptr, handle_size, err);
  11551. if (ret < 0) {
  11552. auto n = 1000;
  11553. #ifdef _WIN32
  11554. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11555. (err.code == tls::ErrorCode::SyscallError &&
  11556. WSAGetLastError() == WSAETIMEDOUT))) {
  11557. #else
  11558. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11559. #endif
  11560. if (wait_writable()) {
  11561. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11562. ret = tls::write(session_, ptr, handle_size, err);
  11563. if (ret >= 0) { return ret; }
  11564. } else {
  11565. break;
  11566. }
  11567. }
  11568. assert(ret < 0);
  11569. tls_error_ = err;
  11570. }
  11571. return ret;
  11572. }
  11573. return -1;
  11574. }
  11575. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11576. int &port) const {
  11577. detail::get_remote_ip_and_port(sock_, ip, port);
  11578. }
  11579. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11580. int &port) const {
  11581. detail::get_local_ip_and_port(sock_, ip, port);
  11582. }
  11583. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11584. inline time_t SSLSocketStream::duration() const {
  11585. return static_cast<time_t>(
  11586. std::chrono::duration_cast<std::chrono::milliseconds>(
  11587. std::chrono::steady_clock::now() - start_time_)
  11588. .count());
  11589. }
  11590. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11591. read_timeout_sec_ = sec;
  11592. read_timeout_usec_ = usec;
  11593. }
  11594. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11595. max_timeout_msec_ = msec;
  11596. start_time_ = std::chrono::steady_clock::now();
  11597. }
  11598. inline void
  11599. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11600. read_interrupted_ = std::move(interrupted);
  11601. }
  11602. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11603. tls::session_t session,
  11604. time_t read_timeout_sec,
  11605. time_t read_timeout_usec,
  11606. time_t write_timeout_sec,
  11607. time_t write_timeout_usec)
  11608. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11609. read_timeout_usec_(read_timeout_usec),
  11610. write_timeout_sec_(write_timeout_sec),
  11611. write_timeout_usec_(write_timeout_usec),
  11612. start_time_(std::chrono::steady_clock::now().time_since_epoch().count()) {
  11613. // The receive and send paths run on different threads, so each TLS call is
  11614. // driven in non-blocking mode and readiness is awaited with select()
  11615. // outside the session lock. Set the socket non-blocking once here; it is
  11616. // never flipped back, so no thread races on the flag.
  11617. detail::set_nonblocking(sock_, true);
  11618. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11619. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11620. #endif
  11621. }
  11622. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11623. inline bool WebSocketSSLStream::is_readable() const {
  11624. std::lock_guard<std::mutex> guard(session_mutex_);
  11625. return tls::pending(session_) > 0;
  11626. }
  11627. inline bool WebSocketSSLStream::wait_readable() const {
  11628. auto max_timeout_msec = max_timeout_msec_.load();
  11629. if (max_timeout_msec <= 0) {
  11630. return select_read_interruptible(sock_, read_timeout_sec_,
  11631. read_timeout_usec_, read_interrupted_) > 0;
  11632. }
  11633. time_t read_timeout_sec;
  11634. time_t read_timeout_usec;
  11635. calc_actual_timeout(max_timeout_msec, duration(), read_timeout_sec_,
  11636. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11637. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11638. read_interrupted_) > 0;
  11639. }
  11640. inline bool WebSocketSSLStream::wait_writable() const {
  11641. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11642. // that probe toggles the socket's blocking flag, which would race with the
  11643. // concurrent reader on a permanently non-blocking socket.
  11644. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11645. }
  11646. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11647. tls::TlsError err;
  11648. auto n = 1000;
  11649. while (--n >= 0) {
  11650. {
  11651. std::lock_guard<std::mutex> guard(session_mutex_);
  11652. auto ret = tls::read(session_, ptr, size, err);
  11653. if (ret > 0) { return ret; }
  11654. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11655. error_ = Error::ConnectionClosed;
  11656. return ret;
  11657. }
  11658. }
  11659. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11660. // direction: the send path shares this session, so output it left pending
  11661. // has to be flushed before more input can be decrypted. Anything else is
  11662. // a hard error.
  11663. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11664. #ifdef _WIN32
  11665. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11666. needs_readable =
  11667. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11668. WSAGetLastError() == WSAETIMEDOUT);
  11669. #endif
  11670. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11671. error_ = Error::Read;
  11672. return -1;
  11673. }
  11674. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11675. error_ = Error::Timeout;
  11676. return -1;
  11677. }
  11678. }
  11679. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11680. // to tell a timeout from a close would otherwise see whatever the previous
  11681. // failure left behind (error_ is never cleared on success).
  11682. error_ = Error::Read;
  11683. return -1;
  11684. }
  11685. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11686. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11687. tls::TlsError err;
  11688. auto n = 1000;
  11689. while (--n >= 0) {
  11690. {
  11691. std::lock_guard<std::mutex> guard(session_mutex_);
  11692. auto ret = tls::write(session_, ptr, handle_size, err);
  11693. if (ret >= 0) { return ret; }
  11694. }
  11695. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11696. // or a post-handshake message must be consumed before the record goes
  11697. // out. Anything else is a hard error.
  11698. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11699. #ifdef _WIN32
  11700. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11701. needs_writable =
  11702. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11703. WSAGetLastError() == WSAETIMEDOUT);
  11704. #endif
  11705. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11706. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11707. }
  11708. return -1;
  11709. }
  11710. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11711. int &port) const {
  11712. detail::get_remote_ip_and_port(sock_, ip, port);
  11713. }
  11714. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11715. int &port) const {
  11716. detail::get_local_ip_and_port(sock_, ip, port);
  11717. }
  11718. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11719. inline time_t WebSocketSSLStream::duration() const {
  11720. auto start = std::chrono::steady_clock::time_point(
  11721. std::chrono::steady_clock::duration(start_time_.load()));
  11722. return static_cast<time_t>(
  11723. std::chrono::duration_cast<std::chrono::milliseconds>(
  11724. std::chrono::steady_clock::now() - start)
  11725. .count());
  11726. }
  11727. // Start time first: a reader that sees the new bound also sees its start
  11728. inline void WebSocketSSLStream::set_max_timeout(time_t msec) {
  11729. start_time_ = std::chrono::steady_clock::now().time_since_epoch().count();
  11730. max_timeout_msec_ = msec;
  11731. }
  11732. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11733. read_timeout_sec_ = sec;
  11734. read_timeout_usec_ = usec;
  11735. }
  11736. inline void
  11737. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11738. read_interrupted_ = std::move(interrupted);
  11739. }
  11740. } // namespace detail
  11741. #endif // CPPHTTPLIB_SSL_ENABLED
  11742. /*
  11743. * Group 4: Server implementation
  11744. */
  11745. // HTTP server implementation
  11746. inline Server::Server()
  11747. : new_task_queue([] {
  11748. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11749. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11750. }) {
  11751. #ifndef _WIN32
  11752. signal(SIGPIPE, SIG_IGN);
  11753. #endif
  11754. }
  11755. inline Server::~Server() = default;
  11756. inline std::unique_ptr<detail::MatcherBase>
  11757. Server::make_matcher(const std::string &pattern) {
  11758. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11759. // a path params pattern
  11760. if (pattern.find("/:") != std::string::npos) {
  11761. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11762. }
  11763. // A pattern with no regex metacharacter only has to be compared literally,
  11764. // which is what PathParamsMatcher already does when it captures no
  11765. // parameter, so std::regex is only worth building for the patterns that
  11766. // actually need it
  11767. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11768. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11769. }
  11770. return detail::make_unique<detail::RegexMatcher>(pattern);
  11771. }
  11772. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11773. return add_handler(get_handlers_, pattern, std::move(handler));
  11774. }
  11775. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11776. return add_handler(post_handlers_, pattern, std::move(handler));
  11777. }
  11778. inline Server &Server::Post(const std::string &pattern,
  11779. HandlerWithContentReader handler) {
  11780. return add_handler(post_handlers_for_content_reader_, pattern,
  11781. std::move(handler));
  11782. }
  11783. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11784. return add_handler(put_handlers_, pattern, std::move(handler));
  11785. }
  11786. inline Server &Server::Put(const std::string &pattern,
  11787. HandlerWithContentReader handler) {
  11788. return add_handler(put_handlers_for_content_reader_, pattern,
  11789. std::move(handler));
  11790. }
  11791. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11792. return add_handler(patch_handlers_, pattern, std::move(handler));
  11793. }
  11794. inline Server &Server::Patch(const std::string &pattern,
  11795. HandlerWithContentReader handler) {
  11796. return add_handler(patch_handlers_for_content_reader_, pattern,
  11797. std::move(handler));
  11798. }
  11799. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11800. return add_handler(delete_handlers_, pattern, std::move(handler));
  11801. }
  11802. inline Server &Server::Delete(const std::string &pattern,
  11803. HandlerWithContentReader handler) {
  11804. return add_handler(delete_handlers_for_content_reader_, pattern,
  11805. std::move(handler));
  11806. }
  11807. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11808. return add_handler(options_handlers_, pattern, std::move(handler));
  11809. }
  11810. inline const std::set<std::string> &Server::builtin_methods() {
  11811. thread_local const std::set<std::string> methods{
  11812. "GET", "HEAD", "POST", "PUT", "DELETE",
  11813. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11814. return methods;
  11815. }
  11816. inline Server::CustomHandlerEntry *
  11817. Server::custom_entry_for_registration(const std::string &method) {
  11818. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11819. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11820. // routing() before the custom tables are consulted, so a route registered
  11821. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11822. // there and would be reachable, but they carry protocol-level meaning
  11823. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11824. // library does not route.
  11825. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11826. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11827. has_invalid_registration_ = true;
  11828. return nullptr;
  11829. }
  11830. return &custom_handlers_[method];
  11831. }
  11832. inline Server &Server::CustomRoute(const std::string &method,
  11833. const std::string &pattern,
  11834. Handler handler) {
  11835. auto *entry = custom_entry_for_registration(method);
  11836. if (!entry) { return *this; }
  11837. return add_handler(entry->handlers, pattern, std::move(handler));
  11838. }
  11839. inline Server &Server::CustomRoute(const std::string &method,
  11840. const std::string &pattern,
  11841. HandlerWithContentReader handler) {
  11842. auto *entry = custom_entry_for_registration(method);
  11843. if (!entry) { return *this; }
  11844. return add_handler(entry->handlers_for_content_reader, pattern,
  11845. std::move(handler));
  11846. }
  11847. inline const Server::CustomHandlerEntry *
  11848. Server::find_custom_entry(const std::string &method) const {
  11849. // find() alone would be correct here. The empty() check is what keeps the
  11850. // per-request cost off servers that never call CustomRoute(), which is the
  11851. // overwhelmingly common case; keep it rather than walking into the tree.
  11852. if (custom_handlers_.empty()) { return nullptr; }
  11853. auto it = custom_handlers_.find(method);
  11854. return it == custom_handlers_.end() ? nullptr : &it->second;
  11855. }
  11856. inline Server &Server::WebSocket(const std::string &pattern,
  11857. WebSocketHandler handler) {
  11858. websocket_handlers_.push_back(
  11859. {make_matcher(pattern), std::move(handler), nullptr});
  11860. return *this;
  11861. }
  11862. inline Server &Server::WebSocket(const std::string &pattern,
  11863. WebSocketHandler handler,
  11864. SubProtocolSelector sub_protocol_selector) {
  11865. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11866. std::move(sub_protocol_selector)});
  11867. return *this;
  11868. }
  11869. inline bool Server::set_base_dir(const std::string &dir,
  11870. const std::string &mount_point) {
  11871. return set_mount_point(mount_point, dir);
  11872. }
  11873. inline bool Server::set_mount_point(const std::string &mount_point,
  11874. const std::string &dir, Headers headers) {
  11875. detail::FileStat stat(dir);
  11876. if (stat.is_dir()) {
  11877. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11878. if (!mnt.empty() && mnt[0] == '/') {
  11879. // Without the resolved directory, a file could not be checked to be
  11880. // inside it.
  11881. std::string resolved_base;
  11882. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11883. return false;
  11884. }
  11885. #if defined(_WIN32)
  11886. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11887. resolved_base += '\\';
  11888. }
  11889. #else
  11890. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11891. #endif
  11892. base_dirs_.push_back(
  11893. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11894. return true;
  11895. }
  11896. }
  11897. return false;
  11898. }
  11899. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11900. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11901. if (it->mount_point == mount_point) {
  11902. base_dirs_.erase(it);
  11903. return true;
  11904. }
  11905. }
  11906. return false;
  11907. }
  11908. inline Server &
  11909. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11910. const std::string &mime) {
  11911. // Keyed as find_content_type() looks it up
  11912. auto key = detail::case_ignore::to_lower(ext);
  11913. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  11914. file_extension_and_mimetype_map_[key] = mime;
  11915. return *this;
  11916. }
  11917. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11918. default_file_mimetype_ = mime;
  11919. return *this;
  11920. }
  11921. inline Server &Server::set_file_request_handler(Handler handler) {
  11922. file_request_handler_ = std::move(handler);
  11923. return *this;
  11924. }
  11925. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11926. std::true_type) {
  11927. error_handler_ = std::move(handler);
  11928. return *this;
  11929. }
  11930. inline Server &Server::set_error_handler_core(Handler handler,
  11931. std::false_type) {
  11932. error_handler_ = [handler](const Request &req, Response &res) {
  11933. handler(req, res);
  11934. return HandlerResponse::Handled;
  11935. };
  11936. return *this;
  11937. }
  11938. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11939. exception_handler_ = std::move(handler);
  11940. return *this;
  11941. }
  11942. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11943. pre_routing_handler_ = std::move(handler);
  11944. return *this;
  11945. }
  11946. inline Server &Server::set_post_routing_handler(Handler handler) {
  11947. post_routing_handler_ = std::move(handler);
  11948. return *this;
  11949. }
  11950. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11951. pre_request_handler_ = std::move(handler);
  11952. return *this;
  11953. }
  11954. inline Server &Server::set_logger(Logger logger) {
  11955. logger_ = std::move(logger);
  11956. return *this;
  11957. }
  11958. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11959. error_logger_ = std::move(error_logger);
  11960. return *this;
  11961. }
  11962. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11963. pre_compression_logger_ = std::move(logger);
  11964. return *this;
  11965. }
  11966. inline Server &
  11967. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11968. expect_100_continue_handler_ = std::move(handler);
  11969. return *this;
  11970. }
  11971. inline Server &Server::set_start_handler(StartHandler handler) {
  11972. start_handler_ = std::move(handler);
  11973. return *this;
  11974. }
  11975. inline Server &Server::set_address_family(int family) {
  11976. address_family_ = family;
  11977. return *this;
  11978. }
  11979. inline Server &Server::set_tcp_nodelay(bool on) {
  11980. tcp_nodelay_ = on;
  11981. return *this;
  11982. }
  11983. inline Server &Server::set_ipv6_v6only(bool on) {
  11984. ipv6_v6only_ = on;
  11985. return *this;
  11986. }
  11987. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11988. socket_options_ = std::move(socket_options);
  11989. return *this;
  11990. }
  11991. inline Server &Server::set_default_headers(Headers headers) {
  11992. default_headers_ = std::move(headers);
  11993. return *this;
  11994. }
  11995. inline Server &Server::set_header_writer(
  11996. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11997. header_writer_ = writer;
  11998. return *this;
  11999. }
  12000. inline Server &
  12001. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  12002. trusted_proxies_.clear();
  12003. trusted_proxies_.reserve(proxies.size());
  12004. for (const auto &proxy : proxies) {
  12005. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  12006. }
  12007. return *this;
  12008. }
  12009. inline Server &Server::set_keep_alive_max_count(size_t count) {
  12010. keep_alive_max_count_ = count;
  12011. return *this;
  12012. }
  12013. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  12014. keep_alive_timeout_sec_ = sec;
  12015. return *this;
  12016. }
  12017. template <class Rep, class Period>
  12018. inline Server &Server::set_keep_alive_timeout(
  12019. const std::chrono::duration<Rep, Period> &duration) {
  12020. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12021. set_keep_alive_timeout(sec);
  12022. });
  12023. return *this;
  12024. }
  12025. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  12026. read_timeout_sec_ = sec;
  12027. read_timeout_usec_ = usec;
  12028. return *this;
  12029. }
  12030. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  12031. write_timeout_sec_ = sec;
  12032. write_timeout_usec_ = usec;
  12033. return *this;
  12034. }
  12035. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  12036. idle_interval_sec_ = sec;
  12037. idle_interval_usec_ = usec;
  12038. return *this;
  12039. }
  12040. inline Server &Server::set_payload_max_length(size_t length) {
  12041. payload_max_length_ = length;
  12042. return *this;
  12043. }
  12044. inline Server &Server::set_compress(bool on) {
  12045. compress_ = on;
  12046. return *this;
  12047. }
  12048. inline Server &Server::set_static_file_compression(bool on) {
  12049. static_file_compression_ = on;
  12050. return *this;
  12051. }
  12052. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  12053. static_file_compression_min_length_ = length;
  12054. return *this;
  12055. }
  12056. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  12057. static_file_compression_max_length_ = length;
  12058. return *this;
  12059. }
  12060. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  12061. websocket_max_missed_pongs_ = count;
  12062. return *this;
  12063. }
  12064. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  12065. websocket_ping_interval_sec_ = sec;
  12066. return *this;
  12067. }
  12068. template <class Rep, class Period>
  12069. inline Server &Server::set_websocket_ping_interval(
  12070. const std::chrono::duration<Rep, Period> &duration) {
  12071. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12072. set_websocket_ping_interval(sec);
  12073. });
  12074. return *this;
  12075. }
  12076. inline bool Server::bind_to_port(const std::string &host, int port,
  12077. int socket_flags) {
  12078. auto ret = bind_internal(host, port, socket_flags);
  12079. if (ret == -1) { is_decommissioned = true; }
  12080. return ret >= 0;
  12081. }
  12082. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  12083. auto ret = bind_internal(host, 0, socket_flags);
  12084. if (ret == -1) { is_decommissioned = true; }
  12085. return ret;
  12086. }
  12087. inline bool Server::listen_after_bind() { return listen_internal(); }
  12088. inline bool Server::listen(const std::string &host, int port,
  12089. int socket_flags) {
  12090. return bind_to_port(host, port, socket_flags) && listen_internal();
  12091. }
  12092. inline bool Server::is_running() const { return is_running_; }
  12093. inline void Server::wait_until_ready() const {
  12094. while (!is_running_ && !is_decommissioned) {
  12095. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12096. }
  12097. }
  12098. inline void Server::stop() noexcept {
  12099. // Release the listening socket whether or not the accept loop is running:
  12100. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  12101. // exchange is what makes this safe to call concurrently with the accept loop.
  12102. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  12103. if (sock != INVALID_SOCKET) {
  12104. detail::shutdown_socket(sock);
  12105. detail::close_socket(sock);
  12106. }
  12107. is_decommissioned = false;
  12108. }
  12109. inline void Server::decommission() { is_decommissioned = true; }
  12110. inline bool Server::parse_request_line(const char *s, Request &req) const {
  12111. auto len = strlen(s);
  12112. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  12113. len -= 2;
  12114. {
  12115. // RFC 9112 §3: exactly one SP between the method, the target and the
  12116. // version. Taking other whitespace as a separator too lets recipients
  12117. // that parse more strictly see a different request.
  12118. auto end = s + len;
  12119. if (std::count(s, end, ' ') != 2) { return false; }
  12120. auto sp1 = std::find(s, end, ' ');
  12121. auto sp2 = std::find(sp1 + 1, end, ' ');
  12122. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  12123. req.method.assign(s, sp1);
  12124. req.target.assign(sp1 + 1, sp2);
  12125. req.version.assign(sp2 + 1, end);
  12126. }
  12127. // A method outside the built-in set is accepted only when a handler has been
  12128. // registered for it with CustomRoute().
  12129. const auto &methods = builtin_methods();
  12130. if (methods.find(req.method) == methods.end() &&
  12131. !find_custom_entry(req.method)) {
  12132. output_error_log(Error::InvalidHTTPMethod, &req);
  12133. return false;
  12134. }
  12135. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  12136. output_error_log(Error::InvalidHTTPVersion, &req);
  12137. return false;
  12138. }
  12139. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  12140. // would leave this server routing a different path than a cache or a
  12141. // filter in front of it sees.
  12142. if (!detail::fields::is_request_target(req.target) ||
  12143. req.target.find('#') != std::string::npos) {
  12144. return false;
  12145. }
  12146. {
  12147. detail::divide(req.target, '?',
  12148. [&](const char *lhs_data, std::size_t lhs_size,
  12149. const char *rhs_data, std::size_t rhs_size) {
  12150. req.path =
  12151. decode_path_component(std::string(lhs_data, lhs_size));
  12152. detail::parse_query_text(rhs_data, rhs_size, req.params);
  12153. });
  12154. }
  12155. return true;
  12156. }
  12157. inline bool Server::write_response(Stream &strm, bool close_connection,
  12158. Request &req, Response &res) {
  12159. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  12160. // incorrectly to the error content.
  12161. req.ranges.clear();
  12162. return write_response_core(strm, close_connection, req, res, false);
  12163. }
  12164. inline bool Server::write_response_with_content(Stream &strm,
  12165. bool close_connection,
  12166. const Request &req,
  12167. Response &res) {
  12168. return write_response_core(strm, close_connection, req, res, true);
  12169. }
  12170. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  12171. const Request &req, Response &res,
  12172. bool need_apply_ranges) {
  12173. assert(res.status != -1);
  12174. if (400 <= res.status && error_handler_ &&
  12175. error_handler_(req, res) == HandlerResponse::Handled) {
  12176. need_apply_ranges = true;
  12177. }
  12178. // Before anything below reads res.headers, which the handlers may have
  12179. // filled directly
  12180. detail::erase_invalid_fields(res.headers);
  12181. if (!detail::body_allowed_for_status(res.status)) {
  12182. detail::clear_content(res);
  12183. }
  12184. detail::prefer_assigned_body(res);
  12185. std::string content_type;
  12186. std::string boundary;
  12187. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  12188. // Prepare additional headers
  12189. if (close_connection ||
  12190. detail::has_header_token(req.headers, "Connection", "close") ||
  12191. 400 <= res.status || // Don't leave connections open after errors
  12192. // The client withholds the body until `100 Continue`, which was never
  12193. // sent, so whether and when the body follows is unknown.
  12194. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  12195. // The body was left partway, e.g. by a content receiver that returned
  12196. // false, so the rest of it cannot be told from the next request.
  12197. (req.body_read_started_ && !req.body_consumed_)) {
  12198. res.set_header("Connection", "close");
  12199. } else {
  12200. std::string s = "timeout=";
  12201. s += std::to_string(keep_alive_timeout_sec_);
  12202. if (keep_alive_max_count_ > 0) {
  12203. s += ", max=";
  12204. s += std::to_string(keep_alive_max_count_);
  12205. }
  12206. res.set_header("Keep-Alive", s);
  12207. }
  12208. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12209. !res.has_header("Content-Type")) {
  12210. res.set_header("Content-Type", "text/plain");
  12211. }
  12212. detail::set_framing_headers(req, res, boundary, content_type);
  12213. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12214. res.set_header("Accept-Ranges", "bytes");
  12215. }
  12216. if (post_routing_handler_) {
  12217. post_routing_handler_(req, res);
  12218. detail::erase_invalid_fields(res.headers);
  12219. // Again, for a body or framing headers the handler changed.
  12220. detail::set_framing_headers(req, res, boundary, content_type);
  12221. }
  12222. // Response line and headers
  12223. detail::BufferStream bstrm;
  12224. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12225. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12226. // Combine a small body with the headers so the whole response leaves in a
  12227. // single write. A large body is written on its own instead: a copy of it
  12228. // costs more than the extra write saves.
  12229. auto send_body =
  12230. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12231. auto body_is_separate = false;
  12232. auto provider_done = false;
  12233. if (send_body && !res.body.empty() && !res.content_provider_) {
  12234. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12235. bstrm.write(res.body.data(), res.body.size());
  12236. } else {
  12237. body_is_separate = true;
  12238. }
  12239. } else if (send_body && res.content_provider_ &&
  12240. res.is_file_content_provider_ &&
  12241. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12242. // A small file is read into the same buffer. Other providers may produce
  12243. // their data over time, so they are never held back.
  12244. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12245. return false;
  12246. }
  12247. provider_done = true;
  12248. }
  12249. // Log before writing to avoid race condition with client-side code that
  12250. // accesses logger-captured data immediately after receiving the response.
  12251. output_log(req, res);
  12252. // Flush buffer
  12253. auto &data = bstrm.get_buffer();
  12254. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12255. if (body_is_separate) {
  12256. return detail::write_data(strm, res.body.data(), res.body.size());
  12257. }
  12258. // Streaming body
  12259. if (send_body && res.content_provider_) {
  12260. if (!provider_done &&
  12261. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12262. return false;
  12263. }
  12264. res.content_provider_success_ = true;
  12265. }
  12266. return true;
  12267. }
  12268. inline bool
  12269. Server::write_content_with_provider(Stream &strm, const Request &req,
  12270. Response &res, const std::string &boundary,
  12271. const std::string &content_type) {
  12272. auto is_shutting_down = [this]() { return is_stopping(); };
  12273. if (res.content_length_ > 0) {
  12274. if (!detail::is_partial_content(req, res)) {
  12275. return detail::write_content(strm, res.content_provider_, 0,
  12276. res.content_length_, is_shutting_down);
  12277. } else if (req.ranges.size() == 1) {
  12278. auto offset_and_length = detail::get_range_offset_and_length(
  12279. req.ranges[0], res.content_length_);
  12280. return detail::write_content(strm, res.content_provider_,
  12281. offset_and_length.first,
  12282. offset_and_length.second, is_shutting_down);
  12283. } else {
  12284. return detail::write_multipart_ranges_data(
  12285. strm, req, res, boundary, content_type, res.content_length_,
  12286. is_shutting_down);
  12287. }
  12288. } else {
  12289. if (res.is_chunked_content_provider_) {
  12290. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12291. // re-negotiating here would disagree with them, e.g. once a handler's
  12292. // own Content-Encoding header suppresses the negotiation.
  12293. auto compressor = detail::make_compressor(res.content_coding_);
  12294. if (!compressor) {
  12295. compressor = detail::make_unique<detail::nocompressor>();
  12296. }
  12297. return detail::write_content_chunked(strm, res.content_provider_,
  12298. is_shutting_down, *compressor);
  12299. } else {
  12300. return detail::write_content_without_length(strm, res.content_provider_,
  12301. is_shutting_down);
  12302. }
  12303. }
  12304. }
  12305. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12306. FormFields::iterator cur_field;
  12307. FormFiles::iterator cur_file;
  12308. auto is_text_field = false;
  12309. size_t count = 0;
  12310. if (read_content_core(
  12311. strm, req, res,
  12312. // Regular
  12313. [&](const char *buf, size_t n) {
  12314. // Prevent arithmetic overflow when checking sizes.
  12315. // Avoid computing (req.body.size() + n) directly because
  12316. // adding two unsigned `size_t` values can wrap around and
  12317. // produce a small result instead of indicating overflow.
  12318. // Instead, check using subtraction: ensure `n` does not
  12319. // exceed the remaining capacity `max_size() - size()`.
  12320. if (req.body.size() >= req.body.max_size() ||
  12321. n > req.body.max_size() - req.body.size()) {
  12322. return false;
  12323. }
  12324. // Limit decompressed body size to payload_max_length_ to protect
  12325. // against "zip bomb" attacks where a small compressed payload
  12326. // decompresses to a massive size.
  12327. if (payload_max_length_ > 0 &&
  12328. (req.body.size() >= payload_max_length_ ||
  12329. n > payload_max_length_ - req.body.size())) {
  12330. return false;
  12331. }
  12332. req.body.append(buf, n);
  12333. return true;
  12334. },
  12335. // Multipart FormData
  12336. [&](const FormData &file) {
  12337. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12338. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12339. output_error_log(Error::TooManyFormDataFiles, &req);
  12340. return false;
  12341. }
  12342. if (file.filename.empty()) {
  12343. cur_field = req.form.fields.emplace(
  12344. file.name, FormField{file.name, file.content, file.headers});
  12345. is_text_field = true;
  12346. } else {
  12347. cur_file = req.form.files.emplace(file.name, file);
  12348. is_text_field = false;
  12349. }
  12350. return true;
  12351. },
  12352. [&](const char *buf, size_t n) {
  12353. if (is_text_field) {
  12354. auto &content = cur_field->second.content;
  12355. if (content.size() + n > content.max_size()) { return false; }
  12356. content.append(buf, n);
  12357. } else {
  12358. auto &content = cur_file->second.content;
  12359. if (content.size() + n > content.max_size()) { return false; }
  12360. content.append(buf, n);
  12361. }
  12362. return true;
  12363. })) {
  12364. const auto &content_type = req.get_header_value("Content-Type");
  12365. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12366. "application/x-www-form-urlencoded")) {
  12367. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12368. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12369. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12370. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12371. return false;
  12372. }
  12373. detail::parse_query_text(req.body, req.params);
  12374. }
  12375. return true;
  12376. }
  12377. return false;
  12378. }
  12379. inline bool Server::read_content_with_content_receiver(
  12380. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12381. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12382. return read_content_core(strm, req, res, std::move(receiver),
  12383. std::move(multipart_header),
  12384. std::move(multipart_receiver));
  12385. }
  12386. inline bool Server::read_content_core(
  12387. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12388. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12389. detail::FormDataParser multipart_form_data_parser;
  12390. ContentReceiverWithProgress out;
  12391. if (req.is_multipart_form_data()) {
  12392. const auto &content_type = req.get_header_value("Content-Type");
  12393. std::string boundary;
  12394. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12395. res.status = StatusCode::BadRequest_400;
  12396. output_error_log(Error::MultipartParsing, &req);
  12397. return false;
  12398. }
  12399. multipart_form_data_parser.set_boundary(std::move(boundary));
  12400. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12401. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12402. multipart_receiver);
  12403. };
  12404. } else {
  12405. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12406. size_t /*len*/) { return receiver(buf, n); };
  12407. }
  12408. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12409. if (!req.has_header("Content-Length") &&
  12410. !detail::is_chunked_transfer_encoding(req.headers)) {
  12411. return true;
  12412. }
  12413. // A second read would start where the first one stopped, or in the next
  12414. // request.
  12415. if (req.body_read_started_) { return false; }
  12416. // The client is waiting for this before it sends the body.
  12417. if (req.expect_100_continue_pending_) {
  12418. req.expect_100_continue_pending_ = false;
  12419. detail::write_response_line(strm, StatusCode::Continue_100);
  12420. strm.write("\r\n");
  12421. }
  12422. // Set before reading, since a receiver may also stop by throwing.
  12423. req.body_read_started_ = true;
  12424. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12425. out, true)) {
  12426. return false;
  12427. }
  12428. req.body_consumed_ = true;
  12429. if (req.is_multipart_form_data()) {
  12430. if (!multipart_form_data_parser.is_valid()) {
  12431. res.status = StatusCode::BadRequest_400;
  12432. output_error_log(Error::MultipartParsing, &req);
  12433. return false;
  12434. }
  12435. }
  12436. return true;
  12437. }
  12438. inline bool Server::handle_file_request(Request &req, Response &res) {
  12439. if (!detail::is_valid_path(req.path)) { return false; }
  12440. for (const auto &entry : base_dirs_) {
  12441. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12442. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12443. // One that already ends in '/' (the root mount among them) carries its own
  12444. // boundary; set_mount_point() guarantees the mount point is not empty.
  12445. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12446. (entry.mount_point.back() == '/' ||
  12447. req.path.size() == entry.mount_point.size() ||
  12448. req.path[entry.mount_point.size()] == '/')) {
  12449. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12450. auto path = entry.base_dir + sub_path;
  12451. if (path.back() == '/') { path += "index.html"; }
  12452. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12453. // but symlinks/junctions can still escape the base directory. A path
  12454. // that cannot be resolved, which includes one that does not exist, is
  12455. // not served from here.
  12456. std::string resolved_path;
  12457. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12458. if (!detail::is_path_within_base(resolved_path,
  12459. entry.resolved_base_dir)) {
  12460. res.status = StatusCode::Forbidden_403;
  12461. return true;
  12462. }
  12463. detail::FileStat stat(path);
  12464. if (stat.is_dir()) {
  12465. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12466. // in the name from reading as a scheme.
  12467. auto name = req.path.substr(req.path.rfind('/') + 1);
  12468. res.set_redirect("./" + encode_path_component(name) + "/",
  12469. StatusCode::MovedPermanently_301);
  12470. return true;
  12471. }
  12472. if (stat.is_file()) {
  12473. for (const auto &kv : entry.headers) {
  12474. res.set_header(kv.first, kv.second);
  12475. }
  12476. auto content_type = detail::find_content_type(
  12477. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12478. auto encoding = detail::EncodingType::None;
  12479. if (static_file_compression_) {
  12480. encoding = static_file_encoding(req, res, content_type, stat.size());
  12481. }
  12482. // The ETag names the representation actually sent, so a client that
  12483. // cached the compressed form revalidates against the compressed ETag
  12484. // and still gets a 304, while one that took identity keeps the plain
  12485. // ETag.
  12486. auto etag = detail::compute_etag(
  12487. stat, encoding == detail::EncodingType::None
  12488. ? std::string()
  12489. : std::string("-") + detail::encoding_name(encoding));
  12490. if (!etag.empty()) { res.set_header("ETag", etag); }
  12491. auto mtime = stat.mtime();
  12492. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12493. if (!last_modified.empty()) {
  12494. res.set_header("Last-Modified", last_modified);
  12495. }
  12496. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12497. check_if_range(req, etag, mtime);
  12498. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12499. if (!mm->is_open()) {
  12500. output_error_log(Error::OpenFile, &req);
  12501. return false;
  12502. }
  12503. detail::set_file_content_provider(res, mm, content_type, encoding);
  12504. if (req.method != "HEAD" && file_request_handler_) {
  12505. file_request_handler_(req, res);
  12506. }
  12507. return true;
  12508. } else {
  12509. output_error_log(Error::OpenFile, &req);
  12510. }
  12511. }
  12512. }
  12513. return false;
  12514. }
  12515. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12516. const std::string &etag,
  12517. time_t mtime) const {
  12518. // Handle conditional GET:
  12519. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12520. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12521. if (req.has_header("If-None-Match")) {
  12522. if (!etag.empty()) {
  12523. auto val =
  12524. detail::get_combined_header_value(req.headers, "If-None-Match");
  12525. // NOTE: We use exact string matching here. This works correctly
  12526. // because our server always generates weak ETags (W/"..."), and
  12527. // clients typically send back the same ETag they received.
  12528. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12529. // If-None-Match, where W/"x" and "x" would match, but this
  12530. // simplified implementation requires exact matches.
  12531. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12532. [&](const char *b, const char *e) {
  12533. auto seg_len = static_cast<size_t>(e - b);
  12534. return (seg_len == 1 && *b == '*') ||
  12535. (seg_len == etag.size() &&
  12536. std::equal(b, e, etag.begin()));
  12537. });
  12538. if (ret) {
  12539. res.status = StatusCode::NotModified_304;
  12540. return true;
  12541. }
  12542. }
  12543. } else if (req.has_header("If-Modified-Since")) {
  12544. auto val = req.get_header_value("If-Modified-Since");
  12545. auto t = detail::parse_http_date(val);
  12546. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12547. res.status = StatusCode::NotModified_304;
  12548. return true;
  12549. }
  12550. }
  12551. return false;
  12552. }
  12553. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12554. time_t mtime) const {
  12555. // Handle If-Range for partial content requests (RFC 9110
  12556. // Section 13.1.5). If-Range is only evaluated when Range header is
  12557. // present. If the validator matches, serve partial content; otherwise
  12558. // serve full content.
  12559. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12560. auto val = req.get_header_value("If-Range");
  12561. auto is_valid_range = [&]() {
  12562. if (detail::is_strong_etag(val)) {
  12563. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12564. // comparison.
  12565. return (!etag.empty() && val == etag);
  12566. } else if (detail::is_weak_etag(val)) {
  12567. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12568. return false;
  12569. } else {
  12570. // HTTP-date comparison
  12571. auto t = detail::parse_http_date(val);
  12572. return (t != static_cast<time_t>(-1) && mtime <= t);
  12573. }
  12574. };
  12575. if (!is_valid_range()) {
  12576. // Validator doesn't match: ignore Range and serve full content
  12577. req.ranges.clear();
  12578. return false;
  12579. }
  12580. }
  12581. return true;
  12582. }
  12583. inline socket_t
  12584. Server::create_server_socket(const std::string &host, int port,
  12585. int socket_flags,
  12586. SocketOptions socket_options) const {
  12587. return detail::create_socket(
  12588. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12589. ipv6_v6only_, std::move(socket_options),
  12590. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12591. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12592. output_error_log(Error::BindIPAddress, nullptr);
  12593. return false;
  12594. }
  12595. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12596. output_error_log(Error::Listen, nullptr);
  12597. return false;
  12598. }
  12599. return true;
  12600. });
  12601. }
  12602. inline int Server::bind_internal(const std::string &host, int port,
  12603. int socket_flags) {
  12604. if (is_decommissioned) { return -1; }
  12605. if (!is_valid()) { return -1; }
  12606. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12607. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12608. if (port == 0) {
  12609. struct sockaddr_storage addr;
  12610. socklen_t addr_len = sizeof(addr);
  12611. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12612. &addr_len) == -1) {
  12613. output_error_log(Error::GetSockName, nullptr);
  12614. return -1;
  12615. }
  12616. if (addr.ss_family == AF_INET) {
  12617. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12618. } else if (addr.ss_family == AF_INET6) {
  12619. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12620. } else {
  12621. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12622. return -1;
  12623. }
  12624. } else {
  12625. return port;
  12626. }
  12627. }
  12628. inline bool Server::listen_internal() {
  12629. // A stop() between bind and listen leaves nothing to accept on. Report
  12630. // failure instead of returning success without ever serving, and mark the
  12631. // server decommissioned the way any failed listen does so that a concurrent
  12632. // wait_until_ready() wakes up instead of spinning forever.
  12633. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12634. is_decommissioned = true;
  12635. return false;
  12636. }
  12637. auto ret = true;
  12638. is_running_ = true;
  12639. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12640. if (start_handler_) { start_handler_(); }
  12641. {
  12642. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12643. while (svr_sock_ != INVALID_SOCKET) {
  12644. #ifndef _WIN32
  12645. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12646. #endif
  12647. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12648. idle_interval_usec_);
  12649. if (val == 0) { // Timeout
  12650. task_queue->on_idle();
  12651. continue;
  12652. }
  12653. #ifndef _WIN32
  12654. }
  12655. #endif
  12656. #if defined _WIN32
  12657. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12658. // OVERLAPPED
  12659. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12660. #elif defined SOCK_CLOEXEC
  12661. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12662. #else
  12663. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12664. #endif
  12665. if (sock == INVALID_SOCKET) {
  12666. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12667. // touches the CRT errno, so the two have to be asked platform by
  12668. // platform rather than by testing errno here.
  12669. if (detail::is_accept_resource_error()) {
  12670. // The per-process descriptor limit or the network stack's buffer
  12671. // space has been reached. Try to accept new connections after a
  12672. // short sleep.
  12673. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12674. continue;
  12675. } else if (detail::is_accept_transient_error()) {
  12676. continue;
  12677. }
  12678. // Take the descriptor out of svr_sock_ before closing it: a later
  12679. // stop() would otherwise shutdown()/close() a value the OS may have
  12680. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12681. // gone. The exchange also settles the race with a concurrent stop(),
  12682. // since whichever side takes the descriptor closes it exactly once.
  12683. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12684. if (listen_sock != INVALID_SOCKET) {
  12685. detail::close_socket(listen_sock);
  12686. ret = false;
  12687. output_error_log(Error::Connection, nullptr);
  12688. } else {
  12689. ; // The server socket was closed by user.
  12690. }
  12691. break;
  12692. }
  12693. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12694. read_timeout_sec_, read_timeout_usec_);
  12695. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12696. write_timeout_sec_, write_timeout_usec_);
  12697. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12698. if (!task_queue->enqueue(
  12699. [this, sock]() { process_and_close_socket(sock); })) {
  12700. output_error_log(Error::ResourceExhaustion, nullptr);
  12701. detail::shutdown_socket(sock);
  12702. detail::close_socket(sock);
  12703. }
  12704. }
  12705. task_queue->shutdown();
  12706. }
  12707. is_decommissioned = !ret;
  12708. return ret;
  12709. }
  12710. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  12711. // Call from a catch block. The response is a 500 unless the exception handler
  12712. // sets another status. Returns whether the exception handler ran.
  12713. inline bool Server::handle_exception(Request &req, Response &res) {
  12714. res.status = StatusCode::InternalServerError_500;
  12715. if (!exception_handler_) { return false; }
  12716. exception_handler_(req, res, std::current_exception());
  12717. return true;
  12718. }
  12719. #endif
  12720. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12721. bool skip_pre_routing) {
  12722. if (!skip_pre_routing && pre_routing_handler_ &&
  12723. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12724. return true;
  12725. }
  12726. // File handler
  12727. if ((req.method == "GET" || req.method == "HEAD") &&
  12728. handle_file_request(req, res)) {
  12729. return true;
  12730. }
  12731. const auto *custom = find_custom_entry(req.method);
  12732. // The second clause mirrors what expect_content() does unconditionally for
  12733. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12734. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12735. // `allprop`) would skip its handler and fall through to 404.
  12736. if (detail::expect_content(req) ||
  12737. (custom && !custom->handlers_for_content_reader.empty())) {
  12738. // Content reader handler
  12739. {
  12740. // Track whether the ContentReader was aborted due to the decompressed
  12741. // payload exceeding `payload_max_length_`.
  12742. // The user handler runs after the lambda returns, so we must restore the
  12743. // 413 status if the handler overwrites it.
  12744. bool content_reader_payload_too_large = false;
  12745. ContentReader reader(
  12746. [&](ContentReceiver receiver) {
  12747. auto result = read_content_with_content_receiver(
  12748. strm, req, res, std::move(receiver), nullptr, nullptr);
  12749. if (!result) {
  12750. output_error_log(Error::Read, &req);
  12751. if (res.status == StatusCode::PayloadTooLarge_413) {
  12752. content_reader_payload_too_large = true;
  12753. }
  12754. }
  12755. return result;
  12756. },
  12757. [&](FormDataHeader header, ContentReceiver receiver) {
  12758. auto result = read_content_with_content_receiver(
  12759. strm, req, res, nullptr, std::move(header),
  12760. std::move(receiver));
  12761. if (!result) {
  12762. output_error_log(Error::Read, &req);
  12763. if (res.status == StatusCode::PayloadTooLarge_413) {
  12764. content_reader_payload_too_large = true;
  12765. }
  12766. }
  12767. return result;
  12768. });
  12769. bool dispatched = false;
  12770. if (req.method == "POST") {
  12771. dispatched = dispatch_request_for_content_reader(
  12772. req, res, std::move(reader), post_handlers_for_content_reader_);
  12773. } else if (req.method == "PUT") {
  12774. dispatched = dispatch_request_for_content_reader(
  12775. req, res, std::move(reader), put_handlers_for_content_reader_);
  12776. } else if (req.method == "PATCH") {
  12777. dispatched = dispatch_request_for_content_reader(
  12778. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12779. } else if (req.method == "DELETE") {
  12780. dispatched = dispatch_request_for_content_reader(
  12781. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12782. } else if (custom) {
  12783. dispatched = dispatch_request_for_content_reader(
  12784. req, res, std::move(reader), custom->handlers_for_content_reader);
  12785. }
  12786. if (dispatched) {
  12787. if (content_reader_payload_too_large) {
  12788. // Enforce the limit: override any status the handler may have set
  12789. // and return false so the error path sends a plain 413 response.
  12790. res.status = StatusCode::PayloadTooLarge_413;
  12791. detail::clear_content(res);
  12792. return false;
  12793. }
  12794. return true;
  12795. }
  12796. }
  12797. // NOTE: `req.body` is not read here. For a regular handler the body is
  12798. // read inside dispatch_request(), after the route has matched and the
  12799. // pre-request handler has approved the request, so that a rejected
  12800. // request (e.g. failed authentication) never forces us to buffer a
  12801. // potentially large body.
  12802. }
  12803. // Regular handler
  12804. if (req.method == "GET" || req.method == "HEAD") {
  12805. return dispatch_request(req, res, get_handlers_, strm);
  12806. } else if (req.method == "POST") {
  12807. return dispatch_request(req, res, post_handlers_, strm);
  12808. } else if (req.method == "PUT") {
  12809. return dispatch_request(req, res, put_handlers_, strm);
  12810. } else if (req.method == "DELETE") {
  12811. return dispatch_request(req, res, delete_handlers_, strm);
  12812. } else if (req.method == "OPTIONS") {
  12813. return dispatch_request(req, res, options_handlers_, strm);
  12814. } else if (req.method == "PATCH") {
  12815. return dispatch_request(req, res, patch_handlers_, strm);
  12816. } else if (custom) {
  12817. return dispatch_request(req, res, custom->handlers, strm);
  12818. }
  12819. res.status = StatusCode::BadRequest_400;
  12820. return false;
  12821. }
  12822. inline bool Server::dispatch_request(Request &req, Response &res,
  12823. const Handlers &handlers, Stream &strm) {
  12824. for (const auto &x : handlers) {
  12825. const auto &matcher = x.first;
  12826. const auto &handler = x.second;
  12827. if (matcher->match(req)) {
  12828. req.matched_route = matcher->pattern();
  12829. // Run the pre-request handler before reading the body so a rejected
  12830. // request (e.g. failed authentication) never forces us to buffer a
  12831. // potentially large body. `req.matched_route` is available here.
  12832. if (pre_request_handler_ &&
  12833. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12834. return true;
  12835. }
  12836. // The route matched and the request was approved; read the body now.
  12837. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12838. output_error_log(Error::Read, &req);
  12839. return false;
  12840. }
  12841. handler(req, res);
  12842. return true;
  12843. }
  12844. }
  12845. return false;
  12846. }
  12847. // Decides the content coding for a response served straight from a file. Both
  12848. // the ETag, which has to name the representation actually sent, and
  12849. // `apply_static_file_compression()` go through this, so the two cannot drift
  12850. // apart.
  12851. inline detail::EncodingType
  12852. Server::static_file_encoding(const Request &req, const Response &res,
  12853. const std::string &content_type,
  12854. size_t length) const {
  12855. if (!static_file_compression_) { return detail::EncodingType::None; }
  12856. // Nothing to compress, and an empty file already answers with
  12857. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12858. // turn an empty body into a 20-byte gzip stream.
  12859. if (length == 0) { return detail::EncodingType::None; }
  12860. // A file that already fits in a single packet gains nothing from being made
  12861. // smaller, since it still travels in that one segment, and a file of a few
  12862. // bytes comes out larger than it went in.
  12863. if (length < static_file_compression_min_length_) {
  12864. return detail::EncodingType::None;
  12865. }
  12866. // RFC 9110 applies Range to the representation after content coding, so a
  12867. // compressed 206 would mean compressing the whole file and then slicing it.
  12868. // Serve ranges from the identity representation instead.
  12869. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12870. if (static_file_compression_max_length_ > 0 &&
  12871. length > static_file_compression_max_length_) {
  12872. return detail::EncodingType::None;
  12873. }
  12874. return detail::encoding_type(req, res, content_type);
  12875. }
  12876. // Compresses a file-backed content provider into `res.body`. Returns false when
  12877. // the response is left untouched.
  12878. inline bool Server::apply_static_file_compression(const Request &req,
  12879. Response &res) const {
  12880. auto type = res.content_coding_;
  12881. if (type == detail::EncodingType::None || !res.content_provider_) {
  12882. return false;
  12883. }
  12884. auto compressor = detail::make_compressor(type);
  12885. if (!compressor) { return false; }
  12886. output_pre_compression_log(req, res);
  12887. std::string compressed;
  12888. if (!detail::compress_content_provider(res.content_provider_,
  12889. res.content_length_, *compressor,
  12890. compressed)) {
  12891. return false;
  12892. }
  12893. res.body.swap(compressed);
  12894. // The provider was consumed in full, so its releaser hears about a success.
  12895. res.content_provider_success_ = true;
  12896. detail::clear_content_provider(res);
  12897. res.set_header("Content-Encoding", detail::encoding_name(type));
  12898. res.set_header("Vary", "Accept-Encoding");
  12899. return true;
  12900. }
  12901. inline void Server::apply_ranges(const Request &req, Response &res,
  12902. std::string &content_type,
  12903. std::string &boundary) const {
  12904. // A known-length content provider leaves `res.body` empty, so the compressor
  12905. // at the end of this function never runs for one (issue #2545). A file-backed
  12906. // provider is fully readable right here, so compress it and answer with an
  12907. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12908. // takes the same path as `set_content()` from here on. Range requests never
  12909. // get a content coding, so `Content-Range` still names identity bytes and
  12910. // none of the range handling below applies.
  12911. if (apply_static_file_compression(req, res)) { return; }
  12912. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12913. auto it = res.headers.find("Content-Type");
  12914. if (it != res.headers.end()) {
  12915. content_type = it->second;
  12916. res.headers.erase(it);
  12917. }
  12918. boundary = detail::make_multipart_data_boundary();
  12919. res.set_header("Content-Type",
  12920. "multipart/byteranges; boundary=" + boundary);
  12921. }
  12922. auto type =
  12923. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  12924. if (res.body.empty()) {
  12925. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12926. res.status == StatusCode::PartialContent_206) {
  12927. auto offset_and_length = detail::get_range_offset_and_length(
  12928. req.ranges[0], res.content_length_);
  12929. auto content_range = detail::make_content_range_header_field(
  12930. offset_and_length, res.content_length_);
  12931. res.set_header("Content-Range", content_range);
  12932. } else if (res.is_chunked_content_provider_) {
  12933. res.content_coding_ = type;
  12934. if (type != detail::EncodingType::None) {
  12935. res.set_header("Content-Encoding", detail::encoding_name(type));
  12936. res.set_header("Vary", "Accept-Encoding");
  12937. }
  12938. }
  12939. } else {
  12940. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12941. ;
  12942. } else if (req.ranges.size() == 1) {
  12943. auto offset_and_length =
  12944. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12945. auto offset = offset_and_length.first;
  12946. auto length = offset_and_length.second;
  12947. auto content_range = detail::make_content_range_header_field(
  12948. offset_and_length, res.body.size());
  12949. res.set_header("Content-Range", content_range);
  12950. assert(offset + length <= res.body.size());
  12951. res.body = res.body.substr(offset, length);
  12952. } else {
  12953. std::string data;
  12954. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12955. res.body.size(), data);
  12956. res.body.swap(data);
  12957. }
  12958. if (type != detail::EncodingType::None) {
  12959. output_pre_compression_log(req, res);
  12960. if (auto compressor = detail::make_compressor(type)) {
  12961. std::string compressed;
  12962. if (compressor->compress(res.body.data(), res.body.size(), true,
  12963. [&](const char *data, size_t data_len) {
  12964. compressed.append(data, data_len);
  12965. return true;
  12966. })) {
  12967. res.body.swap(compressed);
  12968. res.set_header("Content-Encoding", detail::encoding_name(type));
  12969. res.set_header("Vary", "Accept-Encoding");
  12970. }
  12971. }
  12972. }
  12973. res.content_length_ = res.body.size();
  12974. }
  12975. }
  12976. inline bool Server::dispatch_request_for_content_reader(
  12977. Request &req, Response &res, ContentReader content_reader,
  12978. const HandlersForContentReader &handlers) const {
  12979. for (const auto &x : handlers) {
  12980. const auto &matcher = x.first;
  12981. const auto &handler = x.second;
  12982. if (matcher->match(req)) {
  12983. req.matched_route = matcher->pattern();
  12984. if (!pre_request_handler_ ||
  12985. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12986. handler(req, res, content_reader);
  12987. }
  12988. return true;
  12989. }
  12990. }
  12991. return false;
  12992. }
  12993. inline std::string
  12994. get_client_ip(const std::string &x_forwarded_for,
  12995. const std::vector<std::string> &trusted_proxies) {
  12996. // X-Forwarded-For is a comma-separated list per RFC 7239
  12997. std::vector<std::string> ip_list;
  12998. detail::split(x_forwarded_for.data(),
  12999. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  13000. [&](const char *b, const char *e) {
  13001. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  13002. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  13003. });
  13004. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  13005. // no segments. Signal "no client IP derived" with an empty string so the
  13006. // caller can fall back to the connection-level remote address.
  13007. if (ip_list.empty()) { return std::string(); }
  13008. // Each hop appends the address it received the request from, so the rightmost
  13009. // entries are the ones written by our own infrastructure while the leftmost
  13010. // are whatever the original client chose to send. Walk from the right and
  13011. // skip trusted proxies; the first address that is not a trusted proxy is the
  13012. // furthest point still attributable to a real hop, i.e. the client. Scanning
  13013. // from the left instead lets a client forge an arbitrary address by following
  13014. // it with a trusted proxy's address, which the left-to-right scan then
  13015. // returned as the client.
  13016. for (size_t i = ip_list.size(); i-- > 0;) {
  13017. const auto &ip = ip_list[i];
  13018. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  13019. }
  13020. // Every hop was a trusted proxy; fall back to the first entry.
  13021. return ip_list.front();
  13022. }
  13023. inline bool
  13024. Server::process_request(Stream &strm, const std::string &remote_addr,
  13025. int remote_port, const std::string &local_addr,
  13026. int local_port, bool close_connection,
  13027. bool &connection_closed,
  13028. const std::function<void(Request &)> &setup_request,
  13029. bool *websocket_upgraded) {
  13030. std::array<char, 2048> buf{};
  13031. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13032. // The read timeout bounds the request line and headers as a whole, so a
  13033. // client sending them a byte at a time cannot hold the worker any longer.
  13034. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  13035. strm.set_max_timeout(read_timeout_msec);
  13036. // Connection has been closed on client
  13037. if (!line_reader.getline()) { return false; }
  13038. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  13039. // clients send an extra CRLF after a request body, which would otherwise be
  13040. // parsed as the next request on a persistent connection.
  13041. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  13042. return false;
  13043. }
  13044. Request req;
  13045. req.start_time_ = std::chrono::steady_clock::now();
  13046. req.remote_addr = remote_addr;
  13047. req.remote_port = remote_port;
  13048. req.local_addr = local_addr;
  13049. req.local_port = local_port;
  13050. Response res;
  13051. res.version = "HTTP/1.1";
  13052. res.headers = default_headers_;
  13053. // RFC 9112 §9.6: a server that sends the "close" connection option must
  13054. // close the connection after that response, whichever path wrote it (an
  13055. // error status, a handler, or a rejected request). Reading on would also
  13056. // parse whatever the client sent next on a connection it considers done.
  13057. auto honor_connection_close = detail::scope_exit([&] {
  13058. if (detail::has_header_token(res.headers, "Connection", "close")) {
  13059. connection_closed = true;
  13060. }
  13061. });
  13062. // Request line and headers. A rejected message leaves the rest of it (and
  13063. // any body) unread, so the connection cannot be reused: the leftover bytes
  13064. // would be parsed as the next request.
  13065. if (!parse_request_line(line_reader.ptr(), req)) {
  13066. connection_closed = true;
  13067. res.status = StatusCode::BadRequest_400;
  13068. output_error_log(Error::InvalidRequestLine, &req);
  13069. return write_response(strm, close_connection, req, res);
  13070. }
  13071. // Request headers
  13072. if (!detail::read_headers(strm, req.headers)) {
  13073. connection_closed = true;
  13074. res.status = StatusCode::BadRequest_400;
  13075. output_error_log(Error::InvalidHeaders, &req);
  13076. return write_response(strm, close_connection, req, res);
  13077. }
  13078. strm.set_max_timeout(0);
  13079. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  13080. // which would otherwise let an intermediary and this parser disagree on
  13081. // where the body ends and enable request smuggling. Three cases: a
  13082. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  13083. // or empty), which would otherwise be read as "no body"; a non-zero
  13084. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  13085. // tolerated for compatibility with existing clients); and a
  13086. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  13087. // length undeterminable. None of them may fall through to the "no body"
  13088. // path, or the body bytes are parsed as the next request on a persistent
  13089. // connection.
  13090. auto is_invalid_content_length = false;
  13091. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  13092. is_invalid_content_length);
  13093. if (is_invalid_content_length ||
  13094. detail::has_conflicting_content_length(req.headers) ||
  13095. (req.has_header("Transfer-Encoding") &&
  13096. !detail::is_chunked_transfer_encoding(req.headers))) {
  13097. connection_closed = true;
  13098. res.status = StatusCode::BadRequest_400;
  13099. return write_response(strm, close_connection, req, res);
  13100. }
  13101. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  13102. if (req.has_header("Transfer-Encoding") &&
  13103. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  13104. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  13105. "chunked"))) {
  13106. connection_closed = true;
  13107. res.status = StatusCode::NotImplemented_501;
  13108. return write_response(strm, close_connection, req, res);
  13109. }
  13110. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  13111. // HTTP/1.0 request, is honoured, but the connection closes after the
  13112. // response.
  13113. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  13114. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  13115. // value, or none in HTTP/1.1, so that every recipient of the request sees
  13116. // the same authority.
  13117. auto host_count = req.get_header_value_count("Host");
  13118. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  13119. !detail::fields::is_host(req.get_header_value("Host"))) {
  13120. connection_closed = true;
  13121. res.status = StatusCode::BadRequest_400;
  13122. output_error_log(Error::InvalidHeaders, &req);
  13123. return write_response(strm, close_connection, req, res);
  13124. }
  13125. // Check if the request URI doesn't exceed the limit
  13126. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13127. connection_closed = true;
  13128. res.status = StatusCode::UriTooLong_414;
  13129. output_error_log(Error::ExceedUriMaxLength, &req);
  13130. return write_response(strm, close_connection, req, res);
  13131. }
  13132. if (detail::has_header_token(req.headers, "Connection", "close")) {
  13133. connection_closed = true;
  13134. }
  13135. if (req.version == "HTTP/1.0" &&
  13136. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  13137. connection_closed = true;
  13138. }
  13139. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  13140. // itself a trusted proxy. Otherwise any direct client could spoof
  13141. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  13142. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  13143. req.has_header("X-Forwarded-For")) {
  13144. // Some proxies append the address they observed as a separate
  13145. // X-Forwarded-For field line instead of extending the one the client sent
  13146. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  13147. // be scanned. Reading only the first occurrence would hand back the
  13148. // client-supplied, and therefore forgeable, value.
  13149. auto x_forwarded_for =
  13150. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  13151. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  13152. req.remote_addr = derived.empty() ? remote_addr : derived;
  13153. } else {
  13154. req.remote_addr = remote_addr;
  13155. }
  13156. req.remote_port = remote_port;
  13157. req.local_addr = local_addr;
  13158. req.local_port = local_port;
  13159. if (req.has_header("Accept")) {
  13160. auto accept_header =
  13161. detail::get_combined_header_value(req.headers, "Accept");
  13162. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  13163. connection_closed = true;
  13164. res.status = StatusCode::BadRequest_400;
  13165. output_error_log(Error::HTTPParsing, &req);
  13166. return write_response(strm, close_connection, req, res);
  13167. }
  13168. }
  13169. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  13170. if ((req.method == "GET" || req.method == "HEAD") &&
  13171. req.has_header("Range")) {
  13172. const auto &range_header_value = req.get_header_value("Range");
  13173. // RFC 9110 14.2: a range unit other than bytes must be ignored
  13174. auto unit = range_header_value.substr(0, range_header_value.find('='));
  13175. if (detail::case_ignore::equal(unit, "bytes") &&
  13176. !detail::parse_range_header(range_header_value, req.ranges)) {
  13177. connection_closed = true;
  13178. res.status = StatusCode::RangeNotSatisfiable_416;
  13179. output_error_log(Error::InvalidRangeHeader, &req);
  13180. return write_response(strm, close_connection, req, res);
  13181. }
  13182. }
  13183. if (setup_request) { setup_request(req); }
  13184. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  13185. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  13186. // must be ignored. An expectation we do not recognize is left alone; the
  13187. // 417 the section allows for one is a MAY, not a requirement.
  13188. //
  13189. // `100 Continue` itself is deferred until the body is actually read (see
  13190. // read_content_core), so a request rejected by a later handler never
  13191. // invites the client to send a body nobody will read.
  13192. if (req.version != "HTTP/1.0" &&
  13193. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  13194. int status = StatusCode::Continue_100;
  13195. if (expect_100_continue_handler_) {
  13196. status = expect_100_continue_handler_(req, res);
  13197. }
  13198. if (status == StatusCode::Continue_100) {
  13199. req.expect_100_continue_pending_ = true;
  13200. } else {
  13201. if (res.status == -1) { res.status = status; }
  13202. connection_closed = true;
  13203. return write_response(strm, true, req, res);
  13204. }
  13205. }
  13206. // Setup `is_connection_closed` method
  13207. auto sock = strm.socket();
  13208. req.is_connection_closed = [sock]() {
  13209. return !detail::is_socket_alive(sock);
  13210. };
  13211. // WebSocket upgrade
  13212. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13213. // that authentication and other middleware can reject the request with an
  13214. // HTTP response (e.g., 401) before the protocol switches.
  13215. // The response says so when this connection closes after it.
  13216. auto close_after_response = close_connection || connection_closed;
  13217. // An upgrade request has been through pre-routing before it reaches routing()
  13218. auto is_upgrade = detail::is_websocket_upgrade(req);
  13219. if (is_upgrade) {
  13220. // A response given here leaves the body unread, and it would be parsed as
  13221. // the next request.
  13222. auto close_if_answered =
  13223. close_after_response || detail::has_framed_body(req);
  13224. const WebSocketHandlerEntry *ws_route = nullptr;
  13225. std::string selected_subprotocol;
  13226. auto answer_before_upgrade = [&]() -> bool {
  13227. if (pre_routing_handler_ &&
  13228. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13229. return true;
  13230. }
  13231. for (const auto &entry : websocket_handlers_) {
  13232. if (!entry.matcher->match(req)) { continue; }
  13233. req.matched_route = entry.matcher->pattern();
  13234. if (pre_request_handler_ &&
  13235. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13236. return true;
  13237. }
  13238. ws_route = &entry;
  13239. if (entry.sub_protocol_selector) {
  13240. auto protocol_header = detail::get_combined_header_value(
  13241. req.headers, "Sec-WebSocket-Protocol");
  13242. if (!protocol_header.empty()) {
  13243. std::vector<std::string> protocols;
  13244. detail::split(protocol_header.data(),
  13245. protocol_header.data() + protocol_header.size(), ',',
  13246. [&](const char *b, const char *e) {
  13247. protocols.emplace_back(b, e);
  13248. });
  13249. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13250. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13251. if (std::find(protocols.begin(), protocols.end(),
  13252. selected_subprotocol) == protocols.end()) {
  13253. selected_subprotocol.clear();
  13254. }
  13255. }
  13256. }
  13257. return false;
  13258. }
  13259. return false;
  13260. };
  13261. auto answered = false;
  13262. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13263. answered = answer_before_upgrade();
  13264. #else
  13265. try {
  13266. answered = answer_before_upgrade();
  13267. } catch (...) {
  13268. if (!handle_exception(req, res)) {
  13269. return write_response(strm, close_if_answered, req, res);
  13270. }
  13271. answered = true;
  13272. }
  13273. #endif
  13274. if (answered) {
  13275. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13276. return write_response_with_content(strm, close_if_answered, req, res);
  13277. }
  13278. if (ws_route) {
  13279. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13280. auto accept_key = detail::websocket_accept_key(client_key);
  13281. // Send 101 Switching Protocols
  13282. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13283. "Upgrade: websocket\r\n"
  13284. "Connection: Upgrade\r\n"
  13285. "Sec-WebSocket-Accept: " +
  13286. accept_key + "\r\n";
  13287. if (!selected_subprotocol.empty()) {
  13288. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13289. return false;
  13290. }
  13291. handshake_response +=
  13292. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13293. }
  13294. handshake_response += "\r\n";
  13295. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13296. 0) {
  13297. return false;
  13298. }
  13299. connection_closed = true;
  13300. if (websocket_upgraded) { *websocket_upgraded = true; }
  13301. auto stopping = [this] { return is_stopping(); };
  13302. if (CPPHTTPLIB_WEBSOCKET_TCP_NODELAY) {
  13303. set_socket_opt(strm.socket(), IPPROTO_TCP, TCP_NODELAY, 1);
  13304. }
  13305. #ifdef CPPHTTPLIB_SSL_ENABLED
  13306. if (req.ssl) {
  13307. // wss: the heartbeat ping thread and the read path enter the same
  13308. // TLS session from different threads. Hand the WebSocket a stream
  13309. // that serializes every TLS call, so the shared SSLSocketStream on
  13310. // the plain HTTP/HTTPS paths stays untouched.
  13311. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13312. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13313. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13314. write_timeout_sec_, write_timeout_usec_));
  13315. ws::WebSocket ws(std::move(ws_strm), req, true,
  13316. websocket_ping_interval_sec_,
  13317. websocket_max_missed_pongs_, stopping);
  13318. ws_route->handler(req, ws);
  13319. return true;
  13320. }
  13321. #endif
  13322. // Use WebSocket-specific read timeout instead of HTTP timeout
  13323. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13324. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13325. websocket_max_missed_pongs_, stopping);
  13326. ws_route->handler(req, ws);
  13327. return true;
  13328. }
  13329. // No WebSocket route: route it as a plain HTTP request
  13330. }
  13331. // Routing
  13332. auto routed = false;
  13333. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13334. routed = routing(req, res, strm, is_upgrade);
  13335. #else
  13336. try {
  13337. routed = routing(req, res, strm, is_upgrade);
  13338. } catch (...) { routed = handle_exception(req, res); }
  13339. #endif
  13340. auto ret = false;
  13341. if (routed) {
  13342. if (res.status == -1) {
  13343. res.status = req.ranges.empty() ? StatusCode::OK_200
  13344. : StatusCode::PartialContent_206;
  13345. }
  13346. // Before the Range checks below, so they see the body's own length.
  13347. detail::prefer_assigned_body(res);
  13348. // Serve file content by using a content provider
  13349. auto file_open_error = false;
  13350. if (!res.file_content_path_.empty()) {
  13351. const auto &path = res.file_content_path_;
  13352. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13353. if (!mm->is_open()) {
  13354. res.status = StatusCode::NotFound_404;
  13355. output_error_log(Error::OpenFile, &req);
  13356. file_open_error = true;
  13357. } else {
  13358. auto content_type = res.file_content_content_type_;
  13359. if (content_type.empty()) {
  13360. // One the handler set after set_file_content()
  13361. content_type = res.get_header_value("Content-Type");
  13362. }
  13363. if (content_type.empty()) {
  13364. content_type = detail::find_content_type(
  13365. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13366. }
  13367. detail::set_file_content_provider(
  13368. res, mm, content_type,
  13369. static_file_encoding(req, res, content_type, mm->size()));
  13370. }
  13371. }
  13372. if (file_open_error) {
  13373. ret = write_response(strm, close_after_response, req, res);
  13374. } else if (detail::range_error(req, res)) {
  13375. detail::clear_content(res);
  13376. res.status = StatusCode::RangeNotSatisfiable_416;
  13377. ret = write_response(strm, close_after_response, req, res);
  13378. } else {
  13379. ret = write_response_with_content(strm, close_after_response, req, res);
  13380. }
  13381. } else {
  13382. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13383. ret = write_response(strm, close_after_response, req, res);
  13384. }
  13385. // Drain any unconsumed framed body to prevent request smuggling on
  13386. // keep-alive. Without framing there is no body to drain — reading would
  13387. // consume the next request (issue #2450). If the response has committed the
  13388. // connection to close, there is no next request to protect. A body read in
  13389. // part cannot be drained from where it stopped, so the connection closes,
  13390. // as it does when the body is longer than the drain limit or does not
  13391. // arrive within the read timeout.
  13392. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13393. !detail::has_header_token(res.headers, "Connection", "close")) {
  13394. strm.set_max_timeout(read_timeout_msec);
  13395. int dummy_status;
  13396. if (req.body_read_started_ ||
  13397. !detail::read_content(
  13398. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13399. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13400. false)) {
  13401. connection_closed = true;
  13402. }
  13403. }
  13404. return ret;
  13405. }
  13406. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13407. inline bool Server::process_and_close_socket(socket_t sock) {
  13408. std::string remote_addr;
  13409. int remote_port = 0;
  13410. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13411. std::string local_addr;
  13412. int local_port = 0;
  13413. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13414. bool websocket_upgraded = false;
  13415. auto ret = serve_guarded([&]() {
  13416. return detail::process_server_socket(
  13417. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13418. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13419. write_timeout_usec_,
  13420. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13421. return process_request(strm, remote_addr, remote_port, local_addr,
  13422. local_port, close_connection,
  13423. connection_closed, nullptr,
  13424. &websocket_upgraded);
  13425. });
  13426. });
  13427. detail::drain_and_close_socket(sock);
  13428. return ret;
  13429. }
  13430. inline void Server::output_log(const Request &req, const Response &res) const {
  13431. if (logger_) {
  13432. std::lock_guard<std::mutex> guard(logger_mutex_);
  13433. logger_(req, res);
  13434. }
  13435. }
  13436. inline void Server::output_pre_compression_log(const Request &req,
  13437. const Response &res) const {
  13438. if (pre_compression_logger_) {
  13439. std::lock_guard<std::mutex> guard(logger_mutex_);
  13440. pre_compression_logger_(req, res);
  13441. }
  13442. }
  13443. inline void Server::output_error_log(const Error &err,
  13444. const Request *req) const {
  13445. if (error_logger_) {
  13446. std::lock_guard<std::mutex> guard(logger_mutex_);
  13447. error_logger_(err, req);
  13448. }
  13449. }
  13450. /*
  13451. * Group 5: ClientImpl and Client (Universal) implementation
  13452. */
  13453. // HTTP client implementation
  13454. inline ClientImpl::ClientImpl(const std::string &host)
  13455. : ClientImpl(host, 80, std::string(), std::string()) {}
  13456. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13457. : ClientImpl(host, port, std::string(), std::string()) {}
  13458. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13459. const std::string &client_cert_path,
  13460. const std::string &client_key_path)
  13461. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13462. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13463. inline ClientImpl::~ClientImpl() {
  13464. // Wait until all the requests in flight are handled.
  13465. size_t retry_count = 10;
  13466. while (retry_count-- > 0) {
  13467. {
  13468. std::lock_guard<std::mutex> guard(socket_mutex_);
  13469. if (socket_requests_in_flight_ == 0) { break; }
  13470. }
  13471. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13472. }
  13473. std::lock_guard<std::mutex> guard(socket_mutex_);
  13474. shutdown_socket(socket_);
  13475. close_socket(socket_);
  13476. }
  13477. inline bool ClientImpl::is_valid() const { return true; }
  13478. inline bool
  13479. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13480. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13481. if (no_proxy_entries_.empty()) { return true; }
  13482. // host_ is const so its normalized form is invariant; cache it. The
  13483. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13484. if (host == host_) {
  13485. if (!host_normalized_valid_) {
  13486. host_normalized_ = detail::normalize_target(host_);
  13487. host_normalized_valid_ = true;
  13488. }
  13489. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13490. }
  13491. auto target = detail::normalize_target(host);
  13492. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13493. }
  13494. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13495. if (is_proxy_enabled_for_host(host_)) {
  13496. return detail::create_client_socket(
  13497. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13498. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13499. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13500. write_timeout_sec_, write_timeout_usec_, interface_, error,
  13501. stop_interrupt());
  13502. }
  13503. // Check is custom IP or hostname specified for host_
  13504. std::string connect_host;
  13505. std::string ip;
  13506. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13507. return detail::create_client_socket(
  13508. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13509. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13510. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13511. write_timeout_usec_, interface_, error, stop_interrupt());
  13512. }
  13513. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13514. Error &error) {
  13515. auto sock = create_client_socket(error);
  13516. if (sock == INVALID_SOCKET) { return false; }
  13517. socket.sock = sock;
  13518. return true;
  13519. }
  13520. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13521. socket_tls_settings_version_ = tls_settings_version_;
  13522. return create_and_connect_socket(socket, error);
  13523. }
  13524. inline bool ClientImpl::setup_proxy_connection(
  13525. Socket & /*socket*/,
  13526. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13527. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13528. return true;
  13529. }
  13530. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13531. bool /*shutdown_gracefully*/) {
  13532. // If there are any requests in flight from threads other than us, then it's
  13533. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13534. assert(socket_requests_in_flight_ == 0 ||
  13535. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13536. }
  13537. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13538. if (socket.sock == INVALID_SOCKET) { return; }
  13539. detail::shutdown_socket(socket.sock);
  13540. }
  13541. inline void ClientImpl::close_socket(Socket &socket) {
  13542. // If there are requests in flight in another thread, usually closing
  13543. // the socket will be fine and they will simply receive an error when
  13544. // using the closed socket, but it is still a bug since rarely the OS
  13545. // may reassign the socket id to be used for a new socket, and then
  13546. // suddenly they will be operating on a live socket that is different
  13547. // than the one they intended!
  13548. assert(socket_requests_in_flight_ == 0 ||
  13549. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13550. // It is also a bug if this happens while SSL is still active
  13551. #ifdef CPPHTTPLIB_SSL_ENABLED
  13552. assert(socket.ssl == nullptr);
  13553. #endif
  13554. if (socket.sock == INVALID_SOCKET) { return; }
  13555. detail::close_socket(socket.sock);
  13556. socket.sock = INVALID_SOCKET;
  13557. }
  13558. inline void ClientImpl::disconnect(bool gracefully) {
  13559. shutdown_ssl(socket_, gracefully);
  13560. shutdown_socket(socket_);
  13561. close_socket(socket_);
  13562. }
  13563. inline bool ClientImpl::socket_reusable() {
  13564. if (!socket_.is_open()) { return false; }
  13565. // RFC 9112 9.2: data with no request outstanding is not a response
  13566. if (detail::select_read(socket_.sock, 0, 0) != 0) {
  13567. disconnect(/*gracefully=*/false);
  13568. return false;
  13569. }
  13570. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13571. disconnect(/*gracefully=*/true);
  13572. return false;
  13573. }
  13574. return true;
  13575. }
  13576. inline bool ClientImpl::prepare_socket(
  13577. std::unique_lock<std::mutex> &guard,
  13578. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13579. Response &res, bool &success, Error &error) {
  13580. auto opened = true;
  13581. if (!socket_reusable()) {
  13582. Socket socket;
  13583. guard.unlock();
  13584. opened = ensure_socket_connection(socket, error);
  13585. if (opened) {
  13586. opened = setup_proxy_connection(socket, start_time, res, success, error);
  13587. } else {
  13588. success = false;
  13589. }
  13590. guard.lock();
  13591. socket_ = socket;
  13592. }
  13593. if (stop_requested_) {
  13594. disconnect(/*gracefully=*/false);
  13595. error = Error::Canceled;
  13596. success = false;
  13597. return false;
  13598. }
  13599. return opened;
  13600. }
  13601. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13602. Response &res,
  13603. bool skip_100_continue) const {
  13604. std::array<char, 2048> buf{};
  13605. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13606. if (!line_reader.getline()) { return false; }
  13607. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13608. res.reason)) {
  13609. return req.method == "CONNECT";
  13610. }
  13611. // Skip interim (1xx) responses along with their header fields, except a 100
  13612. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13613. // HTTP on the connection, so it is final. A server sending them without end
  13614. // would hold the client, so there may be only so many.
  13615. size_t interim_count = 0;
  13616. while (100 <= res.status && res.status < 200 &&
  13617. res.status != StatusCode::SwitchingProtocol_101 &&
  13618. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13619. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13620. return false;
  13621. }
  13622. Headers interim_headers;
  13623. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13624. if (!line_reader.getline()) { return false; } // next response line
  13625. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13626. res.reason)) {
  13627. return false;
  13628. }
  13629. }
  13630. return true;
  13631. }
  13632. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13633. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13634. // A same-origin redirect and a digest retry send through here again. Only
  13635. // the call the caller made reports a failure, once, with its request.
  13636. auto outermost = send_depth_++ == 0;
  13637. auto se = detail::scope_exit([&] { send_depth_--; });
  13638. if (outermost) {
  13639. error = Error::Success;
  13640. stop_requested_ = false;
  13641. }
  13642. auto ret = send_(req, res, error);
  13643. if (error == Error::SSLPeerCouldBeClosed_) {
  13644. assert(!ret);
  13645. ret = send_(req, res, error);
  13646. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13647. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13648. }
  13649. // Also an answer that carries an error, such as a proxy's 407
  13650. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13651. return ret;
  13652. }
  13653. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13654. #ifdef CPPHTTPLIB_SSL_ENABLED
  13655. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13656. // client that failed to set up its TLS context keeps reporting why.
  13657. if (is_valid()) {
  13658. last_ssl_error_ = 0;
  13659. last_backend_error_ = 0;
  13660. }
  13661. #endif
  13662. {
  13663. std::unique_lock<std::mutex> guard(socket_mutex_);
  13664. // Set this to false immediately - if it ever gets set to true by the end
  13665. // of the request, we know another thread instructed us to close the
  13666. // socket.
  13667. socket_should_be_closed_when_request_is_done_ = false;
  13668. auto success = true;
  13669. if (!prepare_socket(guard, req.start_time_, res, success, error)) {
  13670. return success;
  13671. }
  13672. // Mark the current socket as being in use so that it cannot be closed by
  13673. // anyone else while this request is ongoing, even though we will be
  13674. // releasing the mutex.
  13675. if (socket_requests_in_flight_ > 1) {
  13676. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13677. }
  13678. socket_requests_in_flight_ += 1;
  13679. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13680. }
  13681. for (const auto &header : default_headers_) {
  13682. if (req.headers.find(header.first) == req.headers.end()) {
  13683. req.headers.insert(header);
  13684. }
  13685. }
  13686. auto ret = false;
  13687. auto close_connection = !keep_alive_;
  13688. auto se = detail::scope_exit([&]() {
  13689. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13690. std::lock_guard<std::mutex> guard(socket_mutex_);
  13691. socket_requests_in_flight_ -= 1;
  13692. if (socket_requests_in_flight_ <= 0) {
  13693. assert(socket_requests_in_flight_ == 0);
  13694. socket_requests_are_from_thread_ = std::thread::id();
  13695. }
  13696. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13697. !ret) {
  13698. disconnect(/*gracefully=*/true);
  13699. }
  13700. });
  13701. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13702. strm.set_read_interrupt(stop_interrupt());
  13703. return handle_request(strm, req, res, close_connection, error);
  13704. });
  13705. if (!ret) {
  13706. if (error == Error::Success) { error = Error::Unknown; }
  13707. }
  13708. return ret;
  13709. }
  13710. inline Result ClientImpl::send(const Request &req) {
  13711. auto req2 = req;
  13712. return send_(std::move(req2));
  13713. }
  13714. inline Result ClientImpl::send_(Request &&req) {
  13715. auto res = detail::make_unique<Response>();
  13716. auto error = Error::Success;
  13717. #ifdef CPPHTTPLIB_SSL_ENABLED
  13718. // Hold the request lock until the Result has read this request's TLS error
  13719. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13720. #endif
  13721. auto ret = send(req, *res, error);
  13722. #ifdef CPPHTTPLIB_SSL_ENABLED
  13723. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13724. last_ssl_error_, last_backend_error_};
  13725. #else
  13726. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13727. #endif
  13728. }
  13729. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13730. const std::string &ct) {
  13731. (void)for_stream;
  13732. // Default headers are meant for the origin and may carry its credentials, so
  13733. // keep them off the CONNECT request the proxy reads.
  13734. if (r.method != "CONNECT") {
  13735. for (const auto &header : default_headers_) {
  13736. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13737. }
  13738. }
  13739. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13740. // prepend it rather than appending it after the caller's own fields.
  13741. if (!r.has_header("Host")) {
  13742. r.headers.emplace_front(
  13743. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13744. address_family_));
  13745. }
  13746. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13747. if (!r.content_receiver) {
  13748. if (!r.has_header("Accept-Encoding")) {
  13749. std::string accept_encoding;
  13750. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13751. accept_encoding = "br";
  13752. #endif
  13753. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13754. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13755. accept_encoding += "gzip, deflate";
  13756. #endif
  13757. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13758. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13759. accept_encoding += "zstd";
  13760. #endif
  13761. r.set_header("Accept-Encoding", accept_encoding);
  13762. }
  13763. detail::add_default_user_agent_header(r);
  13764. }
  13765. if (!r.body.empty()) {
  13766. if (!ct.empty() && !r.has_header("Content-Type")) {
  13767. r.headers.emplace("Content-Type", ct);
  13768. }
  13769. if (!r.has_header("Content-Length")) {
  13770. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13771. }
  13772. }
  13773. }
  13774. inline ClientImpl::StreamHandle
  13775. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13776. const Params &params, const Headers &headers,
  13777. const std::string &body,
  13778. const std::string &content_type) {
  13779. // Encode the target exactly like the buffered send path does, so that the
  13780. // same `path` produces the same request line through either API.
  13781. auto raw_query_path =
  13782. params.empty() ? path : append_query_params(path, params);
  13783. Request req;
  13784. req.method = method;
  13785. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13786. req.headers = headers;
  13787. req.body = body;
  13788. prepare_default_headers(req, true, content_type);
  13789. auto handle = open_stream_(req);
  13790. // Like a buffered request, a stream that fails to open is reported once
  13791. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13792. return handle;
  13793. }
  13794. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13795. StreamHandle handle;
  13796. handle.response = detail::make_unique<Response>();
  13797. handle.error = Error::Success;
  13798. handle.connection_ = detail::make_unique<ClientConnection>();
  13799. {
  13800. // A request in flight uses socket_ without holding socket_mutex_
  13801. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13802. if (send_depth_ == 0) { stop_requested_ = false; }
  13803. std::unique_lock<std::mutex> guard(socket_mutex_);
  13804. auto success = true;
  13805. if (!prepare_socket(guard, std::chrono::steady_clock::now(),
  13806. *handle.response, success, handle.error)) {
  13807. if (!success) { handle.response.reset(); }
  13808. return handle;
  13809. }
  13810. transfer_socket_ownership_to_handle(handle);
  13811. }
  13812. #ifdef CPPHTTPLIB_SSL_ENABLED
  13813. if (is_ssl() && handle.connection_->session) {
  13814. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13815. handle.connection_->sock, handle.connection_->session,
  13816. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13817. write_timeout_usec_);
  13818. } else {
  13819. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13820. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13821. write_timeout_sec_, write_timeout_usec_);
  13822. }
  13823. #else
  13824. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13825. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13826. write_timeout_sec_, write_timeout_usec_);
  13827. #endif
  13828. handle.stream_ = handle.socket_stream_.get();
  13829. auto &strm = *handle.stream_;
  13830. // Only for the head, as the handle may outlive this client
  13831. strm.set_read_interrupt(stop_interrupt());
  13832. auto release_interrupt =
  13833. detail::scope_exit([&] { strm.set_read_interrupt(nullptr); });
  13834. // After connecting, as for a buffered request
  13835. add_credential_headers(req);
  13836. // Build the request line and headers in memory first, like write_request()
  13837. // does, so that a rejected header leaves nothing on the wire.
  13838. {
  13839. detail::BufferStream bstrm;
  13840. // The path follows the authority in absolute-form, so one that does not
  13841. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13842. auto prefix = proxy_target_prefix();
  13843. if ((!prefix.empty() && req.path[0] != '/') ||
  13844. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  13845. handle.error = Error::Write;
  13846. handle.response.reset();
  13847. return handle;
  13848. }
  13849. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13850. handle.error)) {
  13851. handle.response.reset();
  13852. return handle;
  13853. }
  13854. const auto &data = bstrm.get_buffer();
  13855. if (!detail::write_data(strm, data.data(), data.size())) {
  13856. handle.error = Error::Write;
  13857. handle.response.reset();
  13858. return handle;
  13859. }
  13860. }
  13861. if (!req.body.empty()) {
  13862. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13863. handle.error = Error::Write;
  13864. handle.response.reset();
  13865. return handle;
  13866. }
  13867. }
  13868. if (!read_response_line(strm, req, *handle.response) ||
  13869. !detail::read_headers(strm, handle.response->headers)) {
  13870. handle.error = Error::Read;
  13871. handle.response.reset();
  13872. return handle;
  13873. }
  13874. handle.body_reader_.stream = handle.stream_;
  13875. handle.body_reader_.payload_max_length = payload_max_length_;
  13876. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13877. // header section, so none of its framing or coding headers apply.
  13878. if (req.method == "HEAD" ||
  13879. handle.response->status == StatusCode::NoContent_204 ||
  13880. handle.response->status == StatusCode::NotModified_304) {
  13881. handle.body_reader_.eof = true;
  13882. return handle;
  13883. }
  13884. // Same framing check as ClientImpl::process_request()
  13885. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13886. handle.error = Error::Read;
  13887. handle.response.reset();
  13888. return handle;
  13889. }
  13890. if (handle.response->has_header("Content-Length")) {
  13891. bool is_invalid = false;
  13892. auto content_length = detail::get_header_value_u64(
  13893. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13894. if (is_invalid) {
  13895. handle.error = Error::Read;
  13896. handle.response.reset();
  13897. return handle;
  13898. }
  13899. handle.body_reader_.has_content_length = true;
  13900. handle.body_reader_.content_length = content_length;
  13901. }
  13902. handle.body_reader_.chunked =
  13903. detail::is_chunked_transfer_encoding(handle.response->headers);
  13904. auto content_encoding = detail::get_combined_header_value(
  13905. handle.response->headers, "Content-Encoding");
  13906. if (decompress_ && !content_encoding.empty()) {
  13907. // Same policy as prepare_content_receiver(): reject a coding we know about
  13908. // but were not built with, pass an unrecognized one through as-is.
  13909. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13910. if (!handle.decompressor_) {
  13911. if (detail::is_known_content_encoding(content_encoding)) {
  13912. handle.error = Error::UnsupportedContentEncoding;
  13913. handle.response.reset();
  13914. return handle;
  13915. }
  13916. } else if (!handle.decompressor_->is_valid()) {
  13917. handle.error = Error::Compression;
  13918. handle.response.reset();
  13919. return handle;
  13920. }
  13921. }
  13922. return handle;
  13923. }
  13924. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13925. if (!is_valid() || !response) { return -1; }
  13926. auto n = decompressor_
  13927. ? read_with_decompression(buf, len)
  13928. : detail::read_body_content(stream_, body_reader_, buf, len);
  13929. if (n == 0) { parse_trailers_if_needed(); }
  13930. return n;
  13931. }
  13932. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13933. size_t len) {
  13934. if (decompress_offset_ < decompress_buffer_.size()) {
  13935. auto available = decompress_buffer_.size() - decompress_offset_;
  13936. auto to_copy = (std::min)(len, available);
  13937. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13938. decompress_offset_ += to_copy;
  13939. decompressed_bytes_read_ += to_copy;
  13940. return static_cast<ssize_t>(to_copy);
  13941. }
  13942. decompress_buffer_.clear();
  13943. decompress_offset_ = 0;
  13944. constexpr size_t kDecompressionBufferSize = 8192;
  13945. char compressed_buf[kDecompressionBufferSize];
  13946. while (true) {
  13947. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13948. sizeof(compressed_buf));
  13949. if (n <= 0) { return n; }
  13950. auto exceeded = false;
  13951. bool decompress_ok = decompressor_->decompress(
  13952. compressed_buf, static_cast<size_t>(n),
  13953. [&](const char *data, size_t data_len) {
  13954. decompress_buffer_.append(data, data_len);
  13955. auto limit = body_reader_.payload_max_length;
  13956. exceeded =
  13957. limit > 0 &&
  13958. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13959. return !exceeded;
  13960. });
  13961. if (!decompress_ok) {
  13962. body_reader_.last_error =
  13963. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13964. return -1;
  13965. }
  13966. if (!decompress_buffer_.empty()) { break; }
  13967. }
  13968. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13969. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13970. decompress_offset_ = to_copy;
  13971. decompressed_bytes_read_ += to_copy;
  13972. return static_cast<ssize_t>(to_copy);
  13973. }
  13974. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13975. // The trailers follow the last chunk, so there are none before it
  13976. auto &decoder = body_reader_.chunked_decoder;
  13977. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13978. return;
  13979. }
  13980. trailers_parsed_ = true;
  13981. decoder->parse_trailers_into(response->trailers, response->headers);
  13982. }
  13983. namespace detail {
  13984. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13985. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13986. size_t &out_chunk_offset,
  13987. size_t &out_chunk_total) {
  13988. if (finished) { return 0; }
  13989. if (chunk_remaining == 0) {
  13990. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13991. if (!lr.getline()) { return -1; }
  13992. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13993. // the line terminator is never mistaken for line content.
  13994. const char *eol = lr.ptr() + lr.size();
  13995. if (lr.end_with_crlf()) {
  13996. eol -= 2;
  13997. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13998. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13999. // getline() ends the line on a bare LF. That LF is the terminator, so it
  14000. // has to come off here or the check below would reject the line.
  14001. eol -= 1;
  14002. }
  14003. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  14004. const char *p = lr.ptr();
  14005. int v = 0;
  14006. if (p == eol || !is_hex(*p, v)) { return -1; }
  14007. size_t chunk_len = 0;
  14008. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  14009. for (; p < eol && is_hex(*p, v); ++p) {
  14010. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  14011. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  14012. }
  14013. while (p < eol && is_space_or_tab(*p)) {
  14014. ++p;
  14015. }
  14016. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  14017. // terminator, and it is built from tokens and quoted-strings, so it never
  14018. // holds a CR, LF or any other control character. getline() reads up to the
  14019. // CRLF, so a bare LF left in here would be swallowed as extension text
  14020. // while an intermediary that ends the line on it delimits the chunks
  14021. // differently, and the two disagree on where the body ends (request
  14022. // smuggling).
  14023. if (p < eol && *p != ';') { return -1; }
  14024. for (; p < eol; ++p) {
  14025. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  14026. }
  14027. // The bytes around the data are no payload, so they are counted on their
  14028. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  14029. // them, which lets a stream send a byte at a time, and what goes past that
  14030. // in padding, leading zeros and extensions builds up to one header field.
  14031. overhead += lr.size() + 2;
  14032. overhead = overhead > 16 ? overhead - 16 : 0;
  14033. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  14034. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  14035. if (chunk_len == 0) {
  14036. chunk_remaining = 0;
  14037. finished = true;
  14038. out_chunk_offset = 0;
  14039. out_chunk_total = 0;
  14040. return 0;
  14041. }
  14042. chunk_remaining = chunk_len;
  14043. last_chunk_total = chunk_remaining;
  14044. last_chunk_offset = 0;
  14045. }
  14046. auto to_read = (std::min)(chunk_remaining, len);
  14047. auto n = strm.read(buf, to_read);
  14048. if (n <= 0) { return -1; }
  14049. auto offset_before = last_chunk_offset;
  14050. last_chunk_offset += static_cast<size_t>(n);
  14051. chunk_remaining -= static_cast<size_t>(n);
  14052. out_chunk_offset = offset_before;
  14053. out_chunk_total = last_chunk_total;
  14054. if (chunk_remaining == 0) {
  14055. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14056. if (!lr.getline()) { return -1; }
  14057. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  14058. }
  14059. return n;
  14060. }
  14061. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  14062. const Headers &src_headers) {
  14063. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14064. if (!lr.getline()) { return false; }
  14065. return parse_trailers(lr, dest, src_headers);
  14066. }
  14067. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  14068. // a redirect without a Location, is a final response.
  14069. inline bool is_redirect(const Response &res) {
  14070. switch (res.status) {
  14071. case StatusCode::MovedPermanently_301:
  14072. case StatusCode::Found_302:
  14073. case StatusCode::SeeOther_303:
  14074. case StatusCode::TemporaryRedirect_307:
  14075. case StatusCode::PermanentRedirect_308:
  14076. return !res.get_header_value("Location").empty();
  14077. default: return false;
  14078. }
  14079. }
  14080. } // namespace detail
  14081. inline void
  14082. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  14083. handle.connection_->sock = socket_.sock;
  14084. #ifdef CPPHTTPLIB_SSL_ENABLED
  14085. handle.connection_->session = socket_.ssl;
  14086. socket_.ssl = nullptr;
  14087. #endif
  14088. socket_.sock = INVALID_SOCKET;
  14089. }
  14090. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  14091. inline std::string ClientImpl::proxy_target_prefix() const {
  14092. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  14093. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  14094. }
  14095. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  14096. Response &res, bool close_connection,
  14097. Error &error) {
  14098. if (req.path.empty()) {
  14099. error = Error::Connection;
  14100. return false;
  14101. }
  14102. auto req_save = req;
  14103. bool ret;
  14104. auto prefix = proxy_target_prefix();
  14105. if (!prefix.empty()) {
  14106. // The path follows the authority in absolute-form, so one that does not
  14107. // begin with '/' (e.g. "@evil.example/x") would name another host.
  14108. if (req.path[0] != '/') {
  14109. error = Error::Write;
  14110. return false;
  14111. }
  14112. auto req2 = req;
  14113. req2.path = prefix + req.path;
  14114. ret = process_request(strm, req2, res, close_connection, error);
  14115. req = std::move(req2);
  14116. req.path = req_save.path;
  14117. } else {
  14118. ret = process_request(strm, req, res, close_connection, error);
  14119. }
  14120. if (!ret) { return false; }
  14121. {
  14122. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  14123. // for this to be safe.
  14124. // This is safe to call because handle_request is only called by send_
  14125. // which locks the request mutex during the process. It would be a bug
  14126. // to call it from a different thread since it's a thread-safety issue
  14127. // to do these things to the socket if another thread is using the socket.
  14128. std::lock_guard<std::mutex> guard(socket_mutex_);
  14129. // Also when the request asked for it (e.g. a body that was never sent,
  14130. // or "Connection: close") or bytes follow the response (RFC 9112 9.2), so
  14131. // that a redirect or an auth retry below does not reuse the socket.
  14132. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14133. strm.is_readable() ||
  14134. detail::has_header_token(res.headers, "Connection", "close") ||
  14135. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  14136. disconnect(/*gracefully=*/true);
  14137. }
  14138. }
  14139. if (follow_location_ && detail::is_redirect(res)) {
  14140. req = std::move(req_save);
  14141. // The client that followed the redirect has answered any challenge it
  14142. // could. Retrying below would sign another host's challenge and send it
  14143. // here.
  14144. return redirect(req, res, error);
  14145. }
  14146. #ifdef CPPHTTPLIB_SSL_ENABLED
  14147. if ((res.status == StatusCode::Unauthorized_401 ||
  14148. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  14149. req.authorization_count_ < 5) {
  14150. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  14151. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  14152. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  14153. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  14154. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  14155. return ret;
  14156. }
  14157. const auto &username =
  14158. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  14159. const auto &password =
  14160. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  14161. if (!username.empty() && !password.empty()) {
  14162. std::map<std::string, std::string> auth;
  14163. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  14164. Request new_req = req;
  14165. new_req.authorization_count_ += 1;
  14166. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  14167. : "Authorization");
  14168. new_req.headers.insert(detail::make_digest_authentication_header(
  14169. req, make_request_target(req), auth, new_req.authorization_count_,
  14170. detail::random_string(10), username, password, is_proxy));
  14171. Response new_res;
  14172. ret = send(new_req, new_res, error);
  14173. if (ret) { res = std::move(new_res); }
  14174. }
  14175. }
  14176. }
  14177. #endif
  14178. return ret;
  14179. }
  14180. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  14181. if (req.redirect_count_ == 0) {
  14182. error = Error::ExceedRedirectCount;
  14183. return false;
  14184. }
  14185. auto location = res.get_header_value("location");
  14186. if (location.empty()) { return false; }
  14187. auto next_url = detail::resolve_relative_location(location, req.path);
  14188. detail::UrlComponents uc;
  14189. if (!detail::parse_url(next_url, uc)) { return false; }
  14190. // Follow only http/https URLs and references starting with '/'
  14191. if (next_url[0] != '/' && uc.scheme != "http" && uc.scheme != "https") {
  14192. return false;
  14193. }
  14194. auto scheme = is_ssl() ? "https" : "http";
  14195. auto next_scheme = std::move(uc.scheme);
  14196. auto next_host = std::move(uc.host);
  14197. auto port_str = std::move(uc.port);
  14198. auto next_path = std::move(uc.path);
  14199. auto next_query = std::move(uc.query);
  14200. auto next_port = port_;
  14201. if (!port_str.empty()) {
  14202. if (!detail::parse_port(port_str, next_port)) { return false; }
  14203. } else if (!next_scheme.empty()) {
  14204. next_port = next_scheme == "https" ? 443 : 80;
  14205. }
  14206. if (next_scheme.empty()) { next_scheme = scheme; }
  14207. if (next_host.empty()) { next_host = host_; }
  14208. if (next_path.empty()) { next_path = "/"; }
  14209. // An absolute or absolute-path location can have dot segments too.
  14210. if (next_path[0] == '/') {
  14211. next_path = detail::remove_dot_segments(next_path);
  14212. }
  14213. auto path = std::move(next_path) + next_query;
  14214. // A Unix socket client sends "Host: localhost", so a Location naming
  14215. // localhost names this client too.
  14216. auto is_same_host = next_host == host_ ||
  14217. (address_family_ == AF_UNIX && next_host == "localhost");
  14218. // Same host redirect - use current client
  14219. if (next_scheme == scheme && is_same_host && next_port == port_) {
  14220. return detail::redirect(*this, req, res, path, location, error);
  14221. }
  14222. // Cross-host/scheme redirect - create new client with robust setup
  14223. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14224. path, location, error);
  14225. }
  14226. // New method for robust redirect client creation
  14227. inline bool ClientImpl::create_redirect_client(
  14228. const std::string &scheme, const std::string &host, int port, Request &req,
  14229. Response &res, const std::string &path, const std::string &location,
  14230. Error &error) {
  14231. // Determine if we need SSL
  14232. auto need_ssl = (scheme == "https");
  14233. // Clean up request headers that are host/client specific
  14234. // Remove headers that should not be carried over to new host
  14235. auto headers_to_remove = std::vector<std::string>{
  14236. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14237. for (const auto &header_name : headers_to_remove) {
  14238. auto it = req.headers.find(header_name);
  14239. while (it != req.headers.end()) {
  14240. it = req.headers.erase(it);
  14241. it = req.headers.find(header_name);
  14242. }
  14243. }
  14244. // Create appropriate client type and handle redirect
  14245. if (need_ssl) {
  14246. #ifdef CPPHTTPLIB_SSL_ENABLED
  14247. // Create SSL client for HTTPS redirect
  14248. SSLClient redirect_client(host, port);
  14249. // Setup basic client configuration first
  14250. setup_redirect_client(redirect_client);
  14251. redirect_client.enable_server_certificate_verification(
  14252. server_certificate_verification_);
  14253. redirect_client.enable_server_hostname_verification(
  14254. server_hostname_verification_);
  14255. redirect_client.system_ca_mode_ = system_ca_mode_;
  14256. // Transfer CA certificate to redirect client
  14257. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14258. if (is_ssl()) {
  14259. auto &self = static_cast<SSLClient &>(*this);
  14260. // A store given to set_ca_cert_store() lives only in this client's
  14261. // context, which then holds all that is trusted.
  14262. if (self.ca_cert_store_set_) {
  14263. std::string pem;
  14264. {
  14265. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14266. pem = detail::ca_certs_to_pem(self.ctx_);
  14267. }
  14268. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14269. redirect_client.ca_cert_store_set_ = true;
  14270. } else if (self.custom_ca_loaded_) {
  14271. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14272. ca_cert_pem_.size());
  14273. }
  14274. redirect_client.set_session_verifier(self.session_verifier_);
  14275. if (self.server_certificate_verifier_) {
  14276. redirect_client.set_server_certificate_verifier(
  14277. self.server_certificate_verifier_);
  14278. }
  14279. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14280. redirect_client.enable_windows_cert_verification_ =
  14281. self.enable_windows_cert_verification_;
  14282. #endif
  14283. }
  14284. // Client certificates are set through constructor for SSLClient
  14285. // NOTE: SSLClient constructor already takes client_cert_path and
  14286. // client_key_path so we need to create it properly if client certs are
  14287. // needed
  14288. // Execute the redirect
  14289. return detail::redirect(redirect_client, req, res, path, location, error);
  14290. #else
  14291. // SSL not supported - set appropriate error
  14292. error = Error::SSLConnection;
  14293. return false;
  14294. #endif
  14295. } else {
  14296. // HTTP redirect
  14297. ClientImpl redirect_client(host, port);
  14298. // Setup client with robust configuration
  14299. setup_redirect_client(redirect_client);
  14300. // Execute the redirect
  14301. return detail::redirect(redirect_client, req, res, path, location, error);
  14302. }
  14303. }
  14304. // New method for robust client setup (based on basic_manual_redirect.cpp
  14305. // logic)
  14306. template <typename ClientType>
  14307. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14308. // Copy basic settings first
  14309. client.set_connection_timeout(connection_timeout_sec_,
  14310. connection_timeout_usec_);
  14311. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14312. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14313. client.set_max_timeout(max_timeout_msec_);
  14314. if (has_payload_max_length_) {
  14315. client.set_payload_max_length(payload_max_length_);
  14316. }
  14317. client.set_keep_alive(keep_alive_);
  14318. client.set_follow_location(
  14319. true); // Enable redirects to handle multi-step redirects
  14320. client.set_path_encode(path_encode_);
  14321. client.set_compress(compress_);
  14322. client.set_decompress(decompress_);
  14323. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14324. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14325. // 15.4, credentials must not be forwarded when redirecting to a different
  14326. // host. This function is only called for cross-host redirects; same-host
  14327. // redirects are handled directly in ClientImpl::redirect().
  14328. // Copy the proxy configuration unconditionally; the per-target bypass is
  14329. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14330. // still use the proxy.
  14331. client.no_proxy_entries_ = no_proxy_entries_;
  14332. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14333. client.set_proxy(proxy_host_, proxy_port_);
  14334. if (!proxy_basic_auth_username_.empty() ||
  14335. !proxy_basic_auth_password_.empty()) {
  14336. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14337. proxy_basic_auth_password_);
  14338. }
  14339. if (!proxy_bearer_token_auth_token_.empty()) {
  14340. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14341. }
  14342. #ifdef CPPHTTPLIB_SSL_ENABLED
  14343. if (!proxy_digest_auth_username_.empty()) {
  14344. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14345. proxy_digest_auth_password_);
  14346. }
  14347. #endif
  14348. }
  14349. // Copy network and socket settings
  14350. client.addr_map_ = addr_map_;
  14351. client.tunnel_addr_map_ = tunnel_addr_map_;
  14352. // A Unix socket client reaches every host through its own socket, as curl's
  14353. // --unix-socket does, unless the caller mapped that host elsewhere. The
  14354. // Location's host is never taken as a socket path.
  14355. if (address_family_ == AF_UNIX) {
  14356. auto &target = client.addr_map_[client.host()];
  14357. if (target.empty()) { target = detail::addr_map_target(addr_map_, host_); }
  14358. }
  14359. client.set_address_family(address_family_);
  14360. client.set_tcp_nodelay(tcp_nodelay_);
  14361. client.set_ipv6_v6only(ipv6_v6only_);
  14362. if (socket_options_) { client.set_socket_options(socket_options_); }
  14363. if (!interface_.empty()) { client.set_interface(interface_); }
  14364. // Copy logging and headers. Not the error logger: a failure comes back to
  14365. // this client's send(), which reports it with the caller's request.
  14366. if (logger_) { client.set_logger(logger_); }
  14367. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14368. // Each new client should generate its own headers based on its target host
  14369. }
  14370. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14371. const Request &req,
  14372. Error &error) const {
  14373. auto is_shutting_down = []() { return false; };
  14374. if (req.is_chunked_content_provider_) {
  14375. auto compressor = compress_ ? detail::create_compressor().first
  14376. : std::unique_ptr<detail::compressor>();
  14377. if (!compressor) {
  14378. compressor = detail::make_unique<detail::nocompressor>();
  14379. }
  14380. return detail::write_content_chunked(strm, req.content_provider_,
  14381. is_shutting_down, *compressor, error);
  14382. } else {
  14383. return detail::write_content_with_progress(
  14384. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14385. req.upload_progress, error);
  14386. }
  14387. }
  14388. // What goes on the request line for req: its path, encoded and without the
  14389. // fragment, with `req.params` as the query when the path has none.
  14390. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14391. auto target = detail::encode_request_target(req.path, path_encode_);
  14392. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14393. target = append_query_params(target, req.params);
  14394. }
  14395. return target;
  14396. }
  14397. inline void ClientImpl::add_credential_headers(Request &req) {
  14398. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14399. // it opens is read by the origin. Each credential goes only to its own hop.
  14400. auto is_connect = req.method == "CONNECT";
  14401. if (!is_connect) {
  14402. detail::add_authorization_header(req, basic_auth_username_,
  14403. basic_auth_password_,
  14404. bearer_token_auth_token_, false);
  14405. }
  14406. // Proxy-Authorization is only sent when the proxy reads this message —
  14407. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14408. // would leak proxy credentials to the destination server.
  14409. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14410. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14411. proxy_basic_auth_password_,
  14412. proxy_bearer_token_auth_token_, true);
  14413. }
  14414. }
  14415. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14416. bool close_connection, Error &error,
  14417. bool skip_body, bool &rejected_locally) {
  14418. rejected_locally = false;
  14419. // Prepare additional headers
  14420. if (close_connection) {
  14421. if (!req.has_header("Connection")) {
  14422. req.set_header("Connection", "close");
  14423. }
  14424. }
  14425. std::string ct_for_defaults;
  14426. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14427. ct_for_defaults = "text/plain";
  14428. }
  14429. prepare_default_headers(req, false, ct_for_defaults);
  14430. if (req.body.empty()) {
  14431. if (req.content_provider_) {
  14432. if (!req.is_chunked_content_provider_) {
  14433. if (!req.has_header("Content-Length")) {
  14434. auto length = std::to_string(req.content_length_);
  14435. req.set_header("Content-Length", length);
  14436. }
  14437. }
  14438. } else {
  14439. if (req.method == "POST" || req.method == "PUT" ||
  14440. req.method == "PATCH") {
  14441. req.set_header("Content-Length", "0");
  14442. }
  14443. }
  14444. }
  14445. add_credential_headers(req);
  14446. // Request line and headers
  14447. {
  14448. detail::BufferStream bstrm;
  14449. auto path_with_query = make_request_target(req);
  14450. // The query already came in through `req.path`; still populate
  14451. // `req.params` for handlers/users who read them.
  14452. auto query_part = detail::query_of(req.path);
  14453. if (!query_part.empty()) {
  14454. detail::parse_query_text(query_part, req.params);
  14455. }
  14456. // Write request line and headers
  14457. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14458. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14459. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14460. // fail the request cleanly instead of emitting a request-line-less,
  14461. // header-injecting request.
  14462. error = Error::Write;
  14463. rejected_locally = true;
  14464. return false;
  14465. }
  14466. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14467. error)) {
  14468. rejected_locally = true;
  14469. return false;
  14470. }
  14471. // Flush buffer
  14472. auto &data = bstrm.get_buffer();
  14473. if (!detail::write_data(strm, data.data(), data.size())) {
  14474. error = Error::Write;
  14475. return false;
  14476. }
  14477. }
  14478. // After sending request line and headers, wait briefly for an early server
  14479. // response (e.g. 4xx) and avoid sending a potentially large request body
  14480. // unnecessarily. This workaround is only enabled on Windows because Unix
  14481. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14482. // buffering can accept large writes even when the peer already responded.
  14483. // Check the stream first (which covers SSL via `is_readable()`), then
  14484. // fall back to select on the socket. Only perform the wait for very large
  14485. // request bodies to avoid interfering with normal small requests and
  14486. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14487. // response. Skip this check when using Expect: 100-continue, as the protocol
  14488. // handles early responses properly.
  14489. #if defined(_WIN32)
  14490. if (!skip_body &&
  14491. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14492. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14493. auto start = std::chrono::high_resolution_clock::now();
  14494. for (;;) {
  14495. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14496. // from SSL internals. If the underlying socket is readable, assume an
  14497. // early response may be present.
  14498. auto sock = strm.socket();
  14499. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14500. return false;
  14501. }
  14502. // Fallback to stream-level check for non-socket streams or when the
  14503. // socket isn't reporting readable. Avoid using `is_readable()` for
  14504. // SSL, since `SSL_pending()` may report buffered records that do not
  14505. // indicate a complete application-level response yet.
  14506. if (!is_ssl() && strm.is_readable()) { return false; }
  14507. auto now = std::chrono::high_resolution_clock::now();
  14508. auto elapsed =
  14509. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14510. .count();
  14511. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14512. break;
  14513. }
  14514. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14515. }
  14516. }
  14517. #endif
  14518. // Body
  14519. if (skip_body) { return true; }
  14520. return write_request_body(strm, req, error);
  14521. }
  14522. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14523. Error &error) {
  14524. if (req.body.empty()) {
  14525. return write_content_with_provider(strm, req, error);
  14526. }
  14527. if (req.upload_progress) {
  14528. auto body_size = req.body.size();
  14529. size_t written = 0;
  14530. auto data = req.body.data();
  14531. while (written < body_size) {
  14532. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14533. if (!detail::write_data(strm, data + written, to_write)) {
  14534. error = Error::Write;
  14535. return false;
  14536. }
  14537. written += to_write;
  14538. if (!req.upload_progress(written, body_size)) {
  14539. error = Error::Canceled;
  14540. return false;
  14541. }
  14542. }
  14543. } else {
  14544. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14545. error = Error::Write;
  14546. return false;
  14547. }
  14548. }
  14549. return true;
  14550. }
  14551. inline std::unique_ptr<Response>
  14552. ClientImpl::send_with_content_provider_and_receiver(
  14553. Request &req, const char *body, size_t content_length,
  14554. ContentProvider content_provider,
  14555. ContentProviderWithoutLength content_provider_without_length,
  14556. const std::string &content_type, ContentReceiver content_receiver,
  14557. Error &error) {
  14558. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14559. auto enc = compress_
  14560. ? detail::create_compressor()
  14561. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14562. nullptr, nullptr);
  14563. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14564. // A compressed or chunked body is framed by the library, not the caller
  14565. if (enc.second || content_provider_without_length) {
  14566. req.headers.erase("Content-Length");
  14567. }
  14568. if (enc.first && !content_provider_without_length) {
  14569. auto &compressor = enc.first;
  14570. if (content_provider) {
  14571. auto ok = true;
  14572. auto finished = false;
  14573. size_t offset = 0;
  14574. DataSink data_sink;
  14575. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14576. if (ok) {
  14577. auto last = offset + data_len == content_length;
  14578. auto ret = compressor->compress(
  14579. data, data_len, last,
  14580. [&](const char *compressed_data, size_t compressed_data_len) {
  14581. req.body.append(compressed_data, compressed_data_len);
  14582. return true;
  14583. });
  14584. if (ret) {
  14585. offset += data_len;
  14586. } else {
  14587. ok = false;
  14588. }
  14589. }
  14590. return ok;
  14591. };
  14592. // As in detail::write_content_with_progress(): the body is framed by
  14593. // content_length, so a provider that finishes early has truncated it.
  14594. // Stop and report that instead of calling the provider forever.
  14595. data_sink.done = [&]() { finished = true; };
  14596. while (ok && !finished && offset < content_length) {
  14597. if (!content_provider(offset, content_length - offset, data_sink)) {
  14598. error = Error::Canceled;
  14599. output_error_log(error, &req);
  14600. return nullptr;
  14601. }
  14602. }
  14603. // A short body here means either the provider stopped early or the
  14604. // compressor gave up. The branch below reports a failing compressor as
  14605. // Error::Compression, so keep the two distinguishable.
  14606. if (offset < content_length) {
  14607. error = ok ? Error::Write : Error::Compression;
  14608. output_error_log(error, &req);
  14609. return nullptr;
  14610. }
  14611. } else {
  14612. if (!compressor->compress(body, content_length, true,
  14613. [&](const char *data, size_t data_len) {
  14614. req.body.append(data, data_len);
  14615. return true;
  14616. })) {
  14617. error = Error::Compression;
  14618. output_error_log(error, &req);
  14619. return nullptr;
  14620. }
  14621. }
  14622. } else {
  14623. if (content_provider) {
  14624. req.content_length_ = content_length;
  14625. req.content_provider_ = std::move(content_provider);
  14626. req.is_chunked_content_provider_ = false;
  14627. } else if (content_provider_without_length) {
  14628. req.content_length_ = 0;
  14629. req.content_provider_ = detail::ContentProviderAdapter(
  14630. std::move(content_provider_without_length));
  14631. req.is_chunked_content_provider_ = true;
  14632. req.set_header("Transfer-Encoding", "chunked");
  14633. } else {
  14634. req.body.assign(body, content_length);
  14635. }
  14636. }
  14637. if (content_receiver) {
  14638. req.content_receiver =
  14639. [content_receiver](const char *data, size_t data_length,
  14640. size_t /*offset*/, size_t /*total_length*/) {
  14641. return content_receiver(data, data_length);
  14642. };
  14643. }
  14644. auto res = detail::make_unique<Response>();
  14645. return send(req, *res, error) ? std::move(res) : nullptr;
  14646. }
  14647. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14648. const std::string &method, const std::string &path, const Headers &headers,
  14649. const char *body, size_t content_length, ContentProvider content_provider,
  14650. ContentProviderWithoutLength content_provider_without_length,
  14651. const std::string &content_type, ContentReceiver content_receiver,
  14652. UploadProgress progress) {
  14653. Request req;
  14654. req.method = method;
  14655. req.headers = headers;
  14656. req.path = path;
  14657. req.upload_progress = std::move(progress);
  14658. if (max_timeout_msec_ > 0) {
  14659. req.start_time_ = std::chrono::steady_clock::now();
  14660. }
  14661. auto error = Error::Success;
  14662. #ifdef CPPHTTPLIB_SSL_ENABLED
  14663. // Hold the request lock until the Result has read this request's TLS error
  14664. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14665. #endif
  14666. auto res = send_with_content_provider_and_receiver(
  14667. req, body, content_length, std::move(content_provider),
  14668. std::move(content_provider_without_length), content_type,
  14669. std::move(content_receiver), error);
  14670. #ifdef CPPHTTPLIB_SSL_ENABLED
  14671. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14672. last_backend_error_};
  14673. #else
  14674. return Result{std::move(res), error, std::move(req.headers)};
  14675. #endif
  14676. }
  14677. inline void ClientImpl::output_log(const Request &req,
  14678. const Response &res) const {
  14679. if (logger_) {
  14680. std::lock_guard<std::mutex> guard(logger_mutex_);
  14681. logger_(req, res);
  14682. }
  14683. }
  14684. inline void ClientImpl::output_error_log(const Error &err,
  14685. const Request *req) const {
  14686. if (error_logger_) {
  14687. std::lock_guard<std::mutex> guard(logger_mutex_);
  14688. error_logger_(err, req);
  14689. }
  14690. }
  14691. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14692. Response &res, bool close_connection,
  14693. Error &error) {
  14694. // Auto-add Expect: 100-continue for large bodies
  14695. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14696. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14697. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14698. req.set_header("Expect", "100-continue");
  14699. }
  14700. }
  14701. // Check for Expect: 100-continue
  14702. auto expect_100_continue =
  14703. detail::has_header_token(req.headers, "Expect", "100-continue");
  14704. // Send request (skip body if using Expect: 100-continue)
  14705. auto rejected_locally = false;
  14706. auto write_request_success =
  14707. write_request(strm, req, close_connection, error, expect_100_continue,
  14708. rejected_locally);
  14709. // A failed write normally still reads the response below, since the server
  14710. // may have answered early (e.g. 413/414) and closed while the body was being
  14711. // sent. A request rejected before any byte reached the socket gets no such
  14712. // response, and waiting for one would block until the read timeout.
  14713. if (rejected_locally) { return false; }
  14714. #ifdef CPPHTTPLIB_SSL_ENABLED
  14715. if (is_ssl() && !expect_100_continue) {
  14716. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14717. if (!is_proxy_enabled) {
  14718. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14719. error = Error::SSLPeerCouldBeClosed_;
  14720. return false;
  14721. }
  14722. }
  14723. }
  14724. #endif
  14725. // Handle Expect: 100-continue.
  14726. //
  14727. // Wait for an interim/early response by attempting to read the status line
  14728. // under a short timeout, instead of trusting raw socket readability. Over
  14729. // TLS, post-handshake records (e.g. session tickets) make the socket
  14730. // readable without any HTTP response being available; relying on
  14731. // `select_read` there caused the body to be withheld forever and the
  14732. // request to fail with `Read` (#2458). If no status line arrives within the
  14733. // timeout, send the body anyway (matching curl's behavior).
  14734. auto status_line_read = false;
  14735. if (expect_100_continue && write_request_success) {
  14736. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14737. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14738. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14739. strm.set_read_timeout(sec, usec);
  14740. status_line_read = read_response_line(strm, req, res, false);
  14741. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14742. }
  14743. if (!status_line_read) {
  14744. // No interim response within the timeout: send the body and handle the
  14745. // response as usual.
  14746. if (!write_request_body(strm, req, error)) { return false; }
  14747. expect_100_continue = false; // Switch to normal response handling
  14748. }
  14749. }
  14750. // Receive response and headers
  14751. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14752. if ((!status_line_read &&
  14753. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14754. !detail::read_headers(strm, res.headers)) {
  14755. if (write_request_success) { error = Error::Read; }
  14756. return false;
  14757. }
  14758. if (!write_request_success) { return false; }
  14759. // Handle Expect: 100-continue response
  14760. if (expect_100_continue) {
  14761. if (res.status == StatusCode::Continue_100) {
  14762. // Server accepted, send the body
  14763. if (!write_request_body(strm, req, error)) { return false; }
  14764. // Read the actual response
  14765. res.headers.clear();
  14766. res.body.clear();
  14767. if (!read_response_line(strm, req, res) ||
  14768. !detail::read_headers(strm, res.headers)) {
  14769. error = Error::Read;
  14770. return false;
  14771. }
  14772. } else {
  14773. // A final response came first, so the body this request declared was
  14774. // never sent, and the server may still be waiting for it. The
  14775. // connection cannot carry another request.
  14776. std::lock_guard<std::mutex> guard(socket_mutex_);
  14777. socket_should_be_closed_when_request_is_done_ = true;
  14778. }
  14779. }
  14780. // Body
  14781. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14782. req.method != "CONNECT") {
  14783. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14784. // whose final transfer coding is not chunked is not ambiguous: its body
  14785. // runs until the server closes the connection, so it is not rejected.
  14786. // HEAD/204 are excluded above and a 304 carries no body.
  14787. if (res.status != StatusCode::NotModified_304) {
  14788. if (detail::has_conflicting_content_length(res.headers)) {
  14789. error = Error::Read;
  14790. return false;
  14791. }
  14792. if (detail::has_faulty_transfer_encoding(res)) {
  14793. std::lock_guard<std::mutex> guard(socket_mutex_);
  14794. socket_should_be_closed_when_request_is_done_ = true;
  14795. }
  14796. }
  14797. auto redirect = follow_location_ && detail::is_redirect(res);
  14798. if (req.response_handler && !redirect) {
  14799. if (!req.response_handler(res)) {
  14800. error = Error::Canceled;
  14801. return false;
  14802. }
  14803. }
  14804. auto out =
  14805. req.content_receiver
  14806. ? static_cast<ContentReceiverWithProgress>(
  14807. [&](const char *buf, size_t n, size_t off, size_t len) {
  14808. if (redirect) { return true; }
  14809. auto ret = req.content_receiver(buf, n, off, len);
  14810. if (!ret) { error = Error::Canceled; }
  14811. return ret;
  14812. })
  14813. : static_cast<ContentReceiverWithProgress>(
  14814. [&](const char *buf, size_t n, size_t /*off*/,
  14815. size_t /*len*/) {
  14816. assert(res.body.size() + n <= res.body.max_size());
  14817. if (payload_max_length_ > 0 &&
  14818. (res.body.size() >= payload_max_length_ ||
  14819. n > payload_max_length_ - res.body.size())) {
  14820. return false;
  14821. }
  14822. res.body.append(buf, n);
  14823. return true;
  14824. });
  14825. auto progress = [&](size_t current, size_t total) {
  14826. if (!req.download_progress || redirect) { return true; }
  14827. auto ret = req.download_progress(current, total);
  14828. if (!ret) { error = Error::Canceled; }
  14829. return ret;
  14830. };
  14831. if (res.has_header("Content-Length")) {
  14832. if (!req.content_receiver) {
  14833. auto len = res.get_header_value_u64("Content-Length");
  14834. if (len > res.body.max_size()) {
  14835. error = Error::Read;
  14836. return false;
  14837. }
  14838. // Content-Length is only the server's claim, so reserve no more than
  14839. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14840. // body has arrived. A longer body grows as it is read.
  14841. auto reserve_len =
  14842. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14843. if (payload_max_length_ > 0) {
  14844. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14845. }
  14846. res.body.reserve(reserve_len);
  14847. }
  14848. }
  14849. if (res.status != StatusCode::NotModified_304) {
  14850. auto content_status = 0;
  14851. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14852. ? (std::numeric_limits<size_t>::max)()
  14853. : payload_max_length_;
  14854. if (!detail::read_content(strm, res, max_length, content_status,
  14855. std::move(progress), std::move(out),
  14856. decompress_)) {
  14857. if (error != Error::Canceled) {
  14858. // Tell the caller apart from a plain read failure when the body was
  14859. // over the payload limit or could not be decoded because of its
  14860. // Content-Encoding.
  14861. switch (content_status) {
  14862. case StatusCode::PayloadTooLarge_413:
  14863. error = Error::ExceedMaxPayloadSize;
  14864. break;
  14865. case StatusCode::UnsupportedMediaType_415:
  14866. error = Error::UnsupportedContentEncoding;
  14867. break;
  14868. case StatusCode::InternalServerError_500:
  14869. error = Error::Compression;
  14870. break;
  14871. default: error = Error::Read; break;
  14872. }
  14873. }
  14874. return false;
  14875. }
  14876. }
  14877. }
  14878. // Log
  14879. output_log(req, res);
  14880. return true;
  14881. }
  14882. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14883. const std::string &boundary, const UploadFormDataItems &items,
  14884. const FormDataProviderItems &provider_items) const {
  14885. size_t cur_item = 0;
  14886. size_t cur_start = 0;
  14887. // cur_item and cur_start are copied to within the std::function and
  14888. // maintain state between successive calls
  14889. return [&, cur_item, cur_start](size_t offset,
  14890. DataSink &sink) mutable -> bool {
  14891. if (!offset && !items.empty()) {
  14892. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14893. return true;
  14894. } else if (cur_item < provider_items.size()) {
  14895. if (!cur_start) {
  14896. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14897. provider_items[cur_item], boundary);
  14898. offset += begin.size();
  14899. cur_start = offset;
  14900. sink.os << begin;
  14901. }
  14902. DataSink cur_sink;
  14903. auto has_data = true;
  14904. cur_sink.write = sink.write;
  14905. // Forward is_writable so a provider item asking whether it may keep
  14906. // going gets the outer sink's answer rather than the default `true`.
  14907. cur_sink.is_writable = sink.is_writable;
  14908. cur_sink.done = [&]() { has_data = false; };
  14909. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14910. return false;
  14911. }
  14912. if (!has_data) {
  14913. sink.os << detail::serialize_multipart_formdata_item_end();
  14914. cur_item++;
  14915. cur_start = 0;
  14916. }
  14917. return true;
  14918. } else {
  14919. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14920. sink.done();
  14921. return true;
  14922. }
  14923. };
  14924. }
  14925. inline bool ClientImpl::process_socket(
  14926. const Socket &socket,
  14927. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14928. std::function<bool(Stream &strm)> callback) {
  14929. return detail::process_client_socket(
  14930. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14931. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14932. }
  14933. inline bool ClientImpl::is_ssl() const { return false; }
  14934. inline Result ClientImpl::Get(const std::string &path,
  14935. DownloadProgress progress) {
  14936. return Get(path, Headers(), std::move(progress));
  14937. }
  14938. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14939. DownloadProgress progress) {
  14940. return Get(path, params, Headers(), std::move(progress));
  14941. }
  14942. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14943. const Headers &headers,
  14944. DownloadProgress progress) {
  14945. if (params.empty()) { return Get(path, headers); }
  14946. std::string path_with_query = append_query_params(path, params);
  14947. return Get(path_with_query, headers, std::move(progress));
  14948. }
  14949. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14950. DownloadProgress progress) {
  14951. Request req;
  14952. req.method = "GET";
  14953. req.path = path;
  14954. req.headers = headers;
  14955. req.download_progress = std::move(progress);
  14956. if (max_timeout_msec_ > 0) {
  14957. req.start_time_ = std::chrono::steady_clock::now();
  14958. }
  14959. return send_(std::move(req));
  14960. }
  14961. inline Result ClientImpl::Get(const std::string &path,
  14962. ContentReceiver content_receiver,
  14963. DownloadProgress progress) {
  14964. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14965. std::move(progress));
  14966. }
  14967. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14968. ContentReceiver content_receiver,
  14969. DownloadProgress progress) {
  14970. return Get(path, headers, nullptr, std::move(content_receiver),
  14971. std::move(progress));
  14972. }
  14973. inline Result ClientImpl::Get(const std::string &path,
  14974. ResponseHandler response_handler,
  14975. ContentReceiver content_receiver,
  14976. DownloadProgress progress) {
  14977. return Get(path, Headers(), std::move(response_handler),
  14978. std::move(content_receiver), std::move(progress));
  14979. }
  14980. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14981. ResponseHandler response_handler,
  14982. ContentReceiver content_receiver,
  14983. DownloadProgress progress) {
  14984. Request req;
  14985. req.method = "GET";
  14986. req.path = path;
  14987. req.headers = headers;
  14988. req.response_handler = std::move(response_handler);
  14989. req.content_receiver =
  14990. [content_receiver](const char *data, size_t data_length,
  14991. size_t /*offset*/, size_t /*total_length*/) {
  14992. return content_receiver(data, data_length);
  14993. };
  14994. req.download_progress = std::move(progress);
  14995. if (max_timeout_msec_ > 0) {
  14996. req.start_time_ = std::chrono::steady_clock::now();
  14997. }
  14998. return send_(std::move(req));
  14999. }
  15000. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15001. const Headers &headers,
  15002. ContentReceiver content_receiver,
  15003. DownloadProgress progress) {
  15004. return Get(path, params, headers, nullptr, std::move(content_receiver),
  15005. std::move(progress));
  15006. }
  15007. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15008. const Headers &headers,
  15009. ResponseHandler response_handler,
  15010. ContentReceiver content_receiver,
  15011. DownloadProgress progress) {
  15012. if (params.empty()) {
  15013. return Get(path, headers, std::move(response_handler),
  15014. std::move(content_receiver), std::move(progress));
  15015. }
  15016. std::string path_with_query = append_query_params(path, params);
  15017. return Get(path_with_query, headers, std::move(response_handler),
  15018. std::move(content_receiver), std::move(progress));
  15019. }
  15020. inline Result ClientImpl::Head(const std::string &path) {
  15021. return Head(path, Headers());
  15022. }
  15023. inline Result ClientImpl::Head(const std::string &path,
  15024. const Headers &headers) {
  15025. Request req;
  15026. req.method = "HEAD";
  15027. req.headers = headers;
  15028. req.path = path;
  15029. if (max_timeout_msec_ > 0) {
  15030. req.start_time_ = std::chrono::steady_clock::now();
  15031. }
  15032. return send_(std::move(req));
  15033. }
  15034. inline Result ClientImpl::Post(const std::string &path) {
  15035. return Post(path, std::string(), std::string());
  15036. }
  15037. inline Result ClientImpl::Post(const std::string &path,
  15038. const Headers &headers) {
  15039. return Post(path, headers, nullptr, 0, std::string());
  15040. }
  15041. inline Result ClientImpl::Post(const std::string &path, const char *body,
  15042. size_t content_length,
  15043. const std::string &content_type,
  15044. UploadProgress progress) {
  15045. return Post(path, Headers(), body, content_length, content_type, progress);
  15046. }
  15047. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  15048. const std::string &content_type,
  15049. UploadProgress progress) {
  15050. return Post(path, Headers(), body, content_type, progress);
  15051. }
  15052. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  15053. return Post(path, Headers(), params);
  15054. }
  15055. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15056. ContentProvider content_provider,
  15057. const std::string &content_type,
  15058. UploadProgress progress) {
  15059. return Post(path, Headers(), content_length, std::move(content_provider),
  15060. content_type, progress);
  15061. }
  15062. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15063. ContentProvider content_provider,
  15064. const std::string &content_type,
  15065. ContentReceiver content_receiver,
  15066. UploadProgress progress) {
  15067. return Post(path, Headers(), content_length, std::move(content_provider),
  15068. content_type, std::move(content_receiver), progress);
  15069. }
  15070. inline Result ClientImpl::Post(const std::string &path,
  15071. ContentProviderWithoutLength content_provider,
  15072. const std::string &content_type,
  15073. UploadProgress progress) {
  15074. return Post(path, Headers(), std::move(content_provider), content_type,
  15075. progress);
  15076. }
  15077. inline Result ClientImpl::Post(const std::string &path,
  15078. ContentProviderWithoutLength content_provider,
  15079. const std::string &content_type,
  15080. ContentReceiver content_receiver,
  15081. UploadProgress progress) {
  15082. return Post(path, Headers(), std::move(content_provider), content_type,
  15083. std::move(content_receiver), progress);
  15084. }
  15085. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15086. const Params &params) {
  15087. auto query = detail::params_to_query_str(params);
  15088. return Post(path, headers, query, "application/x-www-form-urlencoded");
  15089. }
  15090. inline Result ClientImpl::Post(const std::string &path,
  15091. const UploadFormDataItems &items,
  15092. UploadProgress progress) {
  15093. return Post(path, Headers(), items, progress);
  15094. }
  15095. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15096. const UploadFormDataItems &items,
  15097. UploadProgress progress) {
  15098. const auto &boundary = detail::make_multipart_data_boundary();
  15099. const auto &content_type =
  15100. detail::serialize_multipart_formdata_get_content_type(boundary);
  15101. auto content_length = detail::get_multipart_content_length(items, boundary);
  15102. return Post(path, headers, content_length,
  15103. detail::make_multipart_content_provider(items, boundary),
  15104. content_type, progress);
  15105. }
  15106. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15107. const UploadFormDataItems &items,
  15108. const std::string &boundary,
  15109. UploadProgress progress) {
  15110. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15111. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15112. }
  15113. const auto &content_type =
  15114. detail::serialize_multipart_formdata_get_content_type(boundary);
  15115. auto content_length = detail::get_multipart_content_length(items, boundary);
  15116. return Post(path, headers, content_length,
  15117. detail::make_multipart_content_provider(items, boundary),
  15118. content_type, progress);
  15119. }
  15120. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15121. const char *body, size_t content_length,
  15122. const std::string &content_type,
  15123. UploadProgress progress) {
  15124. return send_with_content_provider_and_receiver(
  15125. "POST", path, headers, body, content_length, nullptr, nullptr,
  15126. content_type, nullptr, progress);
  15127. }
  15128. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15129. const std::string &body,
  15130. const std::string &content_type,
  15131. UploadProgress progress) {
  15132. return send_with_content_provider_and_receiver(
  15133. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  15134. content_type, nullptr, progress);
  15135. }
  15136. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15137. size_t content_length,
  15138. ContentProvider content_provider,
  15139. const std::string &content_type,
  15140. UploadProgress progress) {
  15141. return send_with_content_provider_and_receiver(
  15142. "POST", path, headers, nullptr, content_length,
  15143. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15144. }
  15145. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15146. size_t content_length,
  15147. ContentProvider content_provider,
  15148. const std::string &content_type,
  15149. ContentReceiver content_receiver,
  15150. DownloadProgress progress) {
  15151. return send_with_content_provider_and_receiver(
  15152. "POST", path, headers, nullptr, content_length,
  15153. std::move(content_provider), nullptr, content_type,
  15154. std::move(content_receiver), std::move(progress));
  15155. }
  15156. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15157. ContentProviderWithoutLength content_provider,
  15158. const std::string &content_type,
  15159. UploadProgress progress) {
  15160. return send_with_content_provider_and_receiver(
  15161. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15162. content_type, nullptr, progress);
  15163. }
  15164. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15165. ContentProviderWithoutLength content_provider,
  15166. const std::string &content_type,
  15167. ContentReceiver content_receiver,
  15168. DownloadProgress progress) {
  15169. return send_with_content_provider_and_receiver(
  15170. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15171. content_type, std::move(content_receiver), std::move(progress));
  15172. }
  15173. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15174. const UploadFormDataItems &items,
  15175. const FormDataProviderItems &provider_items,
  15176. UploadProgress progress) {
  15177. const auto &boundary = detail::make_multipart_data_boundary();
  15178. const auto &content_type =
  15179. detail::serialize_multipart_formdata_get_content_type(boundary);
  15180. return send_with_content_provider_and_receiver(
  15181. "POST", path, headers, nullptr, 0, nullptr,
  15182. get_multipart_content_provider(boundary, items, provider_items),
  15183. content_type, nullptr, progress);
  15184. }
  15185. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15186. const std::string &body,
  15187. const std::string &content_type,
  15188. ContentReceiver content_receiver,
  15189. DownloadProgress progress) {
  15190. Request req;
  15191. req.method = "POST";
  15192. req.path = path;
  15193. req.headers = headers;
  15194. req.body = body;
  15195. req.content_receiver =
  15196. [content_receiver](const char *data, size_t data_length,
  15197. size_t /*offset*/, size_t /*total_length*/) {
  15198. return content_receiver(data, data_length);
  15199. };
  15200. req.download_progress = std::move(progress);
  15201. if (max_timeout_msec_ > 0) {
  15202. req.start_time_ = std::chrono::steady_clock::now();
  15203. }
  15204. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15205. return send_(std::move(req));
  15206. }
  15207. inline Result ClientImpl::Put(const std::string &path) {
  15208. return Put(path, std::string(), std::string());
  15209. }
  15210. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  15211. return Put(path, headers, nullptr, 0, std::string());
  15212. }
  15213. inline Result ClientImpl::Put(const std::string &path, const char *body,
  15214. size_t content_length,
  15215. const std::string &content_type,
  15216. UploadProgress progress) {
  15217. return Put(path, Headers(), body, content_length, content_type, progress);
  15218. }
  15219. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  15220. const std::string &content_type,
  15221. UploadProgress progress) {
  15222. return Put(path, Headers(), body, content_type, progress);
  15223. }
  15224. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  15225. return Put(path, Headers(), params);
  15226. }
  15227. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15228. ContentProvider content_provider,
  15229. const std::string &content_type,
  15230. UploadProgress progress) {
  15231. return Put(path, Headers(), content_length, std::move(content_provider),
  15232. content_type, progress);
  15233. }
  15234. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15235. ContentProvider content_provider,
  15236. const std::string &content_type,
  15237. ContentReceiver content_receiver,
  15238. UploadProgress progress) {
  15239. return Put(path, Headers(), content_length, std::move(content_provider),
  15240. content_type, std::move(content_receiver), progress);
  15241. }
  15242. inline Result ClientImpl::Put(const std::string &path,
  15243. ContentProviderWithoutLength content_provider,
  15244. const std::string &content_type,
  15245. UploadProgress progress) {
  15246. return Put(path, Headers(), std::move(content_provider), content_type,
  15247. progress);
  15248. }
  15249. inline Result ClientImpl::Put(const std::string &path,
  15250. ContentProviderWithoutLength content_provider,
  15251. const std::string &content_type,
  15252. ContentReceiver content_receiver,
  15253. UploadProgress progress) {
  15254. return Put(path, Headers(), std::move(content_provider), content_type,
  15255. std::move(content_receiver), progress);
  15256. }
  15257. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15258. const Params &params) {
  15259. auto query = detail::params_to_query_str(params);
  15260. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15261. }
  15262. inline Result ClientImpl::Put(const std::string &path,
  15263. const UploadFormDataItems &items,
  15264. UploadProgress progress) {
  15265. return Put(path, Headers(), items, progress);
  15266. }
  15267. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15268. const UploadFormDataItems &items,
  15269. UploadProgress progress) {
  15270. const auto &boundary = detail::make_multipart_data_boundary();
  15271. const auto &content_type =
  15272. detail::serialize_multipart_formdata_get_content_type(boundary);
  15273. auto content_length = detail::get_multipart_content_length(items, boundary);
  15274. return Put(path, headers, content_length,
  15275. detail::make_multipart_content_provider(items, boundary),
  15276. content_type, progress);
  15277. }
  15278. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15279. const UploadFormDataItems &items,
  15280. const std::string &boundary,
  15281. UploadProgress progress) {
  15282. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15283. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15284. }
  15285. const auto &content_type =
  15286. detail::serialize_multipart_formdata_get_content_type(boundary);
  15287. auto content_length = detail::get_multipart_content_length(items, boundary);
  15288. return Put(path, headers, content_length,
  15289. detail::make_multipart_content_provider(items, boundary),
  15290. content_type, progress);
  15291. }
  15292. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15293. const char *body, size_t content_length,
  15294. const std::string &content_type,
  15295. UploadProgress progress) {
  15296. return send_with_content_provider_and_receiver(
  15297. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15298. content_type, nullptr, progress);
  15299. }
  15300. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15301. const std::string &body,
  15302. const std::string &content_type,
  15303. UploadProgress progress) {
  15304. return send_with_content_provider_and_receiver(
  15305. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15306. content_type, nullptr, progress);
  15307. }
  15308. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15309. size_t content_length,
  15310. ContentProvider content_provider,
  15311. const std::string &content_type,
  15312. UploadProgress progress) {
  15313. return send_with_content_provider_and_receiver(
  15314. "PUT", path, headers, nullptr, content_length,
  15315. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15316. }
  15317. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15318. size_t content_length,
  15319. ContentProvider content_provider,
  15320. const std::string &content_type,
  15321. ContentReceiver content_receiver,
  15322. UploadProgress progress) {
  15323. return send_with_content_provider_and_receiver(
  15324. "PUT", path, headers, nullptr, content_length,
  15325. std::move(content_provider), nullptr, content_type,
  15326. std::move(content_receiver), progress);
  15327. }
  15328. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15329. ContentProviderWithoutLength content_provider,
  15330. const std::string &content_type,
  15331. UploadProgress progress) {
  15332. return send_with_content_provider_and_receiver(
  15333. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15334. content_type, nullptr, progress);
  15335. }
  15336. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15337. ContentProviderWithoutLength content_provider,
  15338. const std::string &content_type,
  15339. ContentReceiver content_receiver,
  15340. UploadProgress progress) {
  15341. return send_with_content_provider_and_receiver(
  15342. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15343. content_type, std::move(content_receiver), progress);
  15344. }
  15345. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15346. const UploadFormDataItems &items,
  15347. const FormDataProviderItems &provider_items,
  15348. UploadProgress progress) {
  15349. const auto &boundary = detail::make_multipart_data_boundary();
  15350. const auto &content_type =
  15351. detail::serialize_multipart_formdata_get_content_type(boundary);
  15352. return send_with_content_provider_and_receiver(
  15353. "PUT", path, headers, nullptr, 0, nullptr,
  15354. get_multipart_content_provider(boundary, items, provider_items),
  15355. content_type, nullptr, progress);
  15356. }
  15357. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15358. const std::string &body,
  15359. const std::string &content_type,
  15360. ContentReceiver content_receiver,
  15361. DownloadProgress progress) {
  15362. Request req;
  15363. req.method = "PUT";
  15364. req.path = path;
  15365. req.headers = headers;
  15366. req.body = body;
  15367. req.content_receiver =
  15368. [content_receiver](const char *data, size_t data_length,
  15369. size_t /*offset*/, size_t /*total_length*/) {
  15370. return content_receiver(data, data_length);
  15371. };
  15372. req.download_progress = std::move(progress);
  15373. if (max_timeout_msec_ > 0) {
  15374. req.start_time_ = std::chrono::steady_clock::now();
  15375. }
  15376. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15377. return send_(std::move(req));
  15378. }
  15379. inline Result ClientImpl::Patch(const std::string &path) {
  15380. return Patch(path, std::string(), std::string());
  15381. }
  15382. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15383. UploadProgress progress) {
  15384. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15385. }
  15386. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15387. size_t content_length,
  15388. const std::string &content_type,
  15389. UploadProgress progress) {
  15390. return Patch(path, Headers(), body, content_length, content_type, progress);
  15391. }
  15392. inline Result ClientImpl::Patch(const std::string &path,
  15393. const std::string &body,
  15394. const std::string &content_type,
  15395. UploadProgress progress) {
  15396. return Patch(path, Headers(), body, content_type, progress);
  15397. }
  15398. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15399. return Patch(path, Headers(), params);
  15400. }
  15401. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15402. ContentProvider content_provider,
  15403. const std::string &content_type,
  15404. UploadProgress progress) {
  15405. return Patch(path, Headers(), content_length, std::move(content_provider),
  15406. content_type, progress);
  15407. }
  15408. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15409. ContentProvider content_provider,
  15410. const std::string &content_type,
  15411. ContentReceiver content_receiver,
  15412. UploadProgress progress) {
  15413. return Patch(path, Headers(), content_length, std::move(content_provider),
  15414. content_type, std::move(content_receiver), progress);
  15415. }
  15416. inline Result ClientImpl::Patch(const std::string &path,
  15417. ContentProviderWithoutLength content_provider,
  15418. const std::string &content_type,
  15419. UploadProgress progress) {
  15420. return Patch(path, Headers(), std::move(content_provider), content_type,
  15421. progress);
  15422. }
  15423. inline Result ClientImpl::Patch(const std::string &path,
  15424. ContentProviderWithoutLength content_provider,
  15425. const std::string &content_type,
  15426. ContentReceiver content_receiver,
  15427. UploadProgress progress) {
  15428. return Patch(path, Headers(), std::move(content_provider), content_type,
  15429. std::move(content_receiver), progress);
  15430. }
  15431. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15432. const Params &params) {
  15433. auto query = detail::params_to_query_str(params);
  15434. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15435. }
  15436. inline Result ClientImpl::Patch(const std::string &path,
  15437. const UploadFormDataItems &items,
  15438. UploadProgress progress) {
  15439. return Patch(path, Headers(), items, progress);
  15440. }
  15441. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15442. const UploadFormDataItems &items,
  15443. UploadProgress progress) {
  15444. const auto &boundary = detail::make_multipart_data_boundary();
  15445. const auto &content_type =
  15446. detail::serialize_multipart_formdata_get_content_type(boundary);
  15447. auto content_length = detail::get_multipart_content_length(items, boundary);
  15448. return Patch(path, headers, content_length,
  15449. detail::make_multipart_content_provider(items, boundary),
  15450. content_type, progress);
  15451. }
  15452. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15453. const UploadFormDataItems &items,
  15454. const std::string &boundary,
  15455. UploadProgress progress) {
  15456. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15457. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15458. }
  15459. const auto &content_type =
  15460. detail::serialize_multipart_formdata_get_content_type(boundary);
  15461. auto content_length = detail::get_multipart_content_length(items, boundary);
  15462. return Patch(path, headers, content_length,
  15463. detail::make_multipart_content_provider(items, boundary),
  15464. content_type, progress);
  15465. }
  15466. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15467. const char *body, size_t content_length,
  15468. const std::string &content_type,
  15469. UploadProgress progress) {
  15470. return send_with_content_provider_and_receiver(
  15471. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15472. content_type, nullptr, progress);
  15473. }
  15474. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15475. const std::string &body,
  15476. const std::string &content_type,
  15477. UploadProgress progress) {
  15478. return send_with_content_provider_and_receiver(
  15479. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15480. content_type, nullptr, progress);
  15481. }
  15482. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15483. size_t content_length,
  15484. ContentProvider content_provider,
  15485. const std::string &content_type,
  15486. UploadProgress progress) {
  15487. return send_with_content_provider_and_receiver(
  15488. "PATCH", path, headers, nullptr, content_length,
  15489. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15490. }
  15491. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15492. size_t content_length,
  15493. ContentProvider content_provider,
  15494. const std::string &content_type,
  15495. ContentReceiver content_receiver,
  15496. UploadProgress progress) {
  15497. return send_with_content_provider_and_receiver(
  15498. "PATCH", path, headers, nullptr, content_length,
  15499. std::move(content_provider), nullptr, content_type,
  15500. std::move(content_receiver), progress);
  15501. }
  15502. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15503. ContentProviderWithoutLength content_provider,
  15504. const std::string &content_type,
  15505. UploadProgress progress) {
  15506. return send_with_content_provider_and_receiver(
  15507. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15508. content_type, nullptr, progress);
  15509. }
  15510. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15511. ContentProviderWithoutLength content_provider,
  15512. const std::string &content_type,
  15513. ContentReceiver content_receiver,
  15514. UploadProgress progress) {
  15515. return send_with_content_provider_and_receiver(
  15516. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15517. content_type, std::move(content_receiver), progress);
  15518. }
  15519. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15520. const UploadFormDataItems &items,
  15521. const FormDataProviderItems &provider_items,
  15522. UploadProgress progress) {
  15523. const auto &boundary = detail::make_multipart_data_boundary();
  15524. const auto &content_type =
  15525. detail::serialize_multipart_formdata_get_content_type(boundary);
  15526. return send_with_content_provider_and_receiver(
  15527. "PATCH", path, headers, nullptr, 0, nullptr,
  15528. get_multipart_content_provider(boundary, items, provider_items),
  15529. content_type, nullptr, progress);
  15530. }
  15531. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15532. const std::string &body,
  15533. const std::string &content_type,
  15534. ContentReceiver content_receiver,
  15535. DownloadProgress progress) {
  15536. Request req;
  15537. req.method = "PATCH";
  15538. req.path = path;
  15539. req.headers = headers;
  15540. req.body = body;
  15541. req.content_receiver =
  15542. [content_receiver](const char *data, size_t data_length,
  15543. size_t /*offset*/, size_t /*total_length*/) {
  15544. return content_receiver(data, data_length);
  15545. };
  15546. req.download_progress = std::move(progress);
  15547. if (max_timeout_msec_ > 0) {
  15548. req.start_time_ = std::chrono::steady_clock::now();
  15549. }
  15550. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15551. return send_(std::move(req));
  15552. }
  15553. inline Result ClientImpl::Delete(const std::string &path,
  15554. DownloadProgress progress) {
  15555. return Delete(path, Headers(), std::string(), std::string(), progress);
  15556. }
  15557. inline Result ClientImpl::Delete(const std::string &path,
  15558. const Headers &headers,
  15559. DownloadProgress progress) {
  15560. return Delete(path, headers, std::string(), std::string(), progress);
  15561. }
  15562. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15563. size_t content_length,
  15564. const std::string &content_type,
  15565. DownloadProgress progress) {
  15566. return Delete(path, Headers(), body, content_length, content_type, progress);
  15567. }
  15568. inline Result ClientImpl::Delete(const std::string &path,
  15569. const std::string &body,
  15570. const std::string &content_type,
  15571. DownloadProgress progress) {
  15572. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15573. progress);
  15574. }
  15575. inline Result ClientImpl::Delete(const std::string &path,
  15576. const Headers &headers,
  15577. const std::string &body,
  15578. const std::string &content_type,
  15579. DownloadProgress progress) {
  15580. return Delete(path, headers, body.data(), body.size(), content_type,
  15581. progress);
  15582. }
  15583. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15584. DownloadProgress progress) {
  15585. return Delete(path, Headers(), params, progress);
  15586. }
  15587. inline Result ClientImpl::Delete(const std::string &path,
  15588. const Headers &headers, const Params &params,
  15589. DownloadProgress progress) {
  15590. auto query = detail::params_to_query_str(params);
  15591. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15592. progress);
  15593. }
  15594. inline Result ClientImpl::Delete(const std::string &path,
  15595. const Headers &headers, const char *body,
  15596. size_t content_length,
  15597. const std::string &content_type,
  15598. DownloadProgress progress) {
  15599. Request req;
  15600. req.method = "DELETE";
  15601. req.headers = headers;
  15602. req.path = path;
  15603. req.download_progress = std::move(progress);
  15604. if (max_timeout_msec_ > 0) {
  15605. req.start_time_ = std::chrono::steady_clock::now();
  15606. }
  15607. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15608. req.body.assign(body, content_length);
  15609. return send_(std::move(req));
  15610. }
  15611. inline Result ClientImpl::Options(const std::string &path) {
  15612. return Options(path, Headers());
  15613. }
  15614. inline Result ClientImpl::Options(const std::string &path,
  15615. const Headers &headers) {
  15616. Request req;
  15617. req.method = "OPTIONS";
  15618. req.headers = headers;
  15619. req.path = path;
  15620. if (max_timeout_msec_ > 0) {
  15621. req.start_time_ = std::chrono::steady_clock::now();
  15622. }
  15623. return send_(std::move(req));
  15624. }
  15625. inline void ClientImpl::stop() {
  15626. std::lock_guard<std::mutex> guard(socket_mutex_);
  15627. stop_requested_ = true;
  15628. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15629. // do is to shutdown_socket, so that threads using this socket suddenly
  15630. // discover they can't read/write any more and error out. Everything else
  15631. // (closing the socket, shutting ssl down) is unsafe because these actions
  15632. // are not thread-safe.
  15633. if (socket_requests_in_flight_ > 0) {
  15634. shutdown_socket(socket_);
  15635. // Aside from that, we set a flag for the socket to be closed when we're
  15636. // done.
  15637. socket_should_be_closed_when_request_is_done_ = true;
  15638. return;
  15639. }
  15640. disconnect(/*gracefully=*/true);
  15641. }
  15642. inline std::string ClientImpl::host() const { return host_; }
  15643. inline int ClientImpl::port() const { return port_; }
  15644. inline size_t ClientImpl::is_socket_open() const {
  15645. std::lock_guard<std::mutex> guard(socket_mutex_);
  15646. return socket_.is_open();
  15647. }
  15648. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15649. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15650. connection_timeout_sec_ = sec;
  15651. connection_timeout_usec_ = usec;
  15652. }
  15653. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15654. read_timeout_sec_ = sec;
  15655. read_timeout_usec_ = usec;
  15656. }
  15657. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15658. write_timeout_sec_ = sec;
  15659. write_timeout_usec_ = usec;
  15660. }
  15661. inline void ClientImpl::set_max_timeout(time_t msec) {
  15662. max_timeout_msec_ = msec;
  15663. }
  15664. inline void ClientImpl::set_basic_auth(const std::string &username,
  15665. const std::string &password) {
  15666. basic_auth_username_ = username;
  15667. basic_auth_password_ = password;
  15668. }
  15669. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15670. bearer_token_auth_token_ = token;
  15671. }
  15672. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15673. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15674. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15675. inline void
  15676. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15677. set_direct_hostname_addr_map(std::move(addr_map));
  15678. }
  15679. inline void ClientImpl::set_direct_hostname_addr_map(
  15680. std::map<std::string, std::string> addr_map) {
  15681. addr_map_ = std::move(addr_map);
  15682. }
  15683. inline void ClientImpl::set_tunnel_hostname_addr_map(
  15684. std::map<std::string, std::string> addr_map) {
  15685. tunnel_addr_map_ = std::move(addr_map);
  15686. }
  15687. inline void ClientImpl::set_default_headers(Headers headers) {
  15688. default_headers_ = std::move(headers);
  15689. }
  15690. inline void ClientImpl::set_header_writer(
  15691. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15692. header_writer_ = writer;
  15693. }
  15694. inline void ClientImpl::set_address_family(int family) {
  15695. address_family_ = family;
  15696. }
  15697. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15698. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15699. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15700. socket_options_ = std::move(socket_options);
  15701. }
  15702. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15703. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15704. inline void ClientImpl::set_payload_max_length(size_t length) {
  15705. payload_max_length_ = length;
  15706. has_payload_max_length_ = true;
  15707. }
  15708. inline void ClientImpl::set_interface(const std::string &intf) {
  15709. interface_ = intf;
  15710. }
  15711. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15712. proxy_host_ = host;
  15713. proxy_port_ = port;
  15714. std::lock_guard<std::mutex> guard(socket_mutex_);
  15715. disconnect(/*gracefully=*/true);
  15716. }
  15717. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15718. const std::string &password) {
  15719. proxy_basic_auth_username_ = username;
  15720. proxy_basic_auth_password_ = password;
  15721. }
  15722. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15723. proxy_bearer_token_auth_token_ = token;
  15724. }
  15725. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15726. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15727. std::lock_guard<std::mutex> guard(socket_mutex_);
  15728. disconnect(/*gracefully=*/true);
  15729. }
  15730. #ifdef CPPHTTPLIB_SSL_ENABLED
  15731. inline void ClientImpl::set_digest_auth(const std::string &username,
  15732. const std::string &password) {
  15733. digest_auth_username_ = username;
  15734. digest_auth_password_ = password;
  15735. }
  15736. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15737. const std::string &ca_cert_dir_path) {
  15738. ca_cert_file_path_ = ca_cert_file_path;
  15739. ca_cert_dir_path_ = ca_cert_dir_path;
  15740. }
  15741. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15742. const std::string &password) {
  15743. proxy_digest_auth_username_ = username;
  15744. proxy_digest_auth_password_ = password;
  15745. }
  15746. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15747. if (server_certificate_verification_ == enabled) { return; }
  15748. server_certificate_verification_ = enabled;
  15749. tls_settings_changed();
  15750. }
  15751. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15752. if (server_hostname_verification_ == enabled) { return; }
  15753. server_hostname_verification_ = enabled;
  15754. tls_settings_changed();
  15755. }
  15756. inline void ClientImpl::enable_system_ca(bool enabled) {
  15757. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15758. }
  15759. #endif
  15760. inline void ClientImpl::set_logger(Logger logger) {
  15761. logger_ = std::move(logger);
  15762. }
  15763. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15764. error_logger_ = std::move(error_logger);
  15765. }
  15766. /*
  15767. * SSL/TLS Common Implementation
  15768. */
  15769. inline ClientConnection::~ClientConnection() {
  15770. #ifdef CPPHTTPLIB_SSL_ENABLED
  15771. if (session) {
  15772. tls::shutdown(session, true);
  15773. tls::free_session(session);
  15774. session = nullptr;
  15775. }
  15776. #endif
  15777. if (sock != INVALID_SOCKET) {
  15778. detail::close_socket(sock);
  15779. sock = INVALID_SOCKET;
  15780. }
  15781. }
  15782. // Universal client implementation
  15783. inline Client::Client(const std::string &scheme_host_port)
  15784. : Client(scheme_host_port, std::string(), std::string()) {}
  15785. inline Client::Client(const std::string &scheme_host_port,
  15786. const std::string &client_cert_path,
  15787. const std::string &client_key_path) {
  15788. detail::UrlComponents uc;
  15789. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15790. auto &scheme = uc.scheme;
  15791. #ifdef CPPHTTPLIB_SSL_ENABLED
  15792. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15793. #else
  15794. if (!scheme.empty() && scheme != "http") {
  15795. #endif
  15796. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15797. std::string msg = "'" + scheme + "' scheme is not supported.";
  15798. throw std::invalid_argument(msg);
  15799. #endif
  15800. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15801. return;
  15802. }
  15803. auto is_ssl = scheme == "https";
  15804. auto host = std::move(uc.host);
  15805. auto port = is_ssl ? 443 : 80;
  15806. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15807. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15808. return;
  15809. }
  15810. if (is_ssl) {
  15811. #ifdef CPPHTTPLIB_SSL_ENABLED
  15812. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15813. client_key_path);
  15814. is_ssl_ = is_ssl;
  15815. #endif
  15816. } else {
  15817. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15818. client_key_path);
  15819. }
  15820. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15821. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15822. // A URL, but not one this client can use, such as one with userinfo. A
  15823. // Unix socket path may have "//" further on.
  15824. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15825. } else {
  15826. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15827. // if port param below changes.
  15828. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15829. client_cert_path, client_key_path);
  15830. }
  15831. }
  15832. inline Client::Client(const std::string &host, int port)
  15833. : Client(host, port, std::string(), std::string()) {}
  15834. inline Client::Client(const std::string &host, int port,
  15835. const std::string &client_cert_path,
  15836. const std::string &client_key_path)
  15837. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15838. client_key_path)) {}
  15839. inline Client::~Client() = default;
  15840. inline bool Client::is_valid() const {
  15841. return cli_ != nullptr && cli_->is_valid();
  15842. }
  15843. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15844. return cli_->Get(path, std::move(progress));
  15845. }
  15846. inline Result Client::Get(const std::string &path, const Headers &headers,
  15847. DownloadProgress progress) {
  15848. return cli_->Get(path, headers, std::move(progress));
  15849. }
  15850. inline Result Client::Get(const std::string &path,
  15851. ContentReceiver content_receiver,
  15852. DownloadProgress progress) {
  15853. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15854. }
  15855. inline Result Client::Get(const std::string &path, const Headers &headers,
  15856. ContentReceiver content_receiver,
  15857. DownloadProgress progress) {
  15858. return cli_->Get(path, headers, std::move(content_receiver),
  15859. std::move(progress));
  15860. }
  15861. inline Result Client::Get(const std::string &path,
  15862. ResponseHandler response_handler,
  15863. ContentReceiver content_receiver,
  15864. DownloadProgress progress) {
  15865. return cli_->Get(path, std::move(response_handler),
  15866. std::move(content_receiver), std::move(progress));
  15867. }
  15868. inline Result Client::Get(const std::string &path, const Headers &headers,
  15869. ResponseHandler response_handler,
  15870. ContentReceiver content_receiver,
  15871. DownloadProgress progress) {
  15872. return cli_->Get(path, headers, std::move(response_handler),
  15873. std::move(content_receiver), std::move(progress));
  15874. }
  15875. inline Result Client::Get(const std::string &path, const Params &params,
  15876. DownloadProgress progress) {
  15877. return cli_->Get(path, params, std::move(progress));
  15878. }
  15879. inline Result Client::Get(const std::string &path, const Params &params,
  15880. const Headers &headers, DownloadProgress progress) {
  15881. return cli_->Get(path, params, headers, std::move(progress));
  15882. }
  15883. inline Result Client::Get(const std::string &path, const Params &params,
  15884. const Headers &headers,
  15885. ContentReceiver content_receiver,
  15886. DownloadProgress progress) {
  15887. return cli_->Get(path, params, headers, std::move(content_receiver),
  15888. std::move(progress));
  15889. }
  15890. inline Result Client::Get(const std::string &path, const Params &params,
  15891. const Headers &headers,
  15892. ResponseHandler response_handler,
  15893. ContentReceiver content_receiver,
  15894. DownloadProgress progress) {
  15895. return cli_->Get(path, params, headers, std::move(response_handler),
  15896. std::move(content_receiver), std::move(progress));
  15897. }
  15898. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15899. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15900. return cli_->Head(path, headers);
  15901. }
  15902. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15903. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15904. return cli_->Post(path, headers);
  15905. }
  15906. inline Result Client::Post(const std::string &path, const char *body,
  15907. size_t content_length,
  15908. const std::string &content_type,
  15909. UploadProgress progress) {
  15910. return cli_->Post(path, body, content_length, content_type, progress);
  15911. }
  15912. inline Result Client::Post(const std::string &path, const Headers &headers,
  15913. const char *body, size_t content_length,
  15914. const std::string &content_type,
  15915. UploadProgress progress) {
  15916. return cli_->Post(path, headers, body, content_length, content_type,
  15917. progress);
  15918. }
  15919. inline Result Client::Post(const std::string &path, const std::string &body,
  15920. const std::string &content_type,
  15921. UploadProgress progress) {
  15922. return cli_->Post(path, body, content_type, progress);
  15923. }
  15924. inline Result Client::Post(const std::string &path, const Headers &headers,
  15925. const std::string &body,
  15926. const std::string &content_type,
  15927. UploadProgress progress) {
  15928. return cli_->Post(path, headers, body, content_type, progress);
  15929. }
  15930. inline Result Client::Post(const std::string &path, size_t content_length,
  15931. ContentProvider content_provider,
  15932. const std::string &content_type,
  15933. UploadProgress progress) {
  15934. return cli_->Post(path, content_length, std::move(content_provider),
  15935. content_type, progress);
  15936. }
  15937. inline Result Client::Post(const std::string &path, size_t content_length,
  15938. ContentProvider content_provider,
  15939. const std::string &content_type,
  15940. ContentReceiver content_receiver,
  15941. UploadProgress progress) {
  15942. return cli_->Post(path, content_length, std::move(content_provider),
  15943. content_type, std::move(content_receiver), progress);
  15944. }
  15945. inline Result Client::Post(const std::string &path,
  15946. ContentProviderWithoutLength content_provider,
  15947. const std::string &content_type,
  15948. UploadProgress progress) {
  15949. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15950. }
  15951. inline Result Client::Post(const std::string &path,
  15952. ContentProviderWithoutLength content_provider,
  15953. const std::string &content_type,
  15954. ContentReceiver content_receiver,
  15955. UploadProgress progress) {
  15956. return cli_->Post(path, std::move(content_provider), content_type,
  15957. std::move(content_receiver), progress);
  15958. }
  15959. inline Result Client::Post(const std::string &path, const Headers &headers,
  15960. size_t content_length,
  15961. ContentProvider content_provider,
  15962. const std::string &content_type,
  15963. UploadProgress progress) {
  15964. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15965. content_type, progress);
  15966. }
  15967. inline Result Client::Post(const std::string &path, const Headers &headers,
  15968. size_t content_length,
  15969. ContentProvider content_provider,
  15970. const std::string &content_type,
  15971. ContentReceiver content_receiver,
  15972. DownloadProgress progress) {
  15973. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15974. content_type, std::move(content_receiver), progress);
  15975. }
  15976. inline Result Client::Post(const std::string &path, const Headers &headers,
  15977. ContentProviderWithoutLength content_provider,
  15978. const std::string &content_type,
  15979. UploadProgress progress) {
  15980. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15981. progress);
  15982. }
  15983. inline Result Client::Post(const std::string &path, const Headers &headers,
  15984. ContentProviderWithoutLength content_provider,
  15985. const std::string &content_type,
  15986. ContentReceiver content_receiver,
  15987. DownloadProgress progress) {
  15988. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15989. std::move(content_receiver), progress);
  15990. }
  15991. inline Result Client::Post(const std::string &path, const Params &params) {
  15992. return cli_->Post(path, params);
  15993. }
  15994. inline Result Client::Post(const std::string &path, const Headers &headers,
  15995. const Params &params) {
  15996. return cli_->Post(path, headers, params);
  15997. }
  15998. inline Result Client::Post(const std::string &path,
  15999. const UploadFormDataItems &items,
  16000. UploadProgress progress) {
  16001. return cli_->Post(path, items, progress);
  16002. }
  16003. inline Result Client::Post(const std::string &path, const Headers &headers,
  16004. const UploadFormDataItems &items,
  16005. UploadProgress progress) {
  16006. return cli_->Post(path, headers, items, progress);
  16007. }
  16008. inline Result Client::Post(const std::string &path, const Headers &headers,
  16009. const UploadFormDataItems &items,
  16010. const std::string &boundary,
  16011. UploadProgress progress) {
  16012. return cli_->Post(path, headers, items, boundary, progress);
  16013. }
  16014. inline Result Client::Post(const std::string &path, const Headers &headers,
  16015. const UploadFormDataItems &items,
  16016. const FormDataProviderItems &provider_items,
  16017. UploadProgress progress) {
  16018. return cli_->Post(path, headers, items, provider_items, progress);
  16019. }
  16020. inline Result Client::Post(const std::string &path, const Headers &headers,
  16021. const std::string &body,
  16022. const std::string &content_type,
  16023. ContentReceiver content_receiver,
  16024. DownloadProgress progress) {
  16025. return cli_->Post(path, headers, body, content_type,
  16026. std::move(content_receiver), progress);
  16027. }
  16028. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  16029. inline Result Client::Put(const std::string &path, const Headers &headers) {
  16030. return cli_->Put(path, headers);
  16031. }
  16032. inline Result Client::Put(const std::string &path, const char *body,
  16033. size_t content_length,
  16034. const std::string &content_type,
  16035. UploadProgress progress) {
  16036. return cli_->Put(path, body, content_length, content_type, progress);
  16037. }
  16038. inline Result Client::Put(const std::string &path, const Headers &headers,
  16039. const char *body, size_t content_length,
  16040. const std::string &content_type,
  16041. UploadProgress progress) {
  16042. return cli_->Put(path, headers, body, content_length, content_type, progress);
  16043. }
  16044. inline Result Client::Put(const std::string &path, const std::string &body,
  16045. const std::string &content_type,
  16046. UploadProgress progress) {
  16047. return cli_->Put(path, body, content_type, progress);
  16048. }
  16049. inline Result Client::Put(const std::string &path, const Headers &headers,
  16050. const std::string &body,
  16051. const std::string &content_type,
  16052. UploadProgress progress) {
  16053. return cli_->Put(path, headers, body, content_type, progress);
  16054. }
  16055. inline Result Client::Put(const std::string &path, size_t content_length,
  16056. ContentProvider content_provider,
  16057. const std::string &content_type,
  16058. UploadProgress progress) {
  16059. return cli_->Put(path, content_length, std::move(content_provider),
  16060. content_type, progress);
  16061. }
  16062. inline Result Client::Put(const std::string &path, size_t content_length,
  16063. ContentProvider content_provider,
  16064. const std::string &content_type,
  16065. ContentReceiver content_receiver,
  16066. UploadProgress progress) {
  16067. return cli_->Put(path, content_length, std::move(content_provider),
  16068. content_type, std::move(content_receiver), progress);
  16069. }
  16070. inline Result Client::Put(const std::string &path,
  16071. ContentProviderWithoutLength content_provider,
  16072. const std::string &content_type,
  16073. UploadProgress progress) {
  16074. return cli_->Put(path, std::move(content_provider), content_type, progress);
  16075. }
  16076. inline Result Client::Put(const std::string &path,
  16077. ContentProviderWithoutLength content_provider,
  16078. const std::string &content_type,
  16079. ContentReceiver content_receiver,
  16080. UploadProgress progress) {
  16081. return cli_->Put(path, std::move(content_provider), content_type,
  16082. std::move(content_receiver), progress);
  16083. }
  16084. inline Result Client::Put(const std::string &path, const Headers &headers,
  16085. size_t content_length,
  16086. ContentProvider content_provider,
  16087. const std::string &content_type,
  16088. UploadProgress progress) {
  16089. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16090. content_type, progress);
  16091. }
  16092. inline Result Client::Put(const std::string &path, const Headers &headers,
  16093. size_t content_length,
  16094. ContentProvider content_provider,
  16095. const std::string &content_type,
  16096. ContentReceiver content_receiver,
  16097. UploadProgress progress) {
  16098. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16099. content_type, std::move(content_receiver), progress);
  16100. }
  16101. inline Result Client::Put(const std::string &path, const Headers &headers,
  16102. ContentProviderWithoutLength content_provider,
  16103. const std::string &content_type,
  16104. UploadProgress progress) {
  16105. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16106. progress);
  16107. }
  16108. inline Result Client::Put(const std::string &path, const Headers &headers,
  16109. ContentProviderWithoutLength content_provider,
  16110. const std::string &content_type,
  16111. ContentReceiver content_receiver,
  16112. UploadProgress progress) {
  16113. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16114. std::move(content_receiver), progress);
  16115. }
  16116. inline Result Client::Put(const std::string &path, const Params &params) {
  16117. return cli_->Put(path, params);
  16118. }
  16119. inline Result Client::Put(const std::string &path, const Headers &headers,
  16120. const Params &params) {
  16121. return cli_->Put(path, headers, params);
  16122. }
  16123. inline Result Client::Put(const std::string &path,
  16124. const UploadFormDataItems &items,
  16125. UploadProgress progress) {
  16126. return cli_->Put(path, items, progress);
  16127. }
  16128. inline Result Client::Put(const std::string &path, const Headers &headers,
  16129. const UploadFormDataItems &items,
  16130. UploadProgress progress) {
  16131. return cli_->Put(path, headers, items, progress);
  16132. }
  16133. inline Result Client::Put(const std::string &path, const Headers &headers,
  16134. const UploadFormDataItems &items,
  16135. const std::string &boundary,
  16136. UploadProgress progress) {
  16137. return cli_->Put(path, headers, items, boundary, progress);
  16138. }
  16139. inline Result Client::Put(const std::string &path, const Headers &headers,
  16140. const UploadFormDataItems &items,
  16141. const FormDataProviderItems &provider_items,
  16142. UploadProgress progress) {
  16143. return cli_->Put(path, headers, items, provider_items, progress);
  16144. }
  16145. inline Result Client::Put(const std::string &path, const Headers &headers,
  16146. const std::string &body,
  16147. const std::string &content_type,
  16148. ContentReceiver content_receiver,
  16149. DownloadProgress progress) {
  16150. return cli_->Put(path, headers, body, content_type, content_receiver,
  16151. progress);
  16152. }
  16153. inline Result Client::Patch(const std::string &path) {
  16154. return cli_->Patch(path);
  16155. }
  16156. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  16157. return cli_->Patch(path, headers);
  16158. }
  16159. inline Result Client::Patch(const std::string &path, const char *body,
  16160. size_t content_length,
  16161. const std::string &content_type,
  16162. UploadProgress progress) {
  16163. return cli_->Patch(path, body, content_length, content_type, progress);
  16164. }
  16165. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16166. const char *body, size_t content_length,
  16167. const std::string &content_type,
  16168. UploadProgress progress) {
  16169. return cli_->Patch(path, headers, body, content_length, content_type,
  16170. progress);
  16171. }
  16172. inline Result Client::Patch(const std::string &path, const std::string &body,
  16173. const std::string &content_type,
  16174. UploadProgress progress) {
  16175. return cli_->Patch(path, body, content_type, progress);
  16176. }
  16177. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16178. const std::string &body,
  16179. const std::string &content_type,
  16180. UploadProgress progress) {
  16181. return cli_->Patch(path, headers, body, content_type, progress);
  16182. }
  16183. inline Result Client::Patch(const std::string &path, size_t content_length,
  16184. ContentProvider content_provider,
  16185. const std::string &content_type,
  16186. UploadProgress progress) {
  16187. return cli_->Patch(path, content_length, std::move(content_provider),
  16188. content_type, progress);
  16189. }
  16190. inline Result Client::Patch(const std::string &path, size_t content_length,
  16191. ContentProvider content_provider,
  16192. const std::string &content_type,
  16193. ContentReceiver content_receiver,
  16194. UploadProgress progress) {
  16195. return cli_->Patch(path, content_length, std::move(content_provider),
  16196. content_type, std::move(content_receiver), progress);
  16197. }
  16198. inline Result Client::Patch(const std::string &path,
  16199. ContentProviderWithoutLength content_provider,
  16200. const std::string &content_type,
  16201. UploadProgress progress) {
  16202. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  16203. }
  16204. inline Result Client::Patch(const std::string &path,
  16205. ContentProviderWithoutLength content_provider,
  16206. const std::string &content_type,
  16207. ContentReceiver content_receiver,
  16208. UploadProgress progress) {
  16209. return cli_->Patch(path, std::move(content_provider), content_type,
  16210. std::move(content_receiver), progress);
  16211. }
  16212. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16213. size_t content_length,
  16214. ContentProvider content_provider,
  16215. const std::string &content_type,
  16216. UploadProgress progress) {
  16217. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16218. content_type, progress);
  16219. }
  16220. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16221. size_t content_length,
  16222. ContentProvider content_provider,
  16223. const std::string &content_type,
  16224. ContentReceiver content_receiver,
  16225. UploadProgress progress) {
  16226. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16227. content_type, std::move(content_receiver), progress);
  16228. }
  16229. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16230. ContentProviderWithoutLength content_provider,
  16231. const std::string &content_type,
  16232. UploadProgress progress) {
  16233. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16234. progress);
  16235. }
  16236. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16237. ContentProviderWithoutLength content_provider,
  16238. const std::string &content_type,
  16239. ContentReceiver content_receiver,
  16240. UploadProgress progress) {
  16241. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16242. std::move(content_receiver), progress);
  16243. }
  16244. inline Result Client::Patch(const std::string &path, const Params &params) {
  16245. return cli_->Patch(path, params);
  16246. }
  16247. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16248. const Params &params) {
  16249. return cli_->Patch(path, headers, params);
  16250. }
  16251. inline Result Client::Patch(const std::string &path,
  16252. const UploadFormDataItems &items,
  16253. UploadProgress progress) {
  16254. return cli_->Patch(path, items, progress);
  16255. }
  16256. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16257. const UploadFormDataItems &items,
  16258. UploadProgress progress) {
  16259. return cli_->Patch(path, headers, items, progress);
  16260. }
  16261. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16262. const UploadFormDataItems &items,
  16263. const std::string &boundary,
  16264. UploadProgress progress) {
  16265. return cli_->Patch(path, headers, items, boundary, progress);
  16266. }
  16267. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16268. const UploadFormDataItems &items,
  16269. const FormDataProviderItems &provider_items,
  16270. UploadProgress progress) {
  16271. return cli_->Patch(path, headers, items, provider_items, progress);
  16272. }
  16273. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16274. const std::string &body,
  16275. const std::string &content_type,
  16276. ContentReceiver content_receiver,
  16277. DownloadProgress progress) {
  16278. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16279. progress);
  16280. }
  16281. inline Result Client::Delete(const std::string &path,
  16282. DownloadProgress progress) {
  16283. return cli_->Delete(path, progress);
  16284. }
  16285. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16286. DownloadProgress progress) {
  16287. return cli_->Delete(path, headers, progress);
  16288. }
  16289. inline Result Client::Delete(const std::string &path, const char *body,
  16290. size_t content_length,
  16291. const std::string &content_type,
  16292. DownloadProgress progress) {
  16293. return cli_->Delete(path, body, content_length, content_type, progress);
  16294. }
  16295. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16296. const char *body, size_t content_length,
  16297. const std::string &content_type,
  16298. DownloadProgress progress) {
  16299. return cli_->Delete(path, headers, body, content_length, content_type,
  16300. progress);
  16301. }
  16302. inline Result Client::Delete(const std::string &path, const std::string &body,
  16303. const std::string &content_type,
  16304. DownloadProgress progress) {
  16305. return cli_->Delete(path, body, content_type, progress);
  16306. }
  16307. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16308. const std::string &body,
  16309. const std::string &content_type,
  16310. DownloadProgress progress) {
  16311. return cli_->Delete(path, headers, body, content_type, progress);
  16312. }
  16313. inline Result Client::Delete(const std::string &path, const Params &params,
  16314. DownloadProgress progress) {
  16315. return cli_->Delete(path, params, progress);
  16316. }
  16317. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16318. const Params &params, DownloadProgress progress) {
  16319. return cli_->Delete(path, headers, params, progress);
  16320. }
  16321. inline Result Client::Options(const std::string &path) {
  16322. return cli_->Options(path);
  16323. }
  16324. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16325. return cli_->Options(path, headers);
  16326. }
  16327. inline ClientImpl::StreamHandle
  16328. Client::open_stream(const std::string &method, const std::string &path,
  16329. const Params &params, const Headers &headers,
  16330. const std::string &body, const std::string &content_type) {
  16331. return cli_->open_stream(method, path, params, headers, body, content_type);
  16332. }
  16333. inline bool Client::send(Request &req, Response &res, Error &error) {
  16334. return cli_->send(req, res, error);
  16335. }
  16336. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16337. inline void Client::stop() { cli_->stop(); }
  16338. inline std::string Client::host() const { return cli_->host(); }
  16339. inline int Client::port() const { return cli_->port(); }
  16340. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16341. inline socket_t Client::socket() const { return cli_->socket(); }
  16342. inline void
  16343. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16344. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16345. }
  16346. inline void Client::set_direct_hostname_addr_map(
  16347. std::map<std::string, std::string> addr_map) {
  16348. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16349. }
  16350. inline void Client::set_tunnel_hostname_addr_map(
  16351. std::map<std::string, std::string> addr_map) {
  16352. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16353. }
  16354. inline void Client::set_default_headers(Headers headers) {
  16355. cli_->set_default_headers(std::move(headers));
  16356. }
  16357. inline void Client::set_header_writer(
  16358. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16359. cli_->set_header_writer(writer);
  16360. }
  16361. inline void Client::set_address_family(int family) {
  16362. cli_->set_address_family(family);
  16363. }
  16364. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16365. inline void Client::set_socket_options(SocketOptions socket_options) {
  16366. cli_->set_socket_options(std::move(socket_options));
  16367. }
  16368. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16369. cli_->set_connection_timeout(sec, usec);
  16370. }
  16371. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16372. cli_->set_read_timeout(sec, usec);
  16373. }
  16374. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16375. cli_->set_write_timeout(sec, usec);
  16376. }
  16377. inline void Client::set_basic_auth(const std::string &username,
  16378. const std::string &password) {
  16379. cli_->set_basic_auth(username, password);
  16380. }
  16381. inline void Client::set_bearer_token_auth(const std::string &token) {
  16382. cli_->set_bearer_token_auth(token);
  16383. }
  16384. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16385. inline void Client::set_follow_location(bool on) {
  16386. cli_->set_follow_location(on);
  16387. }
  16388. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16389. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16390. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16391. inline void Client::set_payload_max_length(size_t length) {
  16392. cli_->set_payload_max_length(length);
  16393. }
  16394. inline void Client::set_interface(const std::string &intf) {
  16395. cli_->set_interface(intf);
  16396. }
  16397. inline void Client::set_proxy(const std::string &host, int port) {
  16398. cli_->set_proxy(host, port);
  16399. }
  16400. inline void Client::set_proxy_basic_auth(const std::string &username,
  16401. const std::string &password) {
  16402. cli_->set_proxy_basic_auth(username, password);
  16403. }
  16404. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16405. cli_->set_proxy_bearer_token_auth(token);
  16406. }
  16407. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16408. cli_->set_no_proxy(patterns);
  16409. }
  16410. inline void Client::set_logger(Logger logger) {
  16411. cli_->set_logger(std::move(logger));
  16412. }
  16413. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16414. cli_->set_error_logger(std::move(error_logger));
  16415. }
  16416. /*
  16417. * Group 6: SSL Server and Client implementation
  16418. */
  16419. #ifdef CPPHTTPLIB_SSL_ENABLED
  16420. // SSL HTTP server implementation
  16421. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16422. const char *client_ca_cert_file_path,
  16423. const char *client_ca_cert_dir_path,
  16424. const char *private_key_password) {
  16425. using namespace tls;
  16426. ctx_ = create_server_context();
  16427. if (!ctx_) { return; }
  16428. // Load server certificate and private key
  16429. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16430. private_key_password)) {
  16431. last_ssl_error_ = static_cast<int>(get_error());
  16432. free_context(ctx_);
  16433. ctx_ = nullptr;
  16434. return;
  16435. }
  16436. // Load client CA certificates for client authentication
  16437. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16438. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16439. client_ca_cert_dir_path)) {
  16440. last_ssl_error_ = static_cast<int>(get_error());
  16441. free_context(ctx_);
  16442. ctx_ = nullptr;
  16443. return;
  16444. }
  16445. // Enable client certificate verification
  16446. set_verify_client(ctx_, true);
  16447. }
  16448. }
  16449. inline SSLServer::SSLServer(const PemMemory &pem) {
  16450. using namespace tls;
  16451. ctx_ = create_server_context();
  16452. if (ctx_) {
  16453. std::string cert_buf, key_buf;
  16454. if (!set_server_cert_pem(
  16455. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16456. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16457. pem.private_key_password)) {
  16458. last_ssl_error_ = static_cast<int>(get_error());
  16459. free_context(ctx_);
  16460. ctx_ = nullptr;
  16461. } else if (pem.client_ca_pem) {
  16462. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16463. : strlen(pem.client_ca_pem);
  16464. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16465. last_ssl_error_ = static_cast<int>(get_error());
  16466. free_context(ctx_);
  16467. ctx_ = nullptr;
  16468. } else {
  16469. set_verify_client(ctx_, true);
  16470. }
  16471. }
  16472. }
  16473. }
  16474. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16475. using namespace tls;
  16476. ctx_ = create_server_context();
  16477. if (ctx_) {
  16478. if (!setup_callback(ctx_)) {
  16479. free_context(ctx_);
  16480. ctx_ = nullptr;
  16481. }
  16482. }
  16483. }
  16484. inline SSLServer::~SSLServer() {
  16485. if (ctx_) { tls::free_context(ctx_); }
  16486. }
  16487. inline bool SSLServer::is_valid() const {
  16488. return ctx_ != nullptr && Server::is_valid();
  16489. }
  16490. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16491. using namespace tls;
  16492. session_t session = nullptr;
  16493. {
  16494. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16495. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16496. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16497. if (session) { handshakes_in_progress_++; }
  16498. }
  16499. if (!session) {
  16500. last_ssl_error_ = static_cast<int>(get_error());
  16501. detail::shutdown_socket(sock);
  16502. detail::close_socket(sock);
  16503. return false;
  16504. }
  16505. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16506. bool handshake_done = false;
  16507. bool ret = false;
  16508. bool websocket_upgraded = false;
  16509. auto cleanup = detail::scope_exit([&] {
  16510. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16511. free_session(session);
  16512. if (handshake_done) {
  16513. detail::drain_and_close_socket(sock);
  16514. } else {
  16515. detail::shutdown_socket(sock);
  16516. detail::close_socket(sock);
  16517. }
  16518. });
  16519. // Perform TLS accept handshake with timeout
  16520. TlsError tls_err;
  16521. auto accepted = false;
  16522. {
  16523. auto handshake_left = detail::scope_exit([&] {
  16524. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16525. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16526. });
  16527. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16528. read_timeout_usec_, &tls_err);
  16529. }
  16530. if (!accepted) {
  16531. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16532. // Map TlsError to legacy ssl_error for backward compatibility
  16533. if (tls_err.code == ErrorCode::WantRead) {
  16534. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16535. } else if (tls_err.code == ErrorCode::WantWrite) {
  16536. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16537. } else {
  16538. last_ssl_error_ = SSL_ERROR_SSL;
  16539. }
  16540. #else
  16541. last_ssl_error_ = static_cast<int>(get_error());
  16542. #endif
  16543. return false;
  16544. }
  16545. handshake_done = true;
  16546. std::string remote_addr;
  16547. int remote_port = 0;
  16548. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16549. std::string local_addr;
  16550. int local_port = 0;
  16551. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16552. ret = serve_guarded([&]() {
  16553. return detail::process_server_socket_ssl(
  16554. svr_sock_, session, sock, keep_alive_max_count_,
  16555. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16556. write_timeout_sec_, write_timeout_usec_,
  16557. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16558. return process_request(
  16559. strm, remote_addr, remote_port, local_addr, local_port,
  16560. close_connection, connection_closed,
  16561. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16562. });
  16563. });
  16564. return ret;
  16565. }
  16566. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16567. const char *key_pem,
  16568. const char *client_ca_pem,
  16569. const char *password) {
  16570. if (!ctx_) { return false; }
  16571. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16572. updates_pending_++;
  16573. auto se = detail::scope_exit([&] {
  16574. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16575. });
  16576. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16577. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16578. return false;
  16579. }
  16580. if (client_ca_pem) {
  16581. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16582. // As in the constructors, a client CA makes client certificates required
  16583. tls::set_verify_client(ctx_, true);
  16584. }
  16585. return true;
  16586. }
  16587. // SSL HTTP client implementation
  16588. inline SSLClient::~SSLClient() {
  16589. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16590. // base function rather than the derived function once we get to the
  16591. // base class destructor, and won't free the SSL (causing a leak).
  16592. // This must happen before the context is freed below: some backends
  16593. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16594. // context, so freeing the context first leaves close_notify reading
  16595. // freed memory.
  16596. shutdown_ssl_impl(socket_, true);
  16597. if (ctx_) {
  16598. tls::free_context(ctx_);
  16599. ctx_ = nullptr;
  16600. }
  16601. }
  16602. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16603. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16604. shutdown_ssl_impl(socket, shutdown_gracefully);
  16605. }
  16606. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16607. bool shutdown_gracefully) {
  16608. if (socket.sock == INVALID_SOCKET) {
  16609. assert(socket.ssl == nullptr);
  16610. return;
  16611. }
  16612. if (socket.ssl) {
  16613. tls::shutdown(socket.ssl, shutdown_gracefully);
  16614. {
  16615. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16616. tls::free_session(socket.ssl);
  16617. }
  16618. socket.ssl = nullptr;
  16619. }
  16620. assert(socket.ssl == nullptr);
  16621. }
  16622. inline bool SSLClient::process_socket(
  16623. const Socket &socket,
  16624. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16625. std::function<bool(Stream &strm)> callback) {
  16626. assert(socket.ssl);
  16627. return detail::process_client_socket_ssl(
  16628. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16629. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16630. [&](detail::SSLSocketStream &strm) {
  16631. auto ret = callback(strm);
  16632. // A request that failed after the handshake reports Error::Read or
  16633. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16634. // from the server, for Result::ssl_error() and ssl_backend_error()
  16635. const auto &tls_error = strm.tls_error();
  16636. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16637. last_ssl_error_ = static_cast<int>(tls_error.code);
  16638. last_backend_error_ = tls_error.backend_code;
  16639. }
  16640. return ret;
  16641. });
  16642. }
  16643. inline bool SSLClient::is_ssl() const { return true; }
  16644. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16645. if (!is_valid()) {
  16646. error = Error::SSLConnection;
  16647. return false;
  16648. }
  16649. return ClientImpl::create_and_connect_socket(socket, error);
  16650. }
  16651. inline bool SSLClient::setup_proxy_connection(
  16652. Socket &socket,
  16653. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16654. Response &res, bool &success, Error &error) {
  16655. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16656. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16657. return false;
  16658. }
  16659. if (!initialize_ssl(socket, error)) {
  16660. shutdown_socket(socket);
  16661. close_socket(socket);
  16662. success = false;
  16663. return false;
  16664. }
  16665. return true;
  16666. }
  16667. // Assumes that socket is a connection being opened, which no other thread uses
  16668. inline bool SSLClient::connect_with_proxy(
  16669. Socket &socket,
  16670. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16671. Response &res, bool &success, Error &error) {
  16672. success = true;
  16673. auto connect_target =
  16674. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  16675. auto retargeted = connect_target !=
  16676. detail::make_host_and_port_string_always_port(host_, port_);
  16677. Response proxy_res;
  16678. if (!detail::process_client_socket(
  16679. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16680. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16681. start_time, [&](Stream &strm) {
  16682. strm.set_read_interrupt(stop_interrupt());
  16683. Request req2;
  16684. req2.method = "CONNECT";
  16685. req2.path = connect_target;
  16686. if (retargeted) { req2.set_header("Host", connect_target); }
  16687. if (max_timeout_msec_ > 0) {
  16688. req2.start_time_ = std::chrono::steady_clock::now();
  16689. }
  16690. return process_request(strm, req2, proxy_res, false, error);
  16691. })) {
  16692. // Thread-safe to close everything because we are assuming there are no
  16693. // requests in flight
  16694. shutdown_ssl(socket, true);
  16695. shutdown_socket(socket);
  16696. close_socket(socket);
  16697. success = false;
  16698. return false;
  16699. }
  16700. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16701. if (!proxy_digest_auth_username_.empty() &&
  16702. !proxy_digest_auth_password_.empty()) {
  16703. std::map<std::string, std::string> auth;
  16704. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16705. // Close the current socket and create a new one for the authenticated
  16706. // request
  16707. shutdown_ssl(socket, true);
  16708. shutdown_socket(socket);
  16709. close_socket(socket);
  16710. // Create a new socket for the authenticated CONNECT request
  16711. if (!ensure_socket_connection(socket, error)) {
  16712. success = false;
  16713. return false;
  16714. }
  16715. proxy_res = Response();
  16716. if (!detail::process_client_socket(
  16717. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16718. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16719. start_time, [&](Stream &strm) {
  16720. strm.set_read_interrupt(stop_interrupt());
  16721. Request req3;
  16722. req3.method = "CONNECT";
  16723. req3.path = connect_target;
  16724. if (retargeted) { req3.set_header("Host", connect_target); }
  16725. req3.headers.insert(detail::make_digest_authentication_header(
  16726. req3, make_request_target(req3), auth, 1,
  16727. detail::random_string(10), proxy_digest_auth_username_,
  16728. proxy_digest_auth_password_, true));
  16729. if (max_timeout_msec_ > 0) {
  16730. req3.start_time_ = std::chrono::steady_clock::now();
  16731. }
  16732. return process_request(strm, req3, proxy_res, false, error);
  16733. })) {
  16734. // Thread-safe to close everything because we are assuming there are
  16735. // no requests in flight
  16736. shutdown_ssl(socket, true);
  16737. shutdown_socket(socket);
  16738. close_socket(socket);
  16739. success = false;
  16740. return false;
  16741. }
  16742. }
  16743. }
  16744. }
  16745. // If status code is not 200, proxy request is failed.
  16746. // Set error to ProxyConnection. A 407 is returned as the response of the
  16747. // request, so the caller sees the proxy asks for credentials; any other
  16748. // status would read as the answer of the origin, which it never reached.
  16749. if (proxy_res.status != StatusCode::OK_200) {
  16750. error = Error::ProxyConnection;
  16751. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16752. res = std::move(proxy_res);
  16753. } else {
  16754. success = false;
  16755. }
  16756. // Thread-safe to close everything because we are assuming there are
  16757. // no requests in flight
  16758. shutdown_ssl(socket, true);
  16759. shutdown_socket(socket);
  16760. close_socket(socket);
  16761. return false;
  16762. }
  16763. return true;
  16764. }
  16765. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16766. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16767. if (is_proxy_enabled_for_host(host_)) { return true; }
  16768. if (!initialize_ssl(socket, error)) {
  16769. shutdown_socket(socket);
  16770. close_socket(socket);
  16771. return false;
  16772. }
  16773. return true;
  16774. }
  16775. // SSL HTTP client implementation
  16776. inline SSLClient::SSLClient(const std::string &host)
  16777. : SSLClient(host, 443, std::string(), std::string()) {}
  16778. inline SSLClient::SSLClient(const std::string &host, int port)
  16779. : SSLClient(host, port, std::string(), std::string()) {}
  16780. inline void SSLClient::init_ctx() {
  16781. ctx_ = tls::create_client_context();
  16782. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16783. }
  16784. inline void SSLClient::reset_ctx_on_error() {
  16785. last_backend_error_ = tls::get_error();
  16786. tls::free_context(ctx_);
  16787. ctx_ = nullptr;
  16788. }
  16789. inline SSLClient::SSLClient(const std::string &host, int port,
  16790. const std::string &client_cert_path,
  16791. const std::string &client_key_path,
  16792. const std::string &private_key_password)
  16793. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16794. init_ctx();
  16795. if (!ctx_) { return; }
  16796. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16797. const char *password =
  16798. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16799. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16800. client_key_path.c_str(), password)) {
  16801. reset_ctx_on_error();
  16802. }
  16803. }
  16804. }
  16805. inline SSLClient::SSLClient(const std::string &host, int port,
  16806. const PemMemory &pem)
  16807. : ClientImpl(host, port) {
  16808. init_ctx();
  16809. if (!ctx_) { return; }
  16810. if (pem.cert_pem && pem.key_pem) {
  16811. std::string cert_buf, key_buf;
  16812. if (!tls::set_client_cert_pem(
  16813. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16814. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16815. pem.private_key_password)) {
  16816. reset_ctx_on_error();
  16817. }
  16818. }
  16819. }
  16820. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16821. if (ca_cert_store && ctx_) {
  16822. // set_ca_store takes ownership of ca_cert_store
  16823. tls::set_ca_store(ctx_, ca_cert_store);
  16824. ca_cert_store_set_ = true;
  16825. } else if (ca_cert_store) {
  16826. tls::free_ca_store(ca_cert_store);
  16827. }
  16828. custom_ca_loaded_ = true;
  16829. tls_settings_changed();
  16830. }
  16831. inline void
  16832. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16833. if (!ctx_) { return; }
  16834. server_certificate_verifier_ = verifier;
  16835. {
  16836. // Under the lock that creating a session from ctx_ takes
  16837. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16838. tls::set_verify_callback(ctx_, std::move(verifier));
  16839. }
  16840. tls_settings_changed();
  16841. }
  16842. inline void SSLClient::set_session_verifier(
  16843. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16844. session_verifier_ = std::move(verifier);
  16845. tls_settings_changed();
  16846. }
  16847. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16848. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16849. if (enable_windows_cert_verification_ == enabled) { return; }
  16850. enable_windows_cert_verification_ = enabled;
  16851. tls_settings_changed();
  16852. }
  16853. #endif
  16854. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16855. std::size_t size) {
  16856. if (ctx_ && ca_cert && size > 0) {
  16857. // Every PEM loaded, for redirect transfer
  16858. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16859. ca_cert_pem_ += '\n';
  16860. }
  16861. ca_cert_pem_.append(ca_cert, size);
  16862. tls::load_ca_pem(ctx_, ca_cert, size);
  16863. }
  16864. custom_ca_loaded_ = true;
  16865. tls_settings_changed();
  16866. }
  16867. inline bool SSLClient::load_certs() {
  16868. auto ret = true;
  16869. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16870. // one client is shared across concurrent requests here.
  16871. std::call_once(initialize_cert_, [&]() {
  16872. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16873. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16874. ca_cert_dir_path_, custom_ca_loaded_,
  16875. system_ca_mode_, last_backend_error_);
  16876. });
  16877. return ret;
  16878. }
  16879. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16880. // Load CA certificates if server verification is enabled
  16881. if (server_certificate_verification_) {
  16882. if (!load_certs()) {
  16883. error = Error::SSLLoadingCerts;
  16884. return false;
  16885. }
  16886. }
  16887. detail::ClientTlsSessionOptions options;
  16888. options.server_hostname_verification = server_hostname_verification_;
  16889. options.session_verifier = session_verifier_;
  16890. options.interrupted = stop_interrupt();
  16891. options.ctx_mutex = &ctx_mutex_;
  16892. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16893. options.windows_cert_verification = detail::use_windows_cert_verification(
  16894. enable_windows_cert_verification_, ca_cert_file_path_, ca_cert_dir_path_,
  16895. custom_ca_loaded_, system_ca_mode_);
  16896. // Only a verifier set through set_server_certificate_verifier() is seen
  16897. // here, not one installed with tls::set_verify_callback() directly.
  16898. options.server_certificate_verifier_set =
  16899. static_cast<bool>(server_certificate_verifier_);
  16900. #endif
  16901. tls::session_t session = nullptr;
  16902. // Use scope_exit to ensure session is freed on error paths
  16903. bool success = false;
  16904. auto session_guard = detail::scope_exit([&] {
  16905. if (!success) { tls::free_session(session); }
  16906. });
  16907. detail::ClientTlsSessionError tls_error;
  16908. if (!detail::setup_client_tls_session(
  16909. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16910. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16911. options)) {
  16912. error = tls_error.error;
  16913. last_ssl_error_ = tls_error.ssl_error;
  16914. last_backend_error_ = tls_error.backend_error;
  16915. return false;
  16916. }
  16917. success = true;
  16918. socket.ssl = session;
  16919. return true;
  16920. }
  16921. inline void Client::set_digest_auth(const std::string &username,
  16922. const std::string &password) {
  16923. cli_->set_digest_auth(username, password);
  16924. }
  16925. inline void Client::set_proxy_digest_auth(const std::string &username,
  16926. const std::string &password) {
  16927. cli_->set_proxy_digest_auth(username, password);
  16928. }
  16929. inline void Client::enable_server_certificate_verification(bool enabled) {
  16930. cli_->enable_server_certificate_verification(enabled);
  16931. }
  16932. inline void Client::enable_server_hostname_verification(bool enabled) {
  16933. cli_->enable_server_hostname_verification(enabled);
  16934. }
  16935. inline void Client::enable_system_ca(bool enabled) {
  16936. cli_->enable_system_ca(enabled);
  16937. }
  16938. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16939. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16940. if (is_ssl_) {
  16941. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16942. enabled);
  16943. }
  16944. }
  16945. #endif
  16946. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16947. const std::string &ca_cert_dir_path) {
  16948. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16949. }
  16950. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16951. if (is_ssl_) {
  16952. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16953. } else if (ca_cert_store) {
  16954. tls::free_ca_store(ca_cert_store);
  16955. }
  16956. }
  16957. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16958. if (is_ssl_) {
  16959. // Use the PEM-based path so the CA data is retained for redirect transfer
  16960. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16961. }
  16962. }
  16963. inline void
  16964. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16965. if (is_ssl_) {
  16966. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16967. std::move(verifier));
  16968. }
  16969. }
  16970. inline void Client::set_session_verifier(
  16971. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16972. if (is_ssl_) {
  16973. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16974. }
  16975. }
  16976. inline tls::ctx_t Client::tls_context() const {
  16977. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16978. return nullptr;
  16979. }
  16980. #endif // CPPHTTPLIB_SSL_ENABLED
  16981. /*
  16982. * Group 7: TLS abstraction layer - Common API
  16983. */
  16984. #ifdef CPPHTTPLIB_SSL_ENABLED
  16985. namespace tls {
  16986. // Helper for PeerCert construction
  16987. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16988. return PeerCert(get_peer_cert(session));
  16989. }
  16990. namespace impl {
  16991. // set_verify_callback() can replace a callback while handshakes on other
  16992. // threads run it, so they share it, and take their reference under this lock.
  16993. inline std::mutex &verify_callback_mutex() {
  16994. static std::mutex mutex;
  16995. return mutex;
  16996. }
  16997. // The TLS libraries are C, so an exception from a verify callback must not
  16998. // unwind through them. It rejects the certificate instead.
  16999. inline bool run_verify_callback(const VerifyCallback &callback,
  17000. const VerifyContext &ctx) {
  17001. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  17002. return callback(ctx);
  17003. #else
  17004. try {
  17005. return callback(ctx);
  17006. } catch (...) { return false; }
  17007. #endif
  17008. }
  17009. // Check if a string is an IPv4 address
  17010. inline bool is_ipv4_address(const std::string &str) {
  17011. int dots = 0;
  17012. for (char c : str) {
  17013. if (c == '.') {
  17014. dots++;
  17015. } else if (!detail::is_ascii_digit(c)) {
  17016. return false;
  17017. }
  17018. }
  17019. return dots == 3;
  17020. }
  17021. // Parse IPv4 address string to bytes
  17022. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  17023. const char *p = str.c_str();
  17024. for (int i = 0; i < 4; i++) {
  17025. if (i > 0) {
  17026. if (*p != '.') { return false; }
  17027. p++;
  17028. }
  17029. int val = 0;
  17030. int digits = 0;
  17031. while (detail::is_ascii_digit(*p)) {
  17032. val = val * 10 + (*p - '0');
  17033. if (val > 255) { return false; }
  17034. p++;
  17035. digits++;
  17036. }
  17037. if (digits == 0) { return false; }
  17038. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  17039. if (digits > 1 && *(p - digits) == '0') { return false; }
  17040. out[i] = static_cast<unsigned char>(val);
  17041. }
  17042. return *p == '\0';
  17043. }
  17044. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  17045. // `out` must have room for at least 16 bytes. Returns the address length
  17046. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  17047. // literal. Used to match a host against iPAddress SANs the same way the
  17048. // OpenSSL backend does via X509_check_ip.
  17049. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  17050. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  17051. struct in6_addr addr6 = {};
  17052. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  17053. memcpy(out, &addr6, 16);
  17054. return 16;
  17055. }
  17056. return 0;
  17057. }
  17058. #ifdef _WIN32
  17059. // Enumerate Windows system certificates and call callback with DER data
  17060. template <typename Callback>
  17061. inline bool enumerate_windows_system_certs(Callback cb) {
  17062. bool loaded = false;
  17063. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17064. for (auto store_name : store_names) {
  17065. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  17066. if (hStore) {
  17067. PCCERT_CONTEXT pContext = nullptr;
  17068. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17069. nullptr) {
  17070. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  17071. loaded = true;
  17072. }
  17073. }
  17074. CertCloseStore(hStore, 0);
  17075. }
  17076. }
  17077. return loaded;
  17078. }
  17079. #endif
  17080. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17081. // The trust a certificate's Trust Settings give it for SSL server
  17082. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  17083. // Otherwise the first usage-constraints dictionary that applies decides: one
  17084. // naming a policy other than SSL, a host name or an application does not
  17085. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  17086. // Trust" as kSecTrustSettingsResultDeny.
  17087. inline SecTrustSettingsResult
  17088. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  17089. auto count = CFArrayGetCount(trust_settings);
  17090. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  17091. for (CFIndex i = 0; i < count; i++) {
  17092. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  17093. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  17094. auto constraint = static_cast<CFDictionaryRef>(value);
  17095. auto policy_value =
  17096. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  17097. if (policy_value) {
  17098. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  17099. auto is_ssl = false;
  17100. if (auto properties = SecPolicyCopyProperties(policy)) {
  17101. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  17102. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  17103. CFRelease(properties);
  17104. }
  17105. if (!is_ssl) { continue; }
  17106. }
  17107. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  17108. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  17109. continue;
  17110. }
  17111. auto result = kSecTrustSettingsResultTrustRoot;
  17112. auto number = static_cast<CFNumberRef>(
  17113. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  17114. if (number) {
  17115. SInt32 number_value = 0;
  17116. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  17117. continue;
  17118. }
  17119. result = static_cast<SecTrustSettingsResult>(number_value);
  17120. }
  17121. if (result == kSecTrustSettingsResultTrustRoot ||
  17122. result == kSecTrustSettingsResultTrustAsRoot ||
  17123. result == kSecTrustSettingsResultDeny) {
  17124. return result;
  17125. }
  17126. }
  17127. return kSecTrustSettingsResultUnspecified;
  17128. }
  17129. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  17130. // with DER data. A certificate with Trust Settings is not trusted just by
  17131. // having them: the settings say whether it is, and a per-user setting
  17132. // overrides the admin domain's, which overrides the system domain's (whose
  17133. // roots are all trusted). So a system root the user set to "Never Trust" is
  17134. // left out, as is one trusted only for S/MIME or code signing.
  17135. template <typename Callback>
  17136. inline bool enumerate_macos_keychain_certs(Callback cb) {
  17137. const SecTrustSettingsDomain domains[] = {
  17138. kSecTrustSettingsDomainUser,
  17139. kSecTrustSettingsDomainAdmin,
  17140. kSecTrustSettingsDomainSystem,
  17141. };
  17142. std::set<std::string> decided;
  17143. std::vector<std::string> trusted;
  17144. for (auto domain : domains) {
  17145. CFArrayRef certs = nullptr;
  17146. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  17147. if (status != errSecSuccess || !certs) {
  17148. if (certs) CFRelease(certs);
  17149. continue;
  17150. }
  17151. CFIndex count = CFArrayGetCount(certs);
  17152. for (CFIndex i = 0; i < count; i++) {
  17153. SecCertificateRef cert =
  17154. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  17155. CFDataRef data = SecCertificateCopyData(cert);
  17156. if (!data) { continue; }
  17157. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  17158. static_cast<size_t>(CFDataGetLength(data)));
  17159. CFRelease(data);
  17160. // Decided by a domain that overrides this one
  17161. if (decided.find(der) != decided.end()) { continue; }
  17162. auto result = kSecTrustSettingsResultTrustRoot;
  17163. if (domain != kSecTrustSettingsDomainSystem) {
  17164. result = kSecTrustSettingsResultUnspecified;
  17165. CFArrayRef trust_settings = nullptr;
  17166. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  17167. errSecSuccess &&
  17168. trust_settings) {
  17169. result = macos_ssl_trust_settings_result(trust_settings);
  17170. }
  17171. if (trust_settings) CFRelease(trust_settings);
  17172. }
  17173. // Neither trusted nor distrusted here; a domain below may decide
  17174. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  17175. decided.insert(der);
  17176. if (result == kSecTrustSettingsResultTrustRoot ||
  17177. result == kSecTrustSettingsResultTrustAsRoot) {
  17178. trusted.push_back(std::move(der));
  17179. }
  17180. }
  17181. CFRelease(certs);
  17182. }
  17183. bool loaded = false;
  17184. for (const auto &der : trusted) {
  17185. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  17186. loaded = true;
  17187. }
  17188. }
  17189. return loaded;
  17190. }
  17191. #endif
  17192. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  17193. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  17194. // Common CA certificate file paths on Linux/Unix
  17195. inline const char **system_ca_paths() {
  17196. static const char *paths[] = {
  17197. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  17198. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  17199. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  17200. "/etc/pki/tls/cacert.pem", // OpenELEC
  17201. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  17202. nullptr};
  17203. return paths;
  17204. }
  17205. // Common CA certificate directory paths on Linux/Unix
  17206. inline const char **system_ca_dirs() {
  17207. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  17208. "/etc/pki/tls/certs", // RHEL/CentOS
  17209. "/usr/share/ca-certificates", // Other
  17210. nullptr};
  17211. return dirs;
  17212. }
  17213. #endif
  17214. } // namespace impl
  17215. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  17216. const char *ca_dir) {
  17217. if (!ctx) { return false; }
  17218. bool success = true;
  17219. if (ca_file && *ca_file) {
  17220. if (!load_ca_file(ctx, ca_file)) { success = false; }
  17221. }
  17222. if (ca_dir && *ca_dir) {
  17223. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  17224. }
  17225. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17226. // Set CA list for client certificate request (CertificateRequest message)
  17227. if (ca_file && *ca_file) {
  17228. auto list = SSL_load_client_CA_file(ca_file);
  17229. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  17230. }
  17231. #endif
  17232. return success;
  17233. }
  17234. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17235. const char *password) {
  17236. return set_client_cert_pem(ctx, cert, key, password);
  17237. }
  17238. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17239. const char *key_path, const char *password) {
  17240. return set_client_cert_file(ctx, cert_path, key_path, password);
  17241. }
  17242. // PeerCert implementation
  17243. inline PeerCert::PeerCert() = default;
  17244. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17245. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17246. other.cert_ = nullptr;
  17247. }
  17248. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17249. if (this != &other) {
  17250. if (cert_) { free_cert(cert_); }
  17251. cert_ = other.cert_;
  17252. other.cert_ = nullptr;
  17253. }
  17254. return *this;
  17255. }
  17256. inline PeerCert::~PeerCert() {
  17257. if (cert_) { free_cert(cert_); }
  17258. }
  17259. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17260. inline std::string PeerCert::subject_cn() const {
  17261. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17262. }
  17263. inline std::string PeerCert::issuer_name() const {
  17264. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17265. }
  17266. inline bool PeerCert::check_hostname(const char *hostname) const {
  17267. return cert_ ? verify_hostname(cert_, hostname) : false;
  17268. }
  17269. inline std::vector<SanEntry> PeerCert::sans() const {
  17270. std::vector<SanEntry> result;
  17271. if (cert_) { get_cert_sans(cert_, result); }
  17272. return result;
  17273. }
  17274. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17275. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17276. }
  17277. inline std::string PeerCert::serial() const {
  17278. return cert_ ? get_cert_serial(cert_) : std::string();
  17279. }
  17280. // VerifyContext method implementations
  17281. inline std::string VerifyContext::subject_cn() const {
  17282. return cert ? get_cert_subject_cn(cert) : std::string();
  17283. }
  17284. inline std::string VerifyContext::issuer_name() const {
  17285. return cert ? get_cert_issuer_name(cert) : std::string();
  17286. }
  17287. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17288. return cert ? verify_hostname(cert, hostname) : false;
  17289. }
  17290. inline std::vector<SanEntry> VerifyContext::sans() const {
  17291. std::vector<SanEntry> result;
  17292. if (cert) { get_cert_sans(cert, result); }
  17293. return result;
  17294. }
  17295. inline bool VerifyContext::validity(time_t &not_before,
  17296. time_t &not_after) const {
  17297. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17298. }
  17299. inline std::string VerifyContext::serial() const {
  17300. return cert ? get_cert_serial(cert) : std::string();
  17301. }
  17302. // TlsError static method implementation
  17303. inline std::string TlsError::verify_error_to_string(long error_code) {
  17304. return verify_error_string(error_code);
  17305. }
  17306. } // namespace tls
  17307. // Request::peer_cert() implementation
  17308. inline tls::PeerCert Request::peer_cert() const {
  17309. return tls::get_peer_cert_from_session(ssl);
  17310. }
  17311. // Request::sni() implementation
  17312. inline std::string Request::sni() const {
  17313. if (!ssl) { return std::string(); }
  17314. const char *s = tls::get_sni(ssl);
  17315. return s ? std::string(s) : std::string();
  17316. }
  17317. #endif // CPPHTTPLIB_SSL_ENABLED
  17318. /*
  17319. * Group 8: TLS abstraction layer - OpenSSL backend
  17320. */
  17321. /*
  17322. * OpenSSL Backend Implementation
  17323. */
  17324. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17325. namespace tls {
  17326. namespace impl {
  17327. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17328. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17329. switch (ssl_error) {
  17330. case SSL_ERROR_NONE: return ErrorCode::Success;
  17331. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17332. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17333. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17334. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17335. case SSL_ERROR_SSL:
  17336. default: return ErrorCode::Fatal;
  17337. }
  17338. }
  17339. // Fills in a failed SSL_connect(). One that the server certificate's
  17340. // verification stopped reports the verify result, as the other backends and
  17341. // a check after the handshake do.
  17342. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17343. auto ssl_err = SSL_get_error(ssl, ret);
  17344. auto error = ERR_get_error();
  17345. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17346. err.backend_code = error;
  17347. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17348. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17349. return;
  17350. }
  17351. // A certificate only a verify callback turned down carries no verdict of
  17352. // its own, and fails as any other handshake does
  17353. auto verify_result = SSL_get_verify_result(ssl);
  17354. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17355. return;
  17356. }
  17357. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17358. ? ErrorCode::HostnameMismatch
  17359. : ErrorCode::CertVerifyFailed;
  17360. err.backend_code = static_cast<uint64_t>(verify_result);
  17361. }
  17362. // Helper: Create client CA list from PEM string
  17363. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17364. // Caller takes ownership of returned list
  17365. inline STACK_OF(X509_NAME) *
  17366. create_client_ca_list_from_pem(const char *ca_pem) {
  17367. if (!ca_pem) { return nullptr; }
  17368. auto ca_list = sk_X509_NAME_new_null();
  17369. if (!ca_list) { return nullptr; }
  17370. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17371. if (!bio) {
  17372. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17373. return nullptr;
  17374. }
  17375. X509 *cert = nullptr;
  17376. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17377. nullptr) {
  17378. const X509_NAME *name = X509_get_subject_name(cert);
  17379. if (name) {
  17380. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17381. }
  17382. X509_free(cert);
  17383. }
  17384. BIO_free(bio);
  17385. return ca_list;
  17386. }
  17387. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17388. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17389. long /*argl*/, void * /*argp*/) {
  17390. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17391. }
  17392. // The SSL_CTX owns its verify callback, so each client or server sees only
  17393. // its own, on whichever thread runs the handshake.
  17394. inline int verify_callback_index() {
  17395. static const auto index = SSL_CTX_get_ex_new_index(
  17396. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17397. return index;
  17398. }
  17399. // OpenSSL verify callback wrapper
  17400. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17401. // Get SSL object from X509_STORE_CTX
  17402. auto ssl = static_cast<SSL *>(
  17403. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17404. if (!ssl) { return preverify_ok; }
  17405. std::shared_ptr<VerifyCallback> callback;
  17406. {
  17407. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17408. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17409. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17410. if (stored) { callback = *stored; }
  17411. }
  17412. if (!callback) { return preverify_ok; }
  17413. // Get current certificate and depth
  17414. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17415. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17416. int error = X509_STORE_CTX_get_error(ctx);
  17417. // Build context
  17418. VerifyContext verify_ctx;
  17419. verify_ctx.session = static_cast<session_t>(ssl);
  17420. verify_ctx.cert = static_cast<cert_t>(cert);
  17421. verify_ctx.depth = depth;
  17422. verify_ctx.preverify_ok = (preverify_ok != 0);
  17423. verify_ctx.error_code = error;
  17424. verify_ctx.error_string =
  17425. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17426. auto accepted = run_verify_callback(*callback, verify_ctx);
  17427. // A client verifying the server during the handshake, which is what
  17428. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17429. if (!SSL_is_server(ssl) &&
  17430. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17431. accepted = accepted && preverify_ok;
  17432. }
  17433. return accepted ? 1 : 0;
  17434. }
  17435. // Sets the verify mode from whether the peer's certificate is required and
  17436. // whether a verify callback is set.
  17437. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17438. auto has_callback =
  17439. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17440. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17441. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17442. SSL_CTX_set_verify(ssl_ctx, mode,
  17443. has_callback ? openssl_verify_callback : nullptr);
  17444. }
  17445. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17446. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17447. // that must be released with release_store_objects
  17448. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17449. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17450. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17451. #endif
  17452. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17453. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17454. return X509_STORE_get1_objects(store);
  17455. #else
  17456. return X509_STORE_get0_objects(store);
  17457. #endif
  17458. }
  17459. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17460. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17461. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17462. #else
  17463. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17464. #endif
  17465. }
  17466. } // namespace impl
  17467. inline ctx_t create_client_context() {
  17468. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17469. if (ctx) {
  17470. // Disable auto-retry to properly handle non-blocking I/O
  17471. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17472. // Set minimum TLS version
  17473. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17474. }
  17475. return static_cast<ctx_t>(ctx);
  17476. }
  17477. inline void free_context(ctx_t ctx) {
  17478. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17479. }
  17480. inline bool set_min_version(ctx_t ctx, Version version) {
  17481. if (!ctx) return false;
  17482. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17483. static_cast<uint16_t>(version)) == 1;
  17484. }
  17485. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17486. if (!ctx || !pem || len == 0) return false;
  17487. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17488. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17489. if (!store) return false;
  17490. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17491. if (!bio) return false;
  17492. bool ok = true;
  17493. X509 *cert = nullptr;
  17494. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17495. nullptr) {
  17496. if (X509_STORE_add_cert(store, cert) != 1) {
  17497. // Ignore duplicate errors
  17498. auto err = ERR_peek_last_error();
  17499. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17500. ok = false;
  17501. }
  17502. }
  17503. X509_free(cert);
  17504. if (!ok) break;
  17505. }
  17506. BIO_free(bio);
  17507. // Clear any "no more certificates" errors
  17508. ERR_clear_error();
  17509. return ok;
  17510. }
  17511. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17512. if (!ctx || !file_path) return false;
  17513. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17514. nullptr) == 1;
  17515. }
  17516. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17517. if (!ctx || !dir_path) return false;
  17518. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17519. dir_path) == 1;
  17520. }
  17521. inline bool load_system_certs(ctx_t ctx) {
  17522. if (!ctx) return false;
  17523. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17524. #ifdef _WIN32
  17525. // Windows: Load from system certificate store (ROOT and CA)
  17526. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17527. if (!store) return false;
  17528. bool loaded_any = false;
  17529. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17530. for (auto store_name : store_names) {
  17531. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17532. if (!hStore) continue;
  17533. PCCERT_CONTEXT pContext = nullptr;
  17534. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17535. nullptr) {
  17536. const unsigned char *data = pContext->pbCertEncoded;
  17537. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17538. if (x509) {
  17539. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17540. X509_free(x509);
  17541. }
  17542. }
  17543. CertCloseStore(hStore, 0);
  17544. }
  17545. return loaded_any;
  17546. #elif defined(__APPLE__)
  17547. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17548. // macOS: Load from Keychain
  17549. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17550. if (!store) return false;
  17551. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17552. [&](const unsigned char *data, size_t len) {
  17553. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17554. if (!x509) { return false; }
  17555. auto added = X509_STORE_add_cert(store, x509) == 1;
  17556. X509_free(x509);
  17557. return added;
  17558. });
  17559. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17560. #else
  17561. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17562. #endif
  17563. #else
  17564. // Other Unix: use default verify paths
  17565. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17566. #endif
  17567. }
  17568. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17569. const char *password) {
  17570. if (!ctx || !cert || !key) return false;
  17571. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17572. // Load certificate
  17573. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17574. if (!cert_bio) return false;
  17575. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17576. BIO_free(cert_bio);
  17577. if (!x509) return false;
  17578. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17579. X509_free(x509);
  17580. if (!cert_ok) return false;
  17581. // Load private key
  17582. auto key_bio = BIO_new_mem_buf(key, -1);
  17583. if (!key_bio) return false;
  17584. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17585. password ? const_cast<char *>(password)
  17586. : nullptr);
  17587. BIO_free(key_bio);
  17588. if (!pkey) return false;
  17589. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17590. EVP_PKEY_free(pkey);
  17591. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17592. }
  17593. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17594. const char *key_path, const char *password) {
  17595. if (!ctx || !cert_path || !key_path) return false;
  17596. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17597. if (password && password[0] != '\0') {
  17598. SSL_CTX_set_default_passwd_cb_userdata(
  17599. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17600. }
  17601. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17602. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17603. }
  17604. inline ctx_t create_server_context() {
  17605. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17606. if (ctx) {
  17607. // No renegotiation, as on the other backends: it would run a handshake
  17608. // that SSLServer::update_certs_pem() does not wait for
  17609. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17610. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17611. SSL_OP_NO_RENEGOTIATION);
  17612. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17613. // Without one, a client resuming its session is sent a fatal alert once
  17614. // client certificates are verified.
  17615. static const unsigned char sid_ctx[] = "cpp-httplib";
  17616. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17617. }
  17618. return static_cast<ctx_t>(ctx);
  17619. }
  17620. inline void set_verify_client(ctx_t ctx, bool require) {
  17621. if (!ctx) return;
  17622. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17623. }
  17624. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17625. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17626. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17627. SSL *ssl = SSL_new(ssl_ctx);
  17628. if (!ssl) return nullptr;
  17629. // Disable auto-retry for proper non-blocking I/O handling
  17630. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17631. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17632. if (!bio) {
  17633. SSL_free(ssl);
  17634. return nullptr;
  17635. }
  17636. SSL_set_bio(ssl, bio, bio);
  17637. return static_cast<session_t>(ssl);
  17638. }
  17639. inline void free_session(session_t session) {
  17640. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17641. }
  17642. inline bool set_sni(session_t session, const char *hostname,
  17643. bool verify_hostname) {
  17644. if (!session || !hostname) return false;
  17645. auto ssl = static_cast<SSL *>(session);
  17646. // The handshake's chain verification then checks the name as well
  17647. if (verify_hostname) {
  17648. auto param = SSL_get0_param(ssl);
  17649. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  17650. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  17651. return false;
  17652. }
  17653. }
  17654. #if defined(OPENSSL_IS_BORINGSSL)
  17655. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17656. #else
  17657. // Direct call instead of macro to suppress -Wold-style-cast warning
  17658. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17659. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17660. #endif
  17661. }
  17662. inline TlsError connect(session_t session) {
  17663. if (!session) { return TlsError(); }
  17664. auto ssl = static_cast<SSL *>(session);
  17665. auto ret = SSL_connect(ssl);
  17666. TlsError err;
  17667. if (ret == 1) {
  17668. err.code = ErrorCode::Success;
  17669. } else {
  17670. impl::fill_connect_error(ssl, ret, err);
  17671. }
  17672. return err;
  17673. }
  17674. inline TlsError accept(session_t session) {
  17675. if (!session) { return TlsError(); }
  17676. auto ssl = static_cast<SSL *>(session);
  17677. auto ret = SSL_accept(ssl);
  17678. TlsError err;
  17679. if (ret == 1) {
  17680. err.code = ErrorCode::Success;
  17681. } else {
  17682. auto ssl_err = SSL_get_error(ssl, ret);
  17683. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17684. err.backend_code = ERR_get_error();
  17685. }
  17686. return err;
  17687. }
  17688. inline bool connect_nonblocking(session_t session, socket_t sock,
  17689. time_t timeout_sec, time_t timeout_usec,
  17690. TlsError *err,
  17691. const std::function<bool()> &interrupted) {
  17692. if (!session) {
  17693. if (err) { err->code = ErrorCode::Fatal; }
  17694. return false;
  17695. }
  17696. auto ssl = static_cast<SSL *>(session);
  17697. auto bio = SSL_get_rbio(ssl);
  17698. // Set non-blocking mode for handshake
  17699. detail::set_nonblocking(sock, true);
  17700. if (bio) { BIO_set_nbio(bio, 1); }
  17701. auto cleanup = detail::scope_exit([&]() {
  17702. // Restore blocking mode after handshake
  17703. if (bio) { BIO_set_nbio(bio, 0); }
  17704. detail::set_nonblocking(sock, false);
  17705. });
  17706. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17707. auto res = 0;
  17708. while ((res = SSL_connect(ssl)) != 1) {
  17709. auto ssl_err = SSL_get_error(ssl, res);
  17710. switch (ssl_err) {
  17711. case SSL_ERROR_WANT_READ:
  17712. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  17713. continue;
  17714. }
  17715. break;
  17716. case SSL_ERROR_WANT_WRITE:
  17717. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  17718. continue;
  17719. }
  17720. break;
  17721. default: break;
  17722. }
  17723. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17724. return false;
  17725. }
  17726. if (err) { err->code = ErrorCode::Success; }
  17727. return true;
  17728. }
  17729. inline bool accept_nonblocking(session_t session, socket_t sock,
  17730. time_t timeout_sec, time_t timeout_usec,
  17731. TlsError *err) {
  17732. if (!session) {
  17733. if (err) { err->code = ErrorCode::Fatal; }
  17734. return false;
  17735. }
  17736. auto ssl = static_cast<SSL *>(session);
  17737. auto bio = SSL_get_rbio(ssl);
  17738. // Set non-blocking mode for handshake
  17739. detail::set_nonblocking(sock, true);
  17740. if (bio) { BIO_set_nbio(bio, 1); }
  17741. auto cleanup = detail::scope_exit([&]() {
  17742. // Restore blocking mode after handshake
  17743. if (bio) { BIO_set_nbio(bio, 0); }
  17744. detail::set_nonblocking(sock, false);
  17745. });
  17746. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17747. auto res = 0;
  17748. while ((res = SSL_accept(ssl)) != 1) {
  17749. auto ssl_err = SSL_get_error(ssl, res);
  17750. switch (ssl_err) {
  17751. case SSL_ERROR_WANT_READ:
  17752. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17753. break;
  17754. case SSL_ERROR_WANT_WRITE:
  17755. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17756. break;
  17757. default: break;
  17758. }
  17759. if (err) {
  17760. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17761. err->backend_code = ERR_get_error();
  17762. }
  17763. return false;
  17764. }
  17765. if (err) { err->code = ErrorCode::Success; }
  17766. return true;
  17767. }
  17768. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17769. if (!session || !buf) {
  17770. err.code = ErrorCode::Fatal;
  17771. return -1;
  17772. }
  17773. auto ssl = static_cast<SSL *>(session);
  17774. constexpr auto max_len =
  17775. static_cast<size_t>((std::numeric_limits<int>::max)());
  17776. if (len > max_len) { len = max_len; }
  17777. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17778. if (ret > 0) {
  17779. err.code = ErrorCode::Success;
  17780. return ret;
  17781. }
  17782. auto ssl_err = SSL_get_error(ssl, ret);
  17783. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17784. if (err.code == ErrorCode::PeerClosed) {
  17785. return 0;
  17786. } // Gracefully handle the peer closed state.
  17787. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17788. return -1;
  17789. }
  17790. inline ssize_t write(session_t session, const void *buf, size_t len,
  17791. TlsError &err) {
  17792. if (!session || !buf) {
  17793. err.code = ErrorCode::Fatal;
  17794. return -1;
  17795. }
  17796. auto ssl = static_cast<SSL *>(session);
  17797. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17798. if (ret > 0) {
  17799. err.code = ErrorCode::Success;
  17800. return ret;
  17801. }
  17802. auto ssl_err = SSL_get_error(ssl, ret);
  17803. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17804. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17805. return -1;
  17806. }
  17807. inline int pending(const_session_t session) {
  17808. if (!session) return 0;
  17809. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17810. }
  17811. inline void shutdown(session_t session, bool graceful) {
  17812. if (!session) return;
  17813. auto ssl = static_cast<SSL *>(session);
  17814. if (graceful) {
  17815. // Send close_notify without waiting for the peer's. The connection is
  17816. // closed right after this, so a unidirectional shutdown is enough, and an
  17817. // idle peer that never answers would otherwise hold this thread until the
  17818. // read timeout. The other backends do not wait either.
  17819. SSL_shutdown(ssl);
  17820. }
  17821. }
  17822. inline bool is_peer_closed(session_t session, socket_t sock) {
  17823. if (!session) return true;
  17824. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17825. detail::set_nonblocking(sock, true);
  17826. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17827. auto ssl = static_cast<SSL *>(session);
  17828. char buf;
  17829. auto ret = SSL_peek(ssl, &buf, 1);
  17830. if (ret > 0) return false;
  17831. auto err = SSL_get_error(ssl, ret);
  17832. return err == SSL_ERROR_ZERO_RETURN;
  17833. }
  17834. inline cert_t get_peer_cert(const_session_t session) {
  17835. if (!session) return nullptr;
  17836. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17837. static_cast<SSL *>(const_cast<void *>(session))));
  17838. }
  17839. inline size_t get_peer_certs(const_session_t session,
  17840. std::vector<cert_t> &certs) {
  17841. certs.clear();
  17842. if (!session) { return 0; }
  17843. auto ssl = static_cast<const SSL *>(session);
  17844. // On the server side, the chain leaves out the peer's own certificate
  17845. if (SSL_is_server(ssl)) {
  17846. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17847. }
  17848. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17849. auto count = sk_X509_num(sk);
  17850. for (decltype(count) i = 0; i < count; i++) {
  17851. auto x509 = sk_X509_value(sk, i);
  17852. X509_up_ref(x509);
  17853. certs.push_back(static_cast<cert_t>(x509));
  17854. }
  17855. }
  17856. return certs.size();
  17857. }
  17858. inline void free_cert(cert_t cert) {
  17859. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17860. }
  17861. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17862. if (!cert || !hostname) return false;
  17863. auto x509 = static_cast<X509 *>(cert);
  17864. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17865. if (detail::is_ip_address(hostname)) {
  17866. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17867. }
  17868. return X509_check_host(x509, hostname, strlen(hostname),
  17869. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  17870. }
  17871. inline uint64_t hostname_mismatch_code() {
  17872. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17873. }
  17874. inline long get_verify_result(const_session_t session) {
  17875. if (!session) return X509_V_ERR_UNSPECIFIED;
  17876. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17877. }
  17878. inline std::string get_cert_subject_cn(cert_t cert) {
  17879. if (!cert) return "";
  17880. auto x509 = static_cast<X509 *>(cert);
  17881. auto subject_name = X509_get_subject_name(x509);
  17882. if (!subject_name) return "";
  17883. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17884. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17885. if (idx < 0) return "";
  17886. auto entry = X509_NAME_get_entry(subject_name, idx);
  17887. if (!entry) return "";
  17888. auto data = X509_NAME_ENTRY_get_data(entry);
  17889. if (!data) return "";
  17890. return std::string(
  17891. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17892. static_cast<size_t>(ASN1_STRING_length(data)));
  17893. }
  17894. inline std::string get_cert_issuer_name(cert_t cert) {
  17895. if (!cert) return "";
  17896. auto x509 = static_cast<X509 *>(cert);
  17897. auto issuer_name = X509_get_issuer_name(x509);
  17898. if (!issuer_name) return "";
  17899. char buf[256];
  17900. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17901. return std::string(buf);
  17902. }
  17903. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17904. sans.clear();
  17905. if (!cert) return false;
  17906. auto x509 = static_cast<X509 *>(cert);
  17907. auto names = static_cast<GENERAL_NAMES *>(
  17908. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17909. if (!names) return true; // No SANs is valid
  17910. auto count = sk_GENERAL_NAME_num(names);
  17911. for (decltype(count) i = 0; i < count; i++) {
  17912. auto gen = sk_GENERAL_NAME_value(names, i);
  17913. if (!gen) continue;
  17914. SanEntry entry;
  17915. switch (gen->type) {
  17916. case GEN_DNS:
  17917. entry.type = SanType::DNS;
  17918. if (gen->d.dNSName) {
  17919. entry.value = std::string(
  17920. reinterpret_cast<const char *>(
  17921. ASN1_STRING_get0_data(gen->d.dNSName)),
  17922. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17923. }
  17924. break;
  17925. case GEN_IPADD:
  17926. entry.type = SanType::IP;
  17927. if (gen->d.iPAddress) {
  17928. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17929. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17930. if (len == 4) {
  17931. // IPv4
  17932. char buf[INET_ADDRSTRLEN];
  17933. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17934. entry.value = buf;
  17935. } else if (len == 16) {
  17936. // IPv6
  17937. char buf[INET6_ADDRSTRLEN];
  17938. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17939. entry.value = buf;
  17940. }
  17941. }
  17942. break;
  17943. case GEN_EMAIL:
  17944. entry.type = SanType::EMAIL;
  17945. if (gen->d.rfc822Name) {
  17946. entry.value = std::string(
  17947. reinterpret_cast<const char *>(
  17948. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17949. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17950. }
  17951. break;
  17952. case GEN_URI:
  17953. entry.type = SanType::URI;
  17954. if (gen->d.uniformResourceIdentifier) {
  17955. entry.value = std::string(
  17956. reinterpret_cast<const char *>(
  17957. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17958. static_cast<size_t>(
  17959. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17960. }
  17961. break;
  17962. default: entry.type = SanType::OTHER; break;
  17963. }
  17964. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17965. }
  17966. GENERAL_NAMES_free(names);
  17967. return true;
  17968. }
  17969. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17970. time_t &not_after) {
  17971. if (!cert) return false;
  17972. auto x509 = static_cast<X509 *>(cert);
  17973. auto nb = X509_get0_notBefore(x509);
  17974. auto na = X509_get0_notAfter(x509);
  17975. if (!nb || !na) return false;
  17976. ASN1_TIME *epoch = ASN1_TIME_new();
  17977. if (!epoch) return false;
  17978. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17979. if (!ASN1_TIME_set(epoch, 0)) return false;
  17980. int pday, psec;
  17981. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17982. not_before = 86400 * (time_t)pday + psec;
  17983. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17984. not_after = 86400 * (time_t)pday + psec;
  17985. return true;
  17986. }
  17987. inline std::string get_cert_serial(cert_t cert) {
  17988. if (!cert) return "";
  17989. auto x509 = static_cast<X509 *>(cert);
  17990. auto serial = X509_get_serialNumber(x509);
  17991. if (!serial) return "";
  17992. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17993. if (!bn) return "";
  17994. auto hex = BN_bn2hex(bn);
  17995. BN_free(bn);
  17996. if (!hex) return "";
  17997. std::string result(hex);
  17998. OPENSSL_free(hex);
  17999. return result;
  18000. }
  18001. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18002. if (!cert) return false;
  18003. auto x509 = static_cast<X509 *>(cert);
  18004. auto len = i2d_X509(x509, nullptr);
  18005. if (len < 0) return false;
  18006. der.resize(static_cast<size_t>(len));
  18007. auto p = der.data();
  18008. i2d_X509(x509, &p);
  18009. return true;
  18010. }
  18011. inline const char *get_sni(const_session_t session) {
  18012. if (!session) return nullptr;
  18013. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18014. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  18015. }
  18016. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  18017. inline uint64_t get_error() { return ERR_get_error(); }
  18018. inline std::string error_string(uint64_t code) {
  18019. char buf[256];
  18020. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  18021. sizeof(buf));
  18022. return std::string(buf);
  18023. }
  18024. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18025. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  18026. if (!mem) { return nullptr; }
  18027. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  18028. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  18029. if (!inf) { return nullptr; }
  18030. auto store = X509_STORE_new();
  18031. if (store) {
  18032. auto count = sk_X509_INFO_num(inf);
  18033. for (decltype(count) i = 0; i < count; i++) {
  18034. auto itmp = sk_X509_INFO_value(inf, i);
  18035. if (!itmp) { continue; }
  18036. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  18037. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  18038. }
  18039. }
  18040. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  18041. return static_cast<ca_store_t>(store);
  18042. }
  18043. inline void free_ca_store(ca_store_t store) {
  18044. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  18045. }
  18046. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18047. if (!ctx || !store) { return false; }
  18048. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18049. auto x509_store = static_cast<X509_STORE *>(store);
  18050. // Check if same store is already set
  18051. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  18052. // SSL_CTX_set_cert_store takes ownership and frees the old store
  18053. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  18054. return true;
  18055. }
  18056. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18057. certs.clear();
  18058. if (!ctx) { return 0; }
  18059. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18060. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18061. if (!store) { return 0; }
  18062. auto objs = impl::get_store_objects(store);
  18063. if (!objs) { return 0; }
  18064. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18065. auto count = sk_X509_OBJECT_num(objs);
  18066. for (decltype(count) i = 0; i < count; i++) {
  18067. auto obj = sk_X509_OBJECT_value(objs, i);
  18068. if (!obj) { continue; }
  18069. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18070. auto x509 = X509_OBJECT_get0_X509(obj);
  18071. if (x509) {
  18072. // Increment reference count so caller can free it
  18073. X509_up_ref(x509);
  18074. certs.push_back(static_cast<cert_t>(x509));
  18075. }
  18076. }
  18077. }
  18078. return certs.size();
  18079. }
  18080. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18081. std::vector<std::string> names;
  18082. if (!ctx) { return names; }
  18083. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18084. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18085. if (!store) { return names; }
  18086. auto objs = impl::get_store_objects(store);
  18087. if (!objs) { return names; }
  18088. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18089. auto count = sk_X509_OBJECT_num(objs);
  18090. for (decltype(count) i = 0; i < count; i++) {
  18091. auto obj = sk_X509_OBJECT_value(objs, i);
  18092. if (!obj) { continue; }
  18093. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18094. auto x509 = X509_OBJECT_get0_X509(obj);
  18095. if (x509) {
  18096. auto subject = X509_get_subject_name(x509);
  18097. if (subject) {
  18098. char buf[512];
  18099. X509_NAME_oneline(subject, buf, sizeof(buf));
  18100. names.push_back(buf);
  18101. }
  18102. }
  18103. }
  18104. }
  18105. return names;
  18106. }
  18107. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18108. const char *key_pem, const char *password) {
  18109. if (!ctx || !cert_pem || !key_pem) { return false; }
  18110. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18111. // Load certificate from PEM
  18112. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  18113. if (!cert_bio) { return false; }
  18114. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  18115. BIO_free(cert_bio);
  18116. if (!cert) { return false; }
  18117. // Load private key from PEM
  18118. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  18119. if (!key_bio) {
  18120. X509_free(cert);
  18121. return false;
  18122. }
  18123. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  18124. password ? const_cast<char *>(password)
  18125. : nullptr);
  18126. BIO_free(key_bio);
  18127. if (!key) {
  18128. X509_free(cert);
  18129. return false;
  18130. }
  18131. // Update certificate and key
  18132. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  18133. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  18134. X509_free(cert);
  18135. EVP_PKEY_free(key);
  18136. return ret;
  18137. }
  18138. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18139. if (!ctx || !ca_pem) { return false; }
  18140. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18141. // Create new X509_STORE from PEM
  18142. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  18143. if (!store) { return false; }
  18144. // A resumed session is not verified again, so the ticket keys from before
  18145. // go, or a client verified under the old CAs could go on resuming.
  18146. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  18147. unsigned char ticket_keys[48];
  18148. #else
  18149. unsigned char ticket_keys[80];
  18150. #endif
  18151. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  18152. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  18153. sizeof(ticket_keys)) != 1) {
  18154. free_ca_store(store);
  18155. return false;
  18156. }
  18157. // SSL_CTX_set_cert_store takes ownership
  18158. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  18159. // Set client CA list for client certificate request
  18160. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  18161. if (ca_list) {
  18162. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  18163. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  18164. }
  18165. // The cached sessions go for the same reason.
  18166. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  18167. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  18168. #else
  18169. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  18170. #endif
  18171. return true;
  18172. }
  18173. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18174. if (!ctx) { return false; }
  18175. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18176. auto index = impl::verify_callback_index();
  18177. if (index < 0) { return false; }
  18178. std::shared_ptr<VerifyCallback> *stored = nullptr;
  18179. if (callback) {
  18180. stored = new std::shared_ptr<VerifyCallback>(
  18181. std::make_shared<VerifyCallback>(std::move(callback)));
  18182. }
  18183. std::shared_ptr<VerifyCallback> *previous = nullptr;
  18184. {
  18185. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  18186. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  18187. SSL_CTX_get_ex_data(ssl_ctx, index));
  18188. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  18189. delete stored;
  18190. return false;
  18191. }
  18192. }
  18193. // A handshake running the previous callback keeps it until it returns.
  18194. delete previous;
  18195. // A resumed handshake shows no certificate to run the callback on.
  18196. if (stored) {
  18197. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  18198. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  18199. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  18200. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  18201. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  18202. #endif
  18203. }
  18204. // Keep requiring the peer's certificate if set_verify_client() asked for it
  18205. auto require =
  18206. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  18207. impl::apply_verify_mode(ssl_ctx, require);
  18208. return true;
  18209. }
  18210. inline long get_verify_error(const_session_t session) {
  18211. if (!session) { return -1; }
  18212. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18213. return SSL_get_verify_result(ssl);
  18214. }
  18215. inline std::string verify_error_string(long error_code) {
  18216. if (error_code == X509_V_OK) { return ""; }
  18217. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  18218. return str ? str : "unknown error";
  18219. }
  18220. } // namespace tls
  18221. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  18222. /*
  18223. * Group 9: TLS abstraction layer - Mbed TLS backend
  18224. */
  18225. /*
  18226. * Mbed TLS Backend Implementation
  18227. */
  18228. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  18229. namespace tls {
  18230. namespace impl {
  18231. // Mbed TLS session wrapper
  18232. struct MbedTlsSession {
  18233. mbedtls_ssl_context ssl;
  18234. socket_t sock = INVALID_SOCKET;
  18235. std::string hostname; // For client: set via set_sni
  18236. std::string sni_hostname; // For server: received from client via SNI callback
  18237. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  18238. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  18239. // (e.g. a response that arrived while this side was still in its post-write
  18240. // check), the byte is pushed back here and served by the next read().
  18241. unsigned char peeked_byte = 0;
  18242. bool has_peeked_byte = false;
  18243. // Set by set_sni() when the caller disabled hostname verification, so the
  18244. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18245. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18246. // OpenSSL and wolfSSL keep them independent).
  18247. bool suppress_hostname_mismatch = false;
  18248. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18249. // ever runs the callback of its own context.
  18250. VerifyCallback verify_callback;
  18251. bool is_server = false;
  18252. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18253. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18254. MbedTlsSession(const MbedTlsSession &) = delete;
  18255. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18256. };
  18257. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18258. // queue)
  18259. inline int &mbedtls_last_error() {
  18260. static thread_local int err = 0;
  18261. return err;
  18262. }
  18263. // Helper to map Mbed TLS error to ErrorCode
  18264. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18265. uint32_t verify_flags) {
  18266. if (ret == 0) { return ErrorCode::Success; }
  18267. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18268. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18269. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18270. return ErrorCode::PeerClosed;
  18271. }
  18272. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18273. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18274. out_errno = errno;
  18275. return ErrorCode::SyscallError;
  18276. }
  18277. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18278. // EOF without close_notify
  18279. out_errno = 0;
  18280. return ErrorCode::SyscallError;
  18281. }
  18282. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18283. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18284. // the handshake's chain verification (see set_sni()); a mismatch there
  18285. // is reported the same way as any other verify_flags bit. Report it as
  18286. // HostnameMismatch, matching the other backends and the post-handshake
  18287. // identity check below, but only when naming is the sole problem -
  18288. // if the chain itself is also untrusted/expired/etc., that takes
  18289. // priority over the naming detail.
  18290. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18291. return ErrorCode::HostnameMismatch;
  18292. }
  18293. return ErrorCode::CertVerifyFailed;
  18294. }
  18295. return ErrorCode::Fatal;
  18296. }
  18297. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18298. // return value, including the verify-flags-dependent HostnameMismatch
  18299. // mapping; shared by connect() and connect_nonblocking() so the
  18300. // backend_code policy for that mapping only lives in one place.
  18301. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18302. int ret) {
  18303. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18304. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18305. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18306. ? static_cast<uint64_t>(verify_flags)
  18307. : static_cast<uint64_t>(-ret);
  18308. }
  18309. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18310. // non-fatal notification delivered between records, not an error and not
  18311. // application data, so I/O calls that see it should just be retried. Kept in
  18312. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18313. // splitting the closing brace across an #if.
  18314. inline bool mbedtls_is_session_ticket(int ret) {
  18315. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18316. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18317. #else
  18318. (void)ret;
  18319. return false;
  18320. #endif
  18321. }
  18322. // BIO-like send callback for Mbed TLS
  18323. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18324. size_t len) {
  18325. auto sock = *static_cast<socket_t *>(ctx);
  18326. #ifdef _WIN32
  18327. auto ret =
  18328. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18329. if (ret == SOCKET_ERROR) {
  18330. int err = WSAGetLastError();
  18331. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18332. return MBEDTLS_ERR_NET_SEND_FAILED;
  18333. }
  18334. #else
  18335. auto ret = send(sock, buf, len, 0);
  18336. if (ret < 0) {
  18337. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18338. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18339. }
  18340. return MBEDTLS_ERR_NET_SEND_FAILED;
  18341. }
  18342. #endif
  18343. return static_cast<int>(ret);
  18344. }
  18345. // BIO-like recv callback for Mbed TLS
  18346. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18347. auto sock = *static_cast<socket_t *>(ctx);
  18348. #ifdef _WIN32
  18349. auto ret =
  18350. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18351. if (ret == SOCKET_ERROR) {
  18352. int err = WSAGetLastError();
  18353. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18354. return MBEDTLS_ERR_NET_RECV_FAILED;
  18355. }
  18356. #else
  18357. auto ret = recv(sock, buf, len, 0);
  18358. if (ret < 0) {
  18359. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18360. return MBEDTLS_ERR_SSL_WANT_READ;
  18361. }
  18362. return MBEDTLS_ERR_NET_RECV_FAILED;
  18363. }
  18364. #endif
  18365. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18366. return static_cast<int>(ret);
  18367. }
  18368. // MbedTlsContext constructor/destructor implementations
  18369. inline MbedTlsContext::MbedTlsContext() {
  18370. mbedtls_ssl_config_init(&conf);
  18371. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18372. mbedtls_entropy_init(&entropy);
  18373. mbedtls_ctr_drbg_init(&ctr_drbg);
  18374. #endif
  18375. mbedtls_x509_crt_init(&ca_chain);
  18376. mbedtls_x509_crt_init(&own_cert);
  18377. mbedtls_pk_init(&own_key);
  18378. }
  18379. inline MbedTlsContext::~MbedTlsContext() {
  18380. mbedtls_pk_free(&own_key);
  18381. mbedtls_x509_crt_free(&own_cert);
  18382. mbedtls_x509_crt_free(&ca_chain);
  18383. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18384. mbedtls_ctr_drbg_free(&ctr_drbg);
  18385. mbedtls_entropy_free(&entropy);
  18386. #endif
  18387. mbedtls_ssl_config_free(&conf);
  18388. }
  18389. // Thread-local storage for SNI captured during handshake
  18390. // This is needed because the SNI callback doesn't have a way to pass
  18391. // session-specific data before the session is fully set up
  18392. inline std::string &mbedpending_sni() {
  18393. static thread_local std::string sni;
  18394. return sni;
  18395. }
  18396. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18397. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18398. const unsigned char *name, size_t name_len) {
  18399. (void)p_ctx;
  18400. (void)ssl;
  18401. // Store SNI name in thread-local storage
  18402. // It will be retrieved and stored in the session after handshake
  18403. if (name && name_len > 0) {
  18404. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18405. } else {
  18406. mbedpending_sni().clear();
  18407. }
  18408. return 0; // Accept any SNI
  18409. }
  18410. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18411. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18412. }
  18413. // MbedTLS verify callback wrapper
  18414. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18415. int cert_depth, uint32_t *flags) {
  18416. // data points to the MbedTlsSession
  18417. auto *session = static_cast<MbedTlsSession *>(data);
  18418. // set_sni() disabled hostname verification for this session: ignore the
  18419. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18420. // pass/fail decision still comes from the remaining flags (and, below, from
  18421. // the user's own verify callback).
  18422. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18423. const auto &callback = session->verify_callback;
  18424. if (!callback) { return 0; } // Continue with default verification
  18425. // Build context
  18426. VerifyContext verify_ctx;
  18427. verify_ctx.session = static_cast<session_t>(session);
  18428. verify_ctx.cert = static_cast<cert_t>(crt);
  18429. verify_ctx.depth = cert_depth;
  18430. verify_ctx.preverify_ok = (*flags == 0);
  18431. verify_ctx.error_code = static_cast<long>(*flags);
  18432. // Convert Mbed TLS flags to error string
  18433. static thread_local char error_buf[256];
  18434. if (*flags != 0) {
  18435. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18436. verify_ctx.error_string = error_buf;
  18437. } else {
  18438. verify_ctx.error_string = nullptr;
  18439. }
  18440. bool accepted = run_verify_callback(callback, verify_ctx);
  18441. if (accepted) {
  18442. // Overrides the built-in verification only on a server, as on OpenSSL and
  18443. // wolfSSL, whose clients check the verify result after the handshake
  18444. if (session->is_server) { *flags = 0; }
  18445. return 0;
  18446. }
  18447. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18448. }
  18449. // Sets the authentication mode from whether the peer's certificate is required
  18450. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18451. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18452. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18453. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18454. if (mctx.verify_client) {
  18455. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18456. } else if (mctx.verify_callback) {
  18457. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18458. }
  18459. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18460. }
  18461. } // namespace impl
  18462. inline ctx_t create_client_context() {
  18463. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18464. if (!ctx) { return nullptr; }
  18465. ctx->is_server = false;
  18466. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18467. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18468. if (!detail::ensure_mbedtls_psa_crypto()) {
  18469. delete ctx;
  18470. return nullptr;
  18471. }
  18472. int ret;
  18473. #else
  18474. // Seed the random number generator
  18475. const char *pers = "httplib_client";
  18476. int ret = mbedtls_ctr_drbg_seed(
  18477. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18478. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18479. if (ret != 0) {
  18480. impl::mbedtls_last_error() = ret;
  18481. delete ctx;
  18482. return nullptr;
  18483. }
  18484. #endif
  18485. // Set up SSL config for client
  18486. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18487. MBEDTLS_SSL_TRANSPORT_STREAM,
  18488. MBEDTLS_SSL_PRESET_DEFAULT);
  18489. if (ret != 0) {
  18490. impl::mbedtls_last_error() = ret;
  18491. delete ctx;
  18492. return nullptr;
  18493. }
  18494. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18495. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18496. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18497. #endif
  18498. // Default: verify peer certificate
  18499. ctx->verify_client = true;
  18500. impl::apply_verify_mode(*ctx);
  18501. // Set minimum TLS version to 1.2
  18502. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18503. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18504. #else
  18505. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18506. MBEDTLS_SSL_MINOR_VERSION_3);
  18507. #endif
  18508. return static_cast<ctx_t>(ctx);
  18509. }
  18510. inline ctx_t create_server_context() {
  18511. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18512. if (!ctx) { return nullptr; }
  18513. ctx->is_server = true;
  18514. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18515. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18516. if (!detail::ensure_mbedtls_psa_crypto()) {
  18517. delete ctx;
  18518. return nullptr;
  18519. }
  18520. int ret;
  18521. #else
  18522. // Seed the random number generator
  18523. const char *pers = "httplib_server";
  18524. int ret = mbedtls_ctr_drbg_seed(
  18525. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18526. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18527. if (ret != 0) {
  18528. impl::mbedtls_last_error() = ret;
  18529. delete ctx;
  18530. return nullptr;
  18531. }
  18532. #endif
  18533. // Set up SSL config for server
  18534. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18535. MBEDTLS_SSL_TRANSPORT_STREAM,
  18536. MBEDTLS_SSL_PRESET_DEFAULT);
  18537. if (ret != 0) {
  18538. impl::mbedtls_last_error() = ret;
  18539. delete ctx;
  18540. return nullptr;
  18541. }
  18542. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18543. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18544. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18545. #endif
  18546. // Default: don't verify client
  18547. impl::apply_verify_mode(*ctx);
  18548. // Set minimum TLS version to 1.2
  18549. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18550. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18551. #else
  18552. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18553. MBEDTLS_SSL_MINOR_VERSION_3);
  18554. #endif
  18555. // Set SNI callback to capture client's SNI hostname
  18556. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18557. return static_cast<ctx_t>(ctx);
  18558. }
  18559. inline void free_context(ctx_t ctx) {
  18560. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18561. }
  18562. inline bool set_min_version(ctx_t ctx, Version version) {
  18563. if (!ctx) { return false; }
  18564. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18565. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18566. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18567. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18568. if (version >= Version::TLS1_3) {
  18569. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18570. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18571. #endif
  18572. }
  18573. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18574. #else
  18575. // Mbed TLS 2.x uses major/minor version numbers
  18576. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18577. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18578. if (version >= Version::TLS1_3) {
  18579. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18580. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18581. #else
  18582. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18583. #endif
  18584. }
  18585. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18586. #endif
  18587. return true;
  18588. }
  18589. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18590. if (!ctx || !pem) { return false; }
  18591. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18592. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18593. // Add null terminator if not present
  18594. std::string pem_str(pem, len);
  18595. int ret = mbedtls_x509_crt_parse(
  18596. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18597. pem_str.size() + 1);
  18598. if (ret != 0) {
  18599. impl::mbedtls_last_error() = ret;
  18600. return false;
  18601. }
  18602. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18603. return true;
  18604. }
  18605. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18606. if (!ctx || !file_path) { return false; }
  18607. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18608. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18609. if (ret != 0) {
  18610. impl::mbedtls_last_error() = ret;
  18611. return false;
  18612. }
  18613. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18614. return true;
  18615. }
  18616. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18617. if (!ctx || !dir_path) { return false; }
  18618. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18619. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18620. if (ret < 0) { // Returns number of certs on success, negative on error
  18621. impl::mbedtls_last_error() = ret;
  18622. return false;
  18623. }
  18624. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18625. return true;
  18626. }
  18627. inline bool load_system_certs(ctx_t ctx) {
  18628. if (!ctx) { return false; }
  18629. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18630. bool loaded = false;
  18631. #ifdef _WIN32
  18632. loaded = impl::enumerate_windows_system_certs(
  18633. [&](const unsigned char *data, size_t len) {
  18634. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18635. });
  18636. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18637. loaded = impl::enumerate_macos_keychain_certs(
  18638. [&](const unsigned char *data, size_t len) {
  18639. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18640. });
  18641. #else
  18642. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18643. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18644. loaded = true;
  18645. break;
  18646. }
  18647. }
  18648. if (!loaded) {
  18649. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18650. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18651. loaded = true;
  18652. break;
  18653. }
  18654. }
  18655. }
  18656. #endif
  18657. if (loaded) {
  18658. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18659. }
  18660. return loaded;
  18661. }
  18662. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18663. const char *password) {
  18664. if (!ctx || !cert || !key) { return false; }
  18665. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18666. // Parse certificate
  18667. std::string cert_str(cert);
  18668. int ret = mbedtls_x509_crt_parse(
  18669. &mctx->own_cert,
  18670. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18671. cert_str.size() + 1);
  18672. if (ret != 0) {
  18673. impl::mbedtls_last_error() = ret;
  18674. return false;
  18675. }
  18676. // Parse private key
  18677. std::string key_str(key);
  18678. const unsigned char *pwd =
  18679. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18680. size_t pwd_len = password ? strlen(password) : 0;
  18681. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18682. ret = mbedtls_pk_parse_key(
  18683. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18684. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18685. &mctx->ctr_drbg);
  18686. #else
  18687. ret = mbedtls_pk_parse_key(
  18688. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18689. key_str.size() + 1, pwd, pwd_len);
  18690. #endif
  18691. if (ret != 0) {
  18692. impl::mbedtls_last_error() = ret;
  18693. return false;
  18694. }
  18695. // Verify that the certificate and private key match.
  18696. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18697. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18698. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18699. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18700. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18701. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18702. #else
  18703. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18704. #endif
  18705. if (ret != 0) {
  18706. impl::mbedtls_last_error() = ret;
  18707. return false;
  18708. }
  18709. #endif
  18710. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18711. if (ret != 0) {
  18712. impl::mbedtls_last_error() = ret;
  18713. return false;
  18714. }
  18715. return true;
  18716. }
  18717. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18718. const char *key_path, const char *password) {
  18719. if (!ctx || !cert_path || !key_path) { return false; }
  18720. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18721. // Parse certificate file
  18722. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18723. if (ret != 0) {
  18724. impl::mbedtls_last_error() = ret;
  18725. return false;
  18726. }
  18727. // Parse private key file
  18728. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18729. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18730. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18731. #else
  18732. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18733. #endif
  18734. if (ret != 0) {
  18735. impl::mbedtls_last_error() = ret;
  18736. return false;
  18737. }
  18738. // Verify that the certificate and private key match.
  18739. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18740. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18741. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18742. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18743. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18744. #else
  18745. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18746. #endif
  18747. if (ret != 0) {
  18748. impl::mbedtls_last_error() = ret;
  18749. return false;
  18750. }
  18751. #endif
  18752. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18753. if (ret != 0) {
  18754. impl::mbedtls_last_error() = ret;
  18755. return false;
  18756. }
  18757. return true;
  18758. }
  18759. inline void set_verify_client(ctx_t ctx, bool require) {
  18760. if (!ctx) { return; }
  18761. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18762. mctx->verify_client = require;
  18763. impl::apply_verify_mode(*mctx);
  18764. }
  18765. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18766. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18767. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18768. auto session = new (std::nothrow) impl::MbedTlsSession();
  18769. if (!session) { return nullptr; }
  18770. session->sock = sock;
  18771. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18772. if (ret != 0) {
  18773. impl::mbedtls_last_error() = ret;
  18774. delete session;
  18775. return nullptr;
  18776. }
  18777. // Explicitly opt out of in-handshake hostname verification by default;
  18778. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18779. // fails outright when no hostname was set. set_sni() installs the real
  18780. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18781. // caller verifies the certificate identity post-handshake via
  18782. // verify_hostname().
  18783. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18784. // Set BIO callbacks
  18785. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18786. impl::mbedtls_net_recv_cb, nullptr);
  18787. // Installed always, as it also masks the hostname mismatch that set_sni()
  18788. // may ask for. The session runs its own copy of the user's callback, which
  18789. // set_verify_callback() cannot replace under a handshake.
  18790. session->verify_callback = mctx->verify_callback;
  18791. session->is_server = mctx->is_server;
  18792. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18793. return static_cast<session_t>(session);
  18794. }
  18795. inline void free_session(session_t session) {
  18796. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18797. }
  18798. inline bool set_sni(session_t session, const char *hostname,
  18799. bool verify_hostname) {
  18800. if (!session || !hostname) { return false; }
  18801. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18802. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18803. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18804. // independently, so a disabled hostname check is handled below by masking
  18805. // the resulting mismatch flag instead of skipping this call.
  18806. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18807. if (ret != 0) {
  18808. impl::mbedtls_last_error() = ret;
  18809. return false;
  18810. }
  18811. msession->hostname = hostname;
  18812. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18813. return true;
  18814. }
  18815. inline TlsError connect(session_t session) {
  18816. TlsError err;
  18817. if (!session) {
  18818. err.code = ErrorCode::Fatal;
  18819. return err;
  18820. }
  18821. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18822. int ret;
  18823. do {
  18824. ret = mbedtls_ssl_handshake(&msession->ssl);
  18825. } while (impl::mbedtls_is_session_ticket(ret));
  18826. if (ret == 0) {
  18827. err.code = ErrorCode::Success;
  18828. } else {
  18829. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18830. impl::mbedtls_last_error() = ret;
  18831. }
  18832. return err;
  18833. }
  18834. inline TlsError accept(session_t session) {
  18835. // A failed handshake leaves its SNI behind, so start without it
  18836. impl::mbedpending_sni().clear();
  18837. // Same as connect for Mbed TLS - handshake works for both client and server
  18838. auto result = connect(session);
  18839. // After successful handshake, capture SNI from thread-local storage
  18840. if (result.code == ErrorCode::Success && session) {
  18841. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18842. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18843. }
  18844. return result;
  18845. }
  18846. inline bool connect_nonblocking(session_t session, socket_t sock,
  18847. time_t timeout_sec, time_t timeout_usec,
  18848. TlsError *err,
  18849. const std::function<bool()> &interrupted) {
  18850. if (!session) {
  18851. if (err) { err->code = ErrorCode::Fatal; }
  18852. return false;
  18853. }
  18854. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18855. // Set socket to non-blocking mode
  18856. detail::set_nonblocking(sock, true);
  18857. auto cleanup =
  18858. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18859. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18860. int ret;
  18861. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18862. // Non-fatal TLS 1.3 ticket; retry immediately.
  18863. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18864. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18865. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  18866. continue;
  18867. }
  18868. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18869. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  18870. continue;
  18871. }
  18872. }
  18873. // TlsError or timeout
  18874. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18875. impl::mbedtls_last_error() = ret;
  18876. return false;
  18877. }
  18878. if (err) { err->code = ErrorCode::Success; }
  18879. return true;
  18880. }
  18881. inline bool accept_nonblocking(session_t session, socket_t sock,
  18882. time_t timeout_sec, time_t timeout_usec,
  18883. TlsError *err) {
  18884. // A failed handshake leaves its SNI behind, so start without it
  18885. impl::mbedpending_sni().clear();
  18886. // Same implementation as connect for Mbed TLS
  18887. bool result =
  18888. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18889. // After successful handshake, capture SNI from thread-local storage
  18890. if (result && session) {
  18891. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18892. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18893. }
  18894. return result;
  18895. }
  18896. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18897. if (!session || !buf) {
  18898. err.code = ErrorCode::Fatal;
  18899. return -1;
  18900. }
  18901. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18902. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18903. if (msession->has_peeked_byte) {
  18904. if (len == 0) { return 0; }
  18905. auto p = static_cast<unsigned char *>(buf);
  18906. p[0] = msession->peeked_byte;
  18907. msession->has_peeked_byte = false;
  18908. size_t n = 1;
  18909. // Top up with any already-decrypted bytes without risking a block.
  18910. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18911. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18912. if (extra > 0) { n += static_cast<size_t>(extra); }
  18913. }
  18914. err.code = ErrorCode::Success;
  18915. return static_cast<ssize_t>(n);
  18916. }
  18917. int ret;
  18918. do {
  18919. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18920. len);
  18921. } while (impl::mbedtls_is_session_ticket(ret));
  18922. if (ret > 0) {
  18923. err.code = ErrorCode::Success;
  18924. return static_cast<ssize_t>(ret);
  18925. }
  18926. // 0 means EOF without close_notify, which is an error as on OpenSSL
  18927. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  18928. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18929. err.backend_code = static_cast<uint64_t>(-ret);
  18930. impl::mbedtls_last_error() = ret;
  18931. // mbedTLS signals a clean close_notify via a negative error code rather
  18932. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18933. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18934. return -1;
  18935. }
  18936. inline ssize_t write(session_t session, const void *buf, size_t len,
  18937. TlsError &err) {
  18938. if (!session || !buf) {
  18939. err.code = ErrorCode::Fatal;
  18940. return -1;
  18941. }
  18942. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18943. int ret;
  18944. do {
  18945. ret = mbedtls_ssl_write(&msession->ssl,
  18946. static_cast<const unsigned char *>(buf), len);
  18947. } while (impl::mbedtls_is_session_ticket(ret));
  18948. if (ret > 0) {
  18949. err.code = ErrorCode::Success;
  18950. return static_cast<ssize_t>(ret);
  18951. }
  18952. if (ret == 0) {
  18953. err.code = ErrorCode::PeerClosed;
  18954. return 0;
  18955. }
  18956. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18957. err.backend_code = static_cast<uint64_t>(-ret);
  18958. impl::mbedtls_last_error() = ret;
  18959. return -1;
  18960. }
  18961. inline int pending(const_session_t session) {
  18962. if (!session) { return 0; }
  18963. auto msession =
  18964. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18965. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18966. (msession->has_peeked_byte ? 1 : 0);
  18967. }
  18968. inline void shutdown(session_t session, bool graceful) {
  18969. if (!session) { return; }
  18970. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18971. if (graceful) {
  18972. // Try to send close_notify, but don't block forever
  18973. int ret;
  18974. int attempts = 0;
  18975. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18976. attempts < 3) {
  18977. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18978. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18979. break;
  18980. }
  18981. attempts++;
  18982. }
  18983. }
  18984. }
  18985. inline bool is_peer_closed(session_t session, socket_t sock) {
  18986. if (!session || sock == INVALID_SOCKET) { return true; }
  18987. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18988. // Check if there's already decrypted or pushed-back data available.
  18989. // If so, the connection is definitely alive.
  18990. if (msession->has_peeked_byte ||
  18991. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18992. return false;
  18993. }
  18994. // Set socket to non-blocking to avoid blocking on read
  18995. detail::set_nonblocking(sock, true);
  18996. auto cleanup =
  18997. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18998. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18999. // on application data — e.g. a response that already arrived — push the
  19000. // byte back so the next read() delivers it instead of losing it.
  19001. unsigned char buf;
  19002. int ret;
  19003. do {
  19004. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  19005. } while (impl::mbedtls_is_session_ticket(ret));
  19006. // If we got data or WANT_READ (would block), connection is alive
  19007. if (ret > 0) {
  19008. msession->peeked_byte = buf;
  19009. msession->has_peeked_byte = true;
  19010. return false;
  19011. }
  19012. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  19013. // If we get a peer close notify or a connection reset, the peer is closed
  19014. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  19015. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  19016. }
  19017. inline cert_t get_peer_cert(const_session_t session) {
  19018. if (!session) { return nullptr; }
  19019. auto msession =
  19020. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19021. // Mbed TLS returns a pointer to the internal peer cert chain.
  19022. // WARNING: This pointer is only valid while the session is active.
  19023. // Do not use the certificate after calling free_session().
  19024. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  19025. return const_cast<mbedtls_x509_crt *>(cert);
  19026. }
  19027. inline size_t get_peer_certs(const_session_t session,
  19028. std::vector<cert_t> &certs) {
  19029. certs.clear();
  19030. // Mbed TLS parses the whole received chain into a list headed by the peer
  19031. // certificate, owned by the session like get_peer_cert()'s result
  19032. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  19033. crt && crt->raw.len > 0; crt = crt->next) {
  19034. certs.push_back(static_cast<cert_t>(crt));
  19035. }
  19036. return certs.size();
  19037. }
  19038. inline void free_cert(cert_t cert) {
  19039. // Mbed TLS: every cert_t handed out points into a session's or a context's
  19040. // chain, so there is nothing to free. Callers still call this for the other
  19041. // backends.
  19042. (void)cert;
  19043. }
  19044. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19045. if (!cert || !hostname) { return false; }
  19046. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  19047. std::string host_str(hostname);
  19048. // Check if hostname is an IP address (IPv4 or IPv6)
  19049. unsigned char ip_bytes[16];
  19050. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19051. auto is_ip = ip_len > 0;
  19052. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  19053. // in buf.tag and the raw value in buf.p / buf.len.
  19054. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  19055. if (!san->buf.p || san->buf.len == 0) { continue; }
  19056. const unsigned char *p = san->buf.p;
  19057. size_t len = san->buf.len;
  19058. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  19059. if (is_ip) {
  19060. // For an IP host, only a matching iPAddress SAN of the same family
  19061. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  19062. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  19063. memcmp(p, ip_bytes, ip_len) == 0) {
  19064. return true;
  19065. }
  19066. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  19067. std::string san_name(reinterpret_cast<const char *>(p), len);
  19068. if (detail::match_hostname(san_name, host_str)) { return true; }
  19069. }
  19070. }
  19071. return false;
  19072. }
  19073. inline uint64_t hostname_mismatch_code() {
  19074. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  19075. }
  19076. inline long get_verify_result(const_session_t session) {
  19077. if (!session) { return -1; }
  19078. auto msession =
  19079. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19080. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  19081. // Return 0 (X509_V_OK equivalent) if verification passed
  19082. return flags == 0 ? 0 : static_cast<long>(flags);
  19083. }
  19084. inline std::string get_cert_subject_cn(cert_t cert) {
  19085. if (!cert) return "";
  19086. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19087. // Find the CN in the subject
  19088. const mbedtls_x509_name *name = &x509->subject;
  19089. while (name != nullptr) {
  19090. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  19091. return std::string(reinterpret_cast<const char *>(name->val.p),
  19092. name->val.len);
  19093. }
  19094. name = name->next;
  19095. }
  19096. return "";
  19097. }
  19098. inline std::string get_cert_issuer_name(cert_t cert) {
  19099. if (!cert) return "";
  19100. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19101. // Build a human-readable issuer name string
  19102. char buf[512];
  19103. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  19104. if (ret < 0) return "";
  19105. return std::string(buf);
  19106. }
  19107. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19108. sans.clear();
  19109. if (!cert) return false;
  19110. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19111. // Parse the Subject Alternative Name extension
  19112. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  19113. while (cur != nullptr) {
  19114. if (cur->buf.len > 0) {
  19115. const unsigned char *p = cur->buf.p;
  19116. size_t value_len = cur->buf.len;
  19117. SanEntry entry;
  19118. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  19119. case MBEDTLS_X509_SAN_DNS_NAME:
  19120. entry.type = SanType::DNS;
  19121. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19122. break;
  19123. case MBEDTLS_X509_SAN_IP_ADDRESS:
  19124. entry.type = SanType::IP;
  19125. if (value_len == 4) {
  19126. // IPv4
  19127. char buf[16];
  19128. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  19129. entry.value = buf;
  19130. } else if (value_len == 16) {
  19131. // IPv6
  19132. char buf[64];
  19133. snprintf(buf, sizeof(buf),
  19134. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19135. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19136. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  19137. p[10], p[11], p[12], p[13], p[14], p[15]);
  19138. entry.value = buf;
  19139. }
  19140. break;
  19141. case MBEDTLS_X509_SAN_RFC822_NAME:
  19142. entry.type = SanType::EMAIL;
  19143. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19144. break;
  19145. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  19146. entry.type = SanType::URI;
  19147. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19148. break;
  19149. default: entry.type = SanType::OTHER; break;
  19150. }
  19151. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19152. }
  19153. cur = cur->next;
  19154. }
  19155. return true;
  19156. }
  19157. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19158. time_t &not_after) {
  19159. if (!cert) return false;
  19160. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19161. // Convert mbedtls_x509_time to time_t
  19162. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  19163. struct tm tm_time = {};
  19164. tm_time.tm_year = t.year - 1900;
  19165. tm_time.tm_mon = t.mon - 1;
  19166. tm_time.tm_mday = t.day;
  19167. tm_time.tm_hour = t.hour;
  19168. tm_time.tm_min = t.min;
  19169. tm_time.tm_sec = t.sec;
  19170. #ifdef _WIN32
  19171. return _mkgmtime(&tm_time);
  19172. #else
  19173. return timegm(&tm_time);
  19174. #endif
  19175. };
  19176. not_before = to_time_t(x509->valid_from);
  19177. not_after = to_time_t(x509->valid_to);
  19178. return true;
  19179. }
  19180. inline std::string get_cert_serial(cert_t cert) {
  19181. if (!cert) return "";
  19182. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19183. // Convert serial number to hex string
  19184. std::string result;
  19185. result.reserve(x509->serial.len * 2);
  19186. for (size_t i = 0; i < x509->serial.len; i++) {
  19187. char hex[3];
  19188. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  19189. result += hex;
  19190. }
  19191. return result;
  19192. }
  19193. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19194. if (!cert) return false;
  19195. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  19196. if (!crt->raw.p || crt->raw.len == 0) return false;
  19197. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  19198. return true;
  19199. }
  19200. inline const char *get_sni(const_session_t session) {
  19201. if (!session) return nullptr;
  19202. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  19203. // For server: return SNI received from client during handshake
  19204. if (!msession->sni_hostname.empty()) {
  19205. return msession->sni_hostname.c_str();
  19206. }
  19207. // For client: return the hostname set via set_sni
  19208. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  19209. return nullptr;
  19210. }
  19211. inline uint64_t peek_error() {
  19212. // Mbed TLS doesn't have an error queue, return the last error
  19213. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  19214. }
  19215. inline uint64_t get_error() {
  19216. // Mbed TLS doesn't have an error queue, return and clear the last error
  19217. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  19218. impl::mbedtls_last_error() = 0;
  19219. return err;
  19220. }
  19221. inline std::string error_string(uint64_t code) {
  19222. char buf[256];
  19223. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  19224. return std::string(buf);
  19225. }
  19226. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19227. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19228. // Parsing certificates needs PSA Crypto, and no context may exist yet
  19229. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  19230. #endif
  19231. if (!pem) { return nullptr; }
  19232. // mbedtls_x509_crt_parse expects null-terminated PEM
  19233. std::string pem_str(pem, len);
  19234. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  19235. if (!ca_chain) { return nullptr; }
  19236. mbedtls_x509_crt_init(ca_chain);
  19237. auto ret = mbedtls_x509_crt_parse(
  19238. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19239. pem_str.size() + 1);
  19240. if (ret != 0) {
  19241. mbedtls_x509_crt_free(ca_chain);
  19242. delete ca_chain;
  19243. return nullptr;
  19244. }
  19245. return static_cast<ca_store_t>(ca_chain);
  19246. }
  19247. inline void free_ca_store(ca_store_t store) {
  19248. if (store) {
  19249. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19250. mbedtls_x509_crt_free(ca_chain);
  19251. delete ca_chain;
  19252. }
  19253. }
  19254. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19255. if (!ctx || !store) { return false; }
  19256. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19257. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19258. // Free existing CA chain
  19259. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19260. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19261. // Copy the CA chain (deep copy)
  19262. // Parse from the raw data of the source cert
  19263. mbedtls_x509_crt *src = ca_chain;
  19264. while (src != nullptr) {
  19265. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19266. src->raw.len);
  19267. if (ret != 0) {
  19268. free_ca_store(store);
  19269. return false;
  19270. }
  19271. src = src->next;
  19272. }
  19273. // This function takes ownership of the store; the chain was deep-copied
  19274. // above, so release the source
  19275. free_ca_store(store);
  19276. // Update the SSL config to use the new CA chain
  19277. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19278. return true;
  19279. }
  19280. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19281. certs.clear();
  19282. if (!ctx) { return 0; }
  19283. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19284. // Owned by the context; see free_cert()
  19285. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19286. cert = cert->next) {
  19287. certs.push_back(static_cast<cert_t>(cert));
  19288. }
  19289. return certs.size();
  19290. }
  19291. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19292. std::vector<std::string> names;
  19293. if (!ctx) { return names; }
  19294. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19295. // Iterate through the CA chain
  19296. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19297. while (cert != nullptr && cert->raw.len > 0) {
  19298. char buf[512];
  19299. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19300. if (ret > 0) { names.push_back(buf); }
  19301. cert = cert->next;
  19302. }
  19303. return names;
  19304. }
  19305. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19306. const char *key_pem, const char *password) {
  19307. if (!ctx || !cert_pem || !key_pem) { return false; }
  19308. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19309. // Parse into new objects first, so that a bad pair leaves the old one in
  19310. // place, and swap them in after; the old ones are freed on the way out.
  19311. mbedtls_x509_crt cert;
  19312. mbedtls_pk_context key;
  19313. mbedtls_x509_crt_init(&cert);
  19314. mbedtls_pk_init(&key);
  19315. auto se = detail::scope_exit([&] {
  19316. mbedtls_x509_crt_free(&cert);
  19317. mbedtls_pk_free(&key);
  19318. });
  19319. // Parse certificate PEM
  19320. int ret = mbedtls_x509_crt_parse(
  19321. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19322. strlen(cert_pem) + 1);
  19323. if (ret != 0) {
  19324. impl::mbedtls_last_error() = ret;
  19325. return false;
  19326. }
  19327. // Parse private key PEM
  19328. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19329. ret = mbedtls_pk_parse_key(
  19330. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19331. strlen(key_pem) + 1,
  19332. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19333. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19334. &mbed_ctx->ctr_drbg);
  19335. #else
  19336. ret = mbedtls_pk_parse_key(
  19337. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19338. strlen(key_pem) + 1,
  19339. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19340. password ? strlen(password) : 0);
  19341. #endif
  19342. if (ret != 0) {
  19343. impl::mbedtls_last_error() = ret;
  19344. return false;
  19345. }
  19346. std::swap(mbed_ctx->own_cert, cert);
  19347. std::swap(mbed_ctx->own_key, key);
  19348. // Configure SSL to use the new certificate and key
  19349. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19350. &mbed_ctx->own_key);
  19351. if (ret != 0) {
  19352. impl::mbedtls_last_error() = ret;
  19353. return false;
  19354. }
  19355. return true;
  19356. }
  19357. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19358. if (!ctx || !ca_pem) { return false; }
  19359. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19360. // Parse into a new chain first, so that a bad one leaves the old in place
  19361. mbedtls_x509_crt chain;
  19362. mbedtls_x509_crt_init(&chain);
  19363. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19364. // Parse CA PEM
  19365. int ret = mbedtls_x509_crt_parse(
  19366. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19367. strlen(ca_pem) + 1);
  19368. if (ret != 0) {
  19369. impl::mbedtls_last_error() = ret;
  19370. return false;
  19371. }
  19372. std::swap(mbed_ctx->ca_chain, chain);
  19373. // Update SSL config to use new CA chain
  19374. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19375. return true;
  19376. }
  19377. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19378. if (!ctx) { return false; }
  19379. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19380. // create_session() hands each session its own copy to run.
  19381. mbed_ctx->verify_callback = std::move(callback);
  19382. impl::apply_verify_mode(*mbed_ctx);
  19383. return true;
  19384. }
  19385. inline long get_verify_error(const_session_t session) {
  19386. if (!session) { return -1; }
  19387. auto *msession =
  19388. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19389. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19390. }
  19391. inline std::string verify_error_string(long error_code) {
  19392. if (error_code == 0) { return ""; }
  19393. char buf[256];
  19394. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19395. static_cast<uint32_t>(error_code));
  19396. // Remove trailing newline if present
  19397. std::string result(buf);
  19398. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19399. result.pop_back();
  19400. }
  19401. return result;
  19402. }
  19403. } // namespace tls
  19404. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19405. /*
  19406. * Group 10: TLS abstraction layer - wolfSSL backend
  19407. */
  19408. /*
  19409. * wolfSSL Backend Implementation
  19410. */
  19411. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19412. namespace tls {
  19413. namespace impl {
  19414. // wolfSSL session wrapper
  19415. struct WolfSSLSession {
  19416. WOLFSSL *ssl = nullptr;
  19417. socket_t sock = INVALID_SOCKET;
  19418. std::string hostname; // For client: set via set_sni
  19419. std::string sni_hostname; // For server: received from client via SNI callback
  19420. WolfSSLSession() = default;
  19421. ~WolfSSLSession() {
  19422. if (ssl) { wolfSSL_free(ssl); }
  19423. }
  19424. WolfSSLSession(const WolfSSLSession &) = delete;
  19425. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19426. };
  19427. // Thread-local error code accessor for wolfSSL
  19428. inline uint64_t &wolfssl_last_error() {
  19429. static thread_local uint64_t err = 0;
  19430. return err;
  19431. }
  19432. // Helper to map wolfSSL error to ErrorCode.
  19433. // ssl_error is the value from wolfSSL_get_error().
  19434. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19435. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19436. int &out_errno) {
  19437. switch (ssl_error) {
  19438. case SSL_ERROR_NONE: return ErrorCode::Success;
  19439. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19440. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19441. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19442. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19443. // EOF without close_notify
  19444. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19445. default:
  19446. if (ssl) {
  19447. // wolfSSL stores the low-level error code as a negative value.
  19448. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19449. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19450. if (low_err == DOMAIN_NAME_MISMATCH) {
  19451. return ErrorCode::HostnameMismatch;
  19452. }
  19453. // Check verify result to distinguish cert verification from generic SSL
  19454. // errors.
  19455. long vr = wolfSSL_get_verify_result(ssl);
  19456. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19457. }
  19458. return ErrorCode::Fatal;
  19459. }
  19460. }
  19461. // WolfSSLContext constructor/destructor implementations
  19462. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19463. inline WolfSSLContext::~WolfSSLContext() {
  19464. if (ctx) { wolfSSL_CTX_free(ctx); }
  19465. }
  19466. // Thread-local storage for SNI captured during handshake
  19467. inline std::string &wolfssl_pending_sni() {
  19468. static thread_local std::string sni;
  19469. return sni;
  19470. }
  19471. // SNI callback for wolfSSL server to capture client's SNI hostname
  19472. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19473. (void)ret;
  19474. (void)exArg;
  19475. void *name_data = nullptr;
  19476. unsigned short name_len =
  19477. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19478. if (name_data && name_len > 0) {
  19479. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19480. name_len);
  19481. } else {
  19482. wolfssl_pending_sni().clear();
  19483. }
  19484. return 0; // Continue regardless
  19485. }
  19486. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19487. // runs the verify callback of its own context.
  19488. inline int context_ex_data_index() {
  19489. static const auto index =
  19490. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19491. return index;
  19492. }
  19493. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19494. // other tls:: function takes.
  19495. inline int session_ex_data_index() {
  19496. static const auto index =
  19497. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19498. return index;
  19499. }
  19500. // A resumed session skips the client's certificate, so a server that checks
  19501. // one would let in a certificate checked against another server's CA, as
  19502. // wolfSSL shares its session cache between contexts, or against a CA since
  19503. // replaced by update_server_client_ca().
  19504. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19505. if (!wctx->is_server) { return; }
  19506. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19507. #ifdef HAVE_SESSION_TICKET
  19508. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19509. #endif
  19510. }
  19511. // wolfSSL verify callback wrapper
  19512. inline int wolfssl_verify_callback(int preverify_ok,
  19513. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19514. // Get the WOLFSSL object from the X509_STORE_CTX
  19515. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19516. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19517. if (!ssl) { return preverify_ok; }
  19518. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19519. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19520. if (!wctx) { return preverify_ok; }
  19521. std::shared_ptr<VerifyCallback> callback;
  19522. {
  19523. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19524. callback = wctx->verify_callback;
  19525. }
  19526. if (!callback) { return preverify_ok; }
  19527. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19528. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19529. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19530. VerifyContext verify_ctx;
  19531. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19532. verify_ctx.cert = static_cast<cert_t>(cert);
  19533. verify_ctx.depth = depth;
  19534. verify_ctx.preverify_ok = (preverify_ok != 0);
  19535. verify_ctx.error_code = static_cast<long>(err);
  19536. if (err != 0) {
  19537. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19538. } else {
  19539. verify_ctx.error_string = nullptr;
  19540. }
  19541. auto accepted = run_verify_callback(*callback, verify_ctx);
  19542. // A client verifying the server during the handshake, which is what
  19543. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19544. if (!wolfSSL_is_server(ssl) &&
  19545. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19546. accepted = accepted && preverify_ok;
  19547. }
  19548. return accepted ? 1 : 0;
  19549. }
  19550. // Sets the verify mode from whether the peer's certificate is required and
  19551. // whether a verify callback is set.
  19552. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19553. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19554. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19555. auto mode = wctx.verify_client
  19556. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19557. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19558. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19559. has_callback ? wolfssl_verify_callback : nullptr);
  19560. }
  19561. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19562. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19563. wolfSSL_CTX_set_default_passwd_cb(
  19564. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19565. auto *pwd = static_cast<const char *>(userdata);
  19566. if (!pwd) return 0;
  19567. auto len = static_cast<int>(strlen(pwd));
  19568. if (len > size) len = size;
  19569. memcpy(buf, pwd, static_cast<size_t>(len));
  19570. return len;
  19571. });
  19572. }
  19573. } // namespace impl
  19574. inline ctx_t create_client_context() {
  19575. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19576. if (!ctx) { return nullptr; }
  19577. ctx->is_server = false;
  19578. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19579. if (!method) {
  19580. delete ctx;
  19581. return nullptr;
  19582. }
  19583. ctx->ctx = wolfSSL_CTX_new(method);
  19584. if (!ctx->ctx ||
  19585. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19586. WOLFSSL_SUCCESS) {
  19587. delete ctx;
  19588. return nullptr;
  19589. }
  19590. // Default: verify peer certificate
  19591. ctx->verify_client = true;
  19592. impl::apply_verify_mode(*ctx);
  19593. return static_cast<ctx_t>(ctx);
  19594. }
  19595. inline ctx_t create_server_context() {
  19596. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19597. if (!ctx) { return nullptr; }
  19598. ctx->is_server = true;
  19599. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19600. if (!method) {
  19601. delete ctx;
  19602. return nullptr;
  19603. }
  19604. ctx->ctx = wolfSSL_CTX_new(method);
  19605. if (!ctx->ctx ||
  19606. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19607. WOLFSSL_SUCCESS) {
  19608. delete ctx;
  19609. return nullptr;
  19610. }
  19611. // Default: don't verify client
  19612. impl::apply_verify_mode(*ctx);
  19613. // Enable SNI on server
  19614. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19615. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19616. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19617. return static_cast<ctx_t>(ctx);
  19618. }
  19619. inline void free_context(ctx_t ctx) {
  19620. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19621. }
  19622. inline bool set_min_version(ctx_t ctx, Version version) {
  19623. if (!ctx) { return false; }
  19624. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19625. int min_ver = WOLFSSL_TLSV1_2;
  19626. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19627. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19628. }
  19629. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19630. if (!ctx || !pem) { return false; }
  19631. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19632. int ret = wolfSSL_CTX_load_verify_buffer(
  19633. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19634. static_cast<long>(len), SSL_FILETYPE_PEM);
  19635. if (ret != SSL_SUCCESS) {
  19636. impl::wolfssl_last_error() =
  19637. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19638. return false;
  19639. }
  19640. wctx->ca_pem_data_.append(pem, len);
  19641. return true;
  19642. }
  19643. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19644. if (!ctx || !file_path) { return false; }
  19645. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19646. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19647. if (ret != SSL_SUCCESS) {
  19648. impl::wolfssl_last_error() =
  19649. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19650. return false;
  19651. }
  19652. return true;
  19653. }
  19654. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19655. if (!ctx || !dir_path) { return false; }
  19656. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19657. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19658. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19659. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19660. // immediately. Return true even on failure since the CA file may have
  19661. // already been loaded, matching OpenSSL's lenient behavior.
  19662. (void)ret;
  19663. return true;
  19664. }
  19665. inline bool load_system_certs(ctx_t ctx) {
  19666. if (!ctx) { return false; }
  19667. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19668. bool loaded = false;
  19669. #ifdef _WIN32
  19670. loaded = impl::enumerate_windows_system_certs(
  19671. [&](const unsigned char *data, size_t len) {
  19672. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19673. static_cast<long>(len),
  19674. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19675. });
  19676. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19677. loaded = impl::enumerate_macos_keychain_certs(
  19678. [&](const unsigned char *data, size_t len) {
  19679. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19680. static_cast<long>(len),
  19681. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19682. });
  19683. #else
  19684. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19685. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19686. SSL_SUCCESS) {
  19687. loaded = true;
  19688. break;
  19689. }
  19690. }
  19691. if (!loaded) {
  19692. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19693. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19694. SSL_SUCCESS) {
  19695. loaded = true;
  19696. break;
  19697. }
  19698. }
  19699. }
  19700. #endif
  19701. return loaded;
  19702. }
  19703. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19704. const char *password) {
  19705. if (!ctx || !cert || !key) { return false; }
  19706. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19707. // Load certificate
  19708. int ret = wolfSSL_CTX_use_certificate_buffer(
  19709. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19710. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19711. if (ret != SSL_SUCCESS) {
  19712. impl::wolfssl_last_error() =
  19713. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19714. return false;
  19715. }
  19716. // Set password callback if password is provided
  19717. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19718. // Load private key
  19719. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19720. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19721. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19722. if (ret != SSL_SUCCESS) {
  19723. impl::wolfssl_last_error() =
  19724. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19725. return false;
  19726. }
  19727. // Verify that the certificate and private key match
  19728. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19729. }
  19730. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19731. const char *key_path, const char *password) {
  19732. if (!ctx || !cert_path || !key_path) { return false; }
  19733. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19734. // Load certificate file
  19735. int ret =
  19736. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19737. if (ret != SSL_SUCCESS) {
  19738. impl::wolfssl_last_error() =
  19739. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19740. return false;
  19741. }
  19742. // Set password callback if password is provided
  19743. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19744. // Load private key file
  19745. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19746. if (ret != SSL_SUCCESS) {
  19747. impl::wolfssl_last_error() =
  19748. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19749. return false;
  19750. }
  19751. // Verify that the certificate and private key match
  19752. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19753. }
  19754. inline void set_verify_client(ctx_t ctx, bool require) {
  19755. if (!ctx) { return; }
  19756. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19757. wctx->verify_client = require;
  19758. impl::apply_verify_mode(*wctx);
  19759. }
  19760. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19761. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19762. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19763. auto session = new (std::nothrow) impl::WolfSSLSession();
  19764. if (!session) { return nullptr; }
  19765. session->sock = sock;
  19766. session->ssl = wolfSSL_new(wctx->ctx);
  19767. if (!session->ssl) {
  19768. impl::wolfssl_last_error() =
  19769. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19770. delete session;
  19771. return nullptr;
  19772. }
  19773. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19774. session) != WOLFSSL_SUCCESS) {
  19775. delete session;
  19776. return nullptr;
  19777. }
  19778. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19779. return static_cast<session_t>(session);
  19780. }
  19781. inline void free_session(session_t session) {
  19782. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19783. }
  19784. inline bool set_sni(session_t session, const char *hostname,
  19785. bool verify_hostname) {
  19786. if (!session || !hostname) { return false; }
  19787. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19788. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19789. static_cast<word16>(strlen(hostname)));
  19790. if (ret != WOLFSSL_SUCCESS) {
  19791. impl::wolfssl_last_error() =
  19792. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19793. return false;
  19794. }
  19795. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19796. // separately from the SNI extension sent above; skip it when hostname
  19797. // verification is disabled so only the chain is checked, matching OpenSSL.
  19798. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19799. wsession->hostname = hostname;
  19800. return true;
  19801. }
  19802. inline TlsError connect(session_t session) {
  19803. TlsError err;
  19804. if (!session) {
  19805. err.code = ErrorCode::Fatal;
  19806. return err;
  19807. }
  19808. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19809. int ret = wolfSSL_connect(wsession->ssl);
  19810. if (ret == SSL_SUCCESS) {
  19811. err.code = ErrorCode::Success;
  19812. } else {
  19813. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19814. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19815. err.backend_code = static_cast<uint64_t>(ssl_error);
  19816. impl::wolfssl_last_error() = err.backend_code;
  19817. }
  19818. return err;
  19819. }
  19820. inline TlsError accept(session_t session) {
  19821. TlsError err;
  19822. if (!session) {
  19823. err.code = ErrorCode::Fatal;
  19824. return err;
  19825. }
  19826. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19827. int ret = wolfSSL_accept(wsession->ssl);
  19828. if (ret == SSL_SUCCESS) {
  19829. err.code = ErrorCode::Success;
  19830. // Capture SNI from thread-local storage after successful handshake
  19831. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19832. impl::wolfssl_pending_sni().clear();
  19833. } else {
  19834. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19835. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19836. err.backend_code = static_cast<uint64_t>(ssl_error);
  19837. impl::wolfssl_last_error() = err.backend_code;
  19838. }
  19839. return err;
  19840. }
  19841. inline bool connect_nonblocking(session_t session, socket_t sock,
  19842. time_t timeout_sec, time_t timeout_usec,
  19843. TlsError *err,
  19844. const std::function<bool()> &interrupted) {
  19845. if (!session) {
  19846. if (err) { err->code = ErrorCode::Fatal; }
  19847. return false;
  19848. }
  19849. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19850. // Set socket to non-blocking mode
  19851. detail::set_nonblocking(sock, true);
  19852. auto cleanup =
  19853. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19854. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19855. int ret;
  19856. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19857. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19858. if (ssl_error == SSL_ERROR_WANT_READ) {
  19859. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  19860. continue;
  19861. }
  19862. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19863. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  19864. continue;
  19865. }
  19866. }
  19867. // Error or timeout
  19868. if (err) {
  19869. err->code =
  19870. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19871. err->backend_code = static_cast<uint64_t>(ssl_error);
  19872. }
  19873. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19874. return false;
  19875. }
  19876. if (err) { err->code = ErrorCode::Success; }
  19877. return true;
  19878. }
  19879. inline bool accept_nonblocking(session_t session, socket_t sock,
  19880. time_t timeout_sec, time_t timeout_usec,
  19881. TlsError *err) {
  19882. if (!session) {
  19883. if (err) { err->code = ErrorCode::Fatal; }
  19884. return false;
  19885. }
  19886. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19887. // Set socket to non-blocking mode
  19888. detail::set_nonblocking(sock, true);
  19889. auto cleanup =
  19890. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19891. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19892. int ret;
  19893. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19894. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19895. if (ssl_error == SSL_ERROR_WANT_READ) {
  19896. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19897. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19898. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19899. }
  19900. // Error or timeout
  19901. if (err) {
  19902. err->code =
  19903. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19904. err->backend_code = static_cast<uint64_t>(ssl_error);
  19905. }
  19906. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19907. return false;
  19908. }
  19909. if (err) { err->code = ErrorCode::Success; }
  19910. // Capture SNI from thread-local storage after successful handshake
  19911. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19912. impl::wolfssl_pending_sni().clear();
  19913. return true;
  19914. }
  19915. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19916. if (!session || !buf) {
  19917. err.code = ErrorCode::Fatal;
  19918. return -1;
  19919. }
  19920. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19921. constexpr auto max_len =
  19922. static_cast<size_t>((std::numeric_limits<int>::max)());
  19923. if (len > max_len) { len = max_len; }
  19924. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19925. if (ret > 0) {
  19926. err.code = ErrorCode::Success;
  19927. return static_cast<ssize_t>(ret);
  19928. }
  19929. // 0 is also returned for EOF without close_notify; get_error tells them apart
  19930. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19931. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19932. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19933. err.backend_code = static_cast<uint64_t>(ssl_error);
  19934. impl::wolfssl_last_error() = err.backend_code;
  19935. return -1;
  19936. }
  19937. inline ssize_t write(session_t session, const void *buf, size_t len,
  19938. TlsError &err) {
  19939. if (!session || !buf) {
  19940. err.code = ErrorCode::Fatal;
  19941. return -1;
  19942. }
  19943. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19944. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19945. if (ret > 0) {
  19946. err.code = ErrorCode::Success;
  19947. return static_cast<ssize_t>(ret);
  19948. }
  19949. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19950. // Treat this as an error (return -1) so callers don't spin in a
  19951. // write loop adding zero to the offset.
  19952. if (ret == 0) {
  19953. err.code = ErrorCode::PeerClosed;
  19954. return -1;
  19955. }
  19956. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19957. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19958. err.backend_code = static_cast<uint64_t>(ssl_error);
  19959. impl::wolfssl_last_error() = err.backend_code;
  19960. return -1;
  19961. }
  19962. inline int pending(const_session_t session) {
  19963. if (!session) { return 0; }
  19964. auto wsession =
  19965. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19966. return wolfSSL_pending(wsession->ssl);
  19967. }
  19968. inline void shutdown(session_t session, bool graceful) {
  19969. if (!session) { return; }
  19970. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19971. if (graceful) {
  19972. int ret;
  19973. int attempts = 0;
  19974. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19975. attempts < 3) {
  19976. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19977. if (ssl_error != SSL_ERROR_WANT_READ &&
  19978. ssl_error != SSL_ERROR_WANT_WRITE) {
  19979. break;
  19980. }
  19981. attempts++;
  19982. }
  19983. } else {
  19984. wolfSSL_shutdown(wsession->ssl);
  19985. }
  19986. }
  19987. inline bool is_peer_closed(session_t session, socket_t sock) {
  19988. if (!session || sock == INVALID_SOCKET) { return true; }
  19989. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19990. // Check if there's already decrypted data available
  19991. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19992. // Set socket to non-blocking to avoid blocking on read
  19993. detail::set_nonblocking(sock, true);
  19994. auto cleanup =
  19995. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19996. // Peek 1 byte to check connection status without consuming data
  19997. unsigned char buf;
  19998. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19999. // If we got data or WANT_READ (would block), connection is alive
  20000. if (ret > 0) { return false; }
  20001. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20002. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  20003. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  20004. ret == 0;
  20005. }
  20006. inline cert_t get_peer_cert(const_session_t session) {
  20007. if (!session) { return nullptr; }
  20008. auto wsession =
  20009. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20010. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  20011. return static_cast<cert_t>(cert);
  20012. }
  20013. inline size_t get_peer_certs(const_session_t session,
  20014. std::vector<cert_t> &certs) {
  20015. certs.clear();
  20016. if (!session) { return 0; }
  20017. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  20018. #ifdef SESSION_CERTS
  20019. auto wsession =
  20020. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20021. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  20022. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  20023. for (int i = 0; i < count; i++) {
  20024. auto x509 = wolfSSL_get_chain_X509(chain, i);
  20025. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20026. }
  20027. #endif
  20028. return certs.size();
  20029. }
  20030. inline void free_cert(cert_t cert) {
  20031. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  20032. }
  20033. inline bool verify_hostname(cert_t cert, const char *hostname) {
  20034. if (!cert || !hostname) { return false; }
  20035. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20036. std::string host_str(hostname);
  20037. // Check if hostname is an IP address (IPv4 or IPv6)
  20038. unsigned char ip_bytes[16];
  20039. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  20040. auto is_ip = ip_len > 0;
  20041. // Check Subject Alternative Names
  20042. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20043. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20044. if (san_names) {
  20045. int san_count = wolfSSL_sk_num(san_names);
  20046. for (int i = 0; i < san_count; i++) {
  20047. auto *names =
  20048. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20049. if (!names) continue;
  20050. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  20051. // DNS name
  20052. unsigned char *dns_name = nullptr;
  20053. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  20054. if (dns_name && dns_len > 0) {
  20055. std::string san_name(reinterpret_cast<char *>(dns_name),
  20056. static_cast<size_t>(dns_len));
  20057. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20058. if (detail::match_hostname(san_name, host_str)) {
  20059. wolfSSL_sk_free(san_names);
  20060. return true;
  20061. }
  20062. }
  20063. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  20064. // IP address: only an iPAddress SAN of the same family (4 bytes for
  20065. // IPv4, 16 bytes for IPv6) may authenticate the host.
  20066. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  20067. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  20068. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  20069. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  20070. wolfSSL_sk_free(san_names);
  20071. return true;
  20072. }
  20073. }
  20074. }
  20075. wolfSSL_sk_free(san_names);
  20076. }
  20077. return false;
  20078. }
  20079. inline uint64_t hostname_mismatch_code() {
  20080. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  20081. }
  20082. inline long get_verify_result(const_session_t session) {
  20083. if (!session) { return -1; }
  20084. auto wsession =
  20085. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20086. long result = wolfSSL_get_verify_result(wsession->ssl);
  20087. return result;
  20088. }
  20089. inline std::string get_cert_subject_cn(cert_t cert) {
  20090. if (!cert) return "";
  20091. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20092. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20093. if (!subject) return "";
  20094. char cn[256] = {};
  20095. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  20096. sizeof(cn));
  20097. if (cn_len <= 0) return "";
  20098. return std::string(cn, static_cast<size_t>(cn_len));
  20099. }
  20100. inline std::string get_cert_issuer_name(cert_t cert) {
  20101. if (!cert) return "";
  20102. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20103. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  20104. if (!issuer) return "";
  20105. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  20106. if (!name_str) return "";
  20107. std::string result(name_str);
  20108. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20109. return result;
  20110. }
  20111. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  20112. sans.clear();
  20113. if (!cert) return false;
  20114. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20115. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20116. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20117. if (!san_names) return true; // No SANs is not an error
  20118. int count = wolfSSL_sk_num(san_names);
  20119. for (int i = 0; i < count; i++) {
  20120. auto *name =
  20121. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20122. if (!name) continue;
  20123. SanEntry entry;
  20124. switch (name->type) {
  20125. case WOLFSSL_GEN_DNS: {
  20126. entry.type = SanType::DNS;
  20127. unsigned char *dns_name = nullptr;
  20128. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  20129. if (dns_name && dns_len > 0) {
  20130. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  20131. static_cast<size_t>(dns_len));
  20132. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20133. }
  20134. break;
  20135. }
  20136. case WOLFSSL_GEN_IPADD: {
  20137. entry.type = SanType::IP;
  20138. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  20139. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  20140. if (ip_data && ip_len == 4) {
  20141. char buf[16];
  20142. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  20143. ip_data[2], ip_data[3]);
  20144. entry.value = buf;
  20145. } else if (ip_data && ip_len == 16) {
  20146. char buf[64];
  20147. snprintf(buf, sizeof(buf),
  20148. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  20149. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  20150. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  20151. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  20152. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  20153. ip_data[14], ip_data[15]);
  20154. entry.value = buf;
  20155. }
  20156. break;
  20157. }
  20158. case WOLFSSL_GEN_EMAIL:
  20159. entry.type = SanType::EMAIL;
  20160. {
  20161. unsigned char *email = nullptr;
  20162. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  20163. if (email && email_len > 0) {
  20164. entry.value = std::string(reinterpret_cast<char *>(email),
  20165. static_cast<size_t>(email_len));
  20166. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  20167. }
  20168. }
  20169. break;
  20170. case WOLFSSL_GEN_URI:
  20171. entry.type = SanType::URI;
  20172. {
  20173. unsigned char *uri = nullptr;
  20174. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  20175. &uri, name->d.uniformResourceIdentifier);
  20176. if (uri && uri_len > 0) {
  20177. entry.value = std::string(reinterpret_cast<char *>(uri),
  20178. static_cast<size_t>(uri_len));
  20179. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  20180. }
  20181. }
  20182. break;
  20183. default: entry.type = SanType::OTHER; break;
  20184. }
  20185. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  20186. }
  20187. wolfSSL_sk_free(san_names);
  20188. return true;
  20189. }
  20190. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  20191. time_t &not_after) {
  20192. if (!cert) return false;
  20193. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20194. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  20195. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  20196. if (!nb || !na) return false;
  20197. // wolfSSL_ASN1_TIME_to_tm is available
  20198. struct tm tm_nb = {}, tm_na = {};
  20199. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  20200. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  20201. #ifdef _WIN32
  20202. not_before = _mkgmtime(&tm_nb);
  20203. not_after = _mkgmtime(&tm_na);
  20204. #else
  20205. not_before = timegm(&tm_nb);
  20206. not_after = timegm(&tm_na);
  20207. #endif
  20208. return true;
  20209. }
  20210. inline std::string get_cert_serial(cert_t cert) {
  20211. if (!cert) return "";
  20212. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20213. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  20214. if (!serial_asn1) return "";
  20215. // Get the serial number data
  20216. int len = serial_asn1->length;
  20217. unsigned char *data = serial_asn1->data;
  20218. if (!data || len <= 0) return "";
  20219. std::string result;
  20220. result.reserve(static_cast<size_t>(len) * 2);
  20221. for (int i = 0; i < len; i++) {
  20222. char hex[3];
  20223. snprintf(hex, sizeof(hex), "%02X", data[i]);
  20224. result += hex;
  20225. }
  20226. return result;
  20227. }
  20228. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20229. if (!cert) return false;
  20230. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20231. int der_len = 0;
  20232. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  20233. if (!der_data || der_len <= 0) return false;
  20234. der.assign(der_data, der_data + der_len);
  20235. return true;
  20236. }
  20237. inline const char *get_sni(const_session_t session) {
  20238. if (!session) return nullptr;
  20239. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  20240. // For server: return SNI received from client during handshake
  20241. if (!wsession->sni_hostname.empty()) {
  20242. return wsession->sni_hostname.c_str();
  20243. }
  20244. // For client: return the hostname set via set_sni
  20245. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  20246. return nullptr;
  20247. }
  20248. inline uint64_t peek_error() {
  20249. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20250. }
  20251. inline uint64_t get_error() {
  20252. uint64_t err = impl::wolfssl_last_error();
  20253. impl::wolfssl_last_error() = 0;
  20254. return err;
  20255. }
  20256. inline std::string error_string(uint64_t code) {
  20257. char buf[256];
  20258. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20259. return std::string(buf);
  20260. }
  20261. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20262. if (!pem || len == 0) { return nullptr; }
  20263. // Validate by attempting to load into a temporary ctx
  20264. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20265. if (!tmp_ctx) { return nullptr; }
  20266. int ret = wolfSSL_CTX_load_verify_buffer(
  20267. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20268. static_cast<long>(len), SSL_FILETYPE_PEM);
  20269. wolfSSL_CTX_free(tmp_ctx);
  20270. if (ret != SSL_SUCCESS) { return nullptr; }
  20271. return static_cast<ca_store_t>(
  20272. new impl::WolfSSLCAStore{std::string(pem, len)});
  20273. }
  20274. inline void free_ca_store(ca_store_t store) {
  20275. delete static_cast<impl::WolfSSLCAStore *>(store);
  20276. }
  20277. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20278. if (!ctx || !store) { return false; }
  20279. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20280. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20281. int ret = wolfSSL_CTX_load_verify_buffer(
  20282. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20283. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20284. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20285. // This function takes ownership of the store; the PEM data was copied into
  20286. // the context, so release the source
  20287. free_ca_store(store);
  20288. return ret == SSL_SUCCESS;
  20289. }
  20290. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20291. certs.clear();
  20292. if (!ctx) { return 0; }
  20293. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20294. if (wctx->ca_pem_data_.empty()) { return 0; }
  20295. const std::string &pem = wctx->ca_pem_data_;
  20296. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20297. const std::string end_marker = "-----END CERTIFICATE-----";
  20298. size_t pos = 0;
  20299. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20300. size_t end_pos = pem.find(end_marker, pos);
  20301. if (end_pos == std::string::npos) { break; }
  20302. end_pos += end_marker.size();
  20303. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20304. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20305. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20306. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20307. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20308. pos = end_pos;
  20309. }
  20310. return certs.size();
  20311. }
  20312. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20313. std::vector<std::string> names;
  20314. if (!ctx) { return names; }
  20315. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20316. if (wctx->ca_pem_data_.empty()) { return names; }
  20317. const std::string &pem = wctx->ca_pem_data_;
  20318. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20319. const std::string end_marker = "-----END CERTIFICATE-----";
  20320. size_t pos = 0;
  20321. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20322. size_t end_pos = pem.find(end_marker, pos);
  20323. if (end_pos == std::string::npos) { break; }
  20324. end_pos += end_marker.size();
  20325. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20326. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20327. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20328. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20329. if (x509) {
  20330. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20331. if (subject) {
  20332. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20333. if (name_str) {
  20334. names.push_back(name_str);
  20335. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20336. }
  20337. }
  20338. wolfSSL_X509_free(x509);
  20339. }
  20340. pos = end_pos;
  20341. }
  20342. return names;
  20343. }
  20344. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20345. const char *key_pem, const char *password) {
  20346. if (!ctx || !cert_pem || !key_pem) { return false; }
  20347. // Try the pair on a scratch context first, so that a bad one leaves the
  20348. // server's certificate and key as they were
  20349. auto tmp = create_server_context();
  20350. if (!tmp) { return false; }
  20351. auto se = detail::scope_exit([&] { free_context(tmp); });
  20352. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20353. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20354. }
  20355. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20356. if (!ctx || !ca_pem) { return false; }
  20357. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20358. // Replace the CAs rather than add to them, as the other backends do, once
  20359. // the new ones are known to load
  20360. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20361. if (!store) { return false; }
  20362. free_ca_store(store);
  20363. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20364. wctx->ca_pem_data_.clear();
  20365. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20366. }
  20367. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20368. if (!ctx) { return false; }
  20369. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20370. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20371. : nullptr;
  20372. {
  20373. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20374. // A handshake running the previous callback keeps it until it returns.
  20375. wctx->verify_callback.swap(stored);
  20376. }
  20377. impl::apply_verify_mode(*wctx);
  20378. return true;
  20379. }
  20380. inline long get_verify_error(const_session_t session) {
  20381. if (!session) { return -1; }
  20382. auto *wsession =
  20383. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20384. return wolfSSL_get_verify_result(wsession->ssl);
  20385. }
  20386. inline std::string verify_error_string(long error_code) {
  20387. if (error_code == 0) { return ""; }
  20388. const char *str =
  20389. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20390. return str ? std::string(str) : std::string();
  20391. }
  20392. } // namespace tls
  20393. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20394. // WebSocket implementation
  20395. namespace ws {
  20396. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20397. bool fin) {
  20398. std::lock_guard<std::mutex> lock(write_mutex_);
  20399. if (closed_) { return false; }
  20400. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20401. }
  20402. inline ReadResult WebSocket::read(std::string &msg) {
  20403. // Answers a control frame; any other opcode here is a protocol error.
  20404. // Returns false when the connection is done.
  20405. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20406. switch (op) {
  20407. case Opcode::Ping: {
  20408. std::lock_guard<std::mutex> lock(write_mutex_);
  20409. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20410. payload.size(), true, !is_server_);
  20411. return true;
  20412. }
  20413. case Opcode::Pong: {
  20414. std::lock_guard<std::mutex> lock(ping_mutex_);
  20415. unacked_pings_ = 0;
  20416. return true;
  20417. }
  20418. case Opcode::Close: {
  20419. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20420. // malformed, which is answered with a protocol error instead.
  20421. if (closed_.exchange(true)) { return false; }
  20422. auto reply = payload;
  20423. if (!impl::is_valid_close_payload(payload)) {
  20424. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20425. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20426. }
  20427. std::lock_guard<std::mutex> lock(write_mutex_);
  20428. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20429. reply.size(), true, !is_server_);
  20430. return false;
  20431. }
  20432. default: closed_ = true; return false;
  20433. }
  20434. };
  20435. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20436. // A server going down closes the connection rather than wait on it: its
  20437. // listen() waits for this handler to return.
  20438. auto going_away = [&]() -> ReadResult {
  20439. read_lock.unlock();
  20440. close(CloseStatus::GoingAway, "server stopping");
  20441. return Fail;
  20442. };
  20443. // close() ends the read, even while the peer keeps sending fragments
  20444. while (!closed_) {
  20445. Opcode opcode;
  20446. std::string payload;
  20447. bool fin;
  20448. // While a message is assembled, only what is left of the limit, but room
  20449. // for a control frame, which may come between its fragments.
  20450. auto max_len =
  20451. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0 || message_kind_ == Fail
  20452. ? size_t(CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)
  20453. : (std::max)(size_t(125), CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20454. message_.size());
  20455. auto r = frames_.read(strm_, opcode, payload, fin, is_server_, max_len);
  20456. if (r != impl::FrameRead::Ok && server_stopping()) { return going_away(); }
  20457. // A timeout leaves what was read of the frame and of the message for the
  20458. // next read(), so the connection is still usable wherever it landed: hand
  20459. // control back without closing it. That is only useful to a caller who
  20460. // asked for the timeout; the compile-time default is a backstop against a
  20461. // peer gone quiet, and elapsing it closes the connection so a plain
  20462. // `while (ws.read(msg))` loop ends. A wait that a pong timeout cut short
  20463. // finds the connection closed.
  20464. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20465. return Timeout;
  20466. }
  20467. if (r != impl::FrameRead::Ok) {
  20468. closed_ = true;
  20469. return Fail;
  20470. }
  20471. auto continues = opcode == Opcode::Continuation;
  20472. if (opcode != Opcode::Text && opcode != Opcode::Binary && !continues) {
  20473. if (handle_control(opcode, payload)) { continue; }
  20474. return Fail;
  20475. }
  20476. // RFC 6455 5.4: a message is a Text or Binary frame and the continuation
  20477. // frames after it, with only control frames between them.
  20478. if (continues == (message_kind_ == Fail)) {
  20479. closed_ = true;
  20480. return Fail;
  20481. }
  20482. if (continues) {
  20483. message_ += payload;
  20484. } else {
  20485. message_ = std::move(payload);
  20486. message_kind_ = opcode == Opcode::Text ? Text : Binary;
  20487. }
  20488. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20489. message_.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20490. closed_ = true;
  20491. return Fail;
  20492. }
  20493. if (!fin) { continue; }
  20494. auto result = message_kind_;
  20495. msg = std::move(message_);
  20496. message_.clear();
  20497. message_kind_ = Fail;
  20498. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20499. if (result == Text && !impl::is_valid_utf8(msg)) {
  20500. // close() takes the read lock to wait for the peer's Close reply, so
  20501. // it must not run while this thread still holds it.
  20502. read_lock.unlock();
  20503. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20504. return Fail;
  20505. }
  20506. return result;
  20507. }
  20508. return Fail;
  20509. }
  20510. inline bool WebSocket::send(const std::string &data) {
  20511. return send_frame(Opcode::Text, data.data(), data.size());
  20512. }
  20513. inline bool WebSocket::send(const char *data, size_t len) {
  20514. return send_frame(Opcode::Binary, data, len);
  20515. }
  20516. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20517. if (closed_.exchange(true)) { return; }
  20518. ping_cv_.notify_all();
  20519. std::string payload;
  20520. auto code = static_cast<uint16_t>(status);
  20521. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20522. payload.push_back(static_cast<char>(code & 0xFF));
  20523. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20524. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20525. // cut back to a whole UTF-8 character
  20526. auto short_reason = reason.substr(0, 123);
  20527. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20528. short_reason.pop_back();
  20529. }
  20530. payload += short_reason;
  20531. // A code that may not be sent, such as NoStatus, goes without a payload
  20532. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20533. {
  20534. std::lock_guard<std::mutex> lock(write_mutex_);
  20535. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20536. payload.size(), true, !is_server_);
  20537. }
  20538. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20539. // Close response before closing the TCP connection.
  20540. //
  20541. // Wait only when no other thread is parsing frames. When one is, it is the
  20542. // thread positioned to see the peer's reply, and reading here would take
  20543. // bytes out of the message it is assembling. Bailing out also leaves the
  20544. // stream, including its read timeout, entirely to that thread.
  20545. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20546. if (!read_lock.owns_lock()) { return; }
  20547. // A max timeout turns a negative (unbounded) read timeout into 0
  20548. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20549. strm_.set_max_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND * 1000);
  20550. // The max timeout cuts a trickled frame short, the deadline a frame flood
  20551. auto deadline =
  20552. detail::deadline_after(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20553. // From where the last read() left the stream, inside a frame as it may be
  20554. Opcode op;
  20555. std::string resp;
  20556. bool fin;
  20557. while (std::chrono::steady_clock::now() < deadline &&
  20558. frames_.read(strm_, op, resp, fin, is_server_, 125) ==
  20559. impl::FrameRead::Ok) {
  20560. if (op == Opcode::Close) { break; }
  20561. }
  20562. }
  20563. inline WebSocket::~WebSocket() {
  20564. {
  20565. std::lock_guard<std::mutex> lock(ping_mutex_);
  20566. closed_ = true;
  20567. }
  20568. ping_cv_.notify_all();
  20569. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20570. // A server's stream outlives this object
  20571. strm_.set_read_interrupt(nullptr);
  20572. }
  20573. // A pong timeout ends a read() blocked on the silent peer, and so does the
  20574. // server stopping: its listen() waits for every handler to return.
  20575. inline void WebSocket::interrupt_reads() {
  20576. auto watches_pongs = ping_interval_sec_ > 0 && max_missed_pongs_ > 0;
  20577. if (!watches_pongs && !server_stopping_) { return; }
  20578. strm_.set_read_interrupt(
  20579. [this] { return pong_timed_out_.load() || server_stopping(); });
  20580. }
  20581. inline void WebSocket::start_heartbeat() {
  20582. if (ping_interval_sec_ <= 0) { return; }
  20583. ping_thread_ = std::thread([this]() {
  20584. std::unique_lock<std::mutex> lock(ping_mutex_);
  20585. // The predicate keeps a spurious wakeup from sending a ping early
  20586. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20587. [this]() { return closed_.load(); })) {
  20588. // If the peer has failed to respond to the previous pings, give up.
  20589. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20590. // opt-in liveness check controlled by max_missed_pongs_.
  20591. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20592. lock.unlock();
  20593. close(CloseStatus::GoingAway, "pong timeout");
  20594. pong_timed_out_ = true;
  20595. return;
  20596. }
  20597. lock.unlock();
  20598. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20599. lock.lock();
  20600. closed_ = true;
  20601. break;
  20602. }
  20603. lock.lock();
  20604. unacked_pings_++;
  20605. }
  20606. });
  20607. }
  20608. inline const Request &WebSocket::request() const { return req_; }
  20609. inline bool WebSocket::is_open() const { return !closed_; }
  20610. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20611. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20612. // poll(), where 0 would instead mean "return immediately", so hand it the
  20613. // negative poll uses for an unbounded wait.
  20614. if (sec == 0 && usec == 0) { sec = -1; }
  20615. strm_.set_read_timeout(sec, usec);
  20616. read_timeout_set_ = true;
  20617. }
  20618. // WebSocketClient implementation
  20619. inline WebSocketClient::WebSocketClient(
  20620. const std::string &scheme_host_port_path, const Headers &headers)
  20621. : headers_(headers) {
  20622. detail::UrlComponents uc;
  20623. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20624. !uc.host.empty() && !uc.path.empty()) {
  20625. auto &scheme = uc.scheme;
  20626. #ifdef CPPHTTPLIB_SSL_ENABLED
  20627. if (scheme != "ws" && scheme != "wss") {
  20628. #else
  20629. if (scheme != "ws") {
  20630. #endif
  20631. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20632. std::string msg = "'" + scheme + "' scheme is not supported.";
  20633. throw std::invalid_argument(msg);
  20634. #endif
  20635. return;
  20636. }
  20637. auto is_ssl = scheme == "wss";
  20638. host_ = std::move(uc.host);
  20639. port_ = is_ssl ? 443 : 80;
  20640. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20641. path_ = std::move(uc.path);
  20642. if (!uc.query.empty()) { path_ += uc.query; }
  20643. #ifdef CPPHTTPLIB_SSL_ENABLED
  20644. is_ssl_ = is_ssl;
  20645. if (is_ssl_) {
  20646. // The context lives as long as the client so that CA configuration
  20647. // survives reconnects; sessions are created per connection.
  20648. tls_ctx_ = tls::create_client_context();
  20649. if (!tls_ctx_) { return; }
  20650. }
  20651. #else
  20652. if (is_ssl) { return; }
  20653. #endif
  20654. is_valid_ = true;
  20655. }
  20656. }
  20657. #ifdef CPPHTTPLIB_SSL_ENABLED
  20658. inline WebSocketClient::WebSocketClient(
  20659. const std::string &scheme_host_port_path, const PemMemory &pem,
  20660. const Headers &headers)
  20661. : WebSocketClient(scheme_host_port_path, headers) {
  20662. // For ws:// URLs the client certificate is silently ignored, consistent
  20663. // with the TLS-only setters such as set_ca_cert_path().
  20664. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20665. std::string cert_buf, key_buf;
  20666. if (!tls::set_client_cert_pem(
  20667. tls_ctx_,
  20668. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20669. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20670. pem.private_key_password)) {
  20671. tls::free_context(tls_ctx_);
  20672. tls_ctx_ = nullptr;
  20673. is_valid_ = false;
  20674. }
  20675. }
  20676. }
  20677. #endif
  20678. inline WebSocketClient::~WebSocketClient() {
  20679. shutdown_and_close();
  20680. #ifdef CPPHTTPLIB_SSL_ENABLED
  20681. if (tls_ctx_) {
  20682. tls::free_context(tls_ctx_);
  20683. tls_ctx_ = nullptr;
  20684. }
  20685. #endif
  20686. }
  20687. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20688. inline void WebSocketClient::shutdown_and_close() {
  20689. // Send the close frame while the TLS session is still alive: ws_ holds an
  20690. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20691. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20692. if (ws_ && ws_->is_open()) { ws_->close(); }
  20693. ws_.reset();
  20694. #ifdef CPPHTTPLIB_SSL_ENABLED
  20695. if (is_ssl_) {
  20696. if (tls_session_) {
  20697. tls::shutdown(tls_session_, true);
  20698. tls::free_session(tls_session_);
  20699. tls_session_ = nullptr;
  20700. }
  20701. }
  20702. #endif
  20703. if (sock_ != INVALID_SOCKET) {
  20704. detail::shutdown_socket(sock_);
  20705. detail::close_socket(sock_);
  20706. sock_ = INVALID_SOCKET;
  20707. }
  20708. }
  20709. // The handshakes belong to establishing the connection, so an unset read
  20710. // timeout leaves them bounded by the connection timeout instead of forever.
  20711. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20712. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20713. return {connection_timeout_sec_, connection_timeout_usec_};
  20714. }
  20715. return {read_timeout_sec_, read_timeout_usec_};
  20716. }
  20717. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20718. Error &error, int &ssl_error,
  20719. uint64_t &ssl_backend_error) {
  20720. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20721. // The streams wait with poll(), where 0 instead means "return immediately",
  20722. // so they are given the negative poll uses for an unbounded wait.
  20723. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20724. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20725. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20726. #ifdef CPPHTTPLIB_SSL_ENABLED
  20727. if (is_ssl_) {
  20728. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20729. // is not safe to call concurrently on one client to begin with, since
  20730. // nothing else here is guarded either.
  20731. if (server_certificate_verification_ && !certs_loaded_) {
  20732. uint64_t backend_error = 0;
  20733. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20734. ca_cert_dir_path_, custom_ca_loaded_,
  20735. system_ca_mode_, backend_error);
  20736. certs_loaded_ = true;
  20737. }
  20738. detail::ClientTlsSessionOptions options;
  20739. options.server_hostname_verification = server_hostname_verification_;
  20740. options.session_verifier = session_verifier_;
  20741. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  20742. options.windows_cert_verification = detail::use_windows_cert_verification(
  20743. enable_windows_cert_verification_, ca_cert_file_path_,
  20744. ca_cert_dir_path_, custom_ca_loaded_, system_ca_mode_);
  20745. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  20746. #endif
  20747. auto timeout = handshake_timeout();
  20748. detail::ClientTlsSessionError tls_error;
  20749. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20750. server_certificate_verification_,
  20751. timeout.first, timeout.second,
  20752. &tls_error, options)) {
  20753. error = tls_error.error;
  20754. ssl_error = tls_error.ssl_error;
  20755. ssl_backend_error = tls_error.backend_error;
  20756. return false;
  20757. }
  20758. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20759. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20760. write_timeout_usec_));
  20761. return true;
  20762. }
  20763. #else
  20764. (void)error;
  20765. (void)ssl_error;
  20766. (void)ssl_backend_error;
  20767. #endif
  20768. strm = std::unique_ptr<Stream>(
  20769. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20770. write_timeout_sec_, write_timeout_usec_));
  20771. return true;
  20772. }
  20773. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20774. #ifdef CPPHTTPLIB_SSL_ENABLED
  20775. auto is_ssl = is_ssl_;
  20776. #else
  20777. auto is_ssl = false;
  20778. #endif
  20779. if (!req.has_header("Host")) {
  20780. req.headers.emplace("Host", detail::make_default_host_header_value(
  20781. host_, port_, is_ssl, address_family_));
  20782. }
  20783. detail::add_default_user_agent_header(req);
  20784. detail::add_authorization_header(req, basic_auth_username_,
  20785. basic_auth_password_,
  20786. bearer_token_auth_token_, false);
  20787. }
  20788. inline Result WebSocketClient::connect() {
  20789. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20790. shutdown_and_close();
  20791. auto error = Error::Success;
  20792. if (!create_and_connect_socket(error)) {
  20793. return Result{error, -1, Headers{}};
  20794. }
  20795. if (is_proxy_enabled()) {
  20796. Response proxy_res;
  20797. if (!connect_with_proxy(proxy_res, error)) {
  20798. shutdown_and_close();
  20799. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20800. }
  20801. }
  20802. std::unique_ptr<Stream> strm;
  20803. auto stream_error = Error::SSLConnection;
  20804. int ssl_error = 0;
  20805. uint64_t ssl_backend_error = 0;
  20806. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20807. shutdown_and_close();
  20808. #ifdef CPPHTTPLIB_SSL_ENABLED
  20809. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20810. #else
  20811. return Result{stream_error, -1, Headers{}};
  20812. #endif
  20813. }
  20814. Request req;
  20815. req.method = "GET";
  20816. req.path = path_;
  20817. req.headers = headers_;
  20818. prepare_default_headers(req);
  20819. detail::WebSocketUpgradeResponse upgrade;
  20820. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20821. shutdown_and_close();
  20822. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20823. }
  20824. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20825. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20826. websocket_ping_interval_sec_,
  20827. websocket_max_missed_pongs_));
  20828. // The stream was created with the timeout already; tell the WebSocket
  20829. // whether it came from the caller, so read() knows to report it as Timeout.
  20830. ws_->read_timeout_set_ = read_timeout_set_;
  20831. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20832. }
  20833. inline ReadResult WebSocketClient::read(std::string &msg) {
  20834. if (!ws_) { return Fail; }
  20835. return ws_->read(msg);
  20836. }
  20837. inline bool WebSocketClient::send(const std::string &data) {
  20838. if (!ws_) { return false; }
  20839. return ws_->send(data);
  20840. }
  20841. inline bool WebSocketClient::send(const char *data, size_t len) {
  20842. if (!ws_) { return false; }
  20843. return ws_->send(data, len);
  20844. }
  20845. inline void WebSocketClient::close(CloseStatus status,
  20846. const std::string &reason) {
  20847. if (ws_) { ws_->close(status, reason); }
  20848. }
  20849. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20850. inline const std::string &WebSocketClient::subprotocol() const {
  20851. return subprotocol_;
  20852. }
  20853. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20854. read_timeout_sec_ = sec;
  20855. read_timeout_usec_ = usec;
  20856. read_timeout_set_ = true;
  20857. // The members above only seed the next connect(); read() consults the
  20858. // stream, so an already-open connection has to be told directly.
  20859. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20860. }
  20861. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20862. write_timeout_sec_ = sec;
  20863. write_timeout_usec_ = usec;
  20864. }
  20865. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20866. websocket_ping_interval_sec_ = sec;
  20867. }
  20868. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20869. websocket_max_missed_pongs_ = count;
  20870. }
  20871. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20872. inline void WebSocketClient::set_address_family(int family) {
  20873. address_family_ = family;
  20874. }
  20875. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20876. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20877. socket_options_ = std::move(socket_options);
  20878. }
  20879. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20880. connection_timeout_sec_ = sec;
  20881. connection_timeout_usec_ = usec;
  20882. }
  20883. inline void WebSocketClient::set_interface(const std::string &intf) {
  20884. interface_ = intf;
  20885. }
  20886. inline void WebSocketClient::set_hostname_addr_map(
  20887. std::map<std::string, std::string> addr_map) {
  20888. set_direct_hostname_addr_map(std::move(addr_map));
  20889. }
  20890. inline void WebSocketClient::set_direct_hostname_addr_map(
  20891. std::map<std::string, std::string> addr_map) {
  20892. addr_map_ = std::move(addr_map);
  20893. }
  20894. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  20895. std::map<std::string, std::string> addr_map) {
  20896. tunnel_addr_map_ = std::move(addr_map);
  20897. }
  20898. inline bool WebSocketClient::is_proxy_enabled() const {
  20899. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20900. if (no_proxy_entries_.empty()) { return true; }
  20901. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20902. no_proxy_entries_);
  20903. }
  20904. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20905. std::string connect_host;
  20906. std::string ip;
  20907. auto port = port_;
  20908. if (is_proxy_enabled()) {
  20909. connect_host = proxy_host_;
  20910. port = proxy_port_;
  20911. } else {
  20912. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20913. }
  20914. sock_ = detail::create_client_socket(
  20915. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20916. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20917. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20918. write_timeout_usec_, interface_, error);
  20919. if (sock_ != INVALID_SOCKET) { return true; }
  20920. if (error == Error::Success) { error = Error::Connection; }
  20921. return false;
  20922. }
  20923. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20924. Response &proxy_res,
  20925. Error &error) {
  20926. auto timeout = handshake_timeout();
  20927. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20928. write_timeout_sec_, write_timeout_usec_);
  20929. if (!detail::write_request_head(strm, req, error)) { return false; }
  20930. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20931. error = Error::Read;
  20932. return false;
  20933. }
  20934. return true;
  20935. }
  20936. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20937. // forward an Upgrade request.
  20938. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20939. Error &error) {
  20940. Request req;
  20941. req.method = "CONNECT";
  20942. req.path =
  20943. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  20944. req.headers.emplace("Host", req.path);
  20945. detail::add_default_user_agent_header(req);
  20946. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20947. proxy_basic_auth_password_,
  20948. proxy_bearer_token_auth_token_, true);
  20949. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20950. #ifdef CPPHTTPLIB_SSL_ENABLED
  20951. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20952. std::map<std::string, std::string> auth;
  20953. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20954. !proxy_digest_auth_username_.empty() &&
  20955. !proxy_digest_auth_password_.empty() &&
  20956. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20957. proxy_res = Response();
  20958. shutdown_and_close();
  20959. if (!create_and_connect_socket(error)) { return false; }
  20960. req.headers.erase("Proxy-Authorization");
  20961. req.headers.insert(detail::make_digest_authentication_header(
  20962. req, req.path, auth, 1, detail::random_string(10),
  20963. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20964. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20965. }
  20966. #endif
  20967. if (proxy_res.status != StatusCode::OK_200) {
  20968. error = Error::ProxyConnection;
  20969. return false;
  20970. }
  20971. return true;
  20972. }
  20973. inline void WebSocketClient::set_basic_auth(const std::string &username,
  20974. const std::string &password) {
  20975. basic_auth_username_ = username;
  20976. basic_auth_password_ = password;
  20977. }
  20978. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  20979. bearer_token_auth_token_ = token;
  20980. }
  20981. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20982. proxy_host_ = host;
  20983. proxy_port_ = port;
  20984. }
  20985. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20986. const std::string &password) {
  20987. proxy_basic_auth_username_ = username;
  20988. proxy_basic_auth_password_ = password;
  20989. }
  20990. inline void
  20991. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20992. proxy_bearer_token_auth_token_ = token;
  20993. }
  20994. inline void
  20995. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20996. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20997. }
  20998. #ifdef CPPHTTPLIB_SSL_ENABLED
  20999. inline void
  21000. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  21001. const std::string &ca_cert_dir_path) {
  21002. ca_cert_file_path_ = ca_cert_file_path;
  21003. ca_cert_dir_path_ = ca_cert_dir_path;
  21004. }
  21005. inline void
  21006. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  21007. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21008. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  21009. #endif
  21010. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  21011. }
  21012. inline void WebSocketClient::set_session_verifier(
  21013. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  21014. session_verifier_ = std::move(verifier);
  21015. }
  21016. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  21017. if (store && tls_ctx_) {
  21018. // set_ca_store takes ownership of store
  21019. tls::set_ca_store(tls_ctx_, store);
  21020. } else if (store) {
  21021. tls::free_ca_store(store);
  21022. }
  21023. custom_ca_loaded_ = true;
  21024. }
  21025. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  21026. std::size_t size) {
  21027. if (tls_ctx_ && ca_cert && size > 0) {
  21028. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  21029. }
  21030. custom_ca_loaded_ = true;
  21031. }
  21032. inline void
  21033. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  21034. server_certificate_verification_ = enabled;
  21035. }
  21036. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  21037. server_hostname_verification_ = enabled;
  21038. }
  21039. inline void WebSocketClient::enable_system_ca(bool enabled) {
  21040. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  21041. }
  21042. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21043. inline void
  21044. WebSocketClient::enable_windows_certificate_verification(bool enabled) {
  21045. enable_windows_cert_verification_ = enabled;
  21046. }
  21047. #endif
  21048. inline void
  21049. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  21050. const std::string &password) {
  21051. proxy_digest_auth_username_ = username;
  21052. proxy_digest_auth_password_ = password;
  21053. }
  21054. #endif // CPPHTTPLIB_SSL_ENABLED
  21055. } // namespace ws
  21056. // ----------------------------------------------------------------------------
  21057. } // namespace httplib
  21058. #endif // CPPHTTPLIB_HTTPLIB_H