httplib.h 757 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452
  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.53.1"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003501"
  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. /*
  18. * Configuration
  19. */
  20. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  21. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  22. #endif
  23. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  24. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  25. #endif
  26. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  27. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  28. #endif
  29. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  30. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  31. #endif
  32. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  33. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  34. #endif
  35. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  36. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  37. #endif
  38. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  39. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  40. #endif
  41. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  42. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  43. #endif
  44. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  45. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  46. #endif
  47. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  48. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  49. #endif
  50. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  51. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  52. #endif
  53. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  54. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  55. #endif
  56. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  57. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  58. #endif
  59. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  60. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  61. #endif
  62. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  63. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  64. #endif
  65. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  66. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  67. #endif
  68. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  69. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  70. #endif
  71. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  72. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  73. #endif
  74. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  75. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  76. #endif
  77. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  78. #ifdef _WIN32
  79. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  80. #else
  81. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  82. #endif
  83. #endif
  84. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  85. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  86. #endif
  87. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  88. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  89. #endif
  90. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  91. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  92. #endif
  93. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  94. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  95. #endif
  96. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  97. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  98. #endif
  99. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  100. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  101. #endif
  102. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  103. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  104. #endif
  105. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  106. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  107. #endif
  108. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  109. // recurses roughly once per matched character for quantified patterns such
  110. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  111. // a default ~8MB thread stack that has been observed to take on the order of
  112. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  113. // margin below that (well under the 8192-byte request URI limit) while still
  114. // fitting any realistic route segment; raise it if a route legitimately needs
  115. // longer paths. Regex routes are never applied to paths longer than this.
  116. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  117. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  118. #endif
  119. #ifndef CPPHTTPLIB_TCP_NODELAY
  120. #define CPPHTTPLIB_TCP_NODELAY false
  121. #endif
  122. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  123. #define CPPHTTPLIB_IPV6_V6ONLY false
  124. #endif
  125. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  126. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  127. #endif
  128. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  129. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  130. #endif
  131. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  132. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  133. #endif
  134. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  135. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  136. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  137. ? std::thread::hardware_concurrency() - 1 \
  138. : 0))
  139. #endif
  140. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  141. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  142. #endif
  143. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  144. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  145. #endif
  146. #ifndef CPPHTTPLIB_RECV_FLAGS
  147. #define CPPHTTPLIB_RECV_FLAGS 0
  148. #endif
  149. #ifndef CPPHTTPLIB_SEND_FLAGS
  150. #define CPPHTTPLIB_SEND_FLAGS 0
  151. #endif
  152. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  153. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  154. #endif
  155. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  156. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  157. #endif
  158. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  159. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  160. #endif
  161. #ifndef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  162. #define CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND 300
  163. #endif
  164. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  165. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  166. #endif
  167. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  168. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  169. #endif
  170. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  171. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  172. #endif
  173. /*
  174. * Headers
  175. */
  176. #ifdef _WIN32
  177. #ifndef _CRT_SECURE_NO_WARNINGS
  178. #define _CRT_SECURE_NO_WARNINGS
  179. #endif //_CRT_SECURE_NO_WARNINGS
  180. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  181. #define _CRT_NONSTDC_NO_DEPRECATE
  182. #endif //_CRT_NONSTDC_NO_DEPRECATE
  183. #if defined(_MSC_VER)
  184. #if _MSC_VER < 1900
  185. #error Sorry, Visual Studio versions prior to 2015 are not supported
  186. #endif
  187. #pragma comment(lib, "ws2_32.lib")
  188. #ifndef _SSIZE_T_DEFINED
  189. using ssize_t = __int64;
  190. #define _SSIZE_T_DEFINED
  191. #endif
  192. #endif // _MSC_VER
  193. #ifndef S_ISREG
  194. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  195. #endif // S_ISREG
  196. #ifndef S_ISDIR
  197. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  198. #endif // S_ISDIR
  199. #ifndef NOMINMAX
  200. #define NOMINMAX
  201. #endif // NOMINMAX
  202. #include <io.h>
  203. #include <winsock2.h>
  204. #include <ws2tcpip.h>
  205. #if defined(__has_include)
  206. #if __has_include(<afunix.h>)
  207. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  208. #include <afunix.h>
  209. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  210. #endif
  211. #endif
  212. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  213. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  214. #endif
  215. using nfds_t = unsigned long;
  216. using socket_t = SOCKET;
  217. using socklen_t = int;
  218. #else // not _WIN32
  219. #include <arpa/inet.h>
  220. #if !defined(_AIX) && !defined(__MVS__)
  221. #include <ifaddrs.h>
  222. #endif
  223. #ifdef __MVS__
  224. #include <strings.h>
  225. #ifndef NI_MAXHOST
  226. #define NI_MAXHOST 1025
  227. #endif
  228. #endif
  229. #include <net/if.h>
  230. #include <netdb.h>
  231. #include <netinet/in.h>
  232. #ifdef __linux__
  233. #include <resolv.h>
  234. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  235. #endif
  236. #include <csignal>
  237. #include <netinet/tcp.h>
  238. #include <poll.h>
  239. #include <pthread.h>
  240. #include <sys/mman.h>
  241. #include <sys/socket.h>
  242. #include <sys/un.h>
  243. #include <unistd.h>
  244. using socket_t = int;
  245. #ifndef INVALID_SOCKET
  246. #define INVALID_SOCKET (-1)
  247. #endif
  248. #endif //_WIN32
  249. #if defined(__APPLE__)
  250. #include <TargetConditionals.h>
  251. #endif
  252. #include <algorithm>
  253. #include <array>
  254. #include <atomic>
  255. #include <cassert>
  256. #include <chrono>
  257. #include <climits>
  258. #include <condition_variable>
  259. #include <cstdlib>
  260. #include <cstring>
  261. #include <errno.h>
  262. #include <exception>
  263. #include <fcntl.h>
  264. #include <fstream>
  265. #include <functional>
  266. #include <iomanip>
  267. #include <iostream>
  268. #include <iterator>
  269. #include <list>
  270. #include <map>
  271. #include <memory>
  272. #include <mutex>
  273. #include <random>
  274. #include <regex>
  275. #include <set>
  276. #include <sstream>
  277. #include <string>
  278. #include <sys/stat.h>
  279. #include <system_error>
  280. #include <thread>
  281. #include <type_traits>
  282. #include <unordered_map>
  283. #include <unordered_set>
  284. #include <utility>
  285. #include <vector>
  286. // On macOS with a TLS backend, enable Keychain root certificates by default
  287. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  288. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  289. // only; on those platforms the user must provide a CA bundle explicitly.
  290. #if defined(__APPLE__) && defined(__clang__) && \
  291. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  292. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  293. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  294. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  295. #if TARGET_OS_OSX
  296. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  297. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  298. #endif
  299. #endif
  300. #endif
  301. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  302. defined(__APPLE__) && !TARGET_OS_OSX
  303. #error \
  304. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  305. #endif
  306. // On Windows, enable Schannel certificate verification by default
  307. // unless the user explicitly opts out.
  308. #if defined(_WIN32) && \
  309. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  310. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  311. #endif
  312. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  313. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  314. #if TARGET_OS_MAC && defined(__clang__)
  315. #include <CFNetwork/CFHost.h>
  316. #include <CoreFoundation/CoreFoundation.h>
  317. #endif
  318. #endif
  319. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  320. #ifdef _WIN32
  321. #include <wincrypt.h>
  322. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  323. // used
  324. #undef X509_NAME
  325. #undef X509_CERT_PAIR
  326. #undef X509_EXTENSIONS
  327. #undef PKCS7_SIGNER_INFO
  328. #ifdef _MSC_VER
  329. #pragma comment(lib, "crypt32.lib")
  330. #endif
  331. #endif // _WIN32
  332. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  333. #if TARGET_OS_OSX
  334. #include <Security/Security.h>
  335. #endif
  336. #endif
  337. #include <openssl/err.h>
  338. #include <openssl/evp.h>
  339. #include <openssl/ssl.h>
  340. #include <openssl/x509v3.h>
  341. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  342. #include <openssl/applink.c>
  343. #endif
  344. #include <iostream>
  345. #include <sstream>
  346. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  347. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  348. #error Please use OpenSSL or a current version of BoringSSL
  349. #endif
  350. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  351. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  352. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  353. #endif
  354. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  355. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  356. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  357. // in with this first include group so the version gating below can use it.
  358. #include <mbedtls/error.h>
  359. #include <mbedtls/net_sockets.h>
  360. #include <mbedtls/oid.h>
  361. #include <mbedtls/pk.h>
  362. #include <mbedtls/ssl.h>
  363. #include <mbedtls/version.h>
  364. #include <mbedtls/x509_crt.h>
  365. #if MBEDTLS_VERSION_MAJOR >= 4
  366. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  367. #include <psa/crypto.h>
  368. #else
  369. #include <mbedtls/ctr_drbg.h>
  370. #include <mbedtls/entropy.h>
  371. #include <mbedtls/md5.h>
  372. #include <mbedtls/sha1.h>
  373. #include <mbedtls/sha256.h>
  374. #include <mbedtls/sha512.h>
  375. #endif
  376. #ifdef _WIN32
  377. #include <wincrypt.h>
  378. #ifdef _MSC_VER
  379. #pragma comment(lib, "crypt32.lib")
  380. #endif
  381. #endif // _WIN32
  382. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  383. #if TARGET_OS_OSX
  384. #include <Security/Security.h>
  385. #endif
  386. #endif
  387. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  388. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  389. #if MBEDTLS_VERSION_MAJOR >= 4
  390. #define CPPHTTPLIB_MBEDTLS_V4
  391. #endif
  392. #if MBEDTLS_VERSION_MAJOR >= 3
  393. #define CPPHTTPLIB_MBEDTLS_V3
  394. #endif
  395. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  396. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  397. #include <wolfssl/options.h>
  398. #include <wolfssl/openssl/x509v3.h>
  399. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  400. #ifndef WOLFSSL_GEN_EMAIL
  401. #define WOLFSSL_GEN_EMAIL 1
  402. #endif
  403. #ifndef WOLFSSL_GEN_DNS
  404. #define WOLFSSL_GEN_DNS 2
  405. #endif
  406. #ifndef WOLFSSL_GEN_URI
  407. #define WOLFSSL_GEN_URI 6
  408. #endif
  409. #ifndef WOLFSSL_GEN_IPADD
  410. #define WOLFSSL_GEN_IPADD 7
  411. #endif
  412. #include <wolfssl/ssl.h>
  413. #include <wolfssl/wolfcrypt/hash.h>
  414. #include <wolfssl/wolfcrypt/md5.h>
  415. #include <wolfssl/wolfcrypt/sha256.h>
  416. #include <wolfssl/wolfcrypt/sha512.h>
  417. #ifdef _WIN32
  418. #include <wincrypt.h>
  419. #ifdef _MSC_VER
  420. #pragma comment(lib, "crypt32.lib")
  421. #endif
  422. #endif // _WIN32
  423. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  424. #if TARGET_OS_OSX
  425. #include <Security/Security.h>
  426. #endif
  427. #endif
  428. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  429. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  430. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  431. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  432. #define CPPHTTPLIB_SSL_ENABLED
  433. #endif
  434. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  435. #include <zlib.h>
  436. #endif
  437. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  438. #include <brotli/decode.h>
  439. #include <brotli/encode.h>
  440. #endif
  441. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  442. #include <zstd.h>
  443. #endif
  444. /*
  445. * Declaration
  446. */
  447. namespace httplib {
  448. namespace ws {
  449. class WebSocket;
  450. } // namespace ws
  451. namespace detail {
  452. /*
  453. * Backport std::make_unique from C++14.
  454. *
  455. * NOTE: This code came up with the following stackoverflow post:
  456. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  457. *
  458. */
  459. template <class T, class... Args>
  460. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  461. make_unique(Args &&...args) {
  462. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  463. }
  464. template <class T>
  465. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  466. make_unique(std::size_t n) {
  467. typedef typename std::remove_extent<T>::type RT;
  468. return std::unique_ptr<T>(new RT[n]);
  469. }
  470. // Locale-independent ASCII character classification. The <cctype>
  471. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  472. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  473. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  474. // classified without regard to the locale.
  475. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  476. inline bool is_ascii_alpha(char c) {
  477. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  478. }
  479. inline bool is_ascii_alnum(char c) {
  480. return is_ascii_digit(c) || is_ascii_alpha(c);
  481. }
  482. namespace case_ignore {
  483. inline unsigned char to_lower(int c) {
  484. const static unsigned char table[256] = {
  485. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  486. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  487. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  488. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  489. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  490. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  491. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  492. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  493. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  494. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  495. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  496. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  497. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  498. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  499. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  500. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  501. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  502. 255,
  503. };
  504. return table[(unsigned char)(char)c];
  505. }
  506. inline std::string to_lower(const std::string &s) {
  507. std::string result = s;
  508. std::transform(
  509. result.begin(), result.end(), result.begin(),
  510. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  511. return result;
  512. }
  513. inline bool equal(const std::string &a, const std::string &b) {
  514. return a.size() == b.size() &&
  515. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  516. return to_lower(ca) == to_lower(cb);
  517. });
  518. }
  519. struct equal_to {
  520. bool operator()(const std::string &a, const std::string &b) const {
  521. return equal(a, b);
  522. }
  523. };
  524. struct hash {
  525. size_t operator()(const std::string &key) const {
  526. return hash_core(key.data(), key.size(), 0);
  527. }
  528. size_t hash_core(const char *s, size_t l, size_t h) const {
  529. return (l == 0) ? h
  530. : hash_core(s + 1, l - 1,
  531. // Unsets the 6 high bits of h, therefore no
  532. // overflow happens
  533. (((std::numeric_limits<size_t>::max)() >> 6) &
  534. h * 33) ^
  535. static_cast<unsigned char>(to_lower(*s)));
  536. }
  537. };
  538. template <typename T>
  539. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  540. detail::case_ignore::equal_to>;
  541. } // namespace case_ignore
  542. // This is based on
  543. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  544. struct scope_exit {
  545. explicit scope_exit(std::function<void(void)> &&f)
  546. : exit_function(std::move(f)), execute_on_destruction{true} {}
  547. scope_exit(scope_exit &&rhs) noexcept
  548. : exit_function(std::move(rhs.exit_function)),
  549. execute_on_destruction{rhs.execute_on_destruction} {
  550. rhs.release();
  551. }
  552. ~scope_exit() {
  553. if (execute_on_destruction) { this->exit_function(); }
  554. }
  555. void release() { this->execute_on_destruction = false; }
  556. private:
  557. scope_exit(const scope_exit &) = delete;
  558. void operator=(const scope_exit &) = delete;
  559. scope_exit &operator=(scope_exit &&) = delete;
  560. std::function<void(void)> exit_function;
  561. bool execute_on_destruction;
  562. };
  563. // Simple from_chars implementation for integer and double types (C++17
  564. // substitute)
  565. template <typename T> struct from_chars_result {
  566. const char *ptr;
  567. std::errc ec;
  568. };
  569. template <typename T>
  570. inline from_chars_result<T> from_chars(const char *first, const char *last,
  571. T &value, int base = 10) {
  572. value = 0;
  573. const char *p = first;
  574. bool negative = false;
  575. if (p != last && *p == '-') {
  576. negative = true;
  577. ++p;
  578. }
  579. if (p == last) { return {first, std::errc::invalid_argument}; }
  580. T result = 0;
  581. for (; p != last; ++p) {
  582. char c = *p;
  583. int digit = -1;
  584. if (is_ascii_digit(c)) {
  585. digit = c - '0';
  586. } else if ('a' <= c && c <= 'z') {
  587. digit = c - 'a' + 10;
  588. } else if ('A' <= c && c <= 'Z') {
  589. digit = c - 'A' + 10;
  590. } else {
  591. break;
  592. }
  593. if (digit < 0 || digit >= base) { break; }
  594. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  595. return {p, std::errc::result_out_of_range};
  596. }
  597. result = result * base + digit;
  598. }
  599. if (p == first || (negative && p == first + 1)) {
  600. return {first, std::errc::invalid_argument};
  601. }
  602. value = negative ? T(0) - result : result;
  603. return {p, std::errc{}};
  604. }
  605. // from_chars for double (hand-written, locale-independent)
  606. //
  607. // The only double consumed by this library is the HTTP quality value, whose
  608. // grammar is (RFC 9110 12.4.2):
  609. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  610. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  611. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  612. // '.' always the decimal separator (std::strtod would instead read it from the
  613. // global C locale, mis-parsing q-values once an embedder calls
  614. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  615. // the result to [0, 1], so inputs outside that range need not be distinguished
  616. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  617. // cases that exponent and wide-range handling would introduce.
  618. inline from_chars_result<double> from_chars(const char *first, const char *last,
  619. double &value) {
  620. value = 0.0;
  621. const char *p = first;
  622. // Each 1eN is exactly representable, so a single final division by the
  623. // matching entry yields a correctly-rounded result.
  624. static const double powers_of_ten[] = {
  625. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  626. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  627. const int max_frac_digits =
  628. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  629. // Accumulate digits into a 64-bit integer and remember how many were
  630. // fractional. Two independent caps keep this bounded and safe:
  631. // * accumulation saturates before mantissa could overflow uint64_t, and
  632. // * frac_digits is capped at max_frac_digits so it is always a valid index
  633. // into powers_of_ten (without this an input like "0.000...0" would never
  634. // grow mantissa, so the saturation cap alone would not bound it).
  635. // Both caps only drop digits far beyond the precision a q-value needs; any
  636. // value they would change is well outside [0, 1] and rejected by the caller.
  637. uint64_t mantissa = 0;
  638. int frac_digits = 0;
  639. bool seen_digit = false;
  640. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  641. auto accumulate = [&](char c) {
  642. if (mantissa <= limit) {
  643. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  644. return true;
  645. }
  646. return false;
  647. };
  648. for (; p != last && is_ascii_digit(*p); ++p) {
  649. seen_digit = true;
  650. accumulate(*p);
  651. }
  652. if (p != last && *p == '.') {
  653. ++p;
  654. for (; p != last && is_ascii_digit(*p); ++p) {
  655. seen_digit = true;
  656. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  657. }
  658. }
  659. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  660. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  661. return {p, std::errc{}};
  662. }
  663. inline bool parse_port(const char *s, size_t len, int &port) {
  664. int val = 0;
  665. auto r = from_chars(s, s + len, val);
  666. if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
  667. port = val;
  668. return true;
  669. }
  670. inline bool parse_port(const std::string &s, int &port) {
  671. return parse_port(s.data(), s.size(), port);
  672. }
  673. struct UrlComponents {
  674. std::string scheme;
  675. std::string host;
  676. std::string port;
  677. std::string path;
  678. std::string query;
  679. };
  680. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  681. uc = {};
  682. size_t pos = 0;
  683. auto sep = url.find("://");
  684. if (sep != std::string::npos) {
  685. uc.scheme = url.substr(0, sep);
  686. // Scheme must be [a-z]+ only
  687. if (uc.scheme.empty()) { return false; }
  688. for (auto c : uc.scheme) {
  689. if (c < 'a' || c > 'z') { return false; }
  690. }
  691. pos = sep + 3;
  692. } else if (url.compare(0, 2, "//") == 0) {
  693. pos = 2;
  694. }
  695. auto has_authority_prefix = pos > 0;
  696. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  697. url[0] != '?' && url[0] != '#');
  698. if (has_authority) {
  699. if (pos < url.size() && url[pos] == '[') {
  700. auto close = url.find(']', pos);
  701. if (close == std::string::npos) { return false; }
  702. uc.host = url.substr(pos + 1, close - pos - 1);
  703. // IPv6 host must be [a-fA-F0-9:]+ only
  704. if (uc.host.empty()) { return false; }
  705. for (auto c : uc.host) {
  706. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  707. (c >= 'A' && c <= 'F') || c == ':')) {
  708. return false;
  709. }
  710. }
  711. pos = close + 1;
  712. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  713. // path, query or fragment delimiter (or the end of input). Otherwise the
  714. // trailing bytes would be folded into the path while the connection
  715. // still targets the bracketed address.
  716. if (pos < url.size()) {
  717. auto c = url[pos];
  718. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  719. }
  720. } else {
  721. auto end = url.find_first_of(":/?#", pos);
  722. if (end == std::string::npos) { end = url.size(); }
  723. uc.host = url.substr(pos, end - pos);
  724. pos = end;
  725. }
  726. if (pos < url.size() && url[pos] == ':') {
  727. ++pos;
  728. auto end = url.find_first_of("/?#", pos);
  729. if (end == std::string::npos) { end = url.size(); }
  730. uc.port = url.substr(pos, end - pos);
  731. pos = end;
  732. }
  733. // Without :// or //, the entire input must be consumed as host[:port].
  734. // If there is leftover (path, query, etc.), this is not a valid
  735. // host[:port] string — clear and reparse as a plain path.
  736. if (!has_authority_prefix && pos < url.size()) {
  737. uc.host.clear();
  738. uc.port.clear();
  739. pos = 0;
  740. }
  741. }
  742. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  743. auto end = url.find_first_of("?#", pos);
  744. if (end == std::string::npos) { end = url.size(); }
  745. uc.path = url.substr(pos, end - pos);
  746. pos = end;
  747. }
  748. if (pos < url.size() && url[pos] == '?') {
  749. auto end = url.find('#', pos);
  750. if (end == std::string::npos) { end = url.size(); }
  751. uc.query = url.substr(pos, end - pos);
  752. }
  753. return true;
  754. }
  755. } // namespace detail
  756. enum class SSLVerifierResponse {
  757. // no decision has been made, use the built-in certificate verifier
  758. NoDecisionMade,
  759. // connection certificate is verified and accepted
  760. CertificateAccepted,
  761. // connection certificate was processed but is rejected
  762. CertificateRejected
  763. };
  764. // System CA loading policy for SSL clients. Auto (the default) loads system
  765. // CA certs only when no custom CA is configured; enable_system_ca() switches
  766. // to an explicit policy.
  767. enum class SystemCAMode { Auto, Enabled, Disabled };
  768. enum StatusCode {
  769. // Information responses
  770. Continue_100 = 100,
  771. SwitchingProtocol_101 = 101,
  772. Processing_102 = 102,
  773. EarlyHints_103 = 103,
  774. // Successful responses
  775. OK_200 = 200,
  776. Created_201 = 201,
  777. Accepted_202 = 202,
  778. NonAuthoritativeInformation_203 = 203,
  779. NoContent_204 = 204,
  780. ResetContent_205 = 205,
  781. PartialContent_206 = 206,
  782. MultiStatus_207 = 207,
  783. AlreadyReported_208 = 208,
  784. IMUsed_226 = 226,
  785. // Redirection messages
  786. MultipleChoices_300 = 300,
  787. MovedPermanently_301 = 301,
  788. Found_302 = 302,
  789. SeeOther_303 = 303,
  790. NotModified_304 = 304,
  791. UseProxy_305 = 305,
  792. unused_306 = 306,
  793. TemporaryRedirect_307 = 307,
  794. PermanentRedirect_308 = 308,
  795. // Client error responses
  796. BadRequest_400 = 400,
  797. Unauthorized_401 = 401,
  798. PaymentRequired_402 = 402,
  799. Forbidden_403 = 403,
  800. NotFound_404 = 404,
  801. MethodNotAllowed_405 = 405,
  802. NotAcceptable_406 = 406,
  803. ProxyAuthenticationRequired_407 = 407,
  804. RequestTimeout_408 = 408,
  805. Conflict_409 = 409,
  806. Gone_410 = 410,
  807. LengthRequired_411 = 411,
  808. PreconditionFailed_412 = 412,
  809. PayloadTooLarge_413 = 413,
  810. UriTooLong_414 = 414,
  811. UnsupportedMediaType_415 = 415,
  812. RangeNotSatisfiable_416 = 416,
  813. ExpectationFailed_417 = 417,
  814. ImATeapot_418 = 418,
  815. MisdirectedRequest_421 = 421,
  816. UnprocessableContent_422 = 422,
  817. Locked_423 = 423,
  818. FailedDependency_424 = 424,
  819. TooEarly_425 = 425,
  820. UpgradeRequired_426 = 426,
  821. PreconditionRequired_428 = 428,
  822. TooManyRequests_429 = 429,
  823. RequestHeaderFieldsTooLarge_431 = 431,
  824. UnavailableForLegalReasons_451 = 451,
  825. // Server error responses
  826. InternalServerError_500 = 500,
  827. NotImplemented_501 = 501,
  828. BadGateway_502 = 502,
  829. ServiceUnavailable_503 = 503,
  830. GatewayTimeout_504 = 504,
  831. HttpVersionNotSupported_505 = 505,
  832. VariantAlsoNegotiates_506 = 506,
  833. InsufficientStorage_507 = 507,
  834. LoopDetected_508 = 508,
  835. NotExtended_510 = 510,
  836. NetworkAuthenticationRequired_511 = 511,
  837. };
  838. namespace detail {
  839. // A multimap that keeps its entries in the order they were inserted.
  840. //
  841. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  842. // fields sharing a field name significant and forbids a proxy from reordering
  843. // them, and a query string's parameters are meaningful in the order the caller
  844. // wrote them. Neither standard container expresses it: std::unordered_multimap
  845. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  846. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  847. // key, which would drop control data such as Host behind whatever else the
  848. // message carries and alphabetise a query string.
  849. //
  850. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  851. // scan, which beats hashing for the handful of entries a message carries
  852. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  853. //
  854. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  855. // Params, whose parameter names are case-sensitive, not.
  856. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  857. public:
  858. using key_type = std::string;
  859. using mapped_type = Mapped;
  860. using value_type = std::pair<std::string, Mapped>;
  861. using size_type = std::size_t;
  862. using difference_type = std::ptrdiff_t;
  863. using reference = value_type &;
  864. using const_reference = const value_type &;
  865. private:
  866. static size_type npos() { return static_cast<size_type>(-1); }
  867. static bool keys_equal(const std::string &a, const std::string &b) {
  868. return KeyEqual()(a, b);
  869. }
  870. // Iterating yields every entry in insertion order, but equal_range() and
  871. // find() have to walk only the entries sharing one key, which are not
  872. // adjacent. Both are the same iterator type: key_idx_ selects between the
  873. // two traversals, and since equality compares only the position, an iterator
  874. // restricted to one key still compares equal to end().
  875. template <typename V> class iterator_t {
  876. public:
  877. using iterator_category = std::bidirectional_iterator_tag;
  878. using value_type = insertion_ordered_multimap::value_type;
  879. using difference_type = insertion_ordered_multimap::difference_type;
  880. using pointer = V *;
  881. using reference = V &;
  882. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  883. template <typename U,
  884. typename std::enable_if<std::is_convertible<U *, V *>::value,
  885. int>::type = 0>
  886. iterator_t(const iterator_t<U> &rhs)
  887. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  888. key_idx_(rhs.key_idx_) {}
  889. reference operator*() const { return data_[idx_]; }
  890. pointer operator->() const { return data_ + idx_; }
  891. iterator_t &operator++() {
  892. // Saturating, so that advancing past the last entry of a key (which
  893. // get_multimap_value() does when asked for an out-of-range id) stays at
  894. // end() instead of running off the container.
  895. if (idx_ >= size_) { return *this; }
  896. ++idx_;
  897. if (key_idx_ != npos()) {
  898. while (idx_ < size_ && !matches(idx_)) {
  899. ++idx_;
  900. }
  901. }
  902. return *this;
  903. }
  904. iterator_t operator++(int) {
  905. auto tmp = *this;
  906. ++*this;
  907. return tmp;
  908. }
  909. iterator_t &operator--() {
  910. if (idx_ == 0) { return *this; }
  911. --idx_;
  912. if (key_idx_ != npos()) {
  913. while (idx_ > 0 && !matches(idx_)) {
  914. --idx_;
  915. }
  916. }
  917. return *this;
  918. }
  919. iterator_t operator--(int) {
  920. auto tmp = *this;
  921. --*this;
  922. return tmp;
  923. }
  924. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  925. return idx_ == rhs.idx_;
  926. }
  927. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  928. return idx_ != rhs.idx_;
  929. }
  930. private:
  931. friend class insertion_ordered_multimap;
  932. template <typename> friend class iterator_t;
  933. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  934. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  935. bool matches(size_type i) const {
  936. return keys_equal(data_[i].first, data_[key_idx_].first);
  937. }
  938. V *data_;
  939. size_type idx_;
  940. size_type size_;
  941. size_type key_idx_;
  942. };
  943. public:
  944. using iterator = iterator_t<value_type>;
  945. using const_iterator = iterator_t<const value_type>;
  946. insertion_ordered_multimap() = default;
  947. insertion_ordered_multimap(std::initializer_list<value_type> il)
  948. : entries_(il) {}
  949. template <typename InputIt>
  950. insertion_ordered_multimap(InputIt first, InputIt last)
  951. : entries_(first, last) {}
  952. iterator begin() { return make_iter(0, npos()); }
  953. iterator end() { return make_iter(entries_.size(), npos()); }
  954. const_iterator begin() const { return make_citer(0, npos()); }
  955. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  956. const_iterator cbegin() const { return begin(); }
  957. const_iterator cend() const { return end(); }
  958. bool empty() const { return entries_.empty(); }
  959. size_type size() const { return entries_.size(); }
  960. void clear() { entries_.clear(); }
  961. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  962. iterator insert(const value_type &val) {
  963. entries_.push_back(val);
  964. return make_iter(entries_.size() - 1, npos());
  965. }
  966. iterator insert(value_type &&val) {
  967. entries_.push_back(std::move(val));
  968. return make_iter(entries_.size() - 1, npos());
  969. }
  970. template <typename... Args> iterator emplace(Args &&...args) {
  971. entries_.emplace_back(std::forward<Args>(args)...);
  972. return make_iter(entries_.size() - 1, npos());
  973. }
  974. // For entries that have to lead the message, such as the Host header field
  975. // (RFC 9110 5.3 recommends sending control data first).
  976. template <typename... Args> iterator emplace_front(Args &&...args) {
  977. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  978. return make_iter(0, npos());
  979. }
  980. iterator find(const std::string &key) {
  981. auto i = index_of(key);
  982. return i == npos() ? end() : make_iter(i, i);
  983. }
  984. const_iterator find(const std::string &key) const {
  985. auto i = index_of(key);
  986. return i == npos() ? end() : make_citer(i, i);
  987. }
  988. size_type count(const std::string &key) const {
  989. size_type n = 0;
  990. for (const auto &entry : entries_) {
  991. if (keys_equal(entry.first, key)) { n++; }
  992. }
  993. return n;
  994. }
  995. std::pair<iterator, iterator> equal_range(const std::string &key) {
  996. auto i = index_of(key);
  997. return i == npos() ? std::make_pair(end(), end())
  998. : std::make_pair(make_iter(i, i), end());
  999. }
  1000. std::pair<const_iterator, const_iterator>
  1001. equal_range(const std::string &key) const {
  1002. auto i = index_of(key);
  1003. return i == npos() ? std::make_pair(end(), end())
  1004. : std::make_pair(make_citer(i, i), end());
  1005. }
  1006. size_type erase(const std::string &key) {
  1007. auto before = entries_.size();
  1008. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1009. [&](const value_type &entry) {
  1010. return keys_equal(entry.first, key);
  1011. }),
  1012. entries_.end());
  1013. return before - entries_.size();
  1014. }
  1015. iterator erase(const_iterator pos) {
  1016. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1017. return make_iter(pos.idx_, npos());
  1018. }
  1019. // Erases what iterating [first, last) would actually visit, so erasing an
  1020. // equal_range() removes only the entries with that key, not everything
  1021. // positioned between them.
  1022. iterator erase(const_iterator first, const_iterator last) {
  1023. auto from = first.idx_;
  1024. auto to = last.idx_;
  1025. if (from >= to) { return make_iter(from, npos()); }
  1026. auto begin_it = entries_.begin();
  1027. auto from_it = begin_it + static_cast<difference_type>(from);
  1028. auto to_it = begin_it + static_cast<difference_type>(to);
  1029. if (first.key_idx_ == npos()) {
  1030. entries_.erase(from_it, to_it);
  1031. } else {
  1032. auto key = entries_[first.key_idx_].first;
  1033. auto keep = from_it;
  1034. for (auto it = from_it; it != to_it; ++it) {
  1035. if (!keys_equal(it->first, key)) {
  1036. if (keep != it) { *keep = std::move(*it); }
  1037. ++keep;
  1038. }
  1039. }
  1040. if (keep != to_it) {
  1041. keep = std::move(to_it, entries_.end(), keep);
  1042. } else {
  1043. keep = entries_.end();
  1044. }
  1045. entries_.erase(keep, entries_.end());
  1046. }
  1047. return make_iter(from, npos());
  1048. }
  1049. friend bool operator==(const insertion_ordered_multimap &lhs,
  1050. const insertion_ordered_multimap &rhs) {
  1051. return lhs.entries_ == rhs.entries_;
  1052. }
  1053. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1054. const insertion_ordered_multimap &rhs) {
  1055. return !(lhs == rhs);
  1056. }
  1057. private:
  1058. size_type index_of(const std::string &key) const {
  1059. for (size_type i = 0; i < entries_.size(); i++) {
  1060. if (keys_equal(entries_[i].first, key)) { return i; }
  1061. }
  1062. return npos();
  1063. }
  1064. iterator make_iter(size_type idx, size_type key_idx) {
  1065. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1066. }
  1067. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1068. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1069. }
  1070. std::vector<value_type> entries_;
  1071. };
  1072. } // namespace detail
  1073. using Headers =
  1074. detail::insertion_ordered_multimap<std::string,
  1075. detail::case_ignore::equal_to>;
  1076. // Query parameter names are case-sensitive, unlike header field names.
  1077. using Params =
  1078. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1079. using Match = std::smatch;
  1080. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1081. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1082. /*
  1083. * detail: type-erased storage used by UserData.
  1084. * ABI-stable regardless of C++ standard — always uses this custom
  1085. * implementation instead of std::any.
  1086. */
  1087. namespace detail {
  1088. using any_type_id = const void *;
  1089. template <typename T> any_type_id any_typeid() noexcept {
  1090. static const char id = 0;
  1091. return &id;
  1092. }
  1093. struct any_storage {
  1094. virtual ~any_storage() = default;
  1095. virtual std::unique_ptr<any_storage> clone() const = 0;
  1096. virtual any_type_id type_id() const noexcept = 0;
  1097. };
  1098. template <typename T> struct any_value final : any_storage {
  1099. T value;
  1100. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1101. std::unique_ptr<any_storage> clone() const override {
  1102. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1103. }
  1104. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1105. };
  1106. } // namespace detail
  1107. class UserData {
  1108. public:
  1109. UserData() = default;
  1110. UserData(UserData &&) noexcept = default;
  1111. UserData &operator=(UserData &&) noexcept = default;
  1112. UserData(const UserData &o) {
  1113. for (const auto &e : o.entries_) {
  1114. if (e.second) { entries_[e.first] = e.second->clone(); }
  1115. }
  1116. }
  1117. UserData &operator=(const UserData &o) {
  1118. if (this != &o) {
  1119. entries_.clear();
  1120. for (const auto &e : o.entries_) {
  1121. if (e.second) { entries_[e.first] = e.second->clone(); }
  1122. }
  1123. }
  1124. return *this;
  1125. }
  1126. template <typename T> void set(const std::string &key, T &&value) {
  1127. using D = typename std::decay<T>::type;
  1128. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1129. }
  1130. template <typename T> T *get(const std::string &key) noexcept {
  1131. auto it = entries_.find(key);
  1132. if (it == entries_.end() || !it->second) { return nullptr; }
  1133. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1134. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1135. }
  1136. template <typename T> const T *get(const std::string &key) const noexcept {
  1137. auto it = entries_.find(key);
  1138. if (it == entries_.end() || !it->second) { return nullptr; }
  1139. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1140. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1141. }
  1142. bool has(const std::string &key) const noexcept {
  1143. return entries_.find(key) != entries_.end();
  1144. }
  1145. void erase(const std::string &key) { entries_.erase(key); }
  1146. void clear() noexcept { entries_.clear(); }
  1147. private:
  1148. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1149. entries_;
  1150. };
  1151. struct Response;
  1152. using ResponseHandler = std::function<bool(const Response &response)>;
  1153. struct FormData {
  1154. std::string name;
  1155. std::string content;
  1156. std::string filename;
  1157. std::string content_type;
  1158. Headers headers;
  1159. };
  1160. struct FormField {
  1161. std::string name;
  1162. std::string content;
  1163. Headers headers;
  1164. };
  1165. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1166. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1167. // should see the parts as they were sent. A std::multimap sorts by field name
  1168. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1169. // than the case-insensitive predicate Headers uses.
  1170. using FormFields =
  1171. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1172. using FormFiles =
  1173. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1174. struct MultipartFormData {
  1175. FormFields fields; // Text fields from multipart
  1176. FormFiles files; // Files from multipart
  1177. // Text field access
  1178. std::string get_field(const std::string &key, size_t id = 0) const;
  1179. std::vector<std::string> get_fields(const std::string &key) const;
  1180. bool has_field(const std::string &key) const;
  1181. size_t get_field_count(const std::string &key) const;
  1182. // File access
  1183. FormData get_file(const std::string &key, size_t id = 0) const;
  1184. std::vector<FormData> get_files(const std::string &key) const;
  1185. bool has_file(const std::string &key) const;
  1186. size_t get_file_count(const std::string &key) const;
  1187. };
  1188. struct UploadFormData {
  1189. std::string name;
  1190. std::string content;
  1191. std::string filename;
  1192. std::string content_type;
  1193. };
  1194. using UploadFormDataItems = std::vector<UploadFormData>;
  1195. class DataSink {
  1196. public:
  1197. DataSink() : os(&sb_), sb_(*this) {}
  1198. DataSink(const DataSink &) = delete;
  1199. DataSink &operator=(const DataSink &) = delete;
  1200. DataSink(DataSink &&) = delete;
  1201. DataSink &operator=(DataSink &&) = delete;
  1202. std::function<bool(const char *data, size_t data_len)> write;
  1203. // Only `write` is mandatory. The rest are defaulted so that a provider
  1204. // calling one on a writer that does not set it gets sensible behaviour
  1205. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1206. // `this` is safe: DataSink is neither copyable nor movable.
  1207. std::function<bool()> is_writable = []() { return true; };
  1208. std::function<void()> done = []() {};
  1209. std::function<void(const Headers &trailer)> done_with_trailer =
  1210. [this](const Headers & /*trailer*/) { done(); };
  1211. std::ostream os;
  1212. private:
  1213. class data_sink_streambuf final : public std::streambuf {
  1214. public:
  1215. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1216. protected:
  1217. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1218. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1219. return 0;
  1220. }
  1221. private:
  1222. DataSink &sink_;
  1223. };
  1224. data_sink_streambuf sb_;
  1225. };
  1226. using ContentProvider =
  1227. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1228. using ContentProviderWithoutLength =
  1229. std::function<bool(size_t offset, DataSink &sink)>;
  1230. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1231. struct FormDataProvider {
  1232. std::string name;
  1233. ContentProviderWithoutLength provider;
  1234. std::string filename;
  1235. std::string content_type;
  1236. };
  1237. using FormDataProviderItems = std::vector<FormDataProvider>;
  1238. inline FormDataProvider
  1239. make_file_provider(const std::string &name, const std::string &filepath,
  1240. const std::string &filename = std::string(),
  1241. const std::string &content_type = std::string()) {
  1242. FormDataProvider fdp;
  1243. fdp.name = name;
  1244. fdp.filename = filename.empty() ? filepath : filename;
  1245. fdp.content_type = content_type;
  1246. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1247. std::ifstream f(filepath, std::ios::binary);
  1248. if (!f) { return false; }
  1249. if (offset > 0) {
  1250. f.seekg(static_cast<std::streamoff>(offset));
  1251. if (!f.good()) {
  1252. sink.done();
  1253. return true;
  1254. }
  1255. }
  1256. char buf[8192];
  1257. f.read(buf, sizeof(buf));
  1258. auto n = static_cast<size_t>(f.gcount());
  1259. if (n > 0) { return sink.write(buf, n); }
  1260. sink.done(); // EOF
  1261. return true;
  1262. };
  1263. return fdp;
  1264. }
  1265. inline std::pair<size_t, ContentProvider>
  1266. make_file_body(const std::string &filepath) {
  1267. size_t size = 0;
  1268. {
  1269. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1270. if (!f) { return {0, ContentProvider{}}; }
  1271. size = static_cast<size_t>(f.tellg());
  1272. }
  1273. ContentProvider provider = [filepath](size_t offset, size_t length,
  1274. DataSink &sink) -> bool {
  1275. std::ifstream f(filepath, std::ios::binary);
  1276. if (!f) { return false; }
  1277. f.seekg(static_cast<std::streamoff>(offset));
  1278. if (!f.good()) { return false; }
  1279. char buf[8192];
  1280. while (length > 0) {
  1281. auto to_read = (std::min)(sizeof(buf), length);
  1282. f.read(buf, static_cast<std::streamsize>(to_read));
  1283. auto n = static_cast<size_t>(f.gcount());
  1284. // The file is shorter than the size make_file_body() measured, which the
  1285. // caller has already committed to as Content-Length. The body cannot be
  1286. // completed, so fail as every other error here does.
  1287. if (n == 0) { return false; }
  1288. if (!sink.write(buf, n)) { return false; }
  1289. length -= n;
  1290. }
  1291. return true;
  1292. };
  1293. return {size, std::move(provider)};
  1294. }
  1295. using ContentReceiverWithProgress = std::function<bool(
  1296. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1297. using ContentReceiver =
  1298. std::function<bool(const char *data, size_t data_length)>;
  1299. using FormDataHeader = std::function<bool(const FormData &file)>;
  1300. class ContentReader {
  1301. public:
  1302. using Reader = std::function<bool(ContentReceiver receiver)>;
  1303. using FormDataReader =
  1304. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1305. ContentReader(Reader reader, FormDataReader multipart_reader)
  1306. : reader_(std::move(reader)),
  1307. formdata_reader_(std::move(multipart_reader)) {}
  1308. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1309. return formdata_reader_(std::move(header), std::move(receiver));
  1310. }
  1311. bool operator()(ContentReceiver receiver) const {
  1312. return reader_(std::move(receiver));
  1313. }
  1314. Reader reader_;
  1315. FormDataReader formdata_reader_;
  1316. };
  1317. using Range = std::pair<ssize_t, ssize_t>;
  1318. using Ranges = std::vector<Range>;
  1319. #ifdef CPPHTTPLIB_SSL_ENABLED
  1320. // TLS abstraction layer - public type definitions and API
  1321. namespace tls {
  1322. // Opaque handles (defined as void* for abstraction)
  1323. using ctx_t = void *;
  1324. using session_t = void *;
  1325. using const_session_t = const void *; // For read-only session access
  1326. using cert_t = void *;
  1327. using ca_store_t = void *;
  1328. // TLS versions
  1329. enum class Version {
  1330. TLS1_2 = 0x0303,
  1331. TLS1_3 = 0x0304,
  1332. };
  1333. // Subject Alternative Names (SAN) entry types
  1334. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1335. // SAN entry structure
  1336. struct SanEntry {
  1337. SanType type;
  1338. std::string value;
  1339. };
  1340. // Verification context for certificate verification callback
  1341. struct VerifyContext {
  1342. session_t session; // TLS session handle
  1343. cert_t cert; // Current certificate being verified
  1344. int depth; // Certificate chain depth (0 = leaf)
  1345. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1346. long error_code; // Backend-specific error code (0 = no error)
  1347. const char *error_string; // Human-readable error description
  1348. // Certificate introspection methods
  1349. std::string subject_cn() const;
  1350. std::string issuer_name() const;
  1351. bool check_hostname(const char *hostname) const;
  1352. std::vector<SanEntry> sans() const;
  1353. bool validity(time_t &not_before, time_t &not_after) const;
  1354. std::string serial() const;
  1355. };
  1356. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1357. // TlsError codes for TLS operations (backend-independent)
  1358. enum class ErrorCode : int {
  1359. Success = 0,
  1360. WantRead, // Non-blocking: need to wait for read
  1361. WantWrite, // Non-blocking: need to wait for write
  1362. PeerClosed, // Peer closed the connection
  1363. Fatal, // Unrecoverable error
  1364. SyscallError, // System call error (check sys_errno)
  1365. CertVerifyFailed, // Certificate verification failed
  1366. HostnameMismatch, // Hostname verification failed
  1367. };
  1368. // TLS error information
  1369. struct TlsError {
  1370. ErrorCode code = ErrorCode::Fatal;
  1371. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1372. int sys_errno = 0; // errno when SyscallError
  1373. // Convert verification error code to human-readable string
  1374. static std::string verify_error_to_string(long error_code);
  1375. };
  1376. // RAII wrapper for peer certificate
  1377. class PeerCert {
  1378. public:
  1379. PeerCert();
  1380. PeerCert(PeerCert &&other) noexcept;
  1381. PeerCert &operator=(PeerCert &&other) noexcept;
  1382. ~PeerCert();
  1383. PeerCert(const PeerCert &) = delete;
  1384. PeerCert &operator=(const PeerCert &) = delete;
  1385. explicit operator bool() const;
  1386. std::string subject_cn() const;
  1387. std::string issuer_name() const;
  1388. bool check_hostname(const char *hostname) const;
  1389. std::vector<SanEntry> sans() const;
  1390. bool validity(time_t &not_before, time_t &not_after) const;
  1391. std::string serial() const;
  1392. private:
  1393. explicit PeerCert(cert_t cert);
  1394. cert_t cert_ = nullptr;
  1395. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1396. };
  1397. // Callback for TLS context setup (used by SSLServer constructor)
  1398. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1399. } // namespace tls
  1400. #endif
  1401. struct Request {
  1402. std::string method;
  1403. std::string path;
  1404. std::string matched_route;
  1405. Params params;
  1406. Headers headers;
  1407. Headers trailers;
  1408. std::string body;
  1409. std::string remote_addr;
  1410. int remote_port = -1;
  1411. std::string local_addr;
  1412. int local_port = -1;
  1413. // for server
  1414. std::string version;
  1415. std::string target;
  1416. MultipartFormData form;
  1417. Ranges ranges;
  1418. Match matches;
  1419. std::unordered_map<std::string, std::string> path_params;
  1420. std::function<bool()> is_connection_closed = []() { return true; };
  1421. // for client
  1422. std::vector<std::string> accept_content_types;
  1423. ResponseHandler response_handler;
  1424. ContentReceiverWithProgress content_receiver;
  1425. DownloadProgress download_progress;
  1426. UploadProgress upload_progress;
  1427. bool has_header(const std::string &key) const;
  1428. std::string get_header_value(const std::string &key, const char *def = "",
  1429. size_t id = 0) const;
  1430. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1431. size_t id = 0) const;
  1432. size_t get_header_value_count(const std::string &key) const;
  1433. void set_header(const std::string &key, const std::string &val);
  1434. bool has_trailer(const std::string &key) const;
  1435. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1436. size_t get_trailer_value_count(const std::string &key) const;
  1437. bool has_param(const std::string &key) const;
  1438. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1439. std::vector<std::string> get_param_values(const std::string &key) const;
  1440. size_t get_param_value_count(const std::string &key) const;
  1441. bool is_multipart_form_data() const;
  1442. // private members...
  1443. bool body_consumed_ = false;
  1444. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1445. size_t content_length_ = 0;
  1446. ContentProvider content_provider_;
  1447. bool is_chunked_content_provider_ = false;
  1448. size_t authorization_count_ = 0;
  1449. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1450. (std::chrono::steady_clock::time_point::min)();
  1451. #ifdef CPPHTTPLIB_SSL_ENABLED
  1452. tls::const_session_t ssl = nullptr;
  1453. tls::PeerCert peer_cert() const;
  1454. std::string sni() const;
  1455. #endif
  1456. };
  1457. struct Response {
  1458. std::string version;
  1459. int status = -1;
  1460. std::string reason;
  1461. Headers headers;
  1462. Headers trailers;
  1463. std::string body;
  1464. std::string location; // Redirect location
  1465. // User-defined context — set by pre-routing/pre-request handlers and read
  1466. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1467. UserData user_data;
  1468. bool has_header(const std::string &key) const;
  1469. std::string get_header_value(const std::string &key, const char *def = "",
  1470. size_t id = 0) const;
  1471. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1472. size_t id = 0) const;
  1473. size_t get_header_value_count(const std::string &key) const;
  1474. void set_header(const std::string &key, const std::string &val);
  1475. bool has_trailer(const std::string &key) const;
  1476. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1477. size_t get_trailer_value_count(const std::string &key) const;
  1478. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1479. void set_content(const char *s, size_t n, const std::string &content_type);
  1480. void set_content(const std::string &s, const std::string &content_type);
  1481. void set_content(std::string &&s, const std::string &content_type);
  1482. void set_content_provider(
  1483. size_t length, const std::string &content_type, ContentProvider provider,
  1484. ContentProviderResourceReleaser resource_releaser = nullptr);
  1485. void set_content_provider(
  1486. const std::string &content_type, ContentProviderWithoutLength provider,
  1487. ContentProviderResourceReleaser resource_releaser = nullptr);
  1488. void set_chunked_content_provider(
  1489. const std::string &content_type, ContentProviderWithoutLength provider,
  1490. ContentProviderResourceReleaser resource_releaser = nullptr);
  1491. void set_file_content(const std::string &path,
  1492. const std::string &content_type);
  1493. void set_file_content(const std::string &path);
  1494. Response() = default;
  1495. Response(const Response &) = default;
  1496. Response &operator=(const Response &) = default;
  1497. Response(Response &&) = default;
  1498. Response &operator=(Response &&) = default;
  1499. ~Response() {
  1500. if (content_provider_resource_releaser_) {
  1501. content_provider_resource_releaser_(content_provider_success_);
  1502. }
  1503. }
  1504. // private members...
  1505. size_t content_length_ = 0;
  1506. ContentProvider content_provider_;
  1507. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1508. bool is_chunked_content_provider_ = false;
  1509. bool content_provider_success_ = false;
  1510. std::string file_content_path_;
  1511. std::string file_content_content_type_;
  1512. };
  1513. enum class Error {
  1514. Success = 0,
  1515. Unknown,
  1516. Connection,
  1517. BindIPAddress,
  1518. Read,
  1519. Write,
  1520. ExceedRedirectCount,
  1521. Canceled,
  1522. SSLConnection,
  1523. SSLLoadingCerts,
  1524. SSLServerVerification,
  1525. SSLServerHostnameVerification,
  1526. UnsupportedMultipartBoundaryChars,
  1527. Compression,
  1528. ConnectionTimeout,
  1529. ProxyConnection,
  1530. ConnectionClosed,
  1531. Timeout,
  1532. ResourceExhaustion,
  1533. TooManyFormDataFiles,
  1534. ExceedMaxPayloadSize,
  1535. ExceedUriMaxLength,
  1536. ExceedMaxSocketDescriptorCount,
  1537. InvalidRequestLine,
  1538. InvalidHTTPMethod,
  1539. InvalidHTTPVersion,
  1540. InvalidHeaders,
  1541. MultipartParsing,
  1542. OpenFile,
  1543. Listen,
  1544. GetSockName,
  1545. UnsupportedAddressFamily,
  1546. HTTPParsing,
  1547. InvalidRangeHeader,
  1548. UnsupportedContentEncoding,
  1549. WebSocketHandshake,
  1550. UserCallbackException,
  1551. // For internal use only
  1552. SSLPeerCouldBeClosed_,
  1553. };
  1554. std::string to_string(Error error);
  1555. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1556. class Stream {
  1557. public:
  1558. virtual ~Stream() = default;
  1559. virtual bool is_readable() const = 0;
  1560. virtual bool wait_readable() const = 0;
  1561. virtual bool wait_writable() const = 0;
  1562. virtual bool is_peer_alive() const { return wait_writable(); }
  1563. virtual ssize_t read(char *ptr, size_t size) = 0;
  1564. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1565. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1566. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1567. virtual socket_t socket() const = 0;
  1568. virtual time_t duration() const = 0;
  1569. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1570. (void)sec;
  1571. (void)usec;
  1572. }
  1573. // Bytes already pulled off the socket and sitting in this stream's own
  1574. // buffer. Exposing them lets a line reader scan for a terminator in one
  1575. // pass instead of asking for a byte at a time. A stream that does no
  1576. // buffering of its own reports none, and readers fall back to read().
  1577. virtual const char *buffered_data(size_t &size) const {
  1578. size = 0;
  1579. return nullptr;
  1580. }
  1581. // Discards `size` bytes previously returned by buffered_data().
  1582. virtual void consume_buffered(size_t size) { (void)size; }
  1583. ssize_t write(const char *ptr);
  1584. ssize_t write(const std::string &s);
  1585. Error get_error() const { return error_; }
  1586. protected:
  1587. Error error_ = Error::Success;
  1588. };
  1589. class TaskQueue {
  1590. public:
  1591. TaskQueue() = default;
  1592. virtual ~TaskQueue() = default;
  1593. virtual bool enqueue(std::function<void()> fn) = 0;
  1594. virtual void shutdown() = 0;
  1595. virtual void on_idle() {}
  1596. };
  1597. class ThreadPool final : public TaskQueue {
  1598. public:
  1599. explicit ThreadPool(
  1600. size_t n, size_t max_n = 0, size_t mqr = 0,
  1601. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1602. ThreadPool(const ThreadPool &) = delete;
  1603. ~ThreadPool() override = default;
  1604. bool enqueue(std::function<void()> fn) override;
  1605. void shutdown() override;
  1606. private:
  1607. void worker(bool is_dynamic);
  1608. void move_to_finished(std::thread::id id);
  1609. void cleanup_finished_threads();
  1610. size_t base_thread_count_;
  1611. size_t max_thread_count_;
  1612. size_t max_queued_requests_;
  1613. time_t idle_timeout_sec_;
  1614. size_t idle_thread_count_;
  1615. bool shutdown_;
  1616. std::list<std::function<void()>> jobs_;
  1617. std::vector<std::thread> threads_; // base threads
  1618. std::list<std::thread> dynamic_threads_; // dynamic threads
  1619. std::vector<std::thread>
  1620. finished_threads_; // exited dynamic threads awaiting join
  1621. std::condition_variable cond_;
  1622. std::mutex mutex_;
  1623. };
  1624. using Logger = std::function<void(const Request &, const Response &)>;
  1625. // Forward declaration for Error type
  1626. enum class Error;
  1627. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1628. using SocketOptions = std::function<void(socket_t sock)>;
  1629. void default_socket_options(socket_t sock);
  1630. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1631. const char *status_message(int status);
  1632. std::string to_string(Error error);
  1633. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1634. std::string get_bearer_token_auth(const Request &req);
  1635. namespace detail {
  1636. class MatcherBase {
  1637. public:
  1638. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1639. virtual ~MatcherBase() = default;
  1640. const std::string &pattern() const { return pattern_; }
  1641. // Match request path and populate its matches and
  1642. virtual bool match(Request &request) const = 0;
  1643. private:
  1644. std::string pattern_;
  1645. };
  1646. /**
  1647. * Captures parameters in request path and stores them in Request::path_params
  1648. *
  1649. * Capture name is a substring of a pattern from : to /.
  1650. * The rest of the pattern is matched against the request path directly
  1651. * Parameters are captured starting from the next character after
  1652. * the end of the last matched static pattern fragment until the next /.
  1653. *
  1654. * Example pattern:
  1655. * "/path/fragments/:capture/more/fragments/:second_capture"
  1656. * Static fragments:
  1657. * "/path/fragments/", "more/fragments/"
  1658. *
  1659. * Given the following request path:
  1660. * "/path/fragments/:1/more/fragments/:2"
  1661. * the resulting capture will be
  1662. * {{"capture", "1"}, {"second_capture", "2"}}
  1663. */
  1664. class PathParamsMatcher final : public MatcherBase {
  1665. public:
  1666. PathParamsMatcher(const std::string &pattern);
  1667. bool match(Request &request) const override;
  1668. private:
  1669. // Treat segment separators as the end of path parameter capture
  1670. // Does not need to handle query parameters as they are parsed before path
  1671. // matching
  1672. static constexpr char separator = '/';
  1673. // Contains static path fragments to match against, excluding the '/' after
  1674. // path params
  1675. // Fragments are separated by path params
  1676. std::vector<std::string> static_fragments_;
  1677. // Stores the names of the path parameters to be used as keys in the
  1678. // Request::path_params map
  1679. std::vector<std::string> param_names_;
  1680. };
  1681. /**
  1682. * Performs std::regex_match on request path
  1683. * and stores the result in Request::matches
  1684. *
  1685. * Note that regex match is performed directly on the whole request.
  1686. * This means that wildcard patterns may match multiple path segments with /:
  1687. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1688. */
  1689. class RegexMatcher final : public MatcherBase {
  1690. public:
  1691. RegexMatcher(const std::string &pattern)
  1692. : MatcherBase(pattern), regex_(pattern) {}
  1693. bool match(Request &request) const override;
  1694. private:
  1695. std::regex regex_;
  1696. };
  1697. int close_socket(socket_t sock) noexcept;
  1698. bool is_accept_resource_error();
  1699. bool is_accept_transient_error();
  1700. ssize_t write_headers(Stream &strm, const Headers &headers);
  1701. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1702. time_t usec);
  1703. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1704. const std::string &boundary);
  1705. ContentProvider
  1706. make_multipart_content_provider(const UploadFormDataItems &items,
  1707. const std::string &boundary);
  1708. } // namespace detail
  1709. bool is_valid_multipart_boundary(const std::string &boundary);
  1710. // Serializer for multipart/form-data request bodies. The boundary is owned
  1711. // by the writer so that per-part framing and the final terminator always
  1712. // agree. Field names and filenames are escaped following the WHATWG HTML
  1713. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1714. // in content types.
  1715. class MultipartFormDataWriter {
  1716. public:
  1717. MultipartFormDataWriter();
  1718. // precondition: is_valid_multipart_boundary(boundary)
  1719. explicit MultipartFormDataWriter(std::string boundary);
  1720. const std::string &boundary() const;
  1721. std::string content_type() const;
  1722. // In-memory items -> whole body (known length)
  1723. std::string serialize(const UploadFormDataItems &items) const;
  1724. size_t content_length(const UploadFormDataItems &items) const;
  1725. // Per-part framing for streaming via a content provider
  1726. std::string item_begin(const UploadFormData &item) const;
  1727. static std::string item_end();
  1728. std::string finish() const;
  1729. private:
  1730. std::string boundary_;
  1731. };
  1732. class Server {
  1733. public:
  1734. using Handler = std::function<void(const Request &, Response &)>;
  1735. using ExceptionHandler =
  1736. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1737. enum class HandlerResponse {
  1738. Handled,
  1739. Unhandled,
  1740. };
  1741. using HandlerWithResponse =
  1742. std::function<HandlerResponse(const Request &, Response &)>;
  1743. using HandlerWithContentReader = std::function<void(
  1744. const Request &, Response &, const ContentReader &content_reader)>;
  1745. using Expect100ContinueHandler =
  1746. std::function<int(const Request &, Response &)>;
  1747. using StartHandler = std::function<void()>;
  1748. using WebSocketHandler =
  1749. std::function<void(const Request &, ws::WebSocket &)>;
  1750. using SubProtocolSelector =
  1751. std::function<std::string(const std::vector<std::string> &protocols)>;
  1752. Server();
  1753. virtual ~Server();
  1754. virtual bool is_valid() const;
  1755. Server &Get(const std::string &pattern, Handler handler);
  1756. Server &Post(const std::string &pattern, Handler handler);
  1757. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1758. Server &Put(const std::string &pattern, Handler handler);
  1759. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1760. Server &Patch(const std::string &pattern, Handler handler);
  1761. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1762. Server &Delete(const std::string &pattern, Handler handler);
  1763. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1764. Server &Options(const std::string &pattern, Handler handler);
  1765. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1766. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1767. // server accept it; an unregistered method is still rejected with 400.
  1768. // `method` must be a valid HTTP method token and must not be one of the
  1769. // built-in methods, which have their own registration functions above. A
  1770. // rejected registration makes is_valid() return false, so listen() fails.
  1771. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1772. Handler handler);
  1773. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1774. HandlerWithContentReader handler);
  1775. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1776. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1777. SubProtocolSelector sub_protocol_selector);
  1778. bool set_base_dir(const std::string &dir,
  1779. const std::string &mount_point = std::string());
  1780. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1781. Headers headers = Headers());
  1782. bool remove_mount_point(const std::string &mount_point);
  1783. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1784. const std::string &mime);
  1785. Server &set_default_file_mimetype(const std::string &mime);
  1786. Server &set_file_request_handler(Handler handler);
  1787. template <class ErrorHandlerFunc>
  1788. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1789. return set_error_handler_core(
  1790. std::forward<ErrorHandlerFunc>(handler),
  1791. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1792. }
  1793. Server &set_exception_handler(ExceptionHandler handler);
  1794. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1795. Server &set_post_routing_handler(Handler handler);
  1796. Server &set_pre_request_handler(HandlerWithResponse handler);
  1797. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1798. Server &set_start_handler(StartHandler handler);
  1799. Server &set_logger(Logger logger);
  1800. Server &set_pre_compression_logger(Logger logger);
  1801. Server &set_error_logger(ErrorLogger error_logger);
  1802. Server &set_address_family(int family);
  1803. Server &set_tcp_nodelay(bool on);
  1804. Server &set_ipv6_v6only(bool on);
  1805. Server &set_socket_options(SocketOptions socket_options);
  1806. Server &set_default_headers(Headers headers);
  1807. Server &
  1808. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1809. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1810. Server &set_keep_alive_max_count(size_t count);
  1811. Server &set_keep_alive_timeout(time_t sec);
  1812. template <class Rep, class Period>
  1813. Server &
  1814. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1815. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1816. template <class Rep, class Period>
  1817. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1818. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1819. template <class Rep, class Period>
  1820. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1821. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1822. template <class Rep, class Period>
  1823. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1824. Server &set_payload_max_length(size_t length);
  1825. Server &set_websocket_ping_interval(time_t sec);
  1826. template <class Rep, class Period>
  1827. Server &set_websocket_ping_interval(
  1828. const std::chrono::duration<Rep, Period> &duration);
  1829. Server &set_websocket_max_missed_pongs(int count);
  1830. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1831. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1832. bool listen_after_bind();
  1833. bool listen(const std::string &host, int port, int socket_flags = 0);
  1834. bool is_running() const;
  1835. void wait_until_ready() const;
  1836. void stop() noexcept;
  1837. void decommission();
  1838. std::function<TaskQueue *(void)> new_task_queue;
  1839. protected:
  1840. bool process_request(Stream &strm, const std::string &remote_addr,
  1841. int remote_port, const std::string &local_addr,
  1842. int local_port, bool close_connection,
  1843. bool &connection_closed,
  1844. const std::function<void(Request &)> &setup_request,
  1845. bool *websocket_upgraded = nullptr);
  1846. // Runs the per-connection serving loop and stops an exception thrown by a
  1847. // user callback from escaping the worker thread.
  1848. //
  1849. // process_request() wraps only routing() in a try/catch. Content providers,
  1850. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1851. // handlers all run outside it, and the task queue calls the job without a
  1852. // catch, so an exception from any of those would terminate the process.
  1853. //
  1854. // No 500 is possible here: by the time a content provider runs, the status
  1855. // line and headers are already on the wire. Report it through the error
  1856. // logger and drop the connection, which is what the peer observes either
  1857. // way. Other connections are unaffected.
  1858. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1859. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1860. return serve();
  1861. #else
  1862. try {
  1863. return serve();
  1864. } catch (...) {
  1865. // The error logger is a user callback too, so it must not be able to
  1866. // throw the guard back open.
  1867. try {
  1868. output_error_log(Error::UserCallbackException, nullptr);
  1869. } catch (...) {}
  1870. return false;
  1871. }
  1872. #endif
  1873. }
  1874. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1875. std::vector<std::string> trusted_proxies_;
  1876. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1877. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1878. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1879. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1880. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1881. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1882. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1883. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1884. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1885. time_t websocket_ping_interval_sec_ =
  1886. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1887. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1888. private:
  1889. using Handlers =
  1890. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1891. using HandlersForContentReader =
  1892. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1893. HandlerWithContentReader>>;
  1894. // Both handler tables for one custom method live in a single entry, so that
  1895. // routing() needs only one map lookup per request to reach either of them.
  1896. struct CustomHandlerEntry {
  1897. Handlers handlers;
  1898. HandlersForContentReader handlers_for_content_reader;
  1899. };
  1900. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1901. static std::unique_ptr<detail::MatcherBase>
  1902. make_matcher(const std::string &pattern);
  1903. static const std::set<std::string> &builtin_methods();
  1904. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  1905. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  1906. template <typename H>
  1907. Server &add_handler(
  1908. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  1909. const std::string &pattern, H handler) {
  1910. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  1911. return *this;
  1912. }
  1913. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  1914. Server &set_error_handler_core(Handler handler, std::false_type);
  1915. socket_t create_server_socket(const std::string &host, int port,
  1916. int socket_flags,
  1917. SocketOptions socket_options) const;
  1918. int bind_internal(const std::string &host, int port, int socket_flags);
  1919. bool listen_internal();
  1920. bool routing(Request &req, Response &res, Stream &strm);
  1921. bool handle_file_request(Request &req, Response &res);
  1922. bool check_if_not_modified(const Request &req, Response &res,
  1923. const std::string &etag, time_t mtime) const;
  1924. bool check_if_range(Request &req, const std::string &etag,
  1925. time_t mtime) const;
  1926. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  1927. Stream &strm);
  1928. bool dispatch_request_for_content_reader(
  1929. Request &req, Response &res, ContentReader content_reader,
  1930. const HandlersForContentReader &handlers) const;
  1931. bool parse_request_line(const char *s, Request &req) const;
  1932. void apply_ranges(const Request &req, Response &res,
  1933. std::string &content_type, std::string &boundary) const;
  1934. bool write_response(Stream &strm, bool close_connection, Request &req,
  1935. Response &res);
  1936. bool write_response_with_content(Stream &strm, bool close_connection,
  1937. const Request &req, Response &res);
  1938. bool write_response_core(Stream &strm, bool close_connection,
  1939. const Request &req, Response &res,
  1940. bool need_apply_ranges);
  1941. bool write_content_with_provider(Stream &strm, const Request &req,
  1942. Response &res, const std::string &boundary,
  1943. const std::string &content_type);
  1944. bool read_content(Stream &strm, Request &req, Response &res);
  1945. bool read_content_with_content_receiver(Stream &strm, Request &req,
  1946. Response &res,
  1947. ContentReceiver receiver,
  1948. FormDataHeader multipart_header,
  1949. ContentReceiver multipart_receiver);
  1950. bool read_content_core(Stream &strm, Request &req, Response &res,
  1951. ContentReceiver receiver,
  1952. FormDataHeader multipart_header,
  1953. ContentReceiver multipart_receiver) const;
  1954. virtual bool process_and_close_socket(socket_t sock);
  1955. void output_log(const Request &req, const Response &res) const;
  1956. void output_pre_compression_log(const Request &req,
  1957. const Response &res) const;
  1958. void output_error_log(const Error &err, const Request *req) const;
  1959. std::atomic<bool> is_running_{false};
  1960. std::atomic<bool> is_decommissioned{false};
  1961. // Set when CustomRoute() refuses a registration. Written before listen(),
  1962. // read by is_valid() on the same thread, so it needs no synchronization.
  1963. bool has_invalid_registration_ = false;
  1964. struct MountPointEntry {
  1965. std::string mount_point;
  1966. std::string base_dir;
  1967. std::string resolved_base_dir;
  1968. Headers headers;
  1969. };
  1970. std::vector<MountPointEntry> base_dirs_;
  1971. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  1972. std::string default_file_mimetype_ = "application/octet-stream";
  1973. Handler file_request_handler_;
  1974. Handlers get_handlers_;
  1975. Handlers post_handlers_;
  1976. HandlersForContentReader post_handlers_for_content_reader_;
  1977. Handlers put_handlers_;
  1978. HandlersForContentReader put_handlers_for_content_reader_;
  1979. Handlers patch_handlers_;
  1980. HandlersForContentReader patch_handlers_for_content_reader_;
  1981. Handlers delete_handlers_;
  1982. HandlersForContentReader delete_handlers_for_content_reader_;
  1983. Handlers options_handlers_;
  1984. CustomHandlers custom_handlers_;
  1985. struct WebSocketHandlerEntry {
  1986. std::unique_ptr<detail::MatcherBase> matcher;
  1987. WebSocketHandler handler;
  1988. SubProtocolSelector sub_protocol_selector;
  1989. };
  1990. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  1991. WebSocketHandlers websocket_handlers_;
  1992. HandlerWithResponse error_handler_;
  1993. ExceptionHandler exception_handler_;
  1994. HandlerWithResponse pre_routing_handler_;
  1995. Handler post_routing_handler_;
  1996. HandlerWithResponse pre_request_handler_;
  1997. Expect100ContinueHandler expect_100_continue_handler_;
  1998. StartHandler start_handler_;
  1999. mutable std::mutex logger_mutex_;
  2000. Logger logger_;
  2001. Logger pre_compression_logger_;
  2002. ErrorLogger error_logger_;
  2003. int address_family_ = AF_UNSPEC;
  2004. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2005. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2006. SocketOptions socket_options_ = default_socket_options;
  2007. Headers default_headers_;
  2008. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2009. detail::write_headers;
  2010. };
  2011. class Result {
  2012. public:
  2013. Result() = default;
  2014. Result(std::unique_ptr<Response> &&res, Error err,
  2015. Headers &&request_headers = Headers{})
  2016. : res_(std::move(res)), err_(err),
  2017. request_headers_(std::move(request_headers)) {}
  2018. // Response
  2019. operator bool() const { return res_ != nullptr; }
  2020. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2021. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2022. const Response &value() const { return *res_; }
  2023. Response &value() { return *res_; }
  2024. const Response &operator*() const { return *res_; }
  2025. Response &operator*() { return *res_; }
  2026. const Response *operator->() const { return res_.get(); }
  2027. Response *operator->() { return res_.get(); }
  2028. // Error
  2029. Error error() const { return err_; }
  2030. // Request Headers
  2031. bool has_request_header(const std::string &key) const;
  2032. std::string get_request_header_value(const std::string &key,
  2033. const char *def = "",
  2034. size_t id = 0) const;
  2035. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2036. size_t id = 0) const;
  2037. size_t get_request_header_value_count(const std::string &key) const;
  2038. private:
  2039. std::unique_ptr<Response> res_;
  2040. Error err_ = Error::Unknown;
  2041. Headers request_headers_;
  2042. #ifdef CPPHTTPLIB_SSL_ENABLED
  2043. public:
  2044. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2045. int ssl_error)
  2046. : res_(std::move(res)), err_(err),
  2047. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2048. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2049. int ssl_error, uint64_t ssl_backend_error)
  2050. : res_(std::move(res)), err_(err),
  2051. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2052. ssl_backend_error_(ssl_backend_error) {}
  2053. int ssl_error() const { return ssl_error_; }
  2054. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2055. private:
  2056. int ssl_error_ = 0;
  2057. uint64_t ssl_backend_error_ = 0;
  2058. #endif
  2059. };
  2060. struct ClientConnection {
  2061. socket_t sock = INVALID_SOCKET;
  2062. bool is_open() const { return sock != INVALID_SOCKET; }
  2063. ClientConnection() = default;
  2064. ~ClientConnection();
  2065. ClientConnection(const ClientConnection &) = delete;
  2066. ClientConnection &operator=(const ClientConnection &) = delete;
  2067. ClientConnection(ClientConnection &&other) noexcept
  2068. : sock(other.sock)
  2069. #ifdef CPPHTTPLIB_SSL_ENABLED
  2070. ,
  2071. session(other.session)
  2072. #endif
  2073. {
  2074. other.sock = INVALID_SOCKET;
  2075. #ifdef CPPHTTPLIB_SSL_ENABLED
  2076. other.session = nullptr;
  2077. #endif
  2078. }
  2079. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2080. if (this != &other) {
  2081. sock = other.sock;
  2082. other.sock = INVALID_SOCKET;
  2083. #ifdef CPPHTTPLIB_SSL_ENABLED
  2084. session = other.session;
  2085. other.session = nullptr;
  2086. #endif
  2087. }
  2088. return *this;
  2089. }
  2090. #ifdef CPPHTTPLIB_SSL_ENABLED
  2091. tls::session_t session = nullptr;
  2092. #endif
  2093. };
  2094. namespace detail {
  2095. struct ChunkedDecoder;
  2096. struct BodyReader {
  2097. Stream *stream = nullptr;
  2098. bool has_content_length = false;
  2099. size_t content_length = 0;
  2100. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2101. size_t bytes_read = 0;
  2102. bool chunked = false;
  2103. bool eof = false;
  2104. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2105. Error last_error = Error::Success;
  2106. ssize_t read(char *buf, size_t len);
  2107. bool has_error() const { return last_error != Error::Success; }
  2108. };
  2109. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2110. size_t len) {
  2111. (void)stream;
  2112. return br.read(buf, len);
  2113. }
  2114. class decompressor;
  2115. enum class NoProxyKind {
  2116. Wildcard, // "*"
  2117. HostnameSuffix, // "example.com" or ".example.com"
  2118. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2119. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2120. };
  2121. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2122. // Lets one CIDR matcher cover both families.
  2123. using IPBytes = std::array<uint8_t, 16>;
  2124. struct NoProxyEntry {
  2125. NoProxyKind kind = NoProxyKind::Wildcard;
  2126. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2127. IPBytes net{};
  2128. int prefix_bits = 0;
  2129. };
  2130. struct NormalizedTarget {
  2131. std::string hostname; // lowercase; brackets and trailing dot removed
  2132. bool is_ipv4 = false;
  2133. bool is_ipv6 = false;
  2134. IPBytes ip{};
  2135. };
  2136. } // namespace detail
  2137. class ClientImpl {
  2138. public:
  2139. explicit ClientImpl(const std::string &host);
  2140. explicit ClientImpl(const std::string &host, int port);
  2141. explicit ClientImpl(const std::string &host, int port,
  2142. const std::string &client_cert_path,
  2143. const std::string &client_key_path);
  2144. virtual ~ClientImpl();
  2145. virtual bool is_valid() const;
  2146. struct StreamHandle {
  2147. std::unique_ptr<Response> response;
  2148. Error error = Error::Success;
  2149. StreamHandle() = default;
  2150. StreamHandle(const StreamHandle &) = delete;
  2151. StreamHandle &operator=(const StreamHandle &) = delete;
  2152. StreamHandle(StreamHandle &&) = default;
  2153. StreamHandle &operator=(StreamHandle &&) = default;
  2154. ~StreamHandle() = default;
  2155. bool is_valid() const {
  2156. return response != nullptr && error == Error::Success;
  2157. }
  2158. ssize_t read(char *buf, size_t len);
  2159. void parse_trailers_if_needed();
  2160. Error get_read_error() const { return body_reader_.last_error; }
  2161. bool has_read_error() const { return body_reader_.has_error(); }
  2162. bool trailers_parsed_ = false;
  2163. private:
  2164. friend class ClientImpl;
  2165. ssize_t read_with_decompression(char *buf, size_t len);
  2166. std::unique_ptr<ClientConnection> connection_;
  2167. std::unique_ptr<Stream> socket_stream_;
  2168. Stream *stream_ = nullptr;
  2169. detail::BodyReader body_reader_;
  2170. std::unique_ptr<detail::decompressor> decompressor_;
  2171. std::string decompress_buffer_;
  2172. size_t decompress_offset_ = 0;
  2173. size_t decompressed_bytes_read_ = 0;
  2174. };
  2175. // clang-format off
  2176. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2177. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2178. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2179. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2180. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2181. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2182. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2183. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2184. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2185. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2186. Result Head(const std::string &path);
  2187. Result Head(const std::string &path, const Headers &headers);
  2188. Result Post(const std::string &path);
  2189. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2190. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2191. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2192. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2193. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2194. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2195. Result Post(const std::string &path, const Params &params);
  2196. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2197. Result Post(const std::string &path, const Headers &headers);
  2198. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2199. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2200. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2201. 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);
  2202. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2203. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2204. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2205. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2206. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2207. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2208. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2209. Result Put(const std::string &path);
  2210. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2211. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2212. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2213. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2214. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2215. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2216. Result Put(const std::string &path, const Params &params);
  2217. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2218. Result Put(const std::string &path, const Headers &headers);
  2219. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2220. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2221. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2222. 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);
  2223. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2224. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2225. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2226. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2227. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2228. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2229. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2230. Result Patch(const std::string &path);
  2231. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2232. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2233. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2234. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2235. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2236. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2237. Result Patch(const std::string &path, const Params &params);
  2238. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2239. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2240. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2241. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2242. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2243. 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);
  2244. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2245. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2246. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2247. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2248. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2249. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2250. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2251. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2252. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2253. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2254. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2255. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2256. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2257. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2258. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2259. Result Options(const std::string &path);
  2260. Result Options(const std::string &path, const Headers &headers);
  2261. // clang-format on
  2262. // Streaming API: Open a stream for reading response body incrementally
  2263. // Socket ownership is transferred to StreamHandle for true streaming
  2264. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2265. StreamHandle open_stream(const std::string &method, const std::string &path,
  2266. const Params &params = {},
  2267. const Headers &headers = {},
  2268. const std::string &body = {},
  2269. const std::string &content_type = {});
  2270. bool send(Request &req, Response &res, Error &error);
  2271. Result send(const Request &req);
  2272. void stop();
  2273. std::string host() const;
  2274. int port() const;
  2275. size_t is_socket_open() const;
  2276. socket_t socket() const;
  2277. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2278. void set_default_headers(Headers headers);
  2279. void
  2280. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2281. void set_address_family(int family);
  2282. void set_tcp_nodelay(bool on);
  2283. void set_ipv6_v6only(bool on);
  2284. void set_socket_options(SocketOptions socket_options);
  2285. void set_connection_timeout(time_t sec, time_t usec = 0);
  2286. template <class Rep, class Period>
  2287. void
  2288. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2289. void set_read_timeout(time_t sec, time_t usec = 0);
  2290. template <class Rep, class Period>
  2291. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2292. void set_write_timeout(time_t sec, time_t usec = 0);
  2293. template <class Rep, class Period>
  2294. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2295. void set_max_timeout(time_t msec);
  2296. template <class Rep, class Period>
  2297. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2298. void set_basic_auth(const std::string &username, const std::string &password);
  2299. void set_bearer_token_auth(const std::string &token);
  2300. void set_keep_alive(bool on);
  2301. void set_follow_location(bool on);
  2302. void set_path_encode(bool on);
  2303. void set_compress(bool on);
  2304. void set_decompress(bool on);
  2305. void set_payload_max_length(size_t length);
  2306. void set_interface(const std::string &intf);
  2307. void set_proxy(const std::string &host, int port);
  2308. void set_proxy_basic_auth(const std::string &username,
  2309. const std::string &password);
  2310. void set_proxy_bearer_token_auth(const std::string &token);
  2311. void set_no_proxy(const std::vector<std::string> &patterns);
  2312. void set_logger(Logger logger);
  2313. void set_error_logger(ErrorLogger error_logger);
  2314. protected:
  2315. struct Socket {
  2316. socket_t sock = INVALID_SOCKET;
  2317. // For Mbed TLS compatibility: start_time for request timeout tracking
  2318. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2319. bool is_open() const { return sock != INVALID_SOCKET; }
  2320. #ifdef CPPHTTPLIB_SSL_ENABLED
  2321. tls::session_t ssl = nullptr;
  2322. #endif
  2323. };
  2324. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2325. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2326. virtual bool setup_proxy_connection(
  2327. Socket &socket,
  2328. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2329. Response &res, bool &success, Error &error);
  2330. bool is_proxy_enabled_for_host(const std::string &host) const;
  2331. // All of:
  2332. // shutdown_ssl
  2333. // shutdown_socket
  2334. // close_socket
  2335. // disconnect
  2336. // should ONLY be called when socket_mutex_ is locked, and only when
  2337. // no other thread is using the socket.
  2338. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2339. void shutdown_socket(Socket &socket) const;
  2340. void close_socket(Socket &socket);
  2341. void disconnect(bool gracefully);
  2342. bool process_request(Stream &strm, Request &req, Response &res,
  2343. bool close_connection, Error &error);
  2344. bool write_content_with_provider(Stream &strm, const Request &req,
  2345. Error &error) const;
  2346. void copy_settings(const ClientImpl &rhs);
  2347. void output_log(const Request &req, const Response &res) const;
  2348. void output_error_log(const Error &err, const Request *req) const;
  2349. // Socket endpoint information
  2350. const std::string host_;
  2351. const int port_;
  2352. // Current open socket
  2353. Socket socket_;
  2354. mutable std::mutex socket_mutex_;
  2355. std::recursive_mutex request_mutex_;
  2356. // These are all protected under socket_mutex
  2357. size_t socket_requests_in_flight_ = 0;
  2358. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2359. bool socket_should_be_closed_when_request_is_done_ = false;
  2360. // Hostname to connection target map. The value is an IP literal or another
  2361. // hostname; only the connection target changes, never the identity.
  2362. std::map<std::string, std::string> addr_map_;
  2363. // Default headers
  2364. Headers default_headers_;
  2365. // Header writer
  2366. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2367. detail::write_headers;
  2368. // Settings
  2369. std::string client_cert_path_;
  2370. std::string client_key_path_;
  2371. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2372. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2373. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2374. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2375. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2376. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2377. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2378. std::string basic_auth_username_;
  2379. std::string basic_auth_password_;
  2380. std::string bearer_token_auth_token_;
  2381. bool keep_alive_ = false;
  2382. bool follow_location_ = false;
  2383. bool path_encode_ = true;
  2384. int address_family_ = AF_UNSPEC;
  2385. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2386. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2387. SocketOptions socket_options_ = nullptr;
  2388. bool compress_ = false;
  2389. bool decompress_ = true;
  2390. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2391. bool has_payload_max_length_ = false;
  2392. std::string interface_;
  2393. std::string proxy_host_;
  2394. int proxy_port_ = -1;
  2395. std::string proxy_basic_auth_username_;
  2396. std::string proxy_basic_auth_password_;
  2397. std::string proxy_bearer_token_auth_token_;
  2398. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2399. mutable detail::NormalizedTarget host_normalized_;
  2400. mutable bool host_normalized_valid_ = false;
  2401. mutable std::mutex logger_mutex_;
  2402. Logger logger_;
  2403. ErrorLogger error_logger_;
  2404. private:
  2405. bool send_(Request &req, Response &res, Error &error);
  2406. Result send_(Request &&req);
  2407. socket_t create_client_socket(Error &error) const;
  2408. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2409. bool skip_100_continue = true) const;
  2410. bool write_request(Stream &strm, Request &req, bool close_connection,
  2411. Error &error, bool skip_body = false);
  2412. bool write_request_body(Stream &strm, Request &req, Error &error);
  2413. void prepare_default_headers(Request &r, bool for_stream,
  2414. const std::string &ct);
  2415. bool redirect(Request &req, Response &res, Error &error);
  2416. bool create_redirect_client(const std::string &scheme,
  2417. const std::string &host, int port, Request &req,
  2418. Response &res, const std::string &path,
  2419. const std::string &location, Error &error);
  2420. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2421. bool handle_request(Stream &strm, Request &req, Response &res,
  2422. bool close_connection, Error &error);
  2423. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2424. Request &req, const char *body, size_t content_length,
  2425. ContentProvider content_provider,
  2426. ContentProviderWithoutLength content_provider_without_length,
  2427. const std::string &content_type, ContentReceiver content_receiver,
  2428. Error &error);
  2429. Result send_with_content_provider_and_receiver(
  2430. const std::string &method, const std::string &path,
  2431. const Headers &headers, const char *body, size_t content_length,
  2432. ContentProvider content_provider,
  2433. ContentProviderWithoutLength content_provider_without_length,
  2434. const std::string &content_type, ContentReceiver content_receiver,
  2435. UploadProgress progress);
  2436. ContentProviderWithoutLength get_multipart_content_provider(
  2437. const std::string &boundary, const UploadFormDataItems &items,
  2438. const FormDataProviderItems &provider_items) const;
  2439. virtual bool
  2440. process_socket(const Socket &socket,
  2441. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2442. std::function<bool(Stream &strm)> callback);
  2443. virtual bool is_ssl() const;
  2444. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2445. #ifdef CPPHTTPLIB_SSL_ENABLED
  2446. public:
  2447. void set_digest_auth(const std::string &username,
  2448. const std::string &password);
  2449. void set_proxy_digest_auth(const std::string &username,
  2450. const std::string &password);
  2451. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2452. const std::string &ca_cert_dir_path = std::string());
  2453. void enable_server_certificate_verification(bool enabled);
  2454. void enable_server_hostname_verification(bool enabled);
  2455. void enable_system_ca(bool enabled);
  2456. protected:
  2457. std::string digest_auth_username_;
  2458. std::string digest_auth_password_;
  2459. std::string proxy_digest_auth_username_;
  2460. std::string proxy_digest_auth_password_;
  2461. std::string ca_cert_file_path_;
  2462. std::string ca_cert_dir_path_;
  2463. bool server_certificate_verification_ = true;
  2464. bool server_hostname_verification_ = true;
  2465. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2466. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2467. int last_ssl_error_ = 0;
  2468. uint64_t last_backend_error_ = 0;
  2469. #endif
  2470. };
  2471. class Client {
  2472. public:
  2473. // Universal interface
  2474. explicit Client(const std::string &scheme_host_port);
  2475. explicit Client(const std::string &scheme_host_port,
  2476. const std::string &client_cert_path,
  2477. const std::string &client_key_path);
  2478. // HTTP only interface
  2479. explicit Client(const std::string &host, int port);
  2480. explicit Client(const std::string &host, int port,
  2481. const std::string &client_cert_path,
  2482. const std::string &client_key_path);
  2483. Client(Client &&) = default;
  2484. Client &operator=(Client &&) = default;
  2485. ~Client();
  2486. bool is_valid() const;
  2487. // clang-format off
  2488. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2489. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2490. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2491. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2492. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2493. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2494. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2495. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2496. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2497. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2498. Result Head(const std::string &path);
  2499. Result Head(const std::string &path, const Headers &headers);
  2500. Result Post(const std::string &path);
  2501. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2502. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2503. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2504. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2505. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2506. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2507. Result Post(const std::string &path, const Params &params);
  2508. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2509. Result Post(const std::string &path, const Headers &headers);
  2510. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2511. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2512. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2513. 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);
  2514. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2515. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2516. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2517. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2518. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2519. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2520. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2521. Result Put(const std::string &path);
  2522. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2523. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2524. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2525. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2526. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2527. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2528. Result Put(const std::string &path, const Params &params);
  2529. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2530. Result Put(const std::string &path, const Headers &headers);
  2531. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2532. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2533. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2534. 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);
  2535. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2536. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2537. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2538. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2539. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2540. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2541. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2542. Result Patch(const std::string &path);
  2543. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2544. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2545. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2546. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2547. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2548. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2549. Result Patch(const std::string &path, const Params &params);
  2550. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2551. Result Patch(const std::string &path, const Headers &headers);
  2552. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2553. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2554. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2555. 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);
  2556. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2557. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2558. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2559. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2560. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2561. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2562. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2563. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2564. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2565. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2566. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2567. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2568. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2569. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2570. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2571. Result Options(const std::string &path);
  2572. Result Options(const std::string &path, const Headers &headers);
  2573. // clang-format on
  2574. // Streaming API: Open a stream for reading response body incrementally
  2575. // Socket ownership is transferred to StreamHandle for true streaming
  2576. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2577. ClientImpl::StreamHandle open_stream(const std::string &method,
  2578. const std::string &path,
  2579. const Params &params = {},
  2580. const Headers &headers = {},
  2581. const std::string &body = {},
  2582. const std::string &content_type = {});
  2583. bool send(Request &req, Response &res, Error &error);
  2584. Result send(const Request &req);
  2585. void stop();
  2586. std::string host() const;
  2587. int port() const;
  2588. size_t is_socket_open() const;
  2589. socket_t socket() const;
  2590. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2591. void set_default_headers(Headers headers);
  2592. void
  2593. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2594. void set_address_family(int family);
  2595. void set_tcp_nodelay(bool on);
  2596. void set_socket_options(SocketOptions socket_options);
  2597. void set_connection_timeout(time_t sec, time_t usec = 0);
  2598. template <class Rep, class Period>
  2599. void
  2600. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2601. void set_read_timeout(time_t sec, time_t usec = 0);
  2602. template <class Rep, class Period>
  2603. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2604. void set_write_timeout(time_t sec, time_t usec = 0);
  2605. template <class Rep, class Period>
  2606. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2607. void set_max_timeout(time_t msec);
  2608. template <class Rep, class Period>
  2609. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2610. void set_basic_auth(const std::string &username, const std::string &password);
  2611. void set_bearer_token_auth(const std::string &token);
  2612. void set_keep_alive(bool on);
  2613. void set_follow_location(bool on);
  2614. void set_path_encode(bool on);
  2615. void set_compress(bool on);
  2616. void set_decompress(bool on);
  2617. void set_payload_max_length(size_t length);
  2618. void set_interface(const std::string &intf);
  2619. void set_proxy(const std::string &host, int port);
  2620. void set_proxy_basic_auth(const std::string &username,
  2621. const std::string &password);
  2622. void set_proxy_bearer_token_auth(const std::string &token);
  2623. void set_no_proxy(const std::vector<std::string> &patterns);
  2624. void set_logger(Logger logger);
  2625. void set_error_logger(ErrorLogger error_logger);
  2626. private:
  2627. std::unique_ptr<ClientImpl> cli_;
  2628. #ifdef CPPHTTPLIB_SSL_ENABLED
  2629. public:
  2630. void set_digest_auth(const std::string &username,
  2631. const std::string &password);
  2632. void set_proxy_digest_auth(const std::string &username,
  2633. const std::string &password);
  2634. void enable_server_certificate_verification(bool enabled);
  2635. void enable_server_hostname_verification(bool enabled);
  2636. void enable_system_ca(bool enabled);
  2637. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2638. const std::string &ca_cert_dir_path = std::string());
  2639. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2640. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2641. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2642. void set_session_verifier(
  2643. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2644. tls::ctx_t tls_context() const;
  2645. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2646. void enable_windows_certificate_verification(bool enabled);
  2647. #endif
  2648. private:
  2649. bool is_ssl_ = false;
  2650. #endif
  2651. };
  2652. #ifdef CPPHTTPLIB_SSL_ENABLED
  2653. class SSLServer : public Server {
  2654. public:
  2655. SSLServer(const char *cert_path, const char *private_key_path,
  2656. const char *client_ca_cert_file_path = nullptr,
  2657. const char *client_ca_cert_dir_path = nullptr,
  2658. const char *private_key_password = nullptr);
  2659. struct PemMemory {
  2660. const char *cert_pem;
  2661. size_t cert_pem_len;
  2662. const char *key_pem;
  2663. size_t key_pem_len;
  2664. const char *client_ca_pem;
  2665. size_t client_ca_pem_len;
  2666. const char *private_key_password;
  2667. };
  2668. explicit SSLServer(const PemMemory &pem);
  2669. // The callback receives the ctx_t handle which can be cast to the
  2670. // appropriate backend type (SSL_CTX* for OpenSSL,
  2671. // tls::impl::MbedTlsContext* for Mbed TLS)
  2672. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2673. ~SSLServer() override;
  2674. bool is_valid() const override;
  2675. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2676. const char *client_ca_pem = nullptr,
  2677. const char *password = nullptr);
  2678. tls::ctx_t tls_context() const { return ctx_; }
  2679. int ssl_last_error() const { return last_ssl_error_; }
  2680. private:
  2681. bool process_and_close_socket(socket_t sock) override;
  2682. tls::ctx_t ctx_ = nullptr;
  2683. std::mutex ctx_mutex_;
  2684. int last_ssl_error_ = 0;
  2685. };
  2686. class SSLClient final : public ClientImpl {
  2687. public:
  2688. explicit SSLClient(const std::string &host);
  2689. explicit SSLClient(const std::string &host, int port);
  2690. explicit SSLClient(const std::string &host, int port,
  2691. const std::string &client_cert_path,
  2692. const std::string &client_key_path,
  2693. const std::string &private_key_password = std::string());
  2694. struct PemMemory {
  2695. const char *cert_pem;
  2696. size_t cert_pem_len;
  2697. const char *key_pem;
  2698. size_t key_pem_len;
  2699. const char *private_key_password;
  2700. };
  2701. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2702. ~SSLClient() override;
  2703. bool is_valid() const override;
  2704. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2705. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2706. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2707. // Post-handshake session verifier (backend-independent)
  2708. void set_session_verifier(
  2709. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2710. tls::ctx_t tls_context() const { return ctx_; }
  2711. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2712. void enable_windows_certificate_verification(bool enabled);
  2713. #endif
  2714. private:
  2715. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2716. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2717. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2718. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2719. bool
  2720. process_socket(const Socket &socket,
  2721. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2722. std::function<bool(Stream &strm)> callback) override;
  2723. bool is_ssl() const override;
  2724. bool setup_proxy_connection(
  2725. Socket &socket,
  2726. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2727. Response &res, bool &success, Error &error) override;
  2728. bool connect_with_proxy(
  2729. Socket &sock,
  2730. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2731. Response &res, bool &success, Error &error);
  2732. bool initialize_ssl(Socket &socket, Error &error);
  2733. void init_ctx();
  2734. void reset_ctx_on_error();
  2735. bool load_certs();
  2736. tls::ctx_t ctx_ = nullptr;
  2737. std::mutex ctx_mutex_;
  2738. std::once_flag initialize_cert_;
  2739. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2740. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2741. // Used to keep custom CA configuration exclusive with system CA loading.
  2742. bool ca_cert_store_set_ = false;
  2743. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2744. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2745. bool enable_windows_cert_verification_ = true;
  2746. #endif
  2747. friend class ClientImpl;
  2748. };
  2749. #endif // CPPHTTPLIB_SSL_ENABLED
  2750. namespace detail {
  2751. template <typename T, typename U>
  2752. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2753. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2754. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2755. duration - std::chrono::seconds(sec))
  2756. .count();
  2757. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2758. }
  2759. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2760. return N - 1;
  2761. }
  2762. inline bool is_numeric(const std::string &str) {
  2763. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2764. }
  2765. inline size_t get_header_value_u64(const Headers &headers,
  2766. const std::string &key, size_t def,
  2767. size_t id, bool &is_invalid_value) {
  2768. is_invalid_value = false;
  2769. auto rng = headers.equal_range(key);
  2770. auto it = rng.first;
  2771. std::advance(it, static_cast<ssize_t>(id));
  2772. if (it != rng.second) {
  2773. if (is_numeric(it->second)) {
  2774. // Parse at size_t width so an out-of-range Content-Length is reported
  2775. // rather than silently saturated/truncated (a value above 2^32 would
  2776. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2777. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2778. size_t val = 0;
  2779. const auto &s = it->second;
  2780. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2781. if (r.ec == std::errc::result_out_of_range) {
  2782. is_invalid_value = true;
  2783. return (std::numeric_limits<size_t>::max)();
  2784. }
  2785. return val;
  2786. } else {
  2787. is_invalid_value = true;
  2788. }
  2789. }
  2790. return def;
  2791. }
  2792. inline size_t get_header_value_u64(const Headers &headers,
  2793. const std::string &key, size_t def,
  2794. size_t id) {
  2795. auto dummy = false;
  2796. return get_header_value_u64(headers, key, def, id, dummy);
  2797. }
  2798. } // namespace detail
  2799. template <class Rep, class Period>
  2800. inline Server &
  2801. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2802. detail::duration_to_sec_and_usec(
  2803. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2804. return *this;
  2805. }
  2806. template <class Rep, class Period>
  2807. inline Server &
  2808. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2809. detail::duration_to_sec_and_usec(
  2810. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2811. return *this;
  2812. }
  2813. template <class Rep, class Period>
  2814. inline Server &
  2815. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2816. detail::duration_to_sec_and_usec(
  2817. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2818. return *this;
  2819. }
  2820. template <class Rep, class Period>
  2821. inline void ClientImpl::set_connection_timeout(
  2822. const std::chrono::duration<Rep, Period> &duration) {
  2823. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2824. set_connection_timeout(sec, usec);
  2825. });
  2826. }
  2827. template <class Rep, class Period>
  2828. inline void ClientImpl::set_read_timeout(
  2829. const std::chrono::duration<Rep, Period> &duration) {
  2830. detail::duration_to_sec_and_usec(
  2831. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2832. }
  2833. template <class Rep, class Period>
  2834. inline void ClientImpl::set_write_timeout(
  2835. const std::chrono::duration<Rep, Period> &duration) {
  2836. detail::duration_to_sec_and_usec(
  2837. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2838. }
  2839. template <class Rep, class Period>
  2840. inline void ClientImpl::set_max_timeout(
  2841. const std::chrono::duration<Rep, Period> &duration) {
  2842. auto msec =
  2843. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2844. set_max_timeout(msec);
  2845. }
  2846. template <class Rep, class Period>
  2847. inline void Client::set_connection_timeout(
  2848. const std::chrono::duration<Rep, Period> &duration) {
  2849. cli_->set_connection_timeout(duration);
  2850. }
  2851. template <class Rep, class Period>
  2852. inline void
  2853. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2854. cli_->set_read_timeout(duration);
  2855. }
  2856. template <class Rep, class Period>
  2857. inline void
  2858. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2859. cli_->set_write_timeout(duration);
  2860. }
  2861. inline void Client::set_max_timeout(time_t msec) {
  2862. cli_->set_max_timeout(msec);
  2863. }
  2864. template <class Rep, class Period>
  2865. inline void
  2866. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2867. cli_->set_max_timeout(duration);
  2868. }
  2869. /*
  2870. * Forward declarations and types that will be part of the .h file if split into
  2871. * .h + .cc.
  2872. */
  2873. std::string hosted_at(const std::string &hostname);
  2874. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2875. // JavaScript-style URL encoding/decoding functions
  2876. std::string encode_uri_component(const std::string &value);
  2877. std::string encode_uri(const std::string &value);
  2878. std::string decode_uri_component(const std::string &value);
  2879. std::string decode_uri(const std::string &value);
  2880. // RFC 3986 compliant URL component encoding/decoding functions
  2881. std::string encode_path_component(const std::string &component);
  2882. std::string decode_path_component(const std::string &component);
  2883. std::string encode_query_component(const std::string &component,
  2884. bool space_as_plus = true);
  2885. std::string decode_query_component(const std::string &component,
  2886. bool plus_as_space = true);
  2887. std::string sanitize_filename(const std::string &filename);
  2888. std::string append_query_params(const std::string &path, const Params &params);
  2889. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2890. std::pair<std::string, std::string>
  2891. make_basic_authentication_header(const std::string &username,
  2892. const std::string &password,
  2893. bool is_proxy = false);
  2894. namespace detail {
  2895. #if defined(_WIN32)
  2896. inline std::wstring u8string_to_wstring(const char *s) {
  2897. if (!s) { return std::wstring(); }
  2898. auto len = static_cast<int>(strlen(s));
  2899. if (!len) { return std::wstring(); }
  2900. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  2901. if (!wlen) { return std::wstring(); }
  2902. std::wstring ws;
  2903. ws.resize(wlen);
  2904. wlen = ::MultiByteToWideChar(
  2905. CP_UTF8, 0, s, len,
  2906. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  2907. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  2908. return ws;
  2909. }
  2910. #endif
  2911. struct FileStat {
  2912. FileStat(const std::string &path);
  2913. bool is_file() const;
  2914. bool is_dir() const;
  2915. time_t mtime() const;
  2916. size_t size() const;
  2917. private:
  2918. #if defined(_WIN32)
  2919. struct _stat st_;
  2920. #else
  2921. struct stat st_;
  2922. #endif
  2923. int ret_ = -1;
  2924. };
  2925. std::string make_host_and_port_string(const std::string &host, int port,
  2926. bool is_ssl);
  2927. template <typename T>
  2928. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  2929. Error &error);
  2930. std::string trim_copy(const std::string &s);
  2931. void divide(
  2932. const char *data, std::size_t size, char d,
  2933. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2934. fn);
  2935. void divide(
  2936. const std::string &str, char d,
  2937. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2938. fn);
  2939. void split(const char *b, const char *e, char d,
  2940. std::function<void(const char *, const char *)> fn);
  2941. void split(const char *b, const char *e, char d, size_t m,
  2942. std::function<void(const char *, const char *)> fn);
  2943. bool split_find(const char *b, const char *e, char d,
  2944. std::function<bool(const char *, const char *)> fn);
  2945. bool has_header_token(const Headers &headers, const std::string &key,
  2946. const std::string &token);
  2947. std::string websocket_accept_key(const std::string &client_key);
  2948. bool is_websocket_upgrade(const Request &req);
  2949. bool process_client_socket(
  2950. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  2951. time_t write_timeout_sec, time_t write_timeout_usec,
  2952. time_t max_timeout_msec,
  2953. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2954. std::function<bool(Stream &)> callback);
  2955. socket_t create_client_socket(const std::string &host, const std::string &ip,
  2956. int port, int address_family, bool tcp_nodelay,
  2957. bool ipv6_v6only, SocketOptions socket_options,
  2958. time_t connection_timeout_sec,
  2959. time_t connection_timeout_usec,
  2960. time_t read_timeout_sec, time_t read_timeout_usec,
  2961. time_t write_timeout_sec,
  2962. time_t write_timeout_usec,
  2963. const std::string &intf, Error &error);
  2964. const char *get_header_value(const Headers &headers, const std::string &key,
  2965. const char *def, size_t id);
  2966. std::string get_combined_header_value(const Headers &headers,
  2967. const std::string &key);
  2968. std::string params_to_query_str(const Params &params);
  2969. void parse_query_text(const char *data, std::size_t size, Params &params);
  2970. void parse_query_text(const std::string &s, Params &params);
  2971. bool parse_multipart_boundary(const std::string &content_type,
  2972. std::string &boundary);
  2973. bool parse_range_header(const std::string &s, Ranges &ranges);
  2974. bool parse_accept_header(const std::string &s,
  2975. std::vector<std::string> &content_types);
  2976. void parse_disposition_params(const std::string &s, Params &params);
  2977. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  2978. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  2979. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  2980. EncodingType encoding_type(const Request &req, const Response &res);
  2981. class BufferStream final : public Stream {
  2982. public:
  2983. BufferStream() = default;
  2984. ~BufferStream() override = default;
  2985. bool is_readable() const override;
  2986. bool wait_readable() const override;
  2987. bool wait_writable() const override;
  2988. ssize_t read(char *ptr, size_t size) override;
  2989. ssize_t write(const char *ptr, size_t size) override;
  2990. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  2991. void get_local_ip_and_port(std::string &ip, int &port) const override;
  2992. socket_t socket() const override;
  2993. time_t duration() const override;
  2994. const std::string &get_buffer() const;
  2995. private:
  2996. std::string buffer;
  2997. size_t position = 0;
  2998. };
  2999. class compressor {
  3000. public:
  3001. virtual ~compressor() = default;
  3002. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3003. virtual bool compress(const char *data, size_t data_length, bool last,
  3004. Callback callback) = 0;
  3005. };
  3006. class decompressor {
  3007. public:
  3008. virtual ~decompressor() = default;
  3009. virtual bool is_valid() const = 0;
  3010. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3011. virtual bool decompress(const char *data, size_t data_length,
  3012. Callback callback) = 0;
  3013. };
  3014. class nocompressor final : public compressor {
  3015. public:
  3016. ~nocompressor() override = default;
  3017. bool compress(const char *data, size_t data_length, bool /*last*/,
  3018. Callback callback) override;
  3019. };
  3020. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3021. class gzip_compressor final : public compressor {
  3022. public:
  3023. gzip_compressor();
  3024. ~gzip_compressor() override;
  3025. bool compress(const char *data, size_t data_length, bool last,
  3026. Callback callback) override;
  3027. private:
  3028. bool is_valid_ = false;
  3029. z_stream strm_;
  3030. };
  3031. class gzip_decompressor final : public decompressor {
  3032. public:
  3033. gzip_decompressor();
  3034. ~gzip_decompressor() override;
  3035. bool is_valid() const override;
  3036. bool decompress(const char *data, size_t data_length,
  3037. Callback callback) override;
  3038. private:
  3039. bool is_valid_ = false;
  3040. z_stream strm_;
  3041. };
  3042. #endif
  3043. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3044. class brotli_compressor final : public compressor {
  3045. public:
  3046. brotli_compressor();
  3047. ~brotli_compressor();
  3048. bool compress(const char *data, size_t data_length, bool last,
  3049. Callback callback) override;
  3050. private:
  3051. BrotliEncoderState *state_ = nullptr;
  3052. };
  3053. class brotli_decompressor final : public decompressor {
  3054. public:
  3055. brotli_decompressor();
  3056. ~brotli_decompressor();
  3057. bool is_valid() const override;
  3058. bool decompress(const char *data, size_t data_length,
  3059. Callback callback) override;
  3060. private:
  3061. BrotliDecoderResult decoder_r;
  3062. BrotliDecoderState *decoder_s = nullptr;
  3063. };
  3064. #endif
  3065. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3066. class zstd_compressor : public compressor {
  3067. public:
  3068. zstd_compressor();
  3069. ~zstd_compressor();
  3070. bool compress(const char *data, size_t data_length, bool last,
  3071. Callback callback) override;
  3072. private:
  3073. ZSTD_CCtx *ctx_ = nullptr;
  3074. };
  3075. class zstd_decompressor : public decompressor {
  3076. public:
  3077. zstd_decompressor();
  3078. ~zstd_decompressor();
  3079. bool is_valid() const override;
  3080. bool decompress(const char *data, size_t data_length,
  3081. Callback callback) override;
  3082. private:
  3083. ZSTD_DCtx *ctx_ = nullptr;
  3084. };
  3085. #endif
  3086. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3087. // to store data. The call can set memory on stack for performance.
  3088. class stream_line_reader {
  3089. public:
  3090. stream_line_reader(Stream &strm, char *fixed_buffer,
  3091. size_t fixed_buffer_size);
  3092. const char *ptr() const;
  3093. size_t size() const;
  3094. bool end_with_crlf() const;
  3095. bool getline();
  3096. private:
  3097. void append(char c);
  3098. void append(const char *data, size_t size);
  3099. Stream &strm_;
  3100. char *fixed_buffer_;
  3101. const size_t fixed_buffer_size_;
  3102. size_t fixed_buffer_used_size_ = 0;
  3103. std::string growable_buffer_;
  3104. };
  3105. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3106. const Headers &src_headers);
  3107. struct ChunkedDecoder {
  3108. Stream &strm;
  3109. size_t chunk_remaining = 0;
  3110. bool finished = false;
  3111. char line_buf[64];
  3112. size_t last_chunk_total = 0;
  3113. size_t last_chunk_offset = 0;
  3114. explicit ChunkedDecoder(Stream &s);
  3115. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3116. size_t &out_chunk_total);
  3117. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3118. };
  3119. class mmap {
  3120. public:
  3121. mmap(const char *path);
  3122. ~mmap();
  3123. bool open(const char *path);
  3124. void close();
  3125. bool is_open() const;
  3126. size_t size() const;
  3127. const char *data() const;
  3128. private:
  3129. #if defined(_WIN32)
  3130. HANDLE hFile_ = NULL;
  3131. HANDLE hMapping_ = NULL;
  3132. #else
  3133. int fd_ = -1;
  3134. #endif
  3135. size_t size_ = 0;
  3136. void *addr_ = nullptr;
  3137. bool is_open_empty_file = false;
  3138. };
  3139. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3140. namespace fields {
  3141. bool is_token_char(char c);
  3142. bool is_token(const std::string &s);
  3143. bool is_field_name(const std::string &s);
  3144. bool is_vchar(char c);
  3145. bool is_obs_text(char c);
  3146. bool is_field_vchar(char c);
  3147. bool is_field_content(const std::string &s);
  3148. bool is_field_value(const std::string &s);
  3149. bool is_field_valid(const std::string &name, const std::string &value);
  3150. } // namespace fields
  3151. } // namespace detail
  3152. /*
  3153. * TLS Abstraction Layer Declarations
  3154. */
  3155. #ifdef CPPHTTPLIB_SSL_ENABLED
  3156. // TLS abstraction layer - backend-specific type declarations
  3157. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3158. namespace tls {
  3159. namespace impl {
  3160. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3161. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3162. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3163. struct MbedTlsContext {
  3164. mbedtls_ssl_config conf;
  3165. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3166. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3167. mbedtls_entropy_context entropy;
  3168. mbedtls_ctr_drbg_context ctr_drbg;
  3169. #endif
  3170. mbedtls_x509_crt ca_chain;
  3171. mbedtls_x509_crt own_cert;
  3172. mbedtls_pk_context own_key;
  3173. bool is_server = false;
  3174. bool verify_client = false;
  3175. bool has_verify_callback = false;
  3176. MbedTlsContext();
  3177. ~MbedTlsContext();
  3178. MbedTlsContext(const MbedTlsContext &) = delete;
  3179. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3180. };
  3181. } // namespace impl
  3182. } // namespace tls
  3183. #endif
  3184. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3185. namespace tls {
  3186. namespace impl {
  3187. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3188. // This struct is accessible via tls::impl for use in SSL context
  3189. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3190. struct WolfSSLContext {
  3191. WOLFSSL_CTX *ctx = nullptr;
  3192. bool is_server = false;
  3193. bool verify_client = false;
  3194. bool has_verify_callback = false;
  3195. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3196. WolfSSLContext();
  3197. ~WolfSSLContext();
  3198. WolfSSLContext(const WolfSSLContext &) = delete;
  3199. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3200. };
  3201. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3202. struct WolfSSLCAStore {
  3203. std::string pem_data;
  3204. };
  3205. } // namespace impl
  3206. } // namespace tls
  3207. #endif
  3208. #endif // CPPHTTPLIB_SSL_ENABLED
  3209. namespace stream {
  3210. class Result {
  3211. public:
  3212. Result();
  3213. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3214. Result(Result &&other) noexcept;
  3215. Result &operator=(Result &&other) noexcept;
  3216. Result(const Result &) = delete;
  3217. Result &operator=(const Result &) = delete;
  3218. // Response info
  3219. bool is_valid() const;
  3220. explicit operator bool() const;
  3221. int status() const;
  3222. const Headers &headers() const;
  3223. std::string get_header_value(const std::string &key,
  3224. const char *def = "") const;
  3225. bool has_header(const std::string &key) const;
  3226. Error error() const;
  3227. Error read_error() const;
  3228. bool has_read_error() const;
  3229. // Stream reading
  3230. bool next();
  3231. const char *data() const;
  3232. size_t size() const;
  3233. std::string read_all();
  3234. private:
  3235. ClientImpl::StreamHandle handle_;
  3236. std::string buffer_;
  3237. size_t current_size_ = 0;
  3238. size_t chunk_size_;
  3239. bool finished_ = false;
  3240. };
  3241. // GET
  3242. template <typename ClientType>
  3243. inline Result Get(ClientType &cli, const std::string &path,
  3244. size_t chunk_size = 8192) {
  3245. return Result{cli.open_stream("GET", path), chunk_size};
  3246. }
  3247. template <typename ClientType>
  3248. inline Result Get(ClientType &cli, const std::string &path,
  3249. const Headers &headers, size_t chunk_size = 8192) {
  3250. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3251. }
  3252. template <typename ClientType>
  3253. inline Result Get(ClientType &cli, const std::string &path,
  3254. const Params &params, size_t chunk_size = 8192) {
  3255. return Result{cli.open_stream("GET", path, params), chunk_size};
  3256. }
  3257. template <typename ClientType>
  3258. inline Result Get(ClientType &cli, const std::string &path,
  3259. const Params &params, const Headers &headers,
  3260. size_t chunk_size = 8192) {
  3261. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3262. }
  3263. // POST
  3264. template <typename ClientType>
  3265. inline Result Post(ClientType &cli, const std::string &path,
  3266. const std::string &body, const std::string &content_type,
  3267. size_t chunk_size = 8192) {
  3268. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3269. chunk_size};
  3270. }
  3271. template <typename ClientType>
  3272. inline Result Post(ClientType &cli, const std::string &path,
  3273. const Headers &headers, const std::string &body,
  3274. const std::string &content_type, size_t chunk_size = 8192) {
  3275. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3276. chunk_size};
  3277. }
  3278. template <typename ClientType>
  3279. inline Result Post(ClientType &cli, const std::string &path,
  3280. const Params &params, const std::string &body,
  3281. const std::string &content_type, size_t chunk_size = 8192) {
  3282. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3283. chunk_size};
  3284. }
  3285. template <typename ClientType>
  3286. inline Result Post(ClientType &cli, const std::string &path,
  3287. const Params &params, const Headers &headers,
  3288. const std::string &body, const std::string &content_type,
  3289. size_t chunk_size = 8192) {
  3290. return Result{
  3291. cli.open_stream("POST", path, params, headers, body, content_type),
  3292. chunk_size};
  3293. }
  3294. // PUT
  3295. template <typename ClientType>
  3296. inline Result Put(ClientType &cli, const std::string &path,
  3297. const std::string &body, const std::string &content_type,
  3298. size_t chunk_size = 8192) {
  3299. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3300. chunk_size};
  3301. }
  3302. template <typename ClientType>
  3303. inline Result Put(ClientType &cli, const std::string &path,
  3304. const Headers &headers, const std::string &body,
  3305. const std::string &content_type, size_t chunk_size = 8192) {
  3306. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3307. chunk_size};
  3308. }
  3309. template <typename ClientType>
  3310. inline Result Put(ClientType &cli, const std::string &path,
  3311. const Params &params, const std::string &body,
  3312. const std::string &content_type, size_t chunk_size = 8192) {
  3313. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3314. chunk_size};
  3315. }
  3316. template <typename ClientType>
  3317. inline Result Put(ClientType &cli, const std::string &path,
  3318. const Params &params, const Headers &headers,
  3319. const std::string &body, const std::string &content_type,
  3320. size_t chunk_size = 8192) {
  3321. return Result{
  3322. cli.open_stream("PUT", path, params, headers, body, content_type),
  3323. chunk_size};
  3324. }
  3325. // PATCH
  3326. template <typename ClientType>
  3327. inline Result Patch(ClientType &cli, const std::string &path,
  3328. const std::string &body, const std::string &content_type,
  3329. size_t chunk_size = 8192) {
  3330. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3331. chunk_size};
  3332. }
  3333. template <typename ClientType>
  3334. inline Result Patch(ClientType &cli, const std::string &path,
  3335. const Headers &headers, const std::string &body,
  3336. const std::string &content_type, size_t chunk_size = 8192) {
  3337. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3338. chunk_size};
  3339. }
  3340. template <typename ClientType>
  3341. inline Result Patch(ClientType &cli, const std::string &path,
  3342. const Params &params, const std::string &body,
  3343. const std::string &content_type, size_t chunk_size = 8192) {
  3344. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3345. chunk_size};
  3346. }
  3347. template <typename ClientType>
  3348. inline Result Patch(ClientType &cli, const std::string &path,
  3349. const Params &params, const Headers &headers,
  3350. const std::string &body, const std::string &content_type,
  3351. size_t chunk_size = 8192) {
  3352. return Result{
  3353. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3354. chunk_size};
  3355. }
  3356. // DELETE
  3357. template <typename ClientType>
  3358. inline Result Delete(ClientType &cli, const std::string &path,
  3359. size_t chunk_size = 8192) {
  3360. return Result{cli.open_stream("DELETE", path), chunk_size};
  3361. }
  3362. template <typename ClientType>
  3363. inline Result Delete(ClientType &cli, const std::string &path,
  3364. const Headers &headers, size_t chunk_size = 8192) {
  3365. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3366. }
  3367. template <typename ClientType>
  3368. inline Result Delete(ClientType &cli, const std::string &path,
  3369. const std::string &body, const std::string &content_type,
  3370. size_t chunk_size = 8192) {
  3371. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3372. chunk_size};
  3373. }
  3374. template <typename ClientType>
  3375. inline Result Delete(ClientType &cli, const std::string &path,
  3376. const Headers &headers, const std::string &body,
  3377. const std::string &content_type,
  3378. size_t chunk_size = 8192) {
  3379. return Result{
  3380. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3381. chunk_size};
  3382. }
  3383. template <typename ClientType>
  3384. inline Result Delete(ClientType &cli, const std::string &path,
  3385. const Params &params, size_t chunk_size = 8192) {
  3386. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3387. }
  3388. template <typename ClientType>
  3389. inline Result Delete(ClientType &cli, const std::string &path,
  3390. const Params &params, const Headers &headers,
  3391. size_t chunk_size = 8192) {
  3392. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3393. }
  3394. template <typename ClientType>
  3395. inline Result Delete(ClientType &cli, const std::string &path,
  3396. const Params &params, const std::string &body,
  3397. const std::string &content_type,
  3398. size_t chunk_size = 8192) {
  3399. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3400. chunk_size};
  3401. }
  3402. template <typename ClientType>
  3403. inline Result Delete(ClientType &cli, const std::string &path,
  3404. const Params &params, const Headers &headers,
  3405. const std::string &body, const std::string &content_type,
  3406. size_t chunk_size = 8192) {
  3407. return Result{
  3408. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3409. chunk_size};
  3410. }
  3411. // HEAD
  3412. template <typename ClientType>
  3413. inline Result Head(ClientType &cli, const std::string &path,
  3414. size_t chunk_size = 8192) {
  3415. return Result{cli.open_stream("HEAD", path), chunk_size};
  3416. }
  3417. template <typename ClientType>
  3418. inline Result Head(ClientType &cli, const std::string &path,
  3419. const Headers &headers, size_t chunk_size = 8192) {
  3420. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3421. }
  3422. template <typename ClientType>
  3423. inline Result Head(ClientType &cli, const std::string &path,
  3424. const Params &params, size_t chunk_size = 8192) {
  3425. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3426. }
  3427. template <typename ClientType>
  3428. inline Result Head(ClientType &cli, const std::string &path,
  3429. const Params &params, const Headers &headers,
  3430. size_t chunk_size = 8192) {
  3431. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3432. }
  3433. // OPTIONS
  3434. template <typename ClientType>
  3435. inline Result Options(ClientType &cli, const std::string &path,
  3436. size_t chunk_size = 8192) {
  3437. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3438. }
  3439. template <typename ClientType>
  3440. inline Result Options(ClientType &cli, const std::string &path,
  3441. const Headers &headers, size_t chunk_size = 8192) {
  3442. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3443. }
  3444. template <typename ClientType>
  3445. inline Result Options(ClientType &cli, const std::string &path,
  3446. const Params &params, size_t chunk_size = 8192) {
  3447. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3448. }
  3449. template <typename ClientType>
  3450. inline Result Options(ClientType &cli, const std::string &path,
  3451. const Params &params, const Headers &headers,
  3452. size_t chunk_size = 8192) {
  3453. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3454. }
  3455. } // namespace stream
  3456. namespace sse {
  3457. struct SSEMessage {
  3458. std::string event; // Event type (default: "message")
  3459. std::string data; // Event payload
  3460. std::string id; // Event ID for Last-Event-ID header
  3461. SSEMessage();
  3462. void clear();
  3463. };
  3464. class SSEClient {
  3465. public:
  3466. using MessageHandler = std::function<void(const SSEMessage &)>;
  3467. using ErrorHandler = std::function<void(Error)>;
  3468. using OpenHandler = std::function<void()>;
  3469. SSEClient(Client &client, const std::string &path);
  3470. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3471. ~SSEClient();
  3472. SSEClient(const SSEClient &) = delete;
  3473. SSEClient &operator=(const SSEClient &) = delete;
  3474. // Event handlers
  3475. SSEClient &on_message(MessageHandler handler);
  3476. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3477. SSEClient &on_open(OpenHandler handler);
  3478. SSEClient &on_error(ErrorHandler handler);
  3479. SSEClient &set_reconnect_interval(int ms);
  3480. SSEClient &set_max_reconnect_attempts(int n);
  3481. // Update headers (thread-safe)
  3482. SSEClient &set_headers(const Headers &headers);
  3483. // State accessors
  3484. bool is_connected() const;
  3485. const std::string &last_event_id() const;
  3486. // Blocking start - runs event loop with auto-reconnect
  3487. void start();
  3488. // Non-blocking start - runs in background thread
  3489. void start_async();
  3490. // Stop the client (thread-safe)
  3491. void stop();
  3492. private:
  3493. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3494. void run_event_loop();
  3495. void dispatch_event(const SSEMessage &msg);
  3496. bool should_reconnect(int count) const;
  3497. void wait_for_reconnect();
  3498. // Client and path
  3499. Client &client_;
  3500. std::string path_;
  3501. Headers headers_;
  3502. mutable std::mutex headers_mutex_;
  3503. // Callbacks
  3504. MessageHandler on_message_;
  3505. std::map<std::string, MessageHandler> event_handlers_;
  3506. OpenHandler on_open_;
  3507. ErrorHandler on_error_;
  3508. // Configuration
  3509. int reconnect_interval_ms_ = 3000;
  3510. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3511. // State
  3512. std::atomic<bool> running_{false};
  3513. std::atomic<bool> connected_{false};
  3514. std::string last_event_id_;
  3515. // Async support
  3516. std::thread async_thread_;
  3517. };
  3518. } // namespace sse
  3519. namespace ws {
  3520. enum class Opcode : uint8_t {
  3521. Continuation = 0x0,
  3522. Text = 0x1,
  3523. Binary = 0x2,
  3524. Close = 0x8,
  3525. Ping = 0x9,
  3526. Pong = 0xA,
  3527. };
  3528. enum class CloseStatus : uint16_t {
  3529. Normal = 1000,
  3530. GoingAway = 1001,
  3531. ProtocolError = 1002,
  3532. UnsupportedData = 1003,
  3533. NoStatus = 1005,
  3534. Abnormal = 1006,
  3535. InvalidPayload = 1007,
  3536. PolicyViolation = 1008,
  3537. MessageTooBig = 1009,
  3538. MandatoryExtension = 1010,
  3539. InternalError = 1011,
  3540. };
  3541. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2 };
  3542. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3543. // upgrade handshake fully succeeded. On failure error() identifies the
  3544. // failing layer; status()/headers() expose the server's upgrade response
  3545. // when one was received (status() is -1 otherwise).
  3546. class Result {
  3547. public:
  3548. Result() = default;
  3549. Result(Error err, int status, Headers &&headers)
  3550. : err_(err), status_(status), headers_(std::move(headers)) {}
  3551. explicit operator bool() const { return err_ == Error::Success; }
  3552. Error error() const { return err_; }
  3553. // Upgrade response info
  3554. int status() const { return status_; }
  3555. const Headers &headers() const { return headers_; }
  3556. std::string get_header_value(const std::string &key,
  3557. const char *def = "") const {
  3558. return detail::get_header_value(headers_, key, def, 0);
  3559. }
  3560. bool has_header(const std::string &key) const {
  3561. return headers_.find(key) != headers_.end();
  3562. }
  3563. #ifdef CPPHTTPLIB_SSL_ENABLED
  3564. Result(Error err, int status, Headers &&headers, int ssl_error,
  3565. uint64_t ssl_backend_error)
  3566. : err_(err), status_(status), headers_(std::move(headers)),
  3567. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3568. int ssl_error() const { return ssl_error_; }
  3569. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3570. #endif
  3571. private:
  3572. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3573. int status_ = -1;
  3574. Headers headers_;
  3575. #ifdef CPPHTTPLIB_SSL_ENABLED
  3576. int ssl_error_ = 0;
  3577. uint64_t ssl_backend_error_ = 0;
  3578. #endif
  3579. };
  3580. class WebSocket {
  3581. public:
  3582. WebSocket(const WebSocket &) = delete;
  3583. WebSocket &operator=(const WebSocket &) = delete;
  3584. ~WebSocket();
  3585. ReadResult read(std::string &msg);
  3586. bool send(const std::string &data);
  3587. bool send(const char *data, size_t len);
  3588. void close(CloseStatus status = CloseStatus::Normal,
  3589. const std::string &reason = "");
  3590. const Request &request() const;
  3591. bool is_open() const;
  3592. private:
  3593. friend class httplib::Server;
  3594. friend class WebSocketClient;
  3595. WebSocket(
  3596. Stream &strm, const Request &req, bool is_server,
  3597. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3598. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3599. : strm_(strm), req_(req), is_server_(is_server),
  3600. ping_interval_sec_(ping_interval_sec),
  3601. max_missed_pongs_(max_missed_pongs) {
  3602. start_heartbeat();
  3603. }
  3604. WebSocket(
  3605. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3606. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3607. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3608. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3609. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3610. max_missed_pongs_(max_missed_pongs) {
  3611. start_heartbeat();
  3612. }
  3613. void start_heartbeat();
  3614. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3615. Stream &strm_;
  3616. std::unique_ptr<Stream> owned_strm_;
  3617. Request req_;
  3618. bool is_server_;
  3619. time_t ping_interval_sec_;
  3620. int max_missed_pongs_;
  3621. int unacked_pings_ = 0;
  3622. std::atomic<bool> closed_{false};
  3623. std::mutex write_mutex_;
  3624. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3625. // may do so: read_websocket_frame() reads a payload until it has the whole
  3626. // declared length, so a second parser stealing bytes silently corrupts the
  3627. // message the first one is assembling.
  3628. std::mutex read_mutex_;
  3629. std::thread ping_thread_;
  3630. std::mutex ping_mutex_;
  3631. std::condition_variable ping_cv_;
  3632. };
  3633. class WebSocketClient {
  3634. public:
  3635. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3636. const Headers &headers = {});
  3637. ~WebSocketClient();
  3638. WebSocketClient(const WebSocketClient &) = delete;
  3639. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3640. bool is_valid() const;
  3641. Result connect();
  3642. ReadResult read(std::string &msg);
  3643. bool send(const std::string &data);
  3644. bool send(const char *data, size_t len);
  3645. void close(CloseStatus status = CloseStatus::Normal,
  3646. const std::string &reason = "");
  3647. bool is_open() const;
  3648. const std::string &subprotocol() const;
  3649. void set_read_timeout(time_t sec, time_t usec = 0);
  3650. template <class Rep, class Period>
  3651. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3652. void set_write_timeout(time_t sec, time_t usec = 0);
  3653. template <class Rep, class Period>
  3654. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3655. void set_websocket_ping_interval(time_t sec);
  3656. void set_websocket_max_missed_pongs(int count);
  3657. void set_tcp_nodelay(bool on);
  3658. void set_address_family(int family);
  3659. void set_ipv6_v6only(bool on);
  3660. void set_socket_options(SocketOptions socket_options);
  3661. void set_connection_timeout(time_t sec, time_t usec = 0);
  3662. template <class Rep, class Period>
  3663. void
  3664. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3665. void set_interface(const std::string &intf);
  3666. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3667. #ifdef CPPHTTPLIB_SSL_ENABLED
  3668. struct PemMemory {
  3669. const char *cert_pem;
  3670. size_t cert_pem_len;
  3671. const char *key_pem;
  3672. size_t key_pem_len;
  3673. const char *private_key_password;
  3674. };
  3675. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3676. const PemMemory &pem, const Headers &headers = {});
  3677. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3678. const std::string &ca_cert_dir_path = std::string());
  3679. void set_ca_cert_store(tls::ca_store_t store);
  3680. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3681. void enable_server_certificate_verification(bool enabled);
  3682. void enable_server_hostname_verification(bool enabled);
  3683. void enable_system_ca(bool enabled);
  3684. #endif
  3685. private:
  3686. void shutdown_and_close();
  3687. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3688. int &ssl_error, uint64_t &ssl_backend_error);
  3689. void prepare_default_headers(Request &req);
  3690. std::string host_;
  3691. int port_;
  3692. std::string path_;
  3693. Headers headers_;
  3694. std::string subprotocol_;
  3695. bool is_valid_ = false;
  3696. socket_t sock_ = INVALID_SOCKET;
  3697. std::unique_ptr<WebSocket> ws_;
  3698. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND;
  3699. time_t read_timeout_usec_ = 0;
  3700. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3701. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3702. time_t websocket_ping_interval_sec_ =
  3703. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3704. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3705. int address_family_ = AF_UNSPEC;
  3706. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3707. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3708. SocketOptions socket_options_ = nullptr;
  3709. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3710. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3711. std::string interface_;
  3712. // Hostname to connection target map. The value is an IP literal or another
  3713. // hostname; only the connection target changes, never the identity.
  3714. std::map<std::string, std::string> addr_map_;
  3715. #ifdef CPPHTTPLIB_SSL_ENABLED
  3716. bool is_ssl_ = false;
  3717. tls::ctx_t tls_ctx_ = nullptr;
  3718. tls::session_t tls_session_ = nullptr;
  3719. std::string ca_cert_file_path_;
  3720. std::string ca_cert_dir_path_;
  3721. bool custom_ca_loaded_ = false;
  3722. bool certs_loaded_ = false;
  3723. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3724. bool server_certificate_verification_ = true;
  3725. bool server_hostname_verification_ = true;
  3726. #endif
  3727. };
  3728. template <class Rep, class Period>
  3729. inline void WebSocketClient::set_read_timeout(
  3730. const std::chrono::duration<Rep, Period> &duration) {
  3731. detail::duration_to_sec_and_usec(
  3732. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3733. }
  3734. template <class Rep, class Period>
  3735. inline void WebSocketClient::set_write_timeout(
  3736. const std::chrono::duration<Rep, Period> &duration) {
  3737. detail::duration_to_sec_and_usec(
  3738. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3739. }
  3740. template <class Rep, class Period>
  3741. inline void WebSocketClient::set_connection_timeout(
  3742. const std::chrono::duration<Rep, Period> &duration) {
  3743. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3744. set_connection_timeout(sec, usec);
  3745. });
  3746. }
  3747. namespace impl {
  3748. bool is_valid_utf8(const std::string &s);
  3749. bool read_websocket_frame(Stream &strm, Opcode &opcode, std::string &payload,
  3750. bool &fin, bool expect_masked, size_t max_len);
  3751. } // namespace impl
  3752. } // namespace ws
  3753. // ----------------------------------------------------------------------------
  3754. /*
  3755. * Implementation that will be part of the .cc file if split into .h + .cc.
  3756. */
  3757. namespace stream {
  3758. // stream::Result implementations
  3759. inline Result::Result() : chunk_size_(8192) {}
  3760. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3761. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3762. inline Result::Result(Result &&other) noexcept
  3763. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3764. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3765. finished_(other.finished_) {
  3766. other.current_size_ = 0;
  3767. other.finished_ = true;
  3768. }
  3769. inline Result &Result::operator=(Result &&other) noexcept {
  3770. if (this != &other) {
  3771. handle_ = std::move(other.handle_);
  3772. buffer_ = std::move(other.buffer_);
  3773. current_size_ = other.current_size_;
  3774. chunk_size_ = other.chunk_size_;
  3775. finished_ = other.finished_;
  3776. other.current_size_ = 0;
  3777. other.finished_ = true;
  3778. }
  3779. return *this;
  3780. }
  3781. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3782. inline Result::operator bool() const { return is_valid(); }
  3783. inline int Result::status() const {
  3784. return handle_.response ? handle_.response->status : -1;
  3785. }
  3786. inline const Headers &Result::headers() const {
  3787. static const Headers empty_headers;
  3788. return handle_.response ? handle_.response->headers : empty_headers;
  3789. }
  3790. inline std::string Result::get_header_value(const std::string &key,
  3791. const char *def) const {
  3792. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3793. }
  3794. inline bool Result::has_header(const std::string &key) const {
  3795. return handle_.response ? handle_.response->has_header(key) : false;
  3796. }
  3797. inline Error Result::error() const { return handle_.error; }
  3798. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3799. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3800. inline bool Result::next() {
  3801. if (!handle_.is_valid() || finished_) { return false; }
  3802. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3803. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3804. if (n > 0) {
  3805. current_size_ = static_cast<size_t>(n);
  3806. return true;
  3807. }
  3808. current_size_ = 0;
  3809. finished_ = true;
  3810. return false;
  3811. }
  3812. inline const char *Result::data() const { return buffer_.data(); }
  3813. inline size_t Result::size() const { return current_size_; }
  3814. inline std::string Result::read_all() {
  3815. std::string result;
  3816. while (next()) {
  3817. result.append(data(), size());
  3818. }
  3819. return result;
  3820. }
  3821. } // namespace stream
  3822. namespace sse {
  3823. // SSEMessage implementations
  3824. inline SSEMessage::SSEMessage() : event("message") {}
  3825. inline void SSEMessage::clear() {
  3826. event = "message";
  3827. data.clear();
  3828. id.clear();
  3829. }
  3830. // SSEClient implementations
  3831. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3832. : client_(client), path_(path) {}
  3833. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3834. const Headers &headers)
  3835. : client_(client), path_(path), headers_(headers) {}
  3836. inline SSEClient::~SSEClient() { stop(); }
  3837. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3838. on_message_ = std::move(handler);
  3839. return *this;
  3840. }
  3841. inline SSEClient &SSEClient::on_event(const std::string &type,
  3842. MessageHandler handler) {
  3843. event_handlers_[type] = std::move(handler);
  3844. return *this;
  3845. }
  3846. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3847. on_open_ = std::move(handler);
  3848. return *this;
  3849. }
  3850. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3851. on_error_ = std::move(handler);
  3852. return *this;
  3853. }
  3854. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3855. reconnect_interval_ms_ = ms;
  3856. return *this;
  3857. }
  3858. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3859. max_reconnect_attempts_ = n;
  3860. return *this;
  3861. }
  3862. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  3863. std::lock_guard<std::mutex> lock(headers_mutex_);
  3864. headers_ = headers;
  3865. return *this;
  3866. }
  3867. inline bool SSEClient::is_connected() const { return connected_.load(); }
  3868. inline const std::string &SSEClient::last_event_id() const {
  3869. return last_event_id_;
  3870. }
  3871. inline void SSEClient::start() {
  3872. running_.store(true);
  3873. run_event_loop();
  3874. }
  3875. inline void SSEClient::start_async() {
  3876. running_.store(true);
  3877. async_thread_ = std::thread([this]() { run_event_loop(); });
  3878. }
  3879. inline void SSEClient::stop() {
  3880. running_.store(false);
  3881. client_.stop(); // Cancel any pending operations
  3882. if (async_thread_.joinable()) { async_thread_.join(); }
  3883. }
  3884. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  3885. int &retry_ms) {
  3886. // Blank line signals end of event
  3887. if (line.empty() || line == "\r") { return true; }
  3888. // Lines starting with ':' are comments (ignored)
  3889. if (!line.empty() && line[0] == ':') { return false; }
  3890. // Find the colon separator
  3891. auto colon_pos = line.find(':');
  3892. if (colon_pos == std::string::npos) {
  3893. // Line with no colon is treated as field name with empty value
  3894. return false;
  3895. }
  3896. auto field = line.substr(0, colon_pos);
  3897. std::string value;
  3898. // Value starts after colon, skip optional single space
  3899. if (colon_pos + 1 < line.size()) {
  3900. auto value_start = colon_pos + 1;
  3901. if (line[value_start] == ' ') { value_start++; }
  3902. value = line.substr(value_start);
  3903. // Remove trailing \r if present
  3904. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  3905. }
  3906. // Handle known fields
  3907. if (field == "event") {
  3908. msg.event = value;
  3909. } else if (field == "data") {
  3910. // Multiple data lines are concatenated with newlines
  3911. if (!msg.data.empty()) { msg.data += "\n"; }
  3912. msg.data += value;
  3913. } else if (field == "id") {
  3914. // Empty id is valid (clears the last event ID)
  3915. msg.id = value;
  3916. } else if (field == "retry") {
  3917. // Parse retry interval in milliseconds
  3918. {
  3919. int v = 0;
  3920. auto res =
  3921. detail::from_chars(value.data(), value.data() + value.size(), v);
  3922. if (res.ec == std::errc{}) { retry_ms = v; }
  3923. }
  3924. }
  3925. // Unknown fields are ignored per SSE spec
  3926. return false;
  3927. }
  3928. inline void SSEClient::run_event_loop() {
  3929. auto reconnect_count = 0;
  3930. while (running_.load()) {
  3931. // Build headers, including Last-Event-ID if we have one
  3932. Headers request_headers;
  3933. {
  3934. std::lock_guard<std::mutex> lock(headers_mutex_);
  3935. request_headers = headers_;
  3936. }
  3937. if (!last_event_id_.empty()) {
  3938. request_headers.emplace("Last-Event-ID", last_event_id_);
  3939. }
  3940. // Open streaming connection
  3941. auto result = stream::Get(client_, path_, request_headers);
  3942. // Connection error handling
  3943. if (!result) {
  3944. connected_.store(false);
  3945. if (on_error_) { on_error_(result.error()); }
  3946. if (!should_reconnect(reconnect_count)) { break; }
  3947. wait_for_reconnect();
  3948. reconnect_count++;
  3949. continue;
  3950. }
  3951. if (result.status() != StatusCode::OK_200) {
  3952. connected_.store(false);
  3953. if (on_error_) { on_error_(Error::Connection); }
  3954. // For certain errors, don't reconnect.
  3955. // Note: 401 is intentionally absent so that handlers can refresh
  3956. // credentials via set_headers() and let the client reconnect.
  3957. if (result.status() == StatusCode::NoContent_204 ||
  3958. result.status() == StatusCode::NotFound_404 ||
  3959. result.status() == StatusCode::Forbidden_403) {
  3960. break;
  3961. }
  3962. if (!should_reconnect(reconnect_count)) { break; }
  3963. wait_for_reconnect();
  3964. reconnect_count++;
  3965. continue;
  3966. }
  3967. // Connection successful
  3968. connected_.store(true);
  3969. reconnect_count = 0;
  3970. if (on_open_) { on_open_(); }
  3971. // Event receiving loop
  3972. std::string buffer;
  3973. SSEMessage current_msg;
  3974. while (running_.load() && result.next()) {
  3975. buffer.append(result.data(), result.size());
  3976. // Process complete lines in the buffer
  3977. size_t line_start = 0;
  3978. size_t newline_pos;
  3979. while ((newline_pos = buffer.find('\n', line_start)) !=
  3980. std::string::npos) {
  3981. auto line = buffer.substr(line_start, newline_pos - line_start);
  3982. line_start = newline_pos + 1;
  3983. // Parse the line and check if event is complete
  3984. auto event_complete =
  3985. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  3986. if (event_complete && !current_msg.data.empty()) {
  3987. // Update last_event_id for reconnection
  3988. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  3989. // Dispatch event to appropriate handler
  3990. dispatch_event(current_msg);
  3991. current_msg.clear();
  3992. }
  3993. }
  3994. // Keep unprocessed data in buffer
  3995. buffer.erase(0, line_start);
  3996. }
  3997. // Connection ended
  3998. connected_.store(false);
  3999. if (!running_.load()) { break; }
  4000. // Check for read errors
  4001. if (result.has_read_error()) {
  4002. if (on_error_) { on_error_(result.read_error()); }
  4003. }
  4004. if (!should_reconnect(reconnect_count)) { break; }
  4005. wait_for_reconnect();
  4006. reconnect_count++;
  4007. }
  4008. connected_.store(false);
  4009. }
  4010. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4011. // Check for specific event type handler first
  4012. auto it = event_handlers_.find(msg.event);
  4013. if (it != event_handlers_.end()) {
  4014. it->second(msg);
  4015. return;
  4016. }
  4017. // Fall back to generic message handler
  4018. if (on_message_) { on_message_(msg); }
  4019. }
  4020. inline bool SSEClient::should_reconnect(int count) const {
  4021. if (!running_.load()) { return false; }
  4022. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4023. return count < max_reconnect_attempts_;
  4024. }
  4025. inline void SSEClient::wait_for_reconnect() {
  4026. // Use small increments to check running_ flag frequently
  4027. auto waited = 0;
  4028. while (running_.load() && waited < reconnect_interval_ms_) {
  4029. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  4030. waited += 100;
  4031. }
  4032. }
  4033. } // namespace sse
  4034. #ifdef CPPHTTPLIB_SSL_ENABLED
  4035. /*
  4036. * TLS abstraction layer - internal function declarations
  4037. * These are implementation details and not part of the public API.
  4038. */
  4039. namespace tls {
  4040. // Client context
  4041. ctx_t create_client_context();
  4042. void free_context(ctx_t ctx);
  4043. bool set_min_version(ctx_t ctx, Version version);
  4044. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4045. bool load_ca_file(ctx_t ctx, const char *file_path);
  4046. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4047. bool load_system_certs(ctx_t ctx);
  4048. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4049. const char *password);
  4050. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4051. const char *key_path, const char *password);
  4052. // Server context
  4053. ctx_t create_server_context();
  4054. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4055. const char *password);
  4056. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4057. const char *key_path, const char *password);
  4058. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4059. void set_verify_client(ctx_t ctx, bool require);
  4060. // Session management
  4061. session_t create_session(ctx_t ctx, socket_t sock);
  4062. void free_session(session_t session);
  4063. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4064. // Handshake (non-blocking capable)
  4065. TlsError connect(session_t session);
  4066. TlsError accept(session_t session);
  4067. // Handshake with timeout (blocking until timeout)
  4068. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4069. time_t timeout_usec, TlsError *err);
  4070. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4071. time_t timeout_usec, TlsError *err);
  4072. // I/O (non-blocking capable)
  4073. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4074. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4075. int pending(const_session_t session);
  4076. void shutdown(session_t session, bool graceful);
  4077. // Connection state
  4078. bool is_peer_closed(session_t session, socket_t sock);
  4079. // Certificate verification
  4080. cert_t get_peer_cert(const_session_t session);
  4081. void free_cert(cert_t cert);
  4082. bool verify_hostname(cert_t cert, const char *hostname);
  4083. uint64_t hostname_mismatch_code();
  4084. long get_verify_result(const_session_t session);
  4085. // Certificate introspection
  4086. std::string get_cert_subject_cn(cert_t cert);
  4087. std::string get_cert_issuer_name(cert_t cert);
  4088. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4089. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4090. std::string get_cert_serial(cert_t cert);
  4091. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4092. const char *get_sni(const_session_t session);
  4093. // CA store management
  4094. ca_store_t create_ca_store(const char *pem, size_t len);
  4095. void free_ca_store(ca_store_t store);
  4096. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4097. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4098. std::vector<std::string> get_ca_names(ctx_t ctx);
  4099. // Dynamic certificate update (for servers)
  4100. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4101. const char *password);
  4102. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4103. // Certificate verification callback
  4104. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4105. long get_verify_error(const_session_t session);
  4106. std::string verify_error_string(long error_code);
  4107. // TlsError information
  4108. uint64_t peek_error();
  4109. uint64_t get_error();
  4110. std::string error_string(uint64_t code);
  4111. } // namespace tls
  4112. #endif // CPPHTTPLIB_SSL_ENABLED
  4113. /*
  4114. * Group 1: detail namespace - Non-SSL utilities
  4115. */
  4116. namespace detail {
  4117. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4118. const void *optval, socklen_t optlen) {
  4119. return setsockopt(sock, level, optname,
  4120. #ifdef _WIN32
  4121. reinterpret_cast<const char *>(optval),
  4122. #else
  4123. optval,
  4124. #endif
  4125. optlen) == 0;
  4126. }
  4127. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4128. time_t sec, time_t usec) {
  4129. #ifdef _WIN32
  4130. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4131. #else
  4132. timeval timeout;
  4133. timeout.tv_sec = static_cast<long>(sec);
  4134. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4135. #endif
  4136. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4137. }
  4138. inline bool is_hex(char c, int &v) {
  4139. if (is_ascii_digit(c)) {
  4140. v = c - '0';
  4141. return true;
  4142. } else if ('A' <= c && c <= 'F') {
  4143. v = c - 'A' + 10;
  4144. return true;
  4145. } else if ('a' <= c && c <= 'f') {
  4146. v = c - 'a' + 10;
  4147. return true;
  4148. }
  4149. return false;
  4150. }
  4151. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4152. int &val) {
  4153. if (i >= s.size()) { return false; }
  4154. val = 0;
  4155. for (; cnt; i++, cnt--) {
  4156. if (!s[i]) { return false; }
  4157. auto v = 0;
  4158. if (is_hex(s[i], v)) {
  4159. val = val * 16 + v;
  4160. } else {
  4161. return false;
  4162. }
  4163. }
  4164. return true;
  4165. }
  4166. inline std::string from_i_to_hex(size_t n) {
  4167. static const auto charset = "0123456789abcdef";
  4168. std::string ret;
  4169. do {
  4170. ret = charset[n & 15] + ret;
  4171. n >>= 4;
  4172. } while (n > 0);
  4173. return ret;
  4174. }
  4175. inline std::string compute_etag(const FileStat &fs) {
  4176. if (!fs.is_file()) { return std::string(); }
  4177. // If mtime cannot be determined (negative value indicates an error
  4178. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4179. // value like 0 could collide with a real file that legitimately has
  4180. // mtime == 0 (epoch) and lead to misleading validators.
  4181. auto mtime_raw = fs.mtime();
  4182. if (mtime_raw < 0) { return std::string(); }
  4183. auto mtime = static_cast<size_t>(mtime_raw);
  4184. auto size = fs.size();
  4185. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4186. from_i_to_hex(size) + "\"";
  4187. }
  4188. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4189. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4190. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4191. inline std::string file_mtime_to_http_date(time_t mtime) {
  4192. if (mtime < 0) { return std::string(); }
  4193. struct tm tm_buf;
  4194. #ifdef _WIN32
  4195. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4196. #else
  4197. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4198. #endif
  4199. char buf[64];
  4200. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4201. return std::string();
  4202. }
  4203. return std::string(buf);
  4204. }
  4205. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4206. inline time_t parse_http_date(const std::string &date_str) {
  4207. struct tm tm_buf;
  4208. // Create a classic locale object once for all parsing attempts
  4209. const std::locale classic_locale = std::locale::classic();
  4210. // Try to parse using std::get_time (C++11, cross-platform)
  4211. auto try_parse = [&](const char *fmt) -> bool {
  4212. std::istringstream ss(date_str);
  4213. ss.imbue(classic_locale);
  4214. memset(&tm_buf, 0, sizeof(tm_buf));
  4215. ss >> std::get_time(&tm_buf, fmt);
  4216. return !ss.fail();
  4217. };
  4218. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4219. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4220. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4221. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4222. // asctime format: "Sun Nov 6 08:49:37 1994"
  4223. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4224. return static_cast<time_t>(-1);
  4225. }
  4226. }
  4227. }
  4228. #ifdef _WIN32
  4229. return _mkgmtime(&tm_buf);
  4230. #elif defined _AIX
  4231. return mktime(&tm_buf);
  4232. #else
  4233. return timegm(&tm_buf);
  4234. #endif
  4235. }
  4236. inline bool is_weak_etag(const std::string &s) {
  4237. // Check if the string is a weak ETag (starts with 'W/"')
  4238. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4239. }
  4240. inline bool is_strong_etag(const std::string &s) {
  4241. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4242. // chars)
  4243. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4244. }
  4245. inline size_t to_utf8(int code, char *buff) {
  4246. if (code < 0x0080) {
  4247. buff[0] = static_cast<char>(code & 0x7F);
  4248. return 1;
  4249. } else if (code < 0x0800) {
  4250. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4251. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4252. return 2;
  4253. } else if (code < 0xD800) {
  4254. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4255. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4256. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4257. return 3;
  4258. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4259. return 0;
  4260. } else if (code < 0x10000) {
  4261. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4262. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4263. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4264. return 3;
  4265. } else if (code < 0x110000) {
  4266. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4267. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4268. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4269. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4270. return 4;
  4271. }
  4272. // NOTREACHED
  4273. return 0;
  4274. }
  4275. } // namespace detail
  4276. namespace ws {
  4277. namespace impl {
  4278. inline bool is_valid_utf8(const std::string &s) {
  4279. size_t i = 0;
  4280. auto n = s.size();
  4281. while (i < n) {
  4282. auto c = static_cast<unsigned char>(s[i]);
  4283. size_t len;
  4284. uint32_t cp;
  4285. if (c < 0x80) {
  4286. i++;
  4287. continue;
  4288. } else if ((c & 0xE0) == 0xC0) {
  4289. len = 2;
  4290. cp = c & 0x1F;
  4291. } else if ((c & 0xF0) == 0xE0) {
  4292. len = 3;
  4293. cp = c & 0x0F;
  4294. } else if ((c & 0xF8) == 0xF0) {
  4295. len = 4;
  4296. cp = c & 0x07;
  4297. } else {
  4298. return false;
  4299. }
  4300. if (i + len > n) { return false; }
  4301. for (size_t j = 1; j < len; j++) {
  4302. auto b = static_cast<unsigned char>(s[i + j]);
  4303. if ((b & 0xC0) != 0x80) { return false; }
  4304. cp = (cp << 6) | (b & 0x3F);
  4305. }
  4306. // Overlong encoding check
  4307. if (len == 2 && cp < 0x80) { return false; }
  4308. if (len == 3 && cp < 0x800) { return false; }
  4309. if (len == 4 && cp < 0x10000) { return false; }
  4310. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4311. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4312. if (cp > 0x10FFFF) { return false; }
  4313. i += len;
  4314. }
  4315. return true;
  4316. }
  4317. } // namespace impl
  4318. } // namespace ws
  4319. namespace detail {
  4320. // NOTE: This code came up with the following stackoverflow post:
  4321. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4322. inline std::string base64_encode(const std::string &in) {
  4323. static const auto lookup =
  4324. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4325. std::string out;
  4326. out.reserve(in.size());
  4327. // Unsigned: the accumulator is never masked, so with a signed int the
  4328. // `val << 8` below overflows once enough bytes are folded in (undefined
  4329. // behaviour before C++20). Only the low bits are ever emitted, so the
  4330. // wrap-around of an unsigned accumulator does not affect the output.
  4331. uint32_t val = 0;
  4332. auto valb = -6;
  4333. for (auto c : in) {
  4334. val = (val << 8) + static_cast<uint8_t>(c);
  4335. valb += 8;
  4336. while (valb >= 0) {
  4337. out.push_back(lookup[(val >> valb) & 0x3F]);
  4338. valb -= 6;
  4339. }
  4340. }
  4341. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4342. while (out.size() % 4) {
  4343. out.push_back('=');
  4344. }
  4345. return out;
  4346. }
  4347. inline std::string sha1(const std::string &input) {
  4348. // RFC 3174 SHA-1 implementation
  4349. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4350. return (x << n) | (x >> (32 - n));
  4351. };
  4352. uint32_t h0 = 0x67452301;
  4353. uint32_t h1 = 0xEFCDAB89;
  4354. uint32_t h2 = 0x98BADCFE;
  4355. uint32_t h3 = 0x10325476;
  4356. uint32_t h4 = 0xC3D2E1F0;
  4357. // Pre-processing: adding padding bits
  4358. std::string msg = input;
  4359. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4360. msg.push_back(static_cast<char>(0x80u));
  4361. while (msg.size() % 64 != 56) {
  4362. msg.push_back(0);
  4363. }
  4364. // Append original length in bits as 64-bit big-endian
  4365. for (int i = 56; i >= 0; i -= 8) {
  4366. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4367. }
  4368. // Process each 512-bit chunk
  4369. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4370. uint32_t w[80];
  4371. for (size_t i = 0; i < 16; i++) {
  4372. w[i] =
  4373. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4374. << 24) |
  4375. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4376. << 16) |
  4377. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4378. << 8) |
  4379. (static_cast<uint32_t>(
  4380. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4381. }
  4382. for (int i = 16; i < 80; i++) {
  4383. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4384. }
  4385. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4386. for (int i = 0; i < 80; i++) {
  4387. uint32_t f, k;
  4388. if (i < 20) {
  4389. f = (b & c) | ((~b) & d);
  4390. k = 0x5A827999;
  4391. } else if (i < 40) {
  4392. f = b ^ c ^ d;
  4393. k = 0x6ED9EBA1;
  4394. } else if (i < 60) {
  4395. f = (b & c) | (b & d) | (c & d);
  4396. k = 0x8F1BBCDC;
  4397. } else {
  4398. f = b ^ c ^ d;
  4399. k = 0xCA62C1D6;
  4400. }
  4401. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4402. e = d;
  4403. d = c;
  4404. c = left_rotate(b, 30);
  4405. b = a;
  4406. a = temp;
  4407. }
  4408. h0 += a;
  4409. h1 += b;
  4410. h2 += c;
  4411. h3 += d;
  4412. h4 += e;
  4413. }
  4414. // Produce the final hash as a 20-byte binary string
  4415. std::string hash(20, '\0');
  4416. for (size_t i = 0; i < 4; i++) {
  4417. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4418. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4419. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4420. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4421. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4422. }
  4423. return hash;
  4424. }
  4425. inline std::string websocket_accept_key(const std::string &client_key) {
  4426. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4427. return base64_encode(sha1(client_key + magic));
  4428. }
  4429. inline bool is_websocket_upgrade(const Request &req) {
  4430. if (req.method != "GET") { return false; }
  4431. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4432. // list of protocols and asks recipients to match each name
  4433. // case-insensitively, so look for the token rather than compare the whole
  4434. // field value.
  4435. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4436. // Check Connection: Upgrade
  4437. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4438. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4439. // RFC 6455 Section 4.2.1
  4440. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4441. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4442. return false;
  4443. }
  4444. static const std::string b64chars =
  4445. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4446. for (size_t i = 0; i < 22; i++) {
  4447. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4448. }
  4449. // Check Sec-WebSocket-Version: 13
  4450. auto version = req.get_header_value("Sec-WebSocket-Version");
  4451. if (version != "13") { return false; }
  4452. return true;
  4453. }
  4454. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4455. const char *data, size_t len, bool fin,
  4456. bool mask) {
  4457. // First byte: FIN + opcode
  4458. uint8_t header[2];
  4459. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4460. (static_cast<uint8_t>(opcode) & 0x0F));
  4461. // Second byte: MASK + payload length
  4462. if (len < 126) {
  4463. header[1] = static_cast<uint8_t>(len);
  4464. if (mask) { header[1] |= 0x80; }
  4465. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4466. } else if (len <= 0xFFFF) {
  4467. header[1] = 126;
  4468. if (mask) { header[1] |= 0x80; }
  4469. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4470. uint8_t ext[2];
  4471. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4472. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4473. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4474. } else {
  4475. header[1] = 127;
  4476. if (mask) { header[1] |= 0x80; }
  4477. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4478. uint8_t ext[8];
  4479. for (int i = 7; i >= 0; i--) {
  4480. ext[7 - i] =
  4481. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4482. }
  4483. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4484. }
  4485. if (mask) {
  4486. // Generate random mask key
  4487. thread_local std::mt19937 rng(std::random_device{}());
  4488. uint8_t mask_key[4];
  4489. auto r = rng();
  4490. std::memcpy(mask_key, &r, 4);
  4491. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4492. // Write masked payload in chunks
  4493. const size_t chunk_size = 4096;
  4494. std::vector<char> buf((std::min)(len, chunk_size));
  4495. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4496. size_t n = (std::min)(chunk_size, len - offset);
  4497. for (size_t i = 0; i < n; i++) {
  4498. buf[i] =
  4499. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4500. }
  4501. if (strm.write(buf.data(), n) < 0) { return false; }
  4502. }
  4503. } else {
  4504. if (len > 0) {
  4505. if (strm.write(data, len) < 0) { return false; }
  4506. }
  4507. }
  4508. return true;
  4509. }
  4510. } // namespace detail
  4511. namespace ws {
  4512. namespace impl {
  4513. inline bool read_websocket_frame(Stream &strm, Opcode &opcode,
  4514. std::string &payload, bool &fin,
  4515. bool expect_masked, size_t max_len) {
  4516. // Read first 2 bytes
  4517. uint8_t header[2];
  4518. if (strm.read(reinterpret_cast<char *>(header), 2) != 2) { return false; }
  4519. fin = (header[0] & 0x80) != 0;
  4520. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4521. if (header[0] & 0x70) { return false; }
  4522. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4523. bool masked = (header[1] & 0x80) != 0;
  4524. uint64_t payload_len = header[1] & 0x7F;
  4525. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4526. // MUST have a payload length of 125 bytes or less
  4527. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4528. if (is_control) {
  4529. if (!fin) { return false; }
  4530. if (payload_len > 125) { return false; }
  4531. }
  4532. if (masked != expect_masked) { return false; }
  4533. // Extended payload length
  4534. if (payload_len == 126) {
  4535. uint8_t ext[2];
  4536. if (strm.read(reinterpret_cast<char *>(ext), 2) != 2) { return false; }
  4537. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4538. } else if (payload_len == 127) {
  4539. uint8_t ext[8];
  4540. if (strm.read(reinterpret_cast<char *>(ext), 8) != 8) { return false; }
  4541. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4542. if (ext[0] & 0x80) { return false; }
  4543. payload_len = 0;
  4544. for (int i = 0; i < 8; i++) {
  4545. payload_len = (payload_len << 8) | ext[i];
  4546. }
  4547. }
  4548. if (payload_len > max_len) { return false; }
  4549. // Read mask key if present
  4550. uint8_t mask_key[4] = {0};
  4551. if (masked) {
  4552. if (strm.read(reinterpret_cast<char *>(mask_key), 4) != 4) { return false; }
  4553. }
  4554. // Read payload
  4555. payload.resize(static_cast<size_t>(payload_len));
  4556. if (payload_len > 0) {
  4557. size_t total_read = 0;
  4558. while (total_read < payload_len) {
  4559. auto n = strm.read(&payload[total_read],
  4560. static_cast<size_t>(payload_len - total_read));
  4561. if (n <= 0) { return false; }
  4562. total_read += static_cast<size_t>(n);
  4563. }
  4564. }
  4565. // Unmask if needed
  4566. if (masked) {
  4567. for (size_t i = 0; i < payload.size(); i++) {
  4568. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4569. }
  4570. }
  4571. return true;
  4572. }
  4573. } // namespace impl
  4574. } // namespace ws
  4575. namespace detail {
  4576. inline bool is_valid_path(const std::string &path) {
  4577. size_t level = 0;
  4578. size_t i = 0;
  4579. // Skip slash
  4580. while (i < path.size() && path[i] == '/') {
  4581. i++;
  4582. }
  4583. while (i < path.size()) {
  4584. // Read component
  4585. auto beg = i;
  4586. while (i < path.size() && path[i] != '/') {
  4587. if (path[i] == '\0') {
  4588. return false;
  4589. } else if (path[i] == '\\') {
  4590. return false;
  4591. }
  4592. i++;
  4593. }
  4594. auto len = i - beg;
  4595. assert(len > 0);
  4596. if (!path.compare(beg, len, ".")) {
  4597. ;
  4598. } else if (!path.compare(beg, len, "..")) {
  4599. if (level == 0) { return false; }
  4600. level--;
  4601. } else {
  4602. level++;
  4603. }
  4604. // Skip slash
  4605. while (i < path.size() && path[i] == '/') {
  4606. i++;
  4607. }
  4608. }
  4609. return true;
  4610. }
  4611. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4612. #if defined(_WIN32)
  4613. char buf[_MAX_PATH];
  4614. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4615. resolved = buf;
  4616. #elif defined(PATH_MAX)
  4617. char buf[PATH_MAX];
  4618. if (realpath(path, buf) == nullptr) { return false; }
  4619. resolved = buf;
  4620. #else
  4621. auto buf = realpath(path, nullptr);
  4622. auto guard = scope_exit([&]() { std::free(buf); });
  4623. if (buf == nullptr) { return false; }
  4624. resolved = buf;
  4625. #endif
  4626. return true;
  4627. }
  4628. inline bool is_path_within_base(const std::string &resolved_path,
  4629. const std::string &resolved_base) {
  4630. #if defined(_WIN32)
  4631. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4632. resolved_base.size()) == 0;
  4633. #else
  4634. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4635. resolved_base.size()) == 0;
  4636. #endif
  4637. }
  4638. inline FileStat::FileStat(const std::string &path) {
  4639. #if defined(_WIN32)
  4640. auto wpath = u8string_to_wstring(path.c_str());
  4641. ret_ = _wstat(wpath.c_str(), &st_);
  4642. #else
  4643. ret_ = stat(path.c_str(), &st_);
  4644. #endif
  4645. }
  4646. inline bool FileStat::is_file() const {
  4647. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4648. }
  4649. inline bool FileStat::is_dir() const {
  4650. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4651. }
  4652. inline time_t FileStat::mtime() const {
  4653. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4654. : static_cast<time_t>(-1);
  4655. }
  4656. inline size_t FileStat::size() const {
  4657. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4658. }
  4659. inline std::string encode_path(const std::string &s) {
  4660. std::string result;
  4661. result.reserve(s.size());
  4662. for (size_t i = 0; s[i]; i++) {
  4663. switch (s[i]) {
  4664. case ' ': result += "%20"; break;
  4665. case '+': result += "%2B"; break;
  4666. case '\r': result += "%0D"; break;
  4667. case '\n': result += "%0A"; break;
  4668. case '\'': result += "%27"; break;
  4669. case ',': result += "%2C"; break;
  4670. // case ':': result += "%3A"; break; // ok? probably...
  4671. case ';': result += "%3B"; break;
  4672. default:
  4673. auto c = static_cast<uint8_t>(s[i]);
  4674. if (c >= 0x80) {
  4675. result += '%';
  4676. char hex[4];
  4677. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4678. assert(len == 2);
  4679. result.append(hex, static_cast<size_t>(len));
  4680. } else {
  4681. result += s[i];
  4682. }
  4683. break;
  4684. }
  4685. }
  4686. return result;
  4687. }
  4688. inline std::string file_extension(const std::string &path) {
  4689. std::smatch m;
  4690. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4691. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4692. return std::string();
  4693. }
  4694. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4695. template <typename T>
  4696. inline bool parse_header(const char *beg, const char *end, T fn);
  4697. template <typename T>
  4698. inline bool parse_header(const char *beg, const char *end, T fn) {
  4699. // Skip trailing spaces and tabs.
  4700. while (beg < end && is_space_or_tab(end[-1])) {
  4701. end--;
  4702. }
  4703. auto p = beg;
  4704. while (p < end && *p != ':') {
  4705. p++;
  4706. }
  4707. auto name = std::string(beg, p);
  4708. if (!detail::fields::is_field_name(name)) { return false; }
  4709. if (p == end) { return false; }
  4710. auto key_end = p;
  4711. if (*p++ != ':') { return false; }
  4712. while (p < end && is_space_or_tab(*p)) {
  4713. p++;
  4714. }
  4715. if (p <= end) {
  4716. auto key_len = key_end - beg;
  4717. if (!key_len) { return false; }
  4718. auto key = std::string(beg, key_end);
  4719. auto val = std::string(p, end);
  4720. if (!detail::fields::is_field_value(val)) { return false; }
  4721. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4722. // percent-decoded by the recipient. Applications that need to interpret a
  4723. // value as a URI component should call httplib::decode_uri_component()
  4724. // (or decode_path_component()) explicitly.
  4725. fn(key, val);
  4726. return true;
  4727. }
  4728. return false;
  4729. }
  4730. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4731. const Headers &src_headers) {
  4732. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4733. // transfer coding is complete when a chunk with a chunk-size of zero is
  4734. // received, possibly followed by a trailer section, and finally terminated by
  4735. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4736. //
  4737. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4738. // doesn't care for the existence of the final CRLF. In other words, it seems
  4739. // to be ok whether the final CRLF exists or not in the chunked data.
  4740. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4741. //
  4742. // According to the reference code in RFC 9112, cpp-httplib now allows
  4743. // chunked transfer coding data without the final CRLF.
  4744. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4745. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4746. "transfer-encoding",
  4747. "content-length",
  4748. "host",
  4749. "authorization",
  4750. "www-authenticate",
  4751. "proxy-authenticate",
  4752. "proxy-authorization",
  4753. "cookie",
  4754. "set-cookie",
  4755. "cache-control",
  4756. "expect",
  4757. "max-forwards",
  4758. "pragma",
  4759. "range",
  4760. "te",
  4761. "age",
  4762. "expires",
  4763. "date",
  4764. "location",
  4765. "retry-after",
  4766. "vary",
  4767. "warning",
  4768. "content-encoding",
  4769. "content-type",
  4770. "content-range",
  4771. "trailer"};
  4772. case_ignore::unordered_set<std::string> declared_trailers;
  4773. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4774. if (!trailer_header.empty()) {
  4775. // split() trims each token and skips empty ones, so the name arrives ready
  4776. // to look up.
  4777. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4778. ',', [&](const char *b, const char *e) {
  4779. std::string key(b, e);
  4780. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4781. declared_trailers.insert(key);
  4782. }
  4783. });
  4784. }
  4785. size_t trailer_header_count = 0;
  4786. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4787. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4788. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4789. constexpr auto line_terminator_len = 2;
  4790. auto line_beg = line_reader.ptr();
  4791. auto line_end =
  4792. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4793. if (!parse_header(line_beg, line_end,
  4794. [&](const std::string &key, const std::string &val) {
  4795. if (declared_trailers.find(key) !=
  4796. declared_trailers.end()) {
  4797. dest.emplace(key, val);
  4798. trailer_header_count++;
  4799. }
  4800. })) {
  4801. return false;
  4802. }
  4803. if (!line_reader.getline()) { return false; }
  4804. }
  4805. return true;
  4806. }
  4807. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4808. size_t right) {
  4809. while (b + left < e && is_space_or_tab(b[left])) {
  4810. left++;
  4811. }
  4812. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4813. right--;
  4814. }
  4815. return std::make_pair(left, right);
  4816. }
  4817. inline std::string trim_copy(const std::string &s) {
  4818. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4819. return s.substr(r.first, r.second - r.first);
  4820. }
  4821. inline std::string trim_double_quotes_copy(const std::string &s) {
  4822. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4823. return s.substr(1, s.size() - 2);
  4824. }
  4825. return s;
  4826. }
  4827. inline void
  4828. divide(const char *data, std::size_t size, char d,
  4829. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4830. fn) {
  4831. const auto it = std::find(data, data + size, d);
  4832. const auto found = static_cast<std::size_t>(it != data + size);
  4833. const auto lhs_data = data;
  4834. const auto lhs_size = static_cast<std::size_t>(it - data);
  4835. const auto rhs_data = it + found;
  4836. const auto rhs_size = size - lhs_size - found;
  4837. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  4838. }
  4839. inline void
  4840. divide(const std::string &str, char d,
  4841. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4842. fn) {
  4843. divide(str.data(), str.size(), d, std::move(fn));
  4844. }
  4845. inline void split(const char *b, const char *e, char d,
  4846. std::function<void(const char *, const char *)> fn) {
  4847. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  4848. }
  4849. inline void split(const char *b, const char *e, char d, size_t m,
  4850. std::function<void(const char *, const char *)> fn) {
  4851. size_t i = 0;
  4852. size_t beg = 0;
  4853. size_t count = 1;
  4854. while (e ? (b + i < e) : (b[i] != '\0')) {
  4855. if (b[i] == d && count < m) {
  4856. auto r = trim(b, e, beg, i);
  4857. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4858. beg = i + 1;
  4859. count++;
  4860. }
  4861. i++;
  4862. }
  4863. if (i) {
  4864. auto r = trim(b, e, beg, i);
  4865. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4866. }
  4867. }
  4868. // Same contract as split(), except that a delimiter inside a quoted-string is
  4869. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  4870. // quoted-string, and ';' and '=' are legal characters inside one.
  4871. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  4872. std::function<void(const char *, const char *)> fn) {
  4873. size_t i = 0;
  4874. size_t beg = 0;
  4875. size_t count = 1;
  4876. auto in_quotes = false;
  4877. while (e ? (b + i < e) : (b[i] != '\0')) {
  4878. if (b[i] == '"') {
  4879. in_quotes = !in_quotes;
  4880. } else if (b[i] == d && !in_quotes && count < m) {
  4881. auto r = trim(b, e, beg, i);
  4882. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4883. beg = i + 1;
  4884. count++;
  4885. }
  4886. i++;
  4887. }
  4888. if (i) {
  4889. auto r = trim(b, e, beg, i);
  4890. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4891. }
  4892. }
  4893. inline void split_unquoted(const char *b, const char *e, char d,
  4894. std::function<void(const char *, const char *)> fn) {
  4895. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  4896. std::move(fn));
  4897. }
  4898. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  4899. // key a token, so the first '=' is the separator even when the value is a
  4900. // quoted-string carrying more of them.
  4901. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  4902. std::string &val) {
  4903. divide(
  4904. b, static_cast<std::size_t>(e - b), '=',
  4905. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  4906. const auto kr = trim(kb, kb + klen, 0, klen);
  4907. key.assign(kb + kr.first, kb + kr.second);
  4908. const auto vr = trim(vb, vb + vlen, 0, vlen);
  4909. val.assign(vb + vr.first, vb + vr.second);
  4910. });
  4911. }
  4912. inline bool split_find(const char *b, const char *e, char d, size_t m,
  4913. std::function<bool(const char *, const char *)> fn) {
  4914. size_t i = 0;
  4915. size_t beg = 0;
  4916. size_t count = 1;
  4917. while (e ? (b + i < e) : (b[i] != '\0')) {
  4918. if (b[i] == d && count < m) {
  4919. auto r = trim(b, e, beg, i);
  4920. if (r.first < r.second) {
  4921. auto found = fn(&b[r.first], &b[r.second]);
  4922. if (found) { return true; }
  4923. }
  4924. beg = i + 1;
  4925. count++;
  4926. }
  4927. i++;
  4928. }
  4929. if (i) {
  4930. auto r = trim(b, e, beg, i);
  4931. if (r.first < r.second) {
  4932. auto found = fn(&b[r.first], &b[r.second]);
  4933. if (found) { return true; }
  4934. }
  4935. }
  4936. return false;
  4937. }
  4938. inline bool split_find(const char *b, const char *e, char d,
  4939. std::function<bool(const char *, const char *)> fn) {
  4940. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  4941. std::move(fn));
  4942. }
  4943. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  4944. size_t fixed_buffer_size)
  4945. : strm_(strm), fixed_buffer_(fixed_buffer),
  4946. fixed_buffer_size_(fixed_buffer_size) {}
  4947. inline const char *stream_line_reader::ptr() const {
  4948. if (growable_buffer_.empty()) {
  4949. return fixed_buffer_;
  4950. } else {
  4951. return growable_buffer_.data();
  4952. }
  4953. }
  4954. inline size_t stream_line_reader::size() const {
  4955. if (growable_buffer_.empty()) {
  4956. return fixed_buffer_used_size_;
  4957. } else {
  4958. return growable_buffer_.size();
  4959. }
  4960. }
  4961. inline bool stream_line_reader::end_with_crlf() const {
  4962. auto end = ptr() + size();
  4963. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  4964. }
  4965. inline bool stream_line_reader::getline() {
  4966. fixed_buffer_used_size_ = 0;
  4967. growable_buffer_.clear();
  4968. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  4969. char prev_byte = 0;
  4970. #endif
  4971. for (size_t i = 0;; i++) {
  4972. // Fast path: whatever the stream has already buffered can be scanned for
  4973. // the terminator in one pass. Asking for a byte at a time costs a virtual
  4974. // call, a bounds check and a one-byte copy per character of the request.
  4975. size_t buffered_size = 0;
  4976. if (auto buffered = strm_.buffered_data(buffered_size)) {
  4977. auto take = buffered_size;
  4978. auto terminated = false;
  4979. for (size_t at = 0; at < buffered_size;) {
  4980. auto nl = static_cast<const char *>(
  4981. memchr(buffered + at, '\n', buffered_size - at));
  4982. if (!nl) { break; }
  4983. auto pos = static_cast<size_t>(nl - buffered);
  4984. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  4985. take = pos + 1;
  4986. terminated = true;
  4987. break;
  4988. #else
  4989. // A bare LF does not end the line; keep looking for CRLF. The CR may
  4990. // be the last byte of an earlier chunk, hence prev_byte.
  4991. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  4992. take = pos + 1;
  4993. terminated = true;
  4994. break;
  4995. }
  4996. at = pos + 1;
  4997. #endif
  4998. }
  4999. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5000. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5001. prev_byte = buffered[take - 1];
  5002. #endif
  5003. append(buffered, take);
  5004. strm_.consume_buffered(take);
  5005. i += take;
  5006. if (terminated) { return true; }
  5007. continue;
  5008. }
  5009. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5010. // Treat exceptionally long lines as an error to
  5011. // prevent infinite loops/memory exhaustion
  5012. return false;
  5013. }
  5014. char byte;
  5015. auto n = strm_.read(&byte, 1);
  5016. if (n < 0) {
  5017. return false;
  5018. } else if (n == 0) {
  5019. if (i == 0) {
  5020. return false;
  5021. } else {
  5022. break;
  5023. }
  5024. }
  5025. append(byte);
  5026. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5027. if (byte == '\n') { break; }
  5028. #else
  5029. if (prev_byte == '\r' && byte == '\n') { break; }
  5030. prev_byte = byte;
  5031. #endif
  5032. }
  5033. return true;
  5034. }
  5035. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5036. inline void stream_line_reader::append(const char *data, size_t size) {
  5037. // Once the line has outgrown the fixed buffer everything must keep going to
  5038. // the growable one, even if a later chunk would have fit. Without the
  5039. // emptiness check a short append after a long one would land in the fixed
  5040. // buffer, which ptr() and size() no longer look at, and be lost.
  5041. if (growable_buffer_.empty() &&
  5042. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5043. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5044. fixed_buffer_used_size_ += size;
  5045. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5046. } else {
  5047. // Unlike the per-character overload, this can be the very first append of
  5048. // the line, so the fixed buffer may hold nothing and carry no terminator
  5049. // yet. assign() takes an explicit length and does not need one.
  5050. if (growable_buffer_.empty()) {
  5051. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5052. }
  5053. growable_buffer_.append(data, size);
  5054. }
  5055. }
  5056. inline mmap::mmap(const char *path) { open(path); }
  5057. inline mmap::~mmap() { close(); }
  5058. inline bool mmap::open(const char *path) {
  5059. close();
  5060. #if defined(_WIN32)
  5061. auto wpath = u8string_to_wstring(path);
  5062. if (wpath.empty()) { return false; }
  5063. hFile_ =
  5064. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5065. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5066. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5067. LARGE_INTEGER size{};
  5068. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5069. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5070. // See:
  5071. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5072. if (static_cast<ULONGLONG>(size.QuadPart) >
  5073. (std::numeric_limits<decltype(size_)>::max)()) {
  5074. // `size_t` might be 32-bits, on 32-bits Windows.
  5075. return false;
  5076. }
  5077. size_ = static_cast<size_t>(size.QuadPart);
  5078. hMapping_ =
  5079. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5080. // Special treatment for an empty file...
  5081. if (hMapping_ == NULL && size_ == 0) {
  5082. close();
  5083. is_open_empty_file = true;
  5084. return true;
  5085. }
  5086. if (hMapping_ == NULL) {
  5087. close();
  5088. return false;
  5089. }
  5090. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5091. if (addr_ == nullptr) {
  5092. close();
  5093. return false;
  5094. }
  5095. #else
  5096. fd_ = ::open(path, O_RDONLY);
  5097. if (fd_ == -1) { return false; }
  5098. struct stat sb;
  5099. if (fstat(fd_, &sb) == -1) {
  5100. close();
  5101. return false;
  5102. }
  5103. size_ = static_cast<size_t>(sb.st_size);
  5104. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5105. // Special treatment for an empty file...
  5106. if (addr_ == MAP_FAILED && size_ == 0) {
  5107. close();
  5108. is_open_empty_file = true;
  5109. return false;
  5110. }
  5111. if (addr_ == MAP_FAILED) {
  5112. // Clear the sentinel before `close()`, since `is_open()` only checks
  5113. // `addr_` against nullptr and `munmap()` must not be called with it.
  5114. addr_ = nullptr;
  5115. close();
  5116. return false;
  5117. }
  5118. #endif
  5119. return true;
  5120. }
  5121. inline bool mmap::is_open() const {
  5122. return is_open_empty_file ? true : addr_ != nullptr;
  5123. }
  5124. inline size_t mmap::size() const { return size_; }
  5125. inline const char *mmap::data() const {
  5126. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5127. }
  5128. inline void mmap::close() {
  5129. #if defined(_WIN32)
  5130. if (addr_) {
  5131. ::UnmapViewOfFile(addr_);
  5132. addr_ = nullptr;
  5133. }
  5134. if (hMapping_) {
  5135. ::CloseHandle(hMapping_);
  5136. hMapping_ = NULL;
  5137. }
  5138. if (hFile_ != INVALID_HANDLE_VALUE) {
  5139. ::CloseHandle(hFile_);
  5140. hFile_ = INVALID_HANDLE_VALUE;
  5141. }
  5142. is_open_empty_file = false;
  5143. #else
  5144. if (addr_ != nullptr) {
  5145. munmap(addr_, size_);
  5146. addr_ = nullptr;
  5147. }
  5148. if (fd_ != -1) {
  5149. ::close(fd_);
  5150. fd_ = -1;
  5151. }
  5152. #endif
  5153. size_ = 0;
  5154. }
  5155. inline int close_socket(socket_t sock) noexcept {
  5156. #ifdef _WIN32
  5157. return closesocket(sock);
  5158. #else
  5159. return close(sock);
  5160. #endif
  5161. }
  5162. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5163. ssize_t res = 0;
  5164. while (true) {
  5165. res = fn();
  5166. if (res < 0 && errno == EINTR) {
  5167. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5168. continue;
  5169. }
  5170. break;
  5171. }
  5172. return res;
  5173. }
  5174. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5175. return handle_EINTR([&]() {
  5176. return recv(sock,
  5177. #ifdef _WIN32
  5178. static_cast<char *>(ptr), static_cast<int>(size),
  5179. #else
  5180. ptr, size,
  5181. #endif
  5182. flags);
  5183. });
  5184. }
  5185. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5186. int flags) {
  5187. return handle_EINTR([&]() {
  5188. return send(sock,
  5189. #ifdef _WIN32
  5190. static_cast<const char *>(ptr), static_cast<int>(size),
  5191. #else
  5192. ptr, size,
  5193. #endif
  5194. flags);
  5195. });
  5196. }
  5197. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5198. #ifdef _WIN32
  5199. return ::WSAPoll(fds, nfds, timeout);
  5200. #else
  5201. return ::poll(fds, nfds, timeout);
  5202. #endif
  5203. }
  5204. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5205. time_t usec) {
  5206. struct pollfd pfd;
  5207. pfd.fd = sock;
  5208. pfd.events = events;
  5209. pfd.revents = 0;
  5210. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5211. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5212. }
  5213. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5214. return select_impl(sock, POLLIN, sec, usec);
  5215. }
  5216. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5217. return select_impl(sock, POLLOUT, sec, usec);
  5218. }
  5219. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5220. time_t usec) {
  5221. struct pollfd pfd_read;
  5222. pfd_read.fd = sock;
  5223. pfd_read.events = POLLIN | POLLOUT;
  5224. pfd_read.revents = 0;
  5225. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5226. auto poll_res =
  5227. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5228. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5229. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5230. auto error = 0;
  5231. socklen_t len = sizeof(error);
  5232. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5233. reinterpret_cast<char *>(&error), &len);
  5234. auto successful = res >= 0 && !error;
  5235. return successful ? Error::Success : Error::Connection;
  5236. }
  5237. return Error::Connection;
  5238. }
  5239. inline bool is_socket_alive(socket_t sock) {
  5240. const auto val = detail::select_read(sock, 0, 0);
  5241. if (val == 0) {
  5242. return true;
  5243. } else if (val < 0 && errno == EBADF) {
  5244. return false;
  5245. }
  5246. char buf[1];
  5247. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5248. }
  5249. class SocketStream final : public Stream {
  5250. public:
  5251. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5252. time_t write_timeout_sec, time_t write_timeout_usec,
  5253. time_t max_timeout_msec = 0,
  5254. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5255. (std::chrono::steady_clock::time_point::min)());
  5256. ~SocketStream() override;
  5257. bool is_readable() const override;
  5258. bool wait_readable() const override;
  5259. bool wait_writable() const override;
  5260. bool is_peer_alive() const override;
  5261. ssize_t read(char *ptr, size_t size) override;
  5262. ssize_t write(const char *ptr, size_t size) override;
  5263. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5264. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5265. socket_t socket() const override;
  5266. time_t duration() const override;
  5267. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5268. const char *buffered_data(size_t &size) const override;
  5269. void consume_buffered(size_t size) override;
  5270. // The caller has just seen this socket become readable. Lets the next read
  5271. // skip its own readiness wait, which would otherwise ask the kernel a
  5272. // question that was answered a moment ago. Consumed by that read.
  5273. void set_readable_hint() { readable_hint_ = true; }
  5274. private:
  5275. bool ensure_readable();
  5276. socket_t sock_;
  5277. time_t read_timeout_sec_;
  5278. time_t read_timeout_usec_;
  5279. time_t write_timeout_sec_;
  5280. time_t write_timeout_usec_;
  5281. time_t max_timeout_msec_;
  5282. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5283. std::vector<char> read_buff_;
  5284. size_t read_buff_off_ = 0;
  5285. size_t read_buff_content_size_ = 0;
  5286. bool readable_hint_ = false;
  5287. static const size_t read_buff_size_ = 1024l * 4;
  5288. };
  5289. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5290. time_t keep_alive_timeout_sec) {
  5291. using namespace std::chrono;
  5292. const auto interval_usec =
  5293. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5294. // Avoid expensive `steady_clock::now()` call for the first time
  5295. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5296. const auto start = steady_clock::now() - microseconds{interval_usec};
  5297. const auto timeout = seconds{keep_alive_timeout_sec};
  5298. while (true) {
  5299. if (svr_sock == INVALID_SOCKET) {
  5300. break; // Server socket is closed
  5301. }
  5302. auto val = select_read(sock, 0, interval_usec);
  5303. if (val < 0) {
  5304. break; // Ssocket error
  5305. } else if (val == 0) {
  5306. if (steady_clock::now() - start > timeout) {
  5307. break; // Timeout
  5308. }
  5309. } else {
  5310. return true; // Ready for read
  5311. }
  5312. }
  5313. return false;
  5314. }
  5315. template <typename T>
  5316. inline bool
  5317. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5318. size_t keep_alive_max_count,
  5319. time_t keep_alive_timeout_sec, T callback) {
  5320. assert(keep_alive_max_count > 0);
  5321. auto ret = false;
  5322. auto count = keep_alive_max_count;
  5323. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5324. auto close_connection = count == 1;
  5325. auto connection_closed = false;
  5326. ret = callback(close_connection, connection_closed);
  5327. if (!ret || connection_closed) { break; }
  5328. count--;
  5329. }
  5330. return ret;
  5331. }
  5332. template <typename T>
  5333. inline bool
  5334. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5335. size_t keep_alive_max_count,
  5336. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5337. time_t read_timeout_usec, time_t write_timeout_sec,
  5338. time_t write_timeout_usec, T callback) {
  5339. return process_server_socket_core(
  5340. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5341. [&](bool close_connection, bool &connection_closed) {
  5342. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5343. write_timeout_sec, write_timeout_usec);
  5344. // process_server_socket_core() only gets here once keep_alive() has
  5345. // seen the socket go readable.
  5346. strm.set_readable_hint();
  5347. return callback(strm, close_connection, connection_closed);
  5348. });
  5349. }
  5350. inline bool process_client_socket(
  5351. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5352. time_t write_timeout_sec, time_t write_timeout_usec,
  5353. time_t max_timeout_msec,
  5354. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5355. std::function<bool(Stream &)> callback) {
  5356. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5357. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5358. start_time);
  5359. return callback(strm);
  5360. }
  5361. inline int shutdown_socket(socket_t sock) noexcept {
  5362. #ifdef _WIN32
  5363. return shutdown(sock, SD_BOTH);
  5364. #else
  5365. return shutdown(sock, SHUT_RDWR);
  5366. #endif
  5367. }
  5368. // Half-closes the write side and drains any in-flight/queued bytes before
  5369. // the final shutdown+close. Closing with unread data in the receive queue
  5370. // (or bytes arriving after the receive side is closed) makes the stack send
  5371. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5372. // response as a failed read even though it was fully written.
  5373. inline void drain_and_close_socket(socket_t sock) noexcept {
  5374. #ifdef _WIN32
  5375. shutdown(sock, SD_SEND);
  5376. #else
  5377. shutdown(sock, SHUT_WR);
  5378. #endif
  5379. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5380. size_t total = 0;
  5381. const auto deadline = std::chrono::steady_clock::now() +
  5382. std::chrono::milliseconds(100); // bound #1
  5383. while (total < size_t(1024u * 1024u)) { // bound #2
  5384. const auto remaining =
  5385. std::chrono::duration_cast<std::chrono::microseconds>(
  5386. deadline - std::chrono::steady_clock::now())
  5387. .count();
  5388. if (remaining <= 0) { break; }
  5389. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5390. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5391. if (n <= 0) { break; }
  5392. total += static_cast<size_t>(n);
  5393. }
  5394. shutdown_socket(sock);
  5395. close_socket(sock);
  5396. }
  5397. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5398. if (s.size() > 1 && s[0] == '\0') {
  5399. auto ret = s;
  5400. ret[0] = '@';
  5401. return ret;
  5402. }
  5403. return s;
  5404. }
  5405. inline std::string
  5406. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5407. if (s.size() > 1 && s[0] == '@') {
  5408. auto ret = s;
  5409. ret[0] = '\0';
  5410. return ret;
  5411. }
  5412. return s;
  5413. }
  5414. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5415. const struct addrinfo *hints,
  5416. struct addrinfo **res, time_t timeout_sec) {
  5417. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5418. if (timeout_sec <= 0) {
  5419. // No timeout specified, use standard getaddrinfo
  5420. return getaddrinfo(node, service, hints, res);
  5421. }
  5422. #ifdef _WIN32
  5423. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5424. OVERLAPPED overlapped = {};
  5425. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5426. if (!event) { return EAI_FAIL; }
  5427. overlapped.hEvent = event;
  5428. PADDRINFOEXW result_addrinfo = nullptr;
  5429. HANDLE cancel_handle = nullptr;
  5430. ADDRINFOEXW hints_ex = {};
  5431. if (hints) {
  5432. hints_ex.ai_flags = hints->ai_flags;
  5433. hints_ex.ai_family = hints->ai_family;
  5434. hints_ex.ai_socktype = hints->ai_socktype;
  5435. hints_ex.ai_protocol = hints->ai_protocol;
  5436. }
  5437. auto wnode = u8string_to_wstring(node);
  5438. auto wservice = u8string_to_wstring(service);
  5439. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5440. hints ? &hints_ex : nullptr, &result_addrinfo,
  5441. nullptr, &overlapped, nullptr, &cancel_handle);
  5442. if (ret == WSA_IO_PENDING) {
  5443. auto wait_result =
  5444. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5445. if (wait_result == WAIT_TIMEOUT) {
  5446. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5447. ::CloseHandle(event);
  5448. return EAI_AGAIN;
  5449. }
  5450. DWORD bytes_returned;
  5451. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5452. &bytes_returned, FALSE)) {
  5453. ::CloseHandle(event);
  5454. return ::WSAGetLastError();
  5455. }
  5456. }
  5457. ::CloseHandle(event);
  5458. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5459. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5460. return 0;
  5461. }
  5462. return ret;
  5463. #elif TARGET_OS_MAC && defined(__clang__)
  5464. if (!node) { return EAI_NONAME; }
  5465. // macOS implementation using CFHost API for asynchronous DNS resolution
  5466. CFStringRef hostname_ref = CFStringCreateWithCString(
  5467. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5468. if (!hostname_ref) { return EAI_MEMORY; }
  5469. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5470. CFRelease(hostname_ref);
  5471. if (!host_ref) { return EAI_MEMORY; }
  5472. // Set up context for callback
  5473. struct CFHostContext {
  5474. bool completed = false;
  5475. bool success = false;
  5476. CFArrayRef addresses = nullptr;
  5477. std::mutex mutex;
  5478. std::condition_variable cv;
  5479. } context;
  5480. CFHostClientContext client_context;
  5481. memset(&client_context, 0, sizeof(client_context));
  5482. client_context.info = &context;
  5483. // Set callback
  5484. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5485. const CFStreamError *error, void *info) {
  5486. auto ctx = static_cast<CFHostContext *>(info);
  5487. std::lock_guard<std::mutex> lock(ctx->mutex);
  5488. if (error && error->error != 0) {
  5489. ctx->success = false;
  5490. } else {
  5491. Boolean hasBeenResolved;
  5492. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5493. if (ctx->addresses && hasBeenResolved) {
  5494. CFRetain(ctx->addresses);
  5495. ctx->success = true;
  5496. } else {
  5497. ctx->success = false;
  5498. }
  5499. }
  5500. ctx->completed = true;
  5501. ctx->cv.notify_one();
  5502. };
  5503. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5504. CFRelease(host_ref);
  5505. return EAI_SYSTEM;
  5506. }
  5507. // Schedule on run loop
  5508. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5509. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5510. // Start resolution
  5511. CFStreamError stream_error;
  5512. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5513. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5514. CFRelease(host_ref);
  5515. return EAI_FAIL;
  5516. }
  5517. // Wait for completion with timeout
  5518. auto timeout_time =
  5519. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5520. bool timed_out = false;
  5521. {
  5522. std::unique_lock<std::mutex> lock(context.mutex);
  5523. while (!context.completed) {
  5524. auto now = std::chrono::steady_clock::now();
  5525. if (now >= timeout_time) {
  5526. timed_out = true;
  5527. break;
  5528. }
  5529. // Run the runloop for a short time
  5530. lock.unlock();
  5531. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5532. lock.lock();
  5533. }
  5534. }
  5535. // Clean up
  5536. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5537. CFHostSetClient(host_ref, nullptr, nullptr);
  5538. if (timed_out || !context.completed) {
  5539. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5540. CFRelease(host_ref);
  5541. return EAI_AGAIN;
  5542. }
  5543. if (!context.success || !context.addresses) {
  5544. CFRelease(host_ref);
  5545. return EAI_NODATA;
  5546. }
  5547. // Convert CFArray to addrinfo
  5548. CFIndex count = CFArrayGetCount(context.addresses);
  5549. if (count == 0) {
  5550. CFRelease(context.addresses);
  5551. CFRelease(host_ref);
  5552. return EAI_NODATA;
  5553. }
  5554. struct addrinfo *result_addrinfo = nullptr;
  5555. struct addrinfo **current = &result_addrinfo;
  5556. for (CFIndex i = 0; i < count; i++) {
  5557. CFDataRef addr_data =
  5558. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5559. if (!addr_data) continue;
  5560. const struct sockaddr *sockaddr_ptr =
  5561. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5562. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5563. // Allocate addrinfo structure
  5564. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5565. if (!*current) {
  5566. freeaddrinfo(result_addrinfo);
  5567. CFRelease(context.addresses);
  5568. CFRelease(host_ref);
  5569. return EAI_MEMORY;
  5570. }
  5571. memset(*current, 0, sizeof(struct addrinfo));
  5572. // Set up addrinfo fields
  5573. (*current)->ai_family = sockaddr_ptr->sa_family;
  5574. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5575. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5576. (*current)->ai_addrlen = sockaddr_len;
  5577. // Copy sockaddr
  5578. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5579. if (!(*current)->ai_addr) {
  5580. freeaddrinfo(result_addrinfo);
  5581. CFRelease(context.addresses);
  5582. CFRelease(host_ref);
  5583. return EAI_MEMORY;
  5584. }
  5585. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5586. // Set port if service is specified
  5587. if (service && *service) {
  5588. int port = 0;
  5589. if (parse_port(service, strlen(service), port)) {
  5590. if (sockaddr_ptr->sa_family == AF_INET) {
  5591. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5592. ->sin_port = htons(static_cast<uint16_t>(port));
  5593. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5594. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5595. ->sin6_port = htons(static_cast<uint16_t>(port));
  5596. }
  5597. }
  5598. }
  5599. current = &((*current)->ai_next);
  5600. }
  5601. CFRelease(context.addresses);
  5602. CFRelease(host_ref);
  5603. *res = result_addrinfo;
  5604. return 0;
  5605. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5606. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5607. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5608. // the resolver worker still references the stack-local gaicb. The cancel
  5609. // path therefore waits (gai_suspend with no timeout) for the worker to
  5610. // actually finish before letting the stack frame go. The trade-off is that
  5611. // a wedged DNS server can hold this thread for the system resolver timeout
  5612. // (~30s by default) past the caller's connection timeout.
  5613. struct gaicb request {};
  5614. struct gaicb *requests[1] = {&request};
  5615. struct sigevent sevp {};
  5616. struct timespec timeout {
  5617. timeout_sec, 0
  5618. };
  5619. request.ar_name = node;
  5620. request.ar_service = service;
  5621. request.ar_request = hints;
  5622. sevp.sigev_notify = SIGEV_NONE;
  5623. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5624. if (rc != 0) { return rc; }
  5625. auto cleanup = scope_exit([&] {
  5626. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5627. });
  5628. int wait_result = gai_suspend(requests, 1, &timeout);
  5629. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5630. int gai_result = gai_error(&request);
  5631. if (gai_result == 0) {
  5632. *res = request.ar_result;
  5633. request.ar_result = nullptr;
  5634. return 0;
  5635. }
  5636. return gai_result;
  5637. }
  5638. gai_cancel(&request);
  5639. while (gai_error(&request) == EAI_INPROGRESS) {
  5640. gai_suspend(requests, 1, nullptr);
  5641. }
  5642. return wait_result;
  5643. #else
  5644. // Fallback implementation using thread-based timeout for other Unix systems.
  5645. struct GetAddrInfoState {
  5646. ~GetAddrInfoState() {
  5647. if (info) { freeaddrinfo(info); }
  5648. }
  5649. std::mutex mutex;
  5650. std::condition_variable result_cv;
  5651. bool completed = false;
  5652. int result = EAI_SYSTEM;
  5653. std::string node;
  5654. std::string service;
  5655. struct addrinfo hints;
  5656. struct addrinfo *info = nullptr;
  5657. };
  5658. // Allocate on the heap, so the resolver thread can keep using the data.
  5659. auto state = std::make_shared<GetAddrInfoState>();
  5660. if (node) { state->node = node; }
  5661. state->service = service;
  5662. state->hints = *hints;
  5663. std::thread resolve_thread([state]() {
  5664. auto thread_result =
  5665. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5666. &state->info);
  5667. std::lock_guard<std::mutex> lock(state->mutex);
  5668. state->result = thread_result;
  5669. state->completed = true;
  5670. state->result_cv.notify_one();
  5671. });
  5672. // Wait for completion or timeout
  5673. std::unique_lock<std::mutex> lock(state->mutex);
  5674. auto finished =
  5675. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5676. [&] { return state->completed; });
  5677. if (finished) {
  5678. // Operation completed within timeout
  5679. resolve_thread.join();
  5680. *res = state->info;
  5681. state->info = nullptr; // Pass ownership to caller
  5682. return state->result;
  5683. } else {
  5684. // Timeout occurred
  5685. resolve_thread.detach(); // Let the thread finish in background
  5686. return EAI_AGAIN; // Return timeout error
  5687. }
  5688. #endif
  5689. #else
  5690. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5691. return getaddrinfo(node, service, hints, res);
  5692. #endif
  5693. }
  5694. template <typename BindOrConnect>
  5695. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5696. int address_family, int socket_flags, bool tcp_nodelay,
  5697. bool ipv6_v6only, SocketOptions socket_options,
  5698. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5699. // Get address info
  5700. const char *node = nullptr;
  5701. struct addrinfo hints;
  5702. struct addrinfo *result;
  5703. memset(&hints, 0, sizeof(struct addrinfo));
  5704. hints.ai_socktype = SOCK_STREAM;
  5705. hints.ai_protocol = IPPROTO_IP;
  5706. if (!ip.empty()) {
  5707. node = ip.c_str();
  5708. // Ask getaddrinfo to convert IP in c-string to address
  5709. hints.ai_family = AF_UNSPEC;
  5710. hints.ai_flags = AI_NUMERICHOST;
  5711. } else {
  5712. if (!host.empty()) { node = host.c_str(); }
  5713. hints.ai_family = address_family;
  5714. hints.ai_flags = socket_flags;
  5715. }
  5716. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5717. if (hints.ai_family == AF_UNIX) {
  5718. const auto addrlen = host.length();
  5719. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5720. #ifdef SOCK_CLOEXEC
  5721. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5722. hints.ai_protocol);
  5723. #else
  5724. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5725. #endif
  5726. if (sock != INVALID_SOCKET) {
  5727. sockaddr_un addr{};
  5728. addr.sun_family = AF_UNIX;
  5729. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5730. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5731. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5732. hints.ai_addrlen = static_cast<socklen_t>(
  5733. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5734. #ifndef SOCK_CLOEXEC
  5735. #ifndef _WIN32
  5736. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5737. #endif
  5738. #endif
  5739. if (socket_options) { socket_options(sock); }
  5740. #ifdef _WIN32
  5741. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5742. // remove the option.
  5743. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5744. #endif
  5745. bool dummy;
  5746. if (!bind_or_connect(sock, hints, dummy)) {
  5747. close_socket(sock);
  5748. sock = INVALID_SOCKET;
  5749. }
  5750. }
  5751. return sock;
  5752. }
  5753. #endif
  5754. auto service = std::to_string(port);
  5755. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5756. timeout_sec)) {
  5757. #if defined __linux__ && !defined __ANDROID__
  5758. res_init();
  5759. #endif
  5760. return INVALID_SOCKET;
  5761. }
  5762. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5763. for (auto rp = result; rp; rp = rp->ai_next) {
  5764. // Create a socket
  5765. #ifdef _WIN32
  5766. auto sock =
  5767. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5768. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5769. /**
  5770. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5771. * and above the socket creation fails on older Windows Systems.
  5772. *
  5773. * Let's try to create a socket the old way in this case.
  5774. *
  5775. * Reference:
  5776. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5777. *
  5778. * WSA_FLAG_NO_HANDLE_INHERIT:
  5779. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5780. * SP1, and later
  5781. *
  5782. */
  5783. if (sock == INVALID_SOCKET) {
  5784. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5785. }
  5786. #else
  5787. #ifdef SOCK_CLOEXEC
  5788. auto sock =
  5789. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5790. #else
  5791. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5792. #endif
  5793. #endif
  5794. if (sock == INVALID_SOCKET) { continue; }
  5795. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5796. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5797. close_socket(sock);
  5798. continue;
  5799. }
  5800. #endif
  5801. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5802. if (rp->ai_family == AF_INET6) {
  5803. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5804. }
  5805. if (socket_options) { socket_options(sock); }
  5806. // bind or connect
  5807. auto quit = false;
  5808. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5809. close_socket(sock);
  5810. if (quit) { break; }
  5811. }
  5812. return INVALID_SOCKET;
  5813. }
  5814. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5815. #ifdef _WIN32
  5816. auto flags = nonblocking ? 1UL : 0UL;
  5817. ioctlsocket(sock, FIONBIO, &flags);
  5818. #else
  5819. auto flags = fcntl(sock, F_GETFL, 0);
  5820. fcntl(sock, F_SETFL,
  5821. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5822. #endif
  5823. }
  5824. inline bool is_connection_error() {
  5825. #ifdef _WIN32
  5826. return WSAGetLastError() != WSAEWOULDBLOCK;
  5827. #else
  5828. return errno != EINPROGRESS;
  5829. #endif
  5830. }
  5831. // accept() failed because the process or the network stack is temporarily out
  5832. // of resources. The listening socket is still usable, so back off briefly and
  5833. // try again.
  5834. inline bool is_accept_resource_error() {
  5835. #ifdef _WIN32
  5836. auto err = WSAGetLastError();
  5837. return err == WSAEMFILE || err == WSAENOBUFS;
  5838. #else
  5839. auto err = errno;
  5840. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  5841. #endif
  5842. }
  5843. // accept() failed for a reason that says nothing about the listening socket:
  5844. // the pending connection went away before it could be accepted, or the call
  5845. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  5846. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  5847. // connection that way.
  5848. inline bool is_accept_transient_error() {
  5849. #ifdef _WIN32
  5850. auto err = WSAGetLastError();
  5851. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  5852. err == WSAECONNABORTED;
  5853. #else
  5854. auto err = errno;
  5855. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  5856. err == ECONNABORTED;
  5857. #endif
  5858. }
  5859. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  5860. struct addrinfo hints;
  5861. struct addrinfo *result;
  5862. memset(&hints, 0, sizeof(struct addrinfo));
  5863. hints.ai_family = AF_UNSPEC;
  5864. hints.ai_socktype = SOCK_STREAM;
  5865. hints.ai_protocol = 0;
  5866. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  5867. return false;
  5868. }
  5869. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5870. auto ret = false;
  5871. for (auto rp = result; rp; rp = rp->ai_next) {
  5872. const auto &ai = *rp;
  5873. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  5874. ret = true;
  5875. break;
  5876. }
  5877. }
  5878. return ret;
  5879. }
  5880. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  5881. #define USE_IF2IP
  5882. #endif
  5883. #ifdef USE_IF2IP
  5884. inline std::string if2ip(int address_family, const std::string &ifn) {
  5885. struct ifaddrs *ifap;
  5886. getifaddrs(&ifap);
  5887. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  5888. std::string addr_candidate;
  5889. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  5890. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  5891. (AF_UNSPEC == address_family ||
  5892. ifa->ifa_addr->sa_family == address_family)) {
  5893. if (ifa->ifa_addr->sa_family == AF_INET) {
  5894. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  5895. char buf[INET_ADDRSTRLEN];
  5896. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  5897. return std::string(buf, INET_ADDRSTRLEN);
  5898. }
  5899. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  5900. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  5901. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  5902. char buf[INET6_ADDRSTRLEN] = {};
  5903. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  5904. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  5905. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  5906. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  5907. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  5908. } else {
  5909. return std::string(buf, INET6_ADDRSTRLEN);
  5910. }
  5911. }
  5912. }
  5913. }
  5914. }
  5915. }
  5916. return addr_candidate;
  5917. }
  5918. #endif
  5919. inline socket_t create_client_socket(
  5920. const std::string &host, const std::string &ip, int port,
  5921. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  5922. SocketOptions socket_options, time_t connection_timeout_sec,
  5923. time_t connection_timeout_usec, time_t read_timeout_sec,
  5924. time_t read_timeout_usec, time_t write_timeout_sec,
  5925. time_t write_timeout_usec, const std::string &intf, Error &error) {
  5926. auto sock = create_socket(
  5927. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  5928. std::move(socket_options),
  5929. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  5930. if (!intf.empty()) {
  5931. #ifdef USE_IF2IP
  5932. auto ip_from_if = if2ip(address_family, intf);
  5933. if (ip_from_if.empty()) { ip_from_if = intf; }
  5934. if (!bind_ip_address(sock2, ip_from_if)) {
  5935. error = Error::BindIPAddress;
  5936. return false;
  5937. }
  5938. #endif
  5939. }
  5940. set_nonblocking(sock2, true);
  5941. auto ret =
  5942. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  5943. if (ret < 0) {
  5944. if (is_connection_error()) {
  5945. error = Error::Connection;
  5946. return false;
  5947. }
  5948. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  5949. connection_timeout_usec);
  5950. if (error != Error::Success) {
  5951. if (error == Error::ConnectionTimeout) { quit = true; }
  5952. return false;
  5953. }
  5954. }
  5955. set_nonblocking(sock2, false);
  5956. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  5957. read_timeout_usec);
  5958. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  5959. write_timeout_usec);
  5960. error = Error::Success;
  5961. return true;
  5962. },
  5963. connection_timeout_sec); // Pass DNS timeout
  5964. if (sock != INVALID_SOCKET) {
  5965. error = Error::Success;
  5966. } else {
  5967. if (error == Error::Success) { error = Error::Connection; }
  5968. }
  5969. return sock;
  5970. }
  5971. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  5972. socklen_t addr_len, std::string &ip, int &port) {
  5973. if (addr.ss_family == AF_INET) {
  5974. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  5975. } else if (addr.ss_family == AF_INET6) {
  5976. port =
  5977. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  5978. } else {
  5979. return false;
  5980. }
  5981. std::array<char, NI_MAXHOST> ipstr{};
  5982. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  5983. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  5984. 0, NI_NUMERICHOST)) {
  5985. return false;
  5986. }
  5987. ip = ipstr.data();
  5988. return true;
  5989. }
  5990. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  5991. struct sockaddr_storage addr;
  5992. socklen_t addr_len = sizeof(addr);
  5993. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  5994. &addr_len)) {
  5995. get_ip_and_port(addr, addr_len, ip, port);
  5996. }
  5997. }
  5998. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  5999. struct sockaddr_storage addr;
  6000. socklen_t addr_len = sizeof(addr);
  6001. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6002. &addr_len)) {
  6003. #ifndef _WIN32
  6004. if (addr.ss_family == AF_UNIX) {
  6005. #if defined(__linux__)
  6006. struct ucred ucred;
  6007. socklen_t len = sizeof(ucred);
  6008. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6009. port = ucred.pid;
  6010. }
  6011. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6012. pid_t pid;
  6013. socklen_t len = sizeof(pid);
  6014. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6015. port = pid;
  6016. }
  6017. #endif
  6018. return;
  6019. }
  6020. #endif
  6021. get_ip_and_port(addr, addr_len, ip, port);
  6022. }
  6023. }
  6024. // Recursive form retained so operator""_t below can compute hashes for
  6025. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6026. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6027. // instead, which is iterative and stack-safe.
  6028. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6029. unsigned int h) {
  6030. return (l == 0)
  6031. ? h
  6032. : str2tag_core(
  6033. s + 1, l - 1,
  6034. // Unsets the 6 high bits of h, therefore no overflow happens
  6035. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6036. h * 33) ^
  6037. static_cast<unsigned char>(*s));
  6038. }
  6039. inline unsigned int str2tag(const std::string &s) {
  6040. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6041. // for compile-time UDL evaluation of short string literals, but at runtime
  6042. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6043. // would blow the stack with one frame per character.
  6044. unsigned int h = 0;
  6045. for (auto c : s) {
  6046. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6047. static_cast<unsigned char>(c);
  6048. }
  6049. return h;
  6050. }
  6051. namespace udl {
  6052. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6053. return str2tag_core(s, l, 0);
  6054. }
  6055. } // namespace udl
  6056. inline std::string
  6057. find_content_type(const std::string &path,
  6058. const std::map<std::string, std::string> &user_data,
  6059. const std::string &default_content_type) {
  6060. auto ext = file_extension(path);
  6061. auto it = user_data.find(ext);
  6062. if (it != user_data.end()) { return it->second; }
  6063. using udl::operator""_t;
  6064. switch (str2tag(ext)) {
  6065. default: return default_content_type;
  6066. case "css"_t: return "text/css";
  6067. case "csv"_t: return "text/csv";
  6068. case "htm"_t:
  6069. case "html"_t: return "text/html";
  6070. case "js"_t:
  6071. case "mjs"_t: return "text/javascript";
  6072. case "txt"_t: return "text/plain";
  6073. case "vtt"_t: return "text/vtt";
  6074. case "apng"_t: return "image/apng";
  6075. case "avif"_t: return "image/avif";
  6076. case "bmp"_t: return "image/bmp";
  6077. case "gif"_t: return "image/gif";
  6078. case "png"_t: return "image/png";
  6079. case "svg"_t: return "image/svg+xml";
  6080. case "webp"_t: return "image/webp";
  6081. case "ico"_t: return "image/x-icon";
  6082. case "tif"_t: return "image/tiff";
  6083. case "tiff"_t: return "image/tiff";
  6084. case "jpg"_t:
  6085. case "jpeg"_t: return "image/jpeg";
  6086. case "mp4"_t: return "video/mp4";
  6087. case "mpeg"_t: return "video/mpeg";
  6088. case "webm"_t: return "video/webm";
  6089. case "mp3"_t: return "audio/mp3";
  6090. case "mpga"_t: return "audio/mpeg";
  6091. case "weba"_t: return "audio/webm";
  6092. case "wav"_t: return "audio/wave";
  6093. case "otf"_t: return "font/otf";
  6094. case "ttf"_t: return "font/ttf";
  6095. case "woff"_t: return "font/woff";
  6096. case "woff2"_t: return "font/woff2";
  6097. case "7z"_t: return "application/x-7z-compressed";
  6098. case "atom"_t: return "application/atom+xml";
  6099. case "pdf"_t: return "application/pdf";
  6100. case "json"_t: return "application/json";
  6101. case "rss"_t: return "application/rss+xml";
  6102. case "tar"_t: return "application/x-tar";
  6103. case "xht"_t:
  6104. case "xhtml"_t: return "application/xhtml+xml";
  6105. case "xslt"_t: return "application/xslt+xml";
  6106. case "xml"_t: return "application/xml";
  6107. case "gz"_t: return "application/gzip";
  6108. case "zip"_t: return "application/zip";
  6109. case "wasm"_t: return "application/wasm";
  6110. }
  6111. }
  6112. inline std::string
  6113. extract_media_type(const std::string &content_type,
  6114. std::map<std::string, std::string> *params = nullptr) {
  6115. // Extract type/subtype from Content-Type value (RFC 2045)
  6116. // e.g. "application/json; charset=utf-8" -> "application/json"
  6117. auto media_type = content_type;
  6118. auto semicolon_pos = media_type.find(';');
  6119. if (semicolon_pos != std::string::npos) {
  6120. auto param_str = media_type.substr(semicolon_pos + 1);
  6121. media_type = media_type.substr(0, semicolon_pos);
  6122. if (params) {
  6123. // Parse parameters: key=value pairs separated by ';'
  6124. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6125. [&](const char *b, const char *e) {
  6126. std::string key;
  6127. std::string val;
  6128. divide_param_pair(b, e, key, val);
  6129. if (!key.empty()) {
  6130. params->emplace(trim_copy(key),
  6131. trim_double_quotes_copy(val));
  6132. }
  6133. });
  6134. }
  6135. }
  6136. // Trim whitespace from media type
  6137. return trim_copy(media_type);
  6138. }
  6139. inline bool can_compress_content_type(const std::string &content_type) {
  6140. using udl::operator""_t;
  6141. auto mime_type = extract_media_type(content_type);
  6142. auto tag = str2tag(mime_type);
  6143. switch (tag) {
  6144. case "image/svg+xml"_t:
  6145. case "application/javascript"_t:
  6146. case "application/x-javascript"_t:
  6147. case "application/json"_t:
  6148. case "application/ld+json"_t:
  6149. case "application/xml"_t:
  6150. case "application/xhtml+xml"_t:
  6151. case "application/rss+xml"_t:
  6152. case "application/atom+xml"_t:
  6153. case "application/xslt+xml"_t:
  6154. case "application/protobuf"_t: return true;
  6155. case "text/event-stream"_t: return false;
  6156. default: return !mime_type.rfind("text/", 0);
  6157. }
  6158. }
  6159. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6160. double &quality) {
  6161. quality = 1.0;
  6162. token.clear();
  6163. // Split on first ';': left = token name, right = parameters
  6164. const char *params_b = nullptr;
  6165. std::size_t params_len = 0;
  6166. divide(
  6167. b, static_cast<std::size_t>(e - b), ';',
  6168. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6169. auto r = trim(lb, lb + llen, 0, llen);
  6170. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6171. params_b = rb;
  6172. params_len = rlen;
  6173. });
  6174. if (token.empty()) { return false; }
  6175. if (params_len == 0) { return true; }
  6176. // Scan parameters for q= (stops on first match)
  6177. bool invalid = false;
  6178. split_find(params_b, params_b + params_len, ';',
  6179. (std::numeric_limits<size_t>::max)(),
  6180. [&](const char *pb, const char *pe) -> bool {
  6181. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6182. auto len = static_cast<size_t>(pe - pb);
  6183. if (len < 2) { return false; }
  6184. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6185. return false;
  6186. }
  6187. // Trim the value portion
  6188. auto r = trim(pb, pe, 2, len);
  6189. if (r.first >= r.second) {
  6190. invalid = true;
  6191. return true;
  6192. }
  6193. double v = 0.0;
  6194. auto res = from_chars(pb + r.first, pb + r.second, v);
  6195. if (res.ec != std::errc{} || v < 0.0 || v > 1.0) {
  6196. invalid = true;
  6197. return true;
  6198. }
  6199. quality = v;
  6200. return true;
  6201. });
  6202. return !invalid;
  6203. }
  6204. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6205. if (!can_compress_content_type(res.get_header_value("Content-Type"))) {
  6206. return EncodingType::None;
  6207. }
  6208. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6209. if (s.empty()) { return EncodingType::None; }
  6210. // Single-pass: iterate tokens and track the best supported encoding.
  6211. // Server preference breaks ties (br > gzip > zstd).
  6212. EncodingType best = EncodingType::None;
  6213. double best_q = 0.0; // q=0 means "not acceptable"
  6214. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6215. auto priority = [](EncodingType t) -> int {
  6216. switch (t) {
  6217. case EncodingType::Brotli: return 0;
  6218. case EncodingType::Gzip: return 1;
  6219. case EncodingType::Zstd: return 2;
  6220. default: return 3;
  6221. }
  6222. };
  6223. std::string name;
  6224. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6225. double quality = 1.0;
  6226. if (!parse_quality(b, e, name, quality)) { return; }
  6227. if (quality <= 0.0) { return; }
  6228. EncodingType type = EncodingType::None;
  6229. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6230. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6231. #endif
  6232. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6233. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6234. type = EncodingType::Gzip;
  6235. }
  6236. #endif
  6237. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6238. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6239. type = EncodingType::Zstd;
  6240. }
  6241. #endif
  6242. if (type == EncodingType::None) { return; }
  6243. // Higher q-value wins; for equal q, server preference breaks ties
  6244. if (quality > best_q ||
  6245. (quality == best_q && priority(type) < priority(best))) {
  6246. best_q = quality;
  6247. best = type;
  6248. }
  6249. });
  6250. return best;
  6251. }
  6252. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6253. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6254. if (type == EncodingType::Gzip) {
  6255. return detail::make_unique<gzip_compressor>();
  6256. }
  6257. #endif
  6258. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6259. if (type == EncodingType::Brotli) {
  6260. return detail::make_unique<brotli_compressor>();
  6261. }
  6262. #endif
  6263. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6264. if (type == EncodingType::Zstd) {
  6265. return detail::make_unique<zstd_compressor>();
  6266. }
  6267. #endif
  6268. (void)type;
  6269. return nullptr;
  6270. }
  6271. inline const char *encoding_name(EncodingType type) {
  6272. switch (type) {
  6273. case EncodingType::Gzip: return "gzip";
  6274. case EncodingType::Brotli: return "br";
  6275. case EncodingType::Zstd: return "zstd";
  6276. default: return "";
  6277. }
  6278. }
  6279. inline bool nocompressor::compress(const char *data, size_t data_length,
  6280. bool /*last*/, Callback callback) {
  6281. if (!data_length) { return true; }
  6282. return callback(data, data_length);
  6283. }
  6284. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6285. inline gzip_compressor::gzip_compressor() {
  6286. std::memset(&strm_, 0, sizeof(strm_));
  6287. strm_.zalloc = Z_NULL;
  6288. strm_.zfree = Z_NULL;
  6289. strm_.opaque = Z_NULL;
  6290. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6291. Z_DEFAULT_STRATEGY) == Z_OK;
  6292. }
  6293. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6294. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6295. bool last, Callback callback) {
  6296. assert(is_valid_);
  6297. do {
  6298. constexpr size_t max_avail_in =
  6299. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6300. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6301. (std::min)(data_length, max_avail_in));
  6302. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6303. data_length -= strm_.avail_in;
  6304. data += strm_.avail_in;
  6305. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6306. auto ret = Z_OK;
  6307. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6308. do {
  6309. strm_.avail_out = static_cast<uInt>(buff.size());
  6310. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6311. ret = deflate(&strm_, flush);
  6312. if (ret == Z_STREAM_ERROR) { return false; }
  6313. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6314. return false;
  6315. }
  6316. } while (strm_.avail_out == 0);
  6317. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6318. (flush == Z_NO_FLUSH && ret == Z_OK));
  6319. assert(strm_.avail_in == 0);
  6320. } while (data_length > 0);
  6321. return true;
  6322. }
  6323. inline gzip_decompressor::gzip_decompressor() {
  6324. std::memset(&strm_, 0, sizeof(strm_));
  6325. strm_.zalloc = Z_NULL;
  6326. strm_.zfree = Z_NULL;
  6327. strm_.opaque = Z_NULL;
  6328. // 15 is the value of wbits, which should be at the maximum possible value
  6329. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6330. // that the stream type should be automatically detected either gzip or
  6331. // deflate.
  6332. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6333. }
  6334. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6335. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6336. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6337. Callback callback) {
  6338. assert(is_valid_);
  6339. auto ret = Z_OK;
  6340. do {
  6341. constexpr size_t max_avail_in =
  6342. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6343. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6344. (std::min)(data_length, max_avail_in));
  6345. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6346. data_length -= strm_.avail_in;
  6347. data += strm_.avail_in;
  6348. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6349. while (strm_.avail_in > 0 && ret == Z_OK) {
  6350. strm_.avail_out = static_cast<uInt>(buff.size());
  6351. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6352. ret = inflate(&strm_, Z_NO_FLUSH);
  6353. assert(ret != Z_STREAM_ERROR);
  6354. switch (ret) {
  6355. case Z_NEED_DICT:
  6356. case Z_DATA_ERROR:
  6357. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6358. }
  6359. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6360. return false;
  6361. }
  6362. }
  6363. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6364. } while (data_length > 0);
  6365. return true;
  6366. }
  6367. #endif
  6368. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6369. inline brotli_compressor::brotli_compressor() {
  6370. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6371. }
  6372. inline brotli_compressor::~brotli_compressor() {
  6373. BrotliEncoderDestroyInstance(state_);
  6374. }
  6375. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6376. bool last, Callback callback) {
  6377. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6378. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6379. auto available_in = data_length;
  6380. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6381. for (;;) {
  6382. if (last) {
  6383. if (BrotliEncoderIsFinished(state_)) { break; }
  6384. } else {
  6385. if (!available_in) { break; }
  6386. }
  6387. auto available_out = buff.size();
  6388. auto next_out = buff.data();
  6389. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6390. &available_out, &next_out, nullptr)) {
  6391. return false;
  6392. }
  6393. auto output_bytes = buff.size() - available_out;
  6394. if (output_bytes) {
  6395. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6396. }
  6397. }
  6398. return true;
  6399. }
  6400. inline brotli_decompressor::brotli_decompressor() {
  6401. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6402. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6403. : BROTLI_DECODER_RESULT_ERROR;
  6404. }
  6405. inline brotli_decompressor::~brotli_decompressor() {
  6406. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6407. }
  6408. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6409. inline bool brotli_decompressor::decompress(const char *data,
  6410. size_t data_length,
  6411. Callback callback) {
  6412. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6413. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6414. return 0;
  6415. }
  6416. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6417. size_t avail_in = data_length;
  6418. size_t total_out;
  6419. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6420. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6421. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6422. char *next_out = buff.data();
  6423. size_t avail_out = buff.size();
  6424. decoder_r = BrotliDecoderDecompressStream(
  6425. decoder_s, &avail_in, &next_in, &avail_out,
  6426. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6427. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6428. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6429. }
  6430. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6431. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6432. }
  6433. #endif
  6434. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6435. inline zstd_compressor::zstd_compressor() {
  6436. ctx_ = ZSTD_createCCtx();
  6437. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6438. }
  6439. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6440. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6441. bool last, Callback callback) {
  6442. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6443. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6444. ZSTD_inBuffer input = {data, data_length, 0};
  6445. bool finished;
  6446. do {
  6447. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6448. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6449. if (ZSTD_isError(remaining)) { return false; }
  6450. if (!callback(buff.data(), output.pos)) { return false; }
  6451. finished = last ? (remaining == 0) : (input.pos == input.size);
  6452. } while (!finished);
  6453. return true;
  6454. }
  6455. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6456. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6457. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6458. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6459. Callback callback) {
  6460. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6461. ZSTD_inBuffer input = {data, data_length, 0};
  6462. while (input.pos < input.size) {
  6463. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6464. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6465. if (ZSTD_isError(remaining)) { return false; }
  6466. if (!callback(buff.data(), output.pos)) { return false; }
  6467. }
  6468. return true;
  6469. }
  6470. #endif
  6471. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6472. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6473. // unknown coding, and its payload would be handed back still compressed.
  6474. inline bool is_zlib_encoding(const std::string &encoding) {
  6475. return case_ignore::equal(encoding, "gzip") ||
  6476. case_ignore::equal(encoding, "deflate");
  6477. }
  6478. inline bool is_brotli_encoding(const std::string &encoding) {
  6479. return case_ignore::equal(encoding, "br");
  6480. }
  6481. inline bool is_zstd_encoding(const std::string &encoding) {
  6482. return case_ignore::equal(encoding, "zstd");
  6483. }
  6484. // Returns true if the content coding is one cpp-httplib is able to decompress
  6485. // when the corresponding support is compiled in.
  6486. inline bool is_known_content_encoding(const std::string &encoding) {
  6487. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6488. is_zstd_encoding(encoding);
  6489. }
  6490. inline std::unique_ptr<decompressor>
  6491. create_decompressor(const std::string &encoding) {
  6492. std::unique_ptr<decompressor> decompressor;
  6493. if (is_zlib_encoding(encoding)) {
  6494. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6495. decompressor = detail::make_unique<gzip_decompressor>();
  6496. #endif
  6497. } else if (is_brotli_encoding(encoding)) {
  6498. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6499. decompressor = detail::make_unique<brotli_decompressor>();
  6500. #endif
  6501. } else if (is_zstd_encoding(encoding)) {
  6502. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6503. decompressor = detail::make_unique<zstd_decompressor>();
  6504. #endif
  6505. }
  6506. return decompressor;
  6507. }
  6508. // Returns the best available compressor and its Content-Encoding name.
  6509. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6510. inline std::pair<std::unique_ptr<compressor>, const char *>
  6511. create_compressor() {
  6512. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6513. return {detail::make_unique<brotli_compressor>(), "br"};
  6514. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6515. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6516. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6517. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6518. #else
  6519. return {nullptr, nullptr};
  6520. #endif
  6521. }
  6522. inline bool is_prohibited_header_name(const std::string &name) {
  6523. using udl::operator""_t;
  6524. switch (str2tag(name)) {
  6525. case "REMOTE_ADDR"_t:
  6526. case "REMOTE_PORT"_t:
  6527. case "LOCAL_ADDR"_t:
  6528. case "LOCAL_PORT"_t: return true;
  6529. default: return false;
  6530. }
  6531. }
  6532. inline bool has_header(const Headers &headers, const std::string &key) {
  6533. if (is_prohibited_header_name(key)) { return false; }
  6534. return headers.find(key) != headers.end();
  6535. }
  6536. inline const char *get_header_value(const Headers &headers,
  6537. const std::string &key, const char *def,
  6538. size_t id) {
  6539. if (is_prohibited_header_name(key)) {
  6540. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6541. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6542. throw std::invalid_argument(msg);
  6543. #else
  6544. return "";
  6545. #endif
  6546. }
  6547. auto rng = headers.equal_range(key);
  6548. auto it = rng.first;
  6549. std::advance(it, static_cast<ssize_t>(id));
  6550. if (it != rng.second) { return it->second.c_str(); }
  6551. return def;
  6552. }
  6553. inline size_t get_header_value_count(const Headers &headers,
  6554. const std::string &key) {
  6555. return headers.count(key);
  6556. }
  6557. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6558. // list may be sent as several field lines, and the combined field value is
  6559. // those values joined by commas in the order they were received. Callers that
  6560. // parse such a list must work on the combined value; reading only the first
  6561. // occurrence silently drops whatever the later field lines carry.
  6562. inline std::string get_combined_header_value(const Headers &headers,
  6563. const std::string &key) {
  6564. std::string combined;
  6565. auto rng = headers.equal_range(key);
  6566. for (auto it = rng.first; it != rng.second; ++it) {
  6567. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6568. // elements, so an empty field line must not contribute a bare comma to the
  6569. // combined value.
  6570. if (it->second.empty()) { continue; }
  6571. if (!combined.empty()) { combined += ", "; }
  6572. combined += it->second;
  6573. }
  6574. return combined;
  6575. }
  6576. inline bool has_header_token(const Headers &headers, const std::string &key,
  6577. const std::string &token) {
  6578. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6579. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6580. // several lines. Match complete tokens rather than searching the raw value,
  6581. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6582. auto rng = headers.equal_range(key);
  6583. for (auto it = rng.first; it != rng.second; ++it) {
  6584. const auto &value = it->second;
  6585. if (split_find(value.data(), value.data() + value.size(), ',',
  6586. [&](const char *b, const char *e) {
  6587. return case_ignore::equal(std::string(b, e), token);
  6588. })) {
  6589. return true;
  6590. }
  6591. }
  6592. return false;
  6593. }
  6594. template <typename Map>
  6595. inline typename Map::mapped_type
  6596. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6597. auto rng = m.equal_range(key);
  6598. auto it = rng.first;
  6599. std::advance(it, static_cast<ssize_t>(id));
  6600. if (it != rng.second) { return it->second; }
  6601. return typename Map::mapped_type();
  6602. }
  6603. inline void set_header(Headers &headers, const std::string &key,
  6604. const std::string &val) {
  6605. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6606. }
  6607. inline bool read_headers(Stream &strm, Headers &headers) {
  6608. const auto bufsiz = 2048;
  6609. char buf[bufsiz];
  6610. stream_line_reader line_reader(strm, buf, bufsiz);
  6611. size_t header_count = 0;
  6612. for (;;) {
  6613. if (!line_reader.getline()) { return false; }
  6614. // Check if the line ends with CRLF.
  6615. auto line_terminator_len = 2;
  6616. if (line_reader.end_with_crlf()) {
  6617. // Blank line indicates end of headers.
  6618. if (line_reader.size() == 2) { break; }
  6619. } else {
  6620. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6621. // Blank line indicates end of headers.
  6622. if (line_reader.size() == 1) { break; }
  6623. line_terminator_len = 1;
  6624. #else
  6625. continue; // Skip invalid line.
  6626. #endif
  6627. }
  6628. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6629. // Check header count limit
  6630. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6631. // Exclude line terminator
  6632. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6633. if (!parse_header(line_reader.ptr(), end,
  6634. [&](const std::string &key, const std::string &val) {
  6635. headers.emplace(key, val);
  6636. })) {
  6637. return false;
  6638. }
  6639. header_count++;
  6640. }
  6641. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6642. // headers that have different values to prevent request smuggling.
  6643. auto cl_range = headers.equal_range("Content-Length");
  6644. if (cl_range.first != cl_range.second) {
  6645. const auto &first_val = cl_range.first->second;
  6646. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6647. if (it->second != first_val) { return false; }
  6648. }
  6649. }
  6650. return true;
  6651. }
  6652. inline bool parse_status_line(const char *line, std::string &version,
  6653. int &status, std::string &reason) {
  6654. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6655. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6656. #else
  6657. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6658. #endif
  6659. std::cmatch m;
  6660. if (!std::regex_match(line, m, re)) { return false; }
  6661. version = std::string(m[1]);
  6662. status = std::stoi(std::string(m[2]));
  6663. reason = std::string(m[3]);
  6664. return true;
  6665. }
  6666. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6667. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6668. struct WebSocketUpgradeResponse {
  6669. Error error = Error::Success;
  6670. int status = -1;
  6671. Headers headers;
  6672. std::string selected_subprotocol;
  6673. };
  6674. inline bool read_websocket_upgrade_response(Stream &strm,
  6675. const std::string &expected_accept,
  6676. WebSocketUpgradeResponse &upgrade) {
  6677. // Read status line
  6678. const auto bufsiz = 2048;
  6679. char buf[bufsiz];
  6680. stream_line_reader line_reader(strm, buf, bufsiz);
  6681. if (!line_reader.getline()) {
  6682. upgrade.error = Error::Read;
  6683. return false;
  6684. }
  6685. std::string version;
  6686. std::string reason;
  6687. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6688. upgrade.error = Error::WebSocketHandshake;
  6689. return false;
  6690. }
  6691. // Read the headers even for a rejection so the caller can see why the
  6692. // server refused the upgrade. A non-101 response may carry a body; it is
  6693. // deliberately left unread since the caller closes the socket right away.
  6694. if (!read_headers(strm, upgrade.headers)) {
  6695. upgrade.error = Error::Read;
  6696. return false;
  6697. }
  6698. const auto &headers = upgrade.headers;
  6699. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6700. upgrade.error = Error::WebSocketHandshake;
  6701. return false;
  6702. }
  6703. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6704. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6705. upgrade.error = Error::WebSocketHandshake;
  6706. return false;
  6707. }
  6708. // Verify Connection: Upgrade
  6709. if (!has_header_token(headers, "Connection", "upgrade")) {
  6710. upgrade.error = Error::WebSocketHandshake;
  6711. return false;
  6712. }
  6713. // Verify Sec-WebSocket-Accept header value
  6714. auto it = headers.find("Sec-WebSocket-Accept");
  6715. if (it == headers.end() || it->second != expected_accept) {
  6716. upgrade.error = Error::WebSocketHandshake;
  6717. return false;
  6718. }
  6719. // Extract negotiated subprotocol
  6720. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6721. if (proto_it != headers.end()) {
  6722. upgrade.selected_subprotocol = proto_it->second;
  6723. }
  6724. return true;
  6725. }
  6726. enum class ReadContentResult {
  6727. Success, // Successfully read the content
  6728. PayloadTooLarge, // The content exceeds the specified payload limit
  6729. Error // An error occurred while reading the content
  6730. };
  6731. inline ReadContentResult read_content_with_length(
  6732. Stream &strm, size_t len, DownloadProgress progress,
  6733. ContentReceiverWithProgress out,
  6734. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6735. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6736. detail::BodyReader br;
  6737. br.stream = &strm;
  6738. br.has_content_length = true;
  6739. br.content_length = len;
  6740. br.payload_max_length = payload_max_length;
  6741. br.chunked = false;
  6742. br.bytes_read = 0;
  6743. br.last_error = Error::Success;
  6744. size_t r = 0;
  6745. while (r < len) {
  6746. auto read_len = static_cast<size_t>(len - r);
  6747. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6748. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6749. if (n <= 0) {
  6750. // Check if it was a payload size error
  6751. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6752. return ReadContentResult::PayloadTooLarge;
  6753. }
  6754. return ReadContentResult::Error;
  6755. }
  6756. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6757. return ReadContentResult::Error;
  6758. }
  6759. r += static_cast<size_t>(n);
  6760. if (progress) {
  6761. if (!progress(r, len)) { return ReadContentResult::Error; }
  6762. }
  6763. }
  6764. return ReadContentResult::Success;
  6765. }
  6766. inline ReadContentResult
  6767. read_content_without_length(Stream &strm, size_t payload_max_length,
  6768. ContentReceiverWithProgress out) {
  6769. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6770. size_t r = 0;
  6771. for (;;) {
  6772. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6773. if (n == 0) { return ReadContentResult::Success; }
  6774. if (n < 0) { return ReadContentResult::Error; }
  6775. // Check if adding this data would exceed the payload limit
  6776. if (r > payload_max_length ||
  6777. payload_max_length - r < static_cast<size_t>(n)) {
  6778. return ReadContentResult::PayloadTooLarge;
  6779. }
  6780. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6781. return ReadContentResult::Error;
  6782. }
  6783. r += static_cast<size_t>(n);
  6784. }
  6785. return ReadContentResult::Success;
  6786. }
  6787. template <typename T>
  6788. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6789. size_t payload_max_length,
  6790. ContentReceiverWithProgress out) {
  6791. detail::ChunkedDecoder dec(strm);
  6792. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6793. size_t total_len = 0;
  6794. for (;;) {
  6795. size_t chunk_offset = 0;
  6796. size_t chunk_total = 0;
  6797. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6798. if (n < 0) { return ReadContentResult::Error; }
  6799. if (n == 0) {
  6800. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6801. return ReadContentResult::Error;
  6802. }
  6803. return ReadContentResult::Success;
  6804. }
  6805. if (total_len > payload_max_length ||
  6806. payload_max_length - total_len < static_cast<size_t>(n)) {
  6807. return ReadContentResult::PayloadTooLarge;
  6808. }
  6809. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6810. return ReadContentResult::Error;
  6811. }
  6812. total_len += static_cast<size_t>(n);
  6813. }
  6814. }
  6815. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  6816. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  6817. // is the final transfer coding. A single field value may list several
  6818. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  6819. // several Transfer-Encoding lines, which combine into one comma-separated
  6820. // list in the order the lines were received. Headers preserves that order,
  6821. // so the final coding is the last token of the last line. Match it
  6822. // case-insensitively rather than comparing the whole value against
  6823. // "chunked".
  6824. //
  6825. // Security: reading a chunked message as unframed leaves its body in the
  6826. // socket, where a keep-alive connection parses it as a smuggled request.
  6827. // Server::process_request() answers 400 and closes when the final coding is
  6828. // not chunked, so a request whose framing cannot be determined never
  6829. // reaches the "no body" path.
  6830. auto rng = headers.equal_range("Transfer-Encoding");
  6831. if (rng.first == rng.second) { return false; }
  6832. // Cleared per line, so a trailing line carrying no coding at all leaves the
  6833. // combined list ending in nothing rather than inheriting the line before it.
  6834. std::string last_coding;
  6835. for (auto it = rng.first; it != rng.second; ++it) {
  6836. const auto &value = it->second;
  6837. last_coding.clear();
  6838. split(value.data(), value.data() + value.size(), ',',
  6839. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  6840. }
  6841. return case_ignore::equal(last_coding, "chunked");
  6842. }
  6843. template <typename T, typename U>
  6844. bool prepare_content_receiver(T &x, int &status,
  6845. ContentReceiverWithProgress receiver,
  6846. bool decompress, size_t payload_max_length,
  6847. bool &exceed_payload_max_length, U callback) {
  6848. if (decompress) {
  6849. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  6850. std::unique_ptr<decompressor> decompressor;
  6851. if (!encoding.empty()) {
  6852. // A coding we know about but were not built with is an error. An
  6853. // unrecognized coding (including "identity") is left alone and the
  6854. // payload is passed through as-is, since some servers misuse the header,
  6855. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  6856. decompressor = detail::create_decompressor(encoding);
  6857. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  6858. status = StatusCode::UnsupportedMediaType_415;
  6859. return false;
  6860. }
  6861. }
  6862. if (decompressor) {
  6863. if (decompressor->is_valid()) {
  6864. size_t decompressed_size = 0;
  6865. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  6866. size_t off, size_t len) {
  6867. return decompressor->decompress(
  6868. buf, n, [&](const char *buf2, size_t n2) {
  6869. // Guard against zip-bomb: check
  6870. // decompressed size against limit.
  6871. if (payload_max_length > 0 &&
  6872. (decompressed_size >= payload_max_length ||
  6873. n2 > payload_max_length - decompressed_size)) {
  6874. exceed_payload_max_length = true;
  6875. return false;
  6876. }
  6877. decompressed_size += n2;
  6878. return receiver(buf2, n2, off, len);
  6879. });
  6880. };
  6881. return callback(std::move(out));
  6882. } else {
  6883. status = StatusCode::InternalServerError_500;
  6884. return false;
  6885. }
  6886. }
  6887. }
  6888. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  6889. size_t len) {
  6890. return receiver(buf, n, off, len);
  6891. };
  6892. return callback(std::move(out));
  6893. }
  6894. template <typename T>
  6895. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  6896. DownloadProgress progress,
  6897. ContentReceiverWithProgress receiver, bool decompress) {
  6898. bool exceed_payload_max_length = false;
  6899. return prepare_content_receiver(
  6900. x, status, std::move(receiver), decompress, payload_max_length,
  6901. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  6902. auto ret = true;
  6903. // Note: exceed_payload_max_length may also be set by the decompressor
  6904. // wrapper in prepare_content_receiver when the decompressed payload
  6905. // size exceeds the limit.
  6906. if (is_chunked_transfer_encoding(x.headers)) {
  6907. auto result = read_content_chunked(strm, x, payload_max_length, out);
  6908. if (result == ReadContentResult::Success) {
  6909. ret = true;
  6910. } else if (result == ReadContentResult::PayloadTooLarge) {
  6911. exceed_payload_max_length = true;
  6912. ret = false;
  6913. } else {
  6914. ret = false;
  6915. }
  6916. } else if (!has_header(x.headers, "Content-Length")) {
  6917. auto result =
  6918. read_content_without_length(strm, payload_max_length, out);
  6919. if (result == ReadContentResult::Success) {
  6920. ret = true;
  6921. } else if (result == ReadContentResult::PayloadTooLarge) {
  6922. exceed_payload_max_length = true;
  6923. ret = false;
  6924. } else {
  6925. ret = false;
  6926. }
  6927. } else {
  6928. auto is_invalid_value = false;
  6929. auto len = get_header_value_u64(x.headers, "Content-Length",
  6930. (std::numeric_limits<size_t>::max)(),
  6931. 0, is_invalid_value);
  6932. if (is_invalid_value) {
  6933. ret = false;
  6934. } else if (len > 0) {
  6935. auto result = read_content_with_length(
  6936. strm, len, std::move(progress), out, payload_max_length);
  6937. ret = (result == ReadContentResult::Success);
  6938. if (result == ReadContentResult::PayloadTooLarge) {
  6939. exceed_payload_max_length = true;
  6940. }
  6941. }
  6942. }
  6943. if (!ret) {
  6944. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  6945. : StatusCode::BadRequest_400;
  6946. }
  6947. return ret;
  6948. });
  6949. }
  6950. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  6951. const std::string &path) {
  6952. // A request target must not carry CR/LF (or other control octets); otherwise
  6953. // a value smuggled into it splits the request line and injects headers or a
  6954. // whole request. The same field-value check already guards header values in
  6955. // check_and_write_headers and the request target in
  6956. // perform_websocket_handshake; apply it here too.
  6957. if (!fields::is_field_value(path)) { return -1; }
  6958. std::string s = method;
  6959. s += ' ';
  6960. s += path;
  6961. s += " HTTP/1.1\r\n";
  6962. return strm.write(s.data(), s.size());
  6963. }
  6964. inline ssize_t write_response_line(Stream &strm, int status) {
  6965. std::string s = "HTTP/1.1 ";
  6966. s += std::to_string(status);
  6967. s += ' ';
  6968. s += httplib::status_message(status);
  6969. s += "\r\n";
  6970. return strm.write(s.data(), s.size());
  6971. }
  6972. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  6973. ssize_t write_len = 0;
  6974. for (const auto &x : headers) {
  6975. // Skip fields with invalid names or values to prevent response splitting
  6976. // via CR/LF injection, matching set_header(). The client validates request
  6977. // headers up front in check_and_write_headers, but the server passes
  6978. // res.headers straight to this writer, and res.headers is a public field
  6979. // an application can populate directly with request-derived values.
  6980. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  6981. std::string s;
  6982. s = x.first;
  6983. s += ": ";
  6984. s += x.second;
  6985. s += "\r\n";
  6986. auto len = strm.write(s.data(), s.size());
  6987. if (len < 0) { return len; }
  6988. write_len += len;
  6989. }
  6990. auto len = strm.write("\r\n");
  6991. if (len < 0) { return len; }
  6992. write_len += len;
  6993. return write_len;
  6994. }
  6995. inline bool write_data(Stream &strm, const char *d, size_t l) {
  6996. size_t offset = 0;
  6997. while (offset < l) {
  6998. auto length = strm.write(d + offset, l - offset);
  6999. if (length < 0) { return false; }
  7000. offset += static_cast<size_t>(length);
  7001. }
  7002. return true;
  7003. }
  7004. template <typename T>
  7005. inline bool write_content_with_progress(Stream &strm,
  7006. const ContentProvider &content_provider,
  7007. size_t offset, size_t length,
  7008. T is_shutting_down,
  7009. const UploadProgress &upload_progress,
  7010. Error &error) {
  7011. size_t end_offset = offset + length;
  7012. size_t start_offset = offset;
  7013. auto ok = true;
  7014. auto finished = false;
  7015. DataSink data_sink;
  7016. data_sink.write = [&](const char *d, size_t l) -> bool {
  7017. if (ok) {
  7018. if (write_data(strm, d, l)) {
  7019. offset += l;
  7020. if (upload_progress && length > 0) {
  7021. size_t current_written = offset - start_offset;
  7022. if (!upload_progress(current_written, length)) {
  7023. ok = false;
  7024. return false;
  7025. }
  7026. }
  7027. } else {
  7028. ok = false;
  7029. }
  7030. }
  7031. return ok;
  7032. };
  7033. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7034. // The body is framed by `length`, so a provider that reports itself done
  7035. // early has truncated it. Record that and let the short-body check below
  7036. // fail the write, rather than calling the provider again forever.
  7037. data_sink.done = [&]() { finished = true; };
  7038. while (offset < end_offset && !finished && !is_shutting_down()) {
  7039. auto last_offset = offset;
  7040. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7041. error = Error::Write;
  7042. return false;
  7043. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7044. error = Error::Canceled;
  7045. return false;
  7046. } else if (!ok) {
  7047. error = Error::Write;
  7048. return false;
  7049. }
  7050. // A provider that reports success without writing anything and without
  7051. // reporting itself done gets handed the same offset and length again on
  7052. // the next pass, so it would spin here for as long as the peer stays
  7053. // connected. Treat making no progress as a short body, like done() early.
  7054. if (!finished && offset == last_offset) {
  7055. error = Error::Write;
  7056. return false;
  7057. }
  7058. }
  7059. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7060. error = Error::Write;
  7061. return false;
  7062. }
  7063. error = Error::Success;
  7064. return true;
  7065. }
  7066. template <typename T>
  7067. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7068. size_t offset, size_t length, T is_shutting_down,
  7069. Error &error) {
  7070. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7071. is_shutting_down, nullptr, error);
  7072. }
  7073. template <typename T>
  7074. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7075. size_t offset, size_t length,
  7076. const T &is_shutting_down) {
  7077. auto error = Error::Success;
  7078. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7079. error);
  7080. }
  7081. template <typename T>
  7082. inline bool
  7083. write_content_without_length(Stream &strm,
  7084. const ContentProvider &content_provider,
  7085. const T &is_shutting_down) {
  7086. size_t offset = 0;
  7087. auto data_available = true;
  7088. auto ok = true;
  7089. DataSink data_sink;
  7090. data_sink.write = [&](const char *d, size_t l) -> bool {
  7091. if (ok) {
  7092. offset += l;
  7093. if (!write_data(strm, d, l)) { ok = false; }
  7094. }
  7095. return ok;
  7096. };
  7097. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7098. data_sink.done = [&](void) { data_available = false; };
  7099. while (data_available && !is_shutting_down()) {
  7100. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7101. return false;
  7102. } else if (!content_provider(offset, 0, data_sink)) {
  7103. return false;
  7104. } else if (!ok) {
  7105. return false;
  7106. }
  7107. }
  7108. return !data_available; // true only if done() was called, false if shutting
  7109. // down
  7110. }
  7111. template <typename T, typename U>
  7112. inline bool
  7113. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7114. const T &is_shutting_down, U &compressor, Error &error) {
  7115. size_t offset = 0;
  7116. auto data_available = true;
  7117. auto ok = true;
  7118. DataSink data_sink;
  7119. data_sink.write = [&](const char *d, size_t l) -> bool {
  7120. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7121. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7122. // zero-length chunk is the terminator, so it must not be emitted here.
  7123. if (ok && l > 0) {
  7124. offset += l;
  7125. std::string payload;
  7126. if (compressor.compress(d, l, false,
  7127. [&](const char *data, size_t data_len) {
  7128. payload.append(data, data_len);
  7129. return true;
  7130. })) {
  7131. if (!payload.empty()) {
  7132. // Emit chunked response header and footer for each chunk
  7133. auto chunk =
  7134. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7135. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7136. }
  7137. } else {
  7138. ok = false;
  7139. }
  7140. }
  7141. return ok;
  7142. };
  7143. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7144. auto done_with_trailer = [&](const Headers *trailer) {
  7145. if (!ok) { return; }
  7146. data_available = false;
  7147. std::string payload;
  7148. if (!compressor.compress(nullptr, 0, true,
  7149. [&](const char *data, size_t data_len) {
  7150. payload.append(data, data_len);
  7151. return true;
  7152. })) {
  7153. ok = false;
  7154. return;
  7155. }
  7156. if (!payload.empty()) {
  7157. // Emit chunked response header and footer for each chunk
  7158. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7159. if (!write_data(strm, chunk.data(), chunk.size())) {
  7160. ok = false;
  7161. return;
  7162. }
  7163. }
  7164. constexpr const char done_marker[] = "0\r\n";
  7165. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7166. // Trailer
  7167. if (trailer) {
  7168. for (const auto &kv : *trailer) {
  7169. // Skip fields with invalid names or values to prevent response
  7170. // splitting via CR/LF injection, matching set_header().
  7171. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7172. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7173. if (!write_data(strm, field_line.data(), field_line.size())) {
  7174. ok = false;
  7175. }
  7176. }
  7177. }
  7178. constexpr const char crlf[] = "\r\n";
  7179. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7180. };
  7181. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7182. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7183. done_with_trailer(&trailer);
  7184. };
  7185. while (data_available && !is_shutting_down()) {
  7186. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7187. error = Error::Write;
  7188. return false;
  7189. } else if (!content_provider(offset, 0, data_sink)) {
  7190. error = Error::Canceled;
  7191. return false;
  7192. } else if (!ok) {
  7193. error = Error::Write;
  7194. return false;
  7195. }
  7196. }
  7197. if (data_available) { // exited due to is_shutting_down(), not done()
  7198. error = Error::Write;
  7199. return false;
  7200. }
  7201. error = Error::Success;
  7202. return true;
  7203. }
  7204. template <typename T, typename U>
  7205. inline bool write_content_chunked(Stream &strm,
  7206. const ContentProvider &content_provider,
  7207. const T &is_shutting_down, U &compressor) {
  7208. auto error = Error::Success;
  7209. return write_content_chunked(strm, content_provider, is_shutting_down,
  7210. compressor, error);
  7211. }
  7212. template <typename T>
  7213. inline bool redirect(T &cli, Request &req, Response &res,
  7214. const std::string &path, const std::string &location,
  7215. Error &error) {
  7216. Request new_req = req;
  7217. new_req.path = path;
  7218. new_req.redirect_count_ -= 1;
  7219. if (res.status == StatusCode::SeeOther_303 &&
  7220. (req.method != "GET" && req.method != "HEAD")) {
  7221. new_req.method = "GET";
  7222. new_req.body.clear();
  7223. new_req.headers.clear();
  7224. }
  7225. Response new_res;
  7226. auto ret = cli.send(new_req, new_res, error);
  7227. if (ret) {
  7228. req = std::move(new_req);
  7229. res = std::move(new_res);
  7230. if (res.location.empty()) { res.location = location; }
  7231. }
  7232. return ret;
  7233. }
  7234. inline std::string params_to_query_str(const Params &params) {
  7235. std::string query;
  7236. for (auto it = params.begin(); it != params.end(); ++it) {
  7237. if (it != params.begin()) { query += '&'; }
  7238. query += encode_query_component(it->first);
  7239. query += '=';
  7240. query += encode_query_component(it->second);
  7241. }
  7242. return query;
  7243. }
  7244. // Splits one "key=value" span of a query string at its first '='. A span with
  7245. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7246. // "?flag" keeps its name.
  7247. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7248. std::string &val) {
  7249. divide(b, static_cast<std::size_t>(e - b), '=',
  7250. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7251. std::size_t rhs_size) {
  7252. key.assign(lhs_data, lhs_size);
  7253. val.assign(rhs_data, rhs_size);
  7254. });
  7255. }
  7256. inline void parse_query_text(const char *data, std::size_t size,
  7257. Params &params) {
  7258. std::set<std::string> cache;
  7259. split(data, data + size, '&', [&](const char *b, const char *e) {
  7260. std::string kv(b, e);
  7261. if (cache.find(kv) != cache.end()) { return; }
  7262. cache.insert(std::move(kv));
  7263. std::string key;
  7264. std::string val;
  7265. divide_query_pair(b, e, key, val);
  7266. if (!key.empty()) {
  7267. params.emplace(decode_query_component(key), decode_query_component(val));
  7268. }
  7269. });
  7270. }
  7271. inline void parse_query_text(const std::string &s, Params &params) {
  7272. parse_query_text(s.data(), s.size(), params);
  7273. }
  7274. // Normalize a query string by decoding and re-encoding each key/value pair
  7275. // while preserving the original parameter order. This avoids double-encoding
  7276. // and ensures consistent encoding. It works on the raw string rather than
  7277. // parsing into Params and re-serializing, because that round trip cannot
  7278. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7279. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7280. // duplicated pairs.
  7281. inline std::string normalize_query_string(const std::string &query) {
  7282. std::string result;
  7283. split(query.data(), query.data() + query.size(), '&',
  7284. [&](const char *b, const char *e) {
  7285. std::string key;
  7286. std::string val;
  7287. divide_query_pair(b, e, key, val);
  7288. if (!key.empty()) {
  7289. auto dec_key = decode_query_component(key);
  7290. auto dec_val = decode_query_component(val);
  7291. if (!result.empty()) { result += '&'; }
  7292. result += encode_query_component(dec_key);
  7293. if (!val.empty() || std::find(b, e, '=') != e) {
  7294. result += '=';
  7295. result += encode_query_component(dec_val);
  7296. }
  7297. }
  7298. });
  7299. return result;
  7300. }
  7301. // Build the request target that goes on the wire from a caller-supplied path.
  7302. // Shared by the buffered send path and the streaming API so that both put the
  7303. // same bytes in the request line for the same input.
  7304. inline std::string encode_request_target(const std::string &target,
  7305. bool path_encode) {
  7306. // `substr(0, npos)` yields the whole string, which is what the no-query
  7307. // case needs.
  7308. auto query_pos = target.find('?');
  7309. auto path_part = target.substr(0, query_pos);
  7310. std::string query_part;
  7311. if (query_pos != std::string::npos) {
  7312. query_part = target.substr(query_pos + 1);
  7313. }
  7314. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7315. if (!query_part.empty()) {
  7316. // When path encoding is disabled the caller has supplied an already-encoded
  7317. // target and expects the exact bytes to be sent on the wire, so skip
  7318. // normalization for the query too. Normalizing would decode-then-re-encode
  7319. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7320. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7321. if (path_encode) {
  7322. auto normalized = normalize_query_string(query_part);
  7323. if (!normalized.empty()) {
  7324. result += '?';
  7325. result += normalized;
  7326. }
  7327. } else {
  7328. result += '?';
  7329. result += query_part;
  7330. }
  7331. }
  7332. return result;
  7333. }
  7334. inline bool parse_multipart_boundary(const std::string &content_type,
  7335. std::string &boundary) {
  7336. std::map<std::string, std::string> params;
  7337. extract_media_type(content_type, &params);
  7338. auto it = params.find("boundary");
  7339. if (it == params.end()) { return false; }
  7340. boundary = it->second;
  7341. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7342. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7343. // bytes costs a nearly full comparison at nearly every position: the
  7344. // boundary's length multiplies the worst-case cost of scanning a body.
  7345. return !boundary.empty() && boundary.size() <= 70;
  7346. }
  7347. inline void parse_disposition_params(const std::string &s, Params &params) {
  7348. std::set<std::string> cache;
  7349. split_unquoted(s.data(), s.data() + s.size(), ';',
  7350. [&](const char *b, const char *e) {
  7351. std::string kv(b, e);
  7352. if (cache.find(kv) != cache.end()) { return; }
  7353. cache.insert(kv);
  7354. std::string key;
  7355. std::string val;
  7356. divide_param_pair(b, e, key, val);
  7357. if (!key.empty()) {
  7358. params.emplace(trim_double_quotes_copy(key),
  7359. trim_double_quotes_copy(val));
  7360. }
  7361. });
  7362. }
  7363. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7364. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7365. #else
  7366. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7367. #endif
  7368. auto is_valid = [](const std::string &str) {
  7369. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7370. };
  7371. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7372. const auto pos = static_cast<size_t>(6);
  7373. const auto len = static_cast<size_t>(s.size() - 6);
  7374. auto all_valid_ranges = true;
  7375. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7376. if (!all_valid_ranges) { return; }
  7377. const auto it = std::find(b, e, '-');
  7378. if (it == e) {
  7379. all_valid_ranges = false;
  7380. return;
  7381. }
  7382. const auto lhs = std::string(b, it);
  7383. const auto rhs = std::string(it + 1, e);
  7384. if (!is_valid(lhs) || !is_valid(rhs)) {
  7385. all_valid_ranges = false;
  7386. return;
  7387. }
  7388. ssize_t first = -1;
  7389. if (!lhs.empty()) {
  7390. ssize_t v;
  7391. auto res = detail::from_chars(lhs.data(), lhs.data() + lhs.size(), v);
  7392. if (res.ec == std::errc{}) { first = v; }
  7393. }
  7394. ssize_t last = -1;
  7395. if (!rhs.empty()) {
  7396. ssize_t v;
  7397. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7398. if (res.ec == std::errc{}) { last = v; }
  7399. }
  7400. if ((first == -1 && last == -1) ||
  7401. (first != -1 && last != -1 && first > last)) {
  7402. all_valid_ranges = false;
  7403. return;
  7404. }
  7405. ranges.emplace_back(first, last);
  7406. });
  7407. return all_valid_ranges && !ranges.empty();
  7408. }
  7409. return false;
  7410. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7411. }
  7412. #else
  7413. } catch (...) { return false; }
  7414. #endif
  7415. inline bool parse_accept_header(const std::string &s,
  7416. std::vector<std::string> &content_types) {
  7417. content_types.clear();
  7418. // Empty string is considered valid (no preference)
  7419. if (s.empty()) { return true; }
  7420. struct AcceptEntry {
  7421. std::string media_type;
  7422. double quality;
  7423. int order;
  7424. };
  7425. std::vector<AcceptEntry> entries;
  7426. int order = 0;
  7427. bool has_invalid_entry = false;
  7428. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7429. // has to parse and ignore empty list elements, so a leading, trailing or
  7430. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7431. // split() skips them, and the header length limit bounds how many a sender
  7432. // can send, so ignoring all of them cannot be used as a denial-of-service
  7433. // vector.
  7434. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7435. std::string entry(b, e);
  7436. entry = trim_copy(entry);
  7437. AcceptEntry accept_entry;
  7438. accept_entry.order = order++;
  7439. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7440. accept_entry.media_type, accept_entry.quality)) {
  7441. has_invalid_entry = true;
  7442. return;
  7443. }
  7444. // Remove additional parameters from media type
  7445. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7446. // Basic validation of media type format
  7447. if (accept_entry.media_type.empty()) {
  7448. has_invalid_entry = true;
  7449. return;
  7450. }
  7451. // Check for basic media type format (should contain '/' or be '*')
  7452. if (accept_entry.media_type != "*" &&
  7453. accept_entry.media_type.find('/') == std::string::npos) {
  7454. has_invalid_entry = true;
  7455. return;
  7456. }
  7457. entries.push_back(std::move(accept_entry));
  7458. });
  7459. // Return false if any invalid entry was found
  7460. if (has_invalid_entry) { return false; }
  7461. // Sort by quality (descending), then by original order (ascending)
  7462. std::sort(entries.begin(), entries.end(),
  7463. [](const AcceptEntry &a, const AcceptEntry &b) {
  7464. if (a.quality != b.quality) {
  7465. return a.quality > b.quality; // Higher quality first
  7466. }
  7467. return a.order < b.order; // Earlier order first for same quality
  7468. });
  7469. // Extract sorted media types
  7470. content_types.reserve(entries.size());
  7471. for (auto &entry : entries) {
  7472. content_types.push_back(std::move(entry.media_type));
  7473. }
  7474. return true;
  7475. }
  7476. class FormDataParser {
  7477. public:
  7478. FormDataParser() = default;
  7479. void set_boundary(std::string &&boundary) {
  7480. boundary_ = std::move(boundary);
  7481. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7482. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7483. }
  7484. bool is_valid() const { return is_valid_; }
  7485. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7486. const ContentReceiver &content_callback) {
  7487. // Once the close delimiter has been seen the rest of the body is epilogue
  7488. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7489. // spread across reads is not copied in only to be erased right away.
  7490. if (state_ == 5) { return true; }
  7491. buf_append(buf, n);
  7492. while (buf_size() > 0) {
  7493. switch (state_) {
  7494. case 0: { // Initial boundary
  7495. auto pos = buf_find(dash_boundary_crlf_);
  7496. if (pos == buf_size()) {
  7497. // Not found yet: keep only a possible partial boundary at the tail so
  7498. // that a body which never contains the boundary cannot grow the
  7499. // buffer (and get rescanned from the start) without bound.
  7500. auto keep = dash_boundary_crlf_.size() - 1;
  7501. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7502. return true;
  7503. }
  7504. buf_erase(pos + dash_boundary_crlf_.size());
  7505. state_ = 1;
  7506. break;
  7507. }
  7508. case 1: { // New entry
  7509. clear_file_info();
  7510. state_ = 2;
  7511. break;
  7512. }
  7513. case 2: { // Headers
  7514. auto pos = buf_find(crlf_);
  7515. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7516. while (pos < buf_size()) {
  7517. // Empty line
  7518. if (pos == 0) {
  7519. if (!header_callback(file_)) {
  7520. is_valid_ = false;
  7521. return false;
  7522. }
  7523. buf_erase(crlf_.size());
  7524. state_ = 3;
  7525. break;
  7526. }
  7527. // Check header count limit
  7528. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7529. is_valid_ = false;
  7530. return false;
  7531. }
  7532. header_count_++;
  7533. const auto header = buf_head(pos);
  7534. if (!parse_header(header.data(), header.data() + header.size(),
  7535. [&](const std::string &, const std::string &) {})) {
  7536. is_valid_ = false;
  7537. return false;
  7538. }
  7539. // Parse and emplace space trimmed headers into a map
  7540. if (!parse_header(
  7541. header.data(), header.data() + header.size(),
  7542. [&](const std::string &key, const std::string &val) {
  7543. file_.headers.emplace(key, val);
  7544. })) {
  7545. is_valid_ = false;
  7546. return false;
  7547. }
  7548. constexpr const char header_content_type[] = "Content-Type:";
  7549. if (start_with_case_ignore(header, header_content_type)) {
  7550. file_.content_type =
  7551. trim_copy(header.substr(str_len(header_content_type)));
  7552. } else {
  7553. std::string disposition_params;
  7554. if (parse_content_disposition(header, disposition_params)) {
  7555. Params params;
  7556. parse_disposition_params(disposition_params, params);
  7557. auto it = params.find("name");
  7558. if (it != params.end()) {
  7559. file_.name = it->second;
  7560. } else {
  7561. is_valid_ = false;
  7562. return false;
  7563. }
  7564. it = params.find("filename");
  7565. if (it != params.end()) { file_.filename = it->second; }
  7566. it = params.find("filename*");
  7567. if (it != params.end()) {
  7568. // RFC 5987: only UTF-8 encoding is allowed
  7569. const auto &val = it->second;
  7570. constexpr const char utf8_prefix[] = "UTF-8''";
  7571. constexpr size_t prefix_len = str_len(utf8_prefix);
  7572. if (val.size() > prefix_len &&
  7573. start_with_case_ignore(val, utf8_prefix)) {
  7574. file_.filename = decode_path_component(
  7575. val.substr(prefix_len)); // override...
  7576. } else {
  7577. is_valid_ = false;
  7578. return false;
  7579. }
  7580. }
  7581. }
  7582. }
  7583. buf_erase(pos + crlf_.size());
  7584. pos = buf_find(crlf_);
  7585. }
  7586. if (state_ != 3) { return true; }
  7587. break;
  7588. }
  7589. case 3: { // Body
  7590. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7591. auto pos = buf_find(crlf_dash_boundary_);
  7592. if (pos < buf_size()) {
  7593. if (!content_callback(buf_data(), pos)) {
  7594. is_valid_ = false;
  7595. return false;
  7596. }
  7597. buf_erase(pos + crlf_dash_boundary_.size());
  7598. state_ = 4;
  7599. } else {
  7600. auto len = buf_size() - crlf_dash_boundary_.size();
  7601. if (len > 0) {
  7602. if (!content_callback(buf_data(), len)) {
  7603. is_valid_ = false;
  7604. return false;
  7605. }
  7606. buf_erase(len);
  7607. }
  7608. return true;
  7609. }
  7610. break;
  7611. }
  7612. case 4: { // Boundary
  7613. if (crlf_.size() > buf_size()) { return true; }
  7614. if (buf_start_with(crlf_)) {
  7615. buf_erase(crlf_.size());
  7616. state_ = 1;
  7617. } else if (buf_start_with(dash_)) {
  7618. buf_erase(dash_.size());
  7619. is_valid_ = true;
  7620. state_ = 5;
  7621. } else {
  7622. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7623. // accepted after a boundary; RFC 2046 allows transport-padding in
  7624. // between, but this parser has never supported it. Either way the
  7625. // body is already destined to be rejected, so fail now instead of
  7626. // buffering the rest of it. Both are two bytes, so the check above
  7627. // already guarantees enough buffered data to decide.
  7628. is_valid_ = false;
  7629. return false;
  7630. }
  7631. break;
  7632. }
  7633. case 5: { // Epilogue
  7634. buf_erase(buf_size());
  7635. break;
  7636. }
  7637. }
  7638. }
  7639. return true;
  7640. }
  7641. private:
  7642. void clear_file_info() {
  7643. file_.name.clear();
  7644. file_.filename.clear();
  7645. file_.content_type.clear();
  7646. file_.headers.clear();
  7647. header_count_ = 0;
  7648. }
  7649. bool start_with_case_ignore(const std::string &a, const char *b,
  7650. size_t offset = 0) const {
  7651. const auto b_len = strlen(b);
  7652. if (a.size() < offset + b_len) { return false; }
  7653. for (size_t i = 0; i < b_len; i++) {
  7654. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7655. return false;
  7656. }
  7657. }
  7658. return true;
  7659. }
  7660. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7661. // Returns true if header matches, with the params portion in `params_out`.
  7662. bool parse_content_disposition(const std::string &header,
  7663. std::string &params_out) const {
  7664. constexpr const char prefix[] = "Content-Disposition:";
  7665. constexpr size_t prefix_len = str_len(prefix);
  7666. if (!start_with_case_ignore(header, prefix)) { return false; }
  7667. // Skip whitespace after "Content-Disposition:"
  7668. auto pos = prefix_len;
  7669. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7670. pos++;
  7671. }
  7672. // Match "form-data;" (case-insensitive)
  7673. constexpr const char form_data[] = "form-data;";
  7674. constexpr size_t form_data_len = str_len(form_data);
  7675. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7676. pos += form_data_len;
  7677. // Skip whitespace after "form-data;"
  7678. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7679. pos++;
  7680. }
  7681. params_out = header.substr(pos);
  7682. return true;
  7683. }
  7684. const std::string dash_ = "--";
  7685. const std::string crlf_ = "\r\n";
  7686. std::string boundary_;
  7687. std::string dash_boundary_crlf_;
  7688. std::string crlf_dash_boundary_;
  7689. size_t state_ = 0;
  7690. bool is_valid_ = false;
  7691. FormData file_;
  7692. size_t header_count_ = 0;
  7693. // Buffer
  7694. bool start_with(const std::string &a, size_t spos, size_t epos,
  7695. const std::string &b) const {
  7696. if (epos - spos < b.size()) { return false; }
  7697. for (size_t i = 0; i < b.size(); i++) {
  7698. if (a[i + spos] != b[i]) { return false; }
  7699. }
  7700. return true;
  7701. }
  7702. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7703. const char *buf_data() const { return &buf_[buf_spos_]; }
  7704. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7705. bool buf_start_with(const std::string &s) const {
  7706. return start_with(buf_, buf_spos_, buf_epos_, s);
  7707. }
  7708. size_t buf_find(const std::string &s) const {
  7709. auto c = s.front();
  7710. size_t off = buf_spos_;
  7711. while (off < buf_epos_) {
  7712. auto pos = off;
  7713. while (true) {
  7714. if (pos == buf_epos_) { return buf_size(); }
  7715. if (buf_[pos] == c) { break; }
  7716. pos++;
  7717. }
  7718. auto remaining_size = buf_epos_ - pos;
  7719. if (s.size() > remaining_size) { return buf_size(); }
  7720. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7721. off = pos + 1;
  7722. }
  7723. return buf_size();
  7724. }
  7725. void buf_append(const char *data, size_t n) {
  7726. auto remaining_size = buf_size();
  7727. if (remaining_size > 0 && buf_spos_ > 0) {
  7728. for (size_t i = 0; i < remaining_size; i++) {
  7729. buf_[i] = buf_[buf_spos_ + i];
  7730. }
  7731. }
  7732. buf_spos_ = 0;
  7733. buf_epos_ = remaining_size;
  7734. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7735. for (size_t i = 0; i < n; i++) {
  7736. buf_[buf_epos_ + i] = data[i];
  7737. }
  7738. buf_epos_ += n;
  7739. }
  7740. void buf_erase(size_t size) { buf_spos_ += size; }
  7741. std::string buf_;
  7742. size_t buf_spos_ = 0;
  7743. size_t buf_epos_ = 0;
  7744. };
  7745. inline std::string random_string(size_t length) {
  7746. constexpr const char data[] =
  7747. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  7748. thread_local auto engine([]() {
  7749. // std::random_device might actually be deterministic on some
  7750. // platforms, but due to lack of support in the c++ standard library,
  7751. // doing better requires either some ugly hacks or breaking portability.
  7752. std::random_device seed_gen;
  7753. // Request 128 bits of entropy for initialization
  7754. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  7755. return std::mt19937(seed_sequence);
  7756. }());
  7757. std::string result;
  7758. for (size_t i = 0; i < length; i++) {
  7759. result += data[engine() % (sizeof(data) - 1)];
  7760. }
  7761. return result;
  7762. }
  7763. inline std::string make_multipart_data_boundary() {
  7764. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  7765. }
  7766. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  7767. auto valid = true;
  7768. for (size_t i = 0; i < boundary.size(); i++) {
  7769. auto c = boundary[i];
  7770. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  7771. valid = false;
  7772. break;
  7773. }
  7774. }
  7775. return valid;
  7776. }
  7777. // Escape a multipart field name/filename following the WHATWG HTML standard
  7778. // ("escape a multipart form-data name"), which is what browsers send:
  7779. // '"' -> %22, CR -> %0D, LF -> %0A
  7780. // With escape_quote = false, only CR and LF are escaped; this is for header
  7781. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  7782. inline std::string escape_multipart_field(const std::string &s,
  7783. bool escape_quote = true) {
  7784. std::string result;
  7785. result.reserve(s.size());
  7786. for (auto c : s) {
  7787. switch (c) {
  7788. case '"':
  7789. if (escape_quote) {
  7790. result += "%22";
  7791. } else {
  7792. result += c;
  7793. }
  7794. break;
  7795. case '\r': result += "%0D"; break;
  7796. case '\n': result += "%0A"; break;
  7797. default: result += c; break;
  7798. }
  7799. }
  7800. return result;
  7801. }
  7802. template <typename T>
  7803. inline std::string
  7804. serialize_multipart_formdata_item_begin(const T &item,
  7805. const std::string &boundary) {
  7806. std::string body = "--" + boundary + "\r\n";
  7807. body += "Content-Disposition: form-data; name=\"" +
  7808. escape_multipart_field(item.name) + "\"";
  7809. if (!item.filename.empty()) {
  7810. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  7811. }
  7812. body += "\r\n";
  7813. if (!item.content_type.empty()) {
  7814. body +=
  7815. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  7816. "\r\n";
  7817. }
  7818. body += "\r\n";
  7819. return body;
  7820. }
  7821. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  7822. inline std::string
  7823. serialize_multipart_formdata_finish(const std::string &boundary) {
  7824. return "--" + boundary + "--\r\n";
  7825. }
  7826. inline std::string
  7827. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  7828. return "multipart/form-data; boundary=" + boundary;
  7829. }
  7830. inline std::string
  7831. serialize_multipart_formdata(const UploadFormDataItems &items,
  7832. const std::string &boundary, bool finish = true) {
  7833. std::string body;
  7834. for (const auto &item : items) {
  7835. body += serialize_multipart_formdata_item_begin(item, boundary);
  7836. body += item.content + serialize_multipart_formdata_item_end();
  7837. }
  7838. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  7839. return body;
  7840. }
  7841. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  7842. const std::string &boundary) {
  7843. size_t total = 0;
  7844. for (const auto &item : items) {
  7845. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  7846. total += item.content.size();
  7847. total += serialize_multipart_formdata_item_end().size();
  7848. }
  7849. total += serialize_multipart_formdata_finish(boundary).size();
  7850. return total;
  7851. }
  7852. struct MultipartSegment {
  7853. const char *data;
  7854. size_t size;
  7855. };
  7856. // NOTE: items must outlive the returned ContentProvider
  7857. // (safe for synchronous use inside Post/Put/Patch)
  7858. inline ContentProvider
  7859. make_multipart_content_provider(const UploadFormDataItems &items,
  7860. const std::string &boundary) {
  7861. // Own the per-item header strings and the finish string
  7862. std::vector<std::string> owned;
  7863. owned.reserve(items.size() + 1);
  7864. for (const auto &item : items)
  7865. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  7866. owned.push_back(serialize_multipart_formdata_finish(boundary));
  7867. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  7868. std::vector<MultipartSegment> segs;
  7869. segs.reserve(items.size() * 3 + 1);
  7870. static const char crlf[] = "\r\n";
  7871. for (size_t i = 0; i < items.size(); i++) {
  7872. segs.push_back({owned[i].data(), owned[i].size()});
  7873. segs.push_back({items[i].content.data(), items[i].content.size()});
  7874. segs.push_back({crlf, 2});
  7875. }
  7876. segs.push_back({owned.back().data(), owned.back().size()});
  7877. struct MultipartState {
  7878. std::vector<std::string> owned;
  7879. std::vector<MultipartSegment> segs;
  7880. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  7881. };
  7882. auto state = std::make_shared<MultipartState>();
  7883. state->owned = std::move(owned);
  7884. // `segs` holds raw pointers into owned strings; std::string move preserves
  7885. // the data pointer, so these pointers remain valid after the move above.
  7886. state->segs = std::move(segs);
  7887. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  7888. // Buffer multiple small segments into fewer, larger writes to avoid
  7889. // excessive TCP packets when there are many form data items (#2410)
  7890. auto &buf = state->buf;
  7891. auto buf_size = buf.size();
  7892. size_t buf_len = 0;
  7893. size_t remaining = length;
  7894. // Find the first segment containing 'offset'
  7895. size_t pos = 0;
  7896. size_t seg_idx = 0;
  7897. for (; seg_idx < state->segs.size(); seg_idx++) {
  7898. const auto &seg = state->segs[seg_idx];
  7899. if (seg.size > 0 && offset - pos < seg.size) { break; }
  7900. pos += seg.size;
  7901. }
  7902. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  7903. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  7904. const auto &seg = state->segs[seg_idx];
  7905. size_t available = seg.size - seg_offset;
  7906. size_t to_copy = (std::min)(available, remaining);
  7907. const char *src = seg.data + seg_offset;
  7908. seg_offset = 0; // only the first segment has a non-zero offset
  7909. while (to_copy > 0) {
  7910. size_t space = buf_size - buf_len;
  7911. size_t chunk = (std::min)(to_copy, space);
  7912. std::memcpy(buf.data() + buf_len, src, chunk);
  7913. buf_len += chunk;
  7914. src += chunk;
  7915. to_copy -= chunk;
  7916. remaining -= chunk;
  7917. if (buf_len == buf_size) {
  7918. if (!sink.write(buf.data(), buf_len)) { return false; }
  7919. buf_len = 0;
  7920. }
  7921. }
  7922. }
  7923. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  7924. return true;
  7925. };
  7926. }
  7927. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  7928. if (ranges.size() <= 1) return;
  7929. // Sort ranges by start position
  7930. std::sort(ranges.begin(), ranges.end(),
  7931. [](const Range &a, const Range &b) { return a.first < b.first; });
  7932. Ranges coalesced;
  7933. coalesced.reserve(ranges.size());
  7934. for (auto &r : ranges) {
  7935. auto first_pos = r.first;
  7936. auto last_pos = r.second;
  7937. // Handle special cases like in range_error
  7938. if (first_pos == -1 && last_pos == -1) {
  7939. first_pos = 0;
  7940. last_pos = static_cast<ssize_t>(content_length);
  7941. }
  7942. if (first_pos == -1) {
  7943. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  7944. last_pos = static_cast<ssize_t>(content_length) - 1;
  7945. }
  7946. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  7947. last_pos = static_cast<ssize_t>(content_length) - 1;
  7948. }
  7949. // Skip invalid ranges
  7950. if (!(0 <= first_pos && first_pos <= last_pos &&
  7951. last_pos < static_cast<ssize_t>(content_length))) {
  7952. continue;
  7953. }
  7954. // Coalesce with previous range if overlapping or adjacent (but not
  7955. // identical)
  7956. if (!coalesced.empty()) {
  7957. auto &prev = coalesced.back();
  7958. // Check if current range overlaps or is adjacent to previous range
  7959. // but don't coalesce identical ranges (allow duplicates)
  7960. if (first_pos <= prev.second + 1 &&
  7961. !(first_pos == prev.first && last_pos == prev.second)) {
  7962. // Extend the previous range
  7963. prev.second = (std::max)(prev.second, last_pos);
  7964. continue;
  7965. }
  7966. }
  7967. // Add new range
  7968. coalesced.emplace_back(first_pos, last_pos);
  7969. }
  7970. ranges = std::move(coalesced);
  7971. }
  7972. inline bool range_error(Request &req, Response &res) {
  7973. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  7974. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  7975. req.ranges.clear();
  7976. if (res.status == StatusCode::PartialContent_206) {
  7977. res.status = StatusCode::OK_200;
  7978. }
  7979. return false;
  7980. }
  7981. ssize_t content_len = static_cast<ssize_t>(
  7982. res.content_length_ ? res.content_length_ : res.body.size());
  7983. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  7984. size_t overwrapping_count = 0;
  7985. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  7986. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  7987. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  7988. // Too many ranges
  7989. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  7990. for (auto &r : req.ranges) {
  7991. auto &first_pos = r.first;
  7992. auto &last_pos = r.second;
  7993. if (first_pos == -1 && last_pos == -1) {
  7994. first_pos = 0;
  7995. last_pos = content_len;
  7996. }
  7997. if (first_pos == -1) {
  7998. first_pos = content_len - last_pos;
  7999. last_pos = content_len - 1;
  8000. }
  8001. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8002. // A client can limit the number of bytes requested without knowing the
  8003. // size of the selected representation. If the last-pos value is absent,
  8004. // or if the value is greater than or equal to the current length of the
  8005. // representation data, the byte range is interpreted as the remainder of
  8006. // the representation (i.e., the server replaces the value of last-pos
  8007. // with a value that is one less than the current length of the selected
  8008. // representation).
  8009. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8010. if (last_pos == -1 || last_pos >= content_len) {
  8011. last_pos = content_len - 1;
  8012. }
  8013. // Range must be within content length
  8014. if (!(0 <= first_pos && first_pos <= last_pos &&
  8015. last_pos <= content_len - 1)) {
  8016. return true;
  8017. }
  8018. // Request must not have more than two overlapping ranges
  8019. for (const auto &processed_range : processed_ranges) {
  8020. if (!(last_pos < processed_range.first ||
  8021. first_pos > processed_range.second)) {
  8022. overwrapping_count++;
  8023. if (overwrapping_count > 2) { return true; }
  8024. break; // Only count once per range
  8025. }
  8026. }
  8027. processed_ranges.emplace_back(first_pos, last_pos);
  8028. }
  8029. // After validation, coalesce overlapping ranges as per RFC 9110
  8030. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8031. }
  8032. return false;
  8033. }
  8034. inline std::pair<size_t, size_t>
  8035. get_range_offset_and_length(Range r, size_t content_length) {
  8036. assert(r.first != -1 && r.second != -1);
  8037. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8038. assert(r.first <= r.second &&
  8039. r.second < static_cast<ssize_t>(content_length));
  8040. (void)(content_length);
  8041. return std::make_pair(static_cast<size_t>(r.first),
  8042. static_cast<size_t>(r.second - r.first) + 1);
  8043. }
  8044. inline std::string make_content_range_header_field(
  8045. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8046. auto st = offset_and_length.first;
  8047. auto ed = st + offset_and_length.second - 1;
  8048. std::string field = "bytes ";
  8049. field += std::to_string(st);
  8050. field += '-';
  8051. field += std::to_string(ed);
  8052. field += '/';
  8053. field += std::to_string(content_length);
  8054. return field;
  8055. }
  8056. template <typename SToken, typename CToken, typename Content>
  8057. bool process_multipart_ranges_data(const Request &req,
  8058. const std::string &boundary,
  8059. const std::string &content_type,
  8060. size_t content_length, SToken stoken,
  8061. CToken ctoken, Content content) {
  8062. for (size_t i = 0; i < req.ranges.size(); i++) {
  8063. ctoken("--");
  8064. stoken(boundary);
  8065. ctoken("\r\n");
  8066. if (!content_type.empty()) {
  8067. ctoken("Content-Type: ");
  8068. stoken(content_type);
  8069. ctoken("\r\n");
  8070. }
  8071. auto offset_and_length =
  8072. get_range_offset_and_length(req.ranges[i], content_length);
  8073. ctoken("Content-Range: ");
  8074. stoken(make_content_range_header_field(offset_and_length, content_length));
  8075. ctoken("\r\n");
  8076. ctoken("\r\n");
  8077. if (!content(offset_and_length.first, offset_and_length.second)) {
  8078. return false;
  8079. }
  8080. ctoken("\r\n");
  8081. }
  8082. ctoken("--");
  8083. stoken(boundary);
  8084. ctoken("--");
  8085. return true;
  8086. }
  8087. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8088. const std::string &boundary,
  8089. const std::string &content_type,
  8090. size_t content_length,
  8091. std::string &data) {
  8092. process_multipart_ranges_data(
  8093. req, boundary, content_type, content_length,
  8094. [&](const std::string &token) { data += token; },
  8095. [&](const std::string &token) { data += token; },
  8096. [&](size_t offset, size_t length) {
  8097. assert(offset + length <= content_length);
  8098. data += res.body.substr(offset, length);
  8099. return true;
  8100. });
  8101. }
  8102. inline size_t get_multipart_ranges_data_length(const Request &req,
  8103. const std::string &boundary,
  8104. const std::string &content_type,
  8105. size_t content_length) {
  8106. size_t data_length = 0;
  8107. process_multipart_ranges_data(
  8108. req, boundary, content_type, content_length,
  8109. [&](const std::string &token) { data_length += token.size(); },
  8110. [&](const std::string &token) { data_length += token.size(); },
  8111. [&](size_t /*offset*/, size_t length) {
  8112. data_length += length;
  8113. return true;
  8114. });
  8115. return data_length;
  8116. }
  8117. template <typename T>
  8118. inline bool
  8119. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8120. const std::string &boundary,
  8121. const std::string &content_type,
  8122. size_t content_length, const T &is_shutting_down) {
  8123. return process_multipart_ranges_data(
  8124. req, boundary, content_type, content_length,
  8125. [&](const std::string &token) { strm.write(token); },
  8126. [&](const std::string &token) { strm.write(token); },
  8127. [&](size_t offset, size_t length) {
  8128. return write_content(strm, res.content_provider_, offset, length,
  8129. is_shutting_down);
  8130. });
  8131. }
  8132. inline bool has_framed_body(const Request &req) {
  8133. return is_chunked_transfer_encoding(req.headers) ||
  8134. req.get_header_value_u64("Content-Length") > 0;
  8135. }
  8136. inline bool is_connection_persistent(const Request &req) {
  8137. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8138. if (req.version == "HTTP/1.0" &&
  8139. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8140. return false;
  8141. }
  8142. return true;
  8143. }
  8144. inline bool expect_content(const Request &req) {
  8145. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8146. req.method == "DELETE") {
  8147. return true;
  8148. }
  8149. return has_framed_body(req);
  8150. }
  8151. #ifdef _WIN32
  8152. class WSInit {
  8153. public:
  8154. WSInit() {
  8155. WSADATA wsaData;
  8156. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8157. }
  8158. ~WSInit() {
  8159. if (is_valid_) WSACleanup();
  8160. }
  8161. bool is_valid_ = false;
  8162. };
  8163. static WSInit wsinit_;
  8164. #endif
  8165. // RFC 9110 Section 11.6.1 defines a challenge list as
  8166. // WWW-Authenticate = #challenge
  8167. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8168. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8169. // so a server may offer several schemes, each with its own comma-separated
  8170. // auth-param list, in either order and either as separate field lines or
  8171. // packed into one. Splitting on every comma would break apart a challenge's
  8172. // own param list; splitting only on the first space would miss a Digest
  8173. // challenge that isn't first. Split on commas that aren't inside a
  8174. // quoted-string instead, then track which scheme each resulting segment
  8175. // belongs to: a segment whose text before "=" contains whitespace (or that
  8176. // has no "=" at all) starts a new challenge named by its leading token.
  8177. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8178. std::vector<std::string> segments;
  8179. size_t start = 0;
  8180. auto in_quotes = false;
  8181. for (size_t i = 0; i < s.size(); i++) {
  8182. auto c = s[i];
  8183. if (in_quotes) {
  8184. if (c == '\\' && i + 1 < s.size()) {
  8185. i++;
  8186. } else if (c == '"') {
  8187. in_quotes = false;
  8188. }
  8189. } else if (c == '"') {
  8190. in_quotes = true;
  8191. } else if (c == ',') {
  8192. segments.push_back(s.substr(start, i - start));
  8193. start = i + 1;
  8194. }
  8195. }
  8196. segments.push_back(s.substr(start));
  8197. return segments;
  8198. }
  8199. inline std::string unescape_quoted_pairs(const std::string &s) {
  8200. std::string out;
  8201. out.reserve(s.size());
  8202. for (size_t i = 0; i < s.size(); i++) {
  8203. if (s[i] == '\\' && i + 1 < s.size()) {
  8204. out += s[++i];
  8205. } else {
  8206. out += s[i];
  8207. }
  8208. }
  8209. return out;
  8210. }
  8211. inline bool parse_www_authenticate(const Response &res,
  8212. std::map<std::string, std::string> &auth,
  8213. bool is_proxy) {
  8214. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8215. auto combined = get_combined_header_value(res.headers, auth_key);
  8216. if (combined.empty()) { return false; }
  8217. auto found_digest = false;
  8218. auto in_digest_challenge = false;
  8219. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8220. auto segment = trim_copy(raw_segment);
  8221. if (segment.empty()) { continue; }
  8222. auto eq_pos = segment.find('=');
  8223. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8224. // for the first segment of a challenge, "<scheme> <key>") must be
  8225. // trimmed before its boundaries are inspected.
  8226. auto key_part = trim_copy(
  8227. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8228. auto space_pos = key_part.find_last_of(" \t");
  8229. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8230. // "<scheme>[ <key>]" starts a new challenge.
  8231. auto scheme_end =
  8232. space_pos == std::string::npos ? key_part.size() : space_pos;
  8233. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8234. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8235. // from one challenge is never paired with another's algorithm.
  8236. in_digest_challenge =
  8237. !found_digest &&
  8238. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8239. if (in_digest_challenge) { found_digest = true; }
  8240. if (space_pos == std::string::npos) {
  8241. // Bare scheme (or a token68), no auth-param on this segment.
  8242. continue;
  8243. }
  8244. key_part = key_part.substr(space_pos + 1);
  8245. }
  8246. if (!in_digest_challenge) { continue; }
  8247. auto val = trim_copy(segment.substr(eq_pos + 1));
  8248. auto unquoted = trim_double_quotes_copy(val);
  8249. if (unquoted.size() != val.size()) {
  8250. unquoted = unescape_quoted_pairs(unquoted);
  8251. }
  8252. auth[std::move(key_part)] = std::move(unquoted);
  8253. }
  8254. // A challenge with no auth-param can't produce a usable Authorization
  8255. // header, so treat it the same as no Digest challenge at all.
  8256. return found_digest && !auth.empty();
  8257. }
  8258. class ContentProviderAdapter {
  8259. public:
  8260. explicit ContentProviderAdapter(
  8261. ContentProviderWithoutLength &&content_provider)
  8262. : content_provider_(std::move(content_provider)) {}
  8263. bool operator()(size_t offset, size_t, DataSink &sink) {
  8264. return content_provider_(offset, sink);
  8265. }
  8266. private:
  8267. ContentProviderWithoutLength content_provider_;
  8268. };
  8269. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8270. namespace fields {
  8271. inline bool is_token_char(char c) {
  8272. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8273. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8274. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8275. }
  8276. inline bool is_token(const std::string &s) {
  8277. if (s.empty()) { return false; }
  8278. for (auto c : s) {
  8279. if (!is_token_char(c)) { return false; }
  8280. }
  8281. return true;
  8282. }
  8283. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8284. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8285. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8286. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8287. inline bool is_field_content(const std::string &s) {
  8288. if (s.empty()) { return true; }
  8289. if (s.size() == 1) {
  8290. return is_field_vchar(s[0]);
  8291. } else if (s.size() == 2) {
  8292. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8293. } else {
  8294. size_t i = 0;
  8295. if (!is_field_vchar(s[i])) { return false; }
  8296. i++;
  8297. while (i < s.size() - 1) {
  8298. auto c = s[i++];
  8299. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8300. } else {
  8301. return false;
  8302. }
  8303. }
  8304. return is_field_vchar(s[i]);
  8305. }
  8306. }
  8307. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8308. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8309. return is_field_name(name) && is_field_value(value);
  8310. }
  8311. } // namespace fields
  8312. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8313. WebSocketUpgradeResponse &upgrade) {
  8314. // Generate random Sec-WebSocket-Key
  8315. thread_local std::mt19937 rng(std::random_device{}());
  8316. std::string key_bytes(16, '\0');
  8317. for (size_t i = 0; i < 16; i += 4) {
  8318. auto r = rng();
  8319. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8320. }
  8321. auto client_key = base64_encode(key_bytes);
  8322. req.headers.erase("Upgrade");
  8323. req.headers.erase("Connection");
  8324. req.headers.erase("Sec-WebSocket-Key");
  8325. req.headers.erase("Sec-WebSocket-Version");
  8326. req.headers.emplace("Upgrade", "websocket");
  8327. req.headers.emplace("Connection", "Upgrade");
  8328. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8329. req.headers.emplace("Sec-WebSocket-Version", "13");
  8330. // Build the request in memory first, like ClientImpl::write_request does.
  8331. // Writing straight to the socket would leak a request line onto the wire
  8332. // before check_and_write_headers gets a chance to reject an invalid header,
  8333. // and would emit one small write per header.
  8334. BufferStream bstrm;
  8335. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8336. upgrade.error = Error::Write;
  8337. return false;
  8338. }
  8339. auto error = Error::Success;
  8340. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8341. upgrade.error = error;
  8342. return false;
  8343. }
  8344. const auto &data = bstrm.get_buffer();
  8345. if (!write_data(strm, data.data(), data.size())) {
  8346. upgrade.error = Error::Write;
  8347. return false;
  8348. }
  8349. // Verify 101 response and Sec-WebSocket-Accept header
  8350. auto expected_accept = websocket_accept_key(client_key);
  8351. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8352. }
  8353. inline bool is_ip_address(const std::string &host) {
  8354. struct in_addr addr4;
  8355. struct in6_addr addr6;
  8356. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8357. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8358. }
  8359. // Resolve where a client should connect for `host`, honoring a user-supplied
  8360. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8361. // supplying the Host header and SNI; only the connection target changes.
  8362. //
  8363. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8364. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8365. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8366. // absent or empty mapping leaves `host` as the connection target; without the
  8367. // empty check the value would reach getaddrinfo as a null node and silently
  8368. // resolve to loopback.
  8369. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8370. const std::string &host, std::string &connect_host,
  8371. std::string &ip) {
  8372. connect_host = host;
  8373. ip.clear();
  8374. auto it = addr_map.find(host);
  8375. if (it == addr_map.end() || it->second.empty()) { return; }
  8376. if (is_ip_address(it->second)) {
  8377. ip = it->second;
  8378. } else {
  8379. connect_host = it->second;
  8380. }
  8381. }
  8382. } // namespace detail
  8383. /*
  8384. * Group 2: detail namespace - SSL common utilities
  8385. */
  8386. #ifdef CPPHTTPLIB_SSL_ENABLED
  8387. namespace detail {
  8388. class SSLSocketStream final : public Stream {
  8389. public:
  8390. SSLSocketStream(
  8391. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8392. time_t read_timeout_usec, time_t write_timeout_sec,
  8393. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8394. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8395. (std::chrono::steady_clock::time_point::min)());
  8396. ~SSLSocketStream() override;
  8397. bool is_readable() const override;
  8398. bool wait_readable() const override;
  8399. bool wait_writable() const override;
  8400. bool is_peer_alive() const override;
  8401. ssize_t read(char *ptr, size_t size) override;
  8402. ssize_t write(const char *ptr, size_t size) override;
  8403. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8404. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8405. socket_t socket() const override;
  8406. time_t duration() const override;
  8407. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8408. // See SocketStream::set_readable_hint().
  8409. void set_readable_hint() { readable_hint_ = true; }
  8410. private:
  8411. bool ensure_readable();
  8412. socket_t sock_;
  8413. tls::session_t session_;
  8414. time_t read_timeout_sec_;
  8415. time_t read_timeout_usec_;
  8416. time_t write_timeout_sec_;
  8417. time_t write_timeout_usec_;
  8418. time_t max_timeout_msec_;
  8419. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8420. bool readable_hint_ = false;
  8421. };
  8422. // A TLS stream for WebSocket connections, where the receive path and the
  8423. // send path (application send() plus the heartbeat ping thread) run on
  8424. // different threads. A single TLS session must never be entered
  8425. // concurrently, so every call into the session is serialized by one mutex.
  8426. //
  8427. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8428. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8429. // call under the lock, then waits for readiness with select() outside the
  8430. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8431. // blocked waiting for data never stalls a concurrent sender.
  8432. //
  8433. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8434. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8435. class WebSocketSSLStream final : public Stream {
  8436. public:
  8437. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8438. time_t read_timeout_sec, time_t read_timeout_usec,
  8439. time_t write_timeout_sec, time_t write_timeout_usec);
  8440. ~WebSocketSSLStream() override;
  8441. bool is_readable() const override;
  8442. bool wait_readable() const override;
  8443. bool wait_writable() const override;
  8444. ssize_t read(char *ptr, size_t size) override;
  8445. ssize_t write(const char *ptr, size_t size) override;
  8446. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8447. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8448. socket_t socket() const override;
  8449. time_t duration() const override;
  8450. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8451. private:
  8452. mutable std::mutex session_mutex_;
  8453. socket_t sock_;
  8454. tls::session_t session_;
  8455. // WebSocket::close() shortens the read timeout from the closing thread
  8456. // while the receive thread is inside wait_readable(), so these two are read
  8457. // and written concurrently. The write timeouts are never mutated.
  8458. std::atomic<time_t> read_timeout_sec_;
  8459. std::atomic<time_t> read_timeout_usec_;
  8460. time_t write_timeout_sec_;
  8461. time_t write_timeout_usec_;
  8462. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8463. };
  8464. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8465. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8466. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8467. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8468. unsigned int hash_length = 0;
  8469. unsigned char hash[EVP_MAX_MD_SIZE];
  8470. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8471. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8472. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8473. std::stringstream ss;
  8474. for (auto i = 0u; i < hash_length; ++i) {
  8475. ss << std::hex << std::setw(2) << std::setfill('0')
  8476. << static_cast<unsigned int>(hash[i]);
  8477. }
  8478. return ss.str();
  8479. }
  8480. inline std::string MD5(const std::string &s) {
  8481. return message_digest(s, EVP_md5());
  8482. }
  8483. inline std::string SHA_256(const std::string &s) {
  8484. return message_digest(s, EVP_sha256());
  8485. }
  8486. inline std::string SHA_512(const std::string &s) {
  8487. return message_digest(s, EVP_sha512());
  8488. }
  8489. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8490. namespace {
  8491. template <size_t N>
  8492. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8493. std::stringstream ss;
  8494. for (size_t i = 0; i < N; ++i) {
  8495. ss << std::hex << std::setw(2) << std::setfill('0')
  8496. << static_cast<unsigned int>(hash[i]);
  8497. }
  8498. return ss.str();
  8499. }
  8500. } // namespace
  8501. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8502. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8503. // initialized once. PSA state is process-global; do not free it.
  8504. inline bool ensure_mbedtls_psa_crypto() {
  8505. static std::once_flag once;
  8506. static bool ok = false;
  8507. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8508. return ok;
  8509. }
  8510. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8511. unsigned char *out, size_t out_size) {
  8512. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8513. size_t olen = 0;
  8514. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8515. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8516. olen == out_size;
  8517. }
  8518. #endif
  8519. inline std::string MD5(const std::string &s) {
  8520. unsigned char hash[16];
  8521. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8522. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8523. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8524. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8525. hash);
  8526. #else
  8527. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8528. hash);
  8529. #endif
  8530. return hash_to_hex(hash);
  8531. }
  8532. inline std::string SHA_256(const std::string &s) {
  8533. unsigned char hash[32];
  8534. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8535. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8536. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8537. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8538. hash, 0);
  8539. #else
  8540. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8541. s.size(), hash, 0);
  8542. #endif
  8543. return hash_to_hex(hash);
  8544. }
  8545. inline std::string SHA_512(const std::string &s) {
  8546. unsigned char hash[64];
  8547. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8548. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8549. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8550. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8551. hash, 0);
  8552. #else
  8553. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8554. s.size(), hash, 0);
  8555. #endif
  8556. return hash_to_hex(hash);
  8557. }
  8558. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8559. namespace {
  8560. template <size_t N>
  8561. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8562. std::stringstream ss;
  8563. for (size_t i = 0; i < N; ++i) {
  8564. ss << std::hex << std::setw(2) << std::setfill('0')
  8565. << static_cast<unsigned int>(hash[i]);
  8566. }
  8567. return ss.str();
  8568. }
  8569. } // namespace
  8570. inline std::string MD5(const std::string &s) {
  8571. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8572. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8573. static_cast<word32>(s.size()), hash);
  8574. return hash_to_hex(hash);
  8575. }
  8576. inline std::string SHA_256(const std::string &s) {
  8577. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8578. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8579. static_cast<word32>(s.size()), hash);
  8580. return hash_to_hex(hash);
  8581. }
  8582. inline std::string SHA_512(const std::string &s) {
  8583. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8584. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8585. static_cast<word32>(s.size()), hash);
  8586. return hash_to_hex(hash);
  8587. }
  8588. #endif
  8589. template <typename T>
  8590. inline bool process_server_socket_ssl(
  8591. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8592. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8593. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8594. time_t write_timeout_usec, T callback) {
  8595. return process_server_socket_core(
  8596. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8597. [&](bool close_connection, bool &connection_closed) {
  8598. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8599. write_timeout_sec, write_timeout_usec);
  8600. // See the non-TLS path in process_server_socket().
  8601. strm.set_readable_hint();
  8602. return callback(strm, close_connection, connection_closed);
  8603. });
  8604. }
  8605. template <typename T>
  8606. inline bool process_client_socket_ssl(
  8607. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8608. time_t read_timeout_usec, time_t write_timeout_sec,
  8609. time_t write_timeout_usec, time_t max_timeout_msec,
  8610. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8611. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8612. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8613. start_time);
  8614. return callback(strm);
  8615. }
  8616. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8617. const Request &req, const std::map<std::string, std::string> &auth,
  8618. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8619. const std::string &password, bool is_proxy = false) {
  8620. std::string nc;
  8621. {
  8622. std::stringstream ss;
  8623. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8624. nc = ss.str();
  8625. }
  8626. std::string qop;
  8627. if (auth.find("qop") != auth.end()) {
  8628. qop = auth.at("qop");
  8629. if (qop.find("auth-int") != std::string::npos) {
  8630. qop = "auth-int";
  8631. } else if (qop.find("auth") != std::string::npos) {
  8632. qop = "auth";
  8633. } else {
  8634. qop.clear();
  8635. }
  8636. }
  8637. std::string algo = "MD5";
  8638. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8639. std::string response;
  8640. {
  8641. auto H = algo == "SHA-256" ? detail::SHA_256
  8642. : algo == "SHA-512" ? detail::SHA_512
  8643. : detail::MD5;
  8644. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8645. auto A2 = req.method + ":" + req.path;
  8646. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8647. if (qop.empty()) {
  8648. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8649. } else {
  8650. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8651. ":" + qop + ":" + H(A2));
  8652. }
  8653. }
  8654. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8655. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8656. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8657. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8658. (qop.empty() ? ", response=\""
  8659. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8660. cnonce + "\", response=\"") +
  8661. response + "\"" +
  8662. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8663. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8664. return std::make_pair(key, field);
  8665. }
  8666. inline bool match_hostname(const std::string &pattern,
  8667. const std::string &hostname) {
  8668. // Exact match (case-insensitive)
  8669. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8670. // Split both pattern and hostname into components by '.'
  8671. std::vector<std::string> pattern_components;
  8672. if (!pattern.empty()) {
  8673. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8674. [&](const char *b, const char *e) {
  8675. pattern_components.emplace_back(b, e);
  8676. });
  8677. }
  8678. std::vector<std::string> host_components;
  8679. if (!hostname.empty()) {
  8680. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8681. [&](const char *b, const char *e) {
  8682. host_components.emplace_back(b, e);
  8683. });
  8684. }
  8685. // Component count must match
  8686. if (host_components.size() != pattern_components.size()) { return false; }
  8687. // Compare each component with wildcard support
  8688. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8689. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8690. auto itr = pattern_components.begin();
  8691. for (const auto &h : host_components) {
  8692. auto &p = *itr;
  8693. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8694. bool partial_match = false;
  8695. if (!p.empty() && p[p.size() - 1] == '*') {
  8696. const auto prefix_length = p.size() - 1;
  8697. if (prefix_length == 0) {
  8698. partial_match = true;
  8699. } else if (h.size() >= prefix_length) {
  8700. partial_match =
  8701. std::equal(p.begin(),
  8702. p.begin() + static_cast<std::string::difference_type>(
  8703. prefix_length),
  8704. h.begin(), [](const char ca, const char cb) {
  8705. return detail::case_ignore::to_lower(ca) ==
  8706. detail::case_ignore::to_lower(cb);
  8707. });
  8708. }
  8709. }
  8710. if (!partial_match) { return false; }
  8711. }
  8712. ++itr;
  8713. }
  8714. return true;
  8715. }
  8716. #ifdef _WIN32
  8717. // Verify certificate using Windows CertGetCertificateChain API.
  8718. // This provides real-time certificate validation with Windows Update
  8719. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8720. inline bool
  8721. verify_cert_with_windows_schannel(const std::vector<unsigned char> &der_cert,
  8722. const std::string &hostname,
  8723. bool verify_hostname, uint64_t &out_error) {
  8724. if (der_cert.empty()) { return false; }
  8725. out_error = 0;
  8726. // Create Windows certificate context from DER data
  8727. auto cert_context = CertCreateCertificateContext(
  8728. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8729. static_cast<DWORD>(der_cert.size()));
  8730. if (!cert_context) {
  8731. out_error = GetLastError();
  8732. return false;
  8733. }
  8734. auto cert_guard =
  8735. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8736. // Setup chain parameters
  8737. CERT_CHAIN_PARA chain_para = {};
  8738. chain_para.cbSize = sizeof(chain_para);
  8739. // Build certificate chain with revocation checking
  8740. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  8741. auto chain_result = CertGetCertificateChain(
  8742. nullptr, cert_context, nullptr, cert_context->hCertStore, &chain_para,
  8743. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  8744. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  8745. nullptr, &chain_context);
  8746. if (!chain_result || !chain_context) {
  8747. out_error = GetLastError();
  8748. return false;
  8749. }
  8750. auto chain_guard =
  8751. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  8752. // Check if chain has errors
  8753. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  8754. out_error = chain_context->TrustStatus.dwErrorStatus;
  8755. return false;
  8756. }
  8757. // Verify SSL policy
  8758. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  8759. extra_policy_para.cbSize = sizeof(extra_policy_para);
  8760. #ifdef AUTHTYPE_SERVER
  8761. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  8762. #endif
  8763. std::wstring whost;
  8764. if (verify_hostname) {
  8765. whost = u8string_to_wstring(hostname.c_str());
  8766. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  8767. }
  8768. CERT_CHAIN_POLICY_PARA policy_para = {};
  8769. policy_para.cbSize = sizeof(policy_para);
  8770. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  8771. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  8772. #else
  8773. policy_para.dwFlags = 0;
  8774. #endif
  8775. policy_para.pvExtraPolicyPara = &extra_policy_para;
  8776. CERT_CHAIN_POLICY_STATUS policy_status = {};
  8777. policy_status.cbSize = sizeof(policy_status);
  8778. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  8779. &policy_para, &policy_status)) {
  8780. out_error = GetLastError();
  8781. return false;
  8782. }
  8783. if (policy_status.dwError != 0) {
  8784. out_error = policy_status.dwError;
  8785. return false;
  8786. }
  8787. return true;
  8788. }
  8789. #endif // _WIN32
  8790. // Loads CA file/dir configuration and applies the system CA policy to a
  8791. // client TLS context. PEM data and native stores are applied to the context
  8792. // directly at set time; has_custom_store reflects them for the Auto policy
  8793. // decision.
  8794. inline bool load_client_ca_config(tls::ctx_t ctx,
  8795. const std::string &ca_cert_file_path,
  8796. const std::string &ca_cert_dir_path,
  8797. bool has_custom_store, SystemCAMode mode,
  8798. uint64_t &backend_error) {
  8799. auto ret = true;
  8800. if (!ca_cert_file_path.empty()) {
  8801. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  8802. backend_error = tls::get_error();
  8803. ret = false;
  8804. }
  8805. } else if (!ca_cert_dir_path.empty()) {
  8806. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  8807. backend_error = tls::get_error();
  8808. ret = false;
  8809. }
  8810. }
  8811. auto has_custom_ca = !ca_cert_file_path.empty() ||
  8812. !ca_cert_dir_path.empty() || has_custom_store;
  8813. if (mode == SystemCAMode::Enabled ||
  8814. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  8815. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  8816. }
  8817. return ret;
  8818. }
  8819. // The parts of session setup that only SSLClient needs, plus the handful
  8820. // WebSocketClient also exposes; everything else takes the defaults, which is
  8821. // what keeps the two clients on one implementation.
  8822. struct ClientTlsSessionOptions {
  8823. // Both SSLClient and WebSocketClient expose this independently of
  8824. // certificate verification.
  8825. bool server_hostname_verification = true;
  8826. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  8827. // When non-null, guards session creation against concurrent use of the
  8828. // context. A WebSocketClient is not safe to use from several threads to
  8829. // begin with, so it passes nothing.
  8830. std::mutex *ctx_mutex = nullptr;
  8831. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  8832. // The caller decides whether Schannel has anything to say about this
  8833. // connection; see SSLClient::initialize_ssl().
  8834. bool windows_cert_verification = false;
  8835. #endif
  8836. };
  8837. // Filled in on failure for callers that report error details.
  8838. struct ClientTlsSessionError {
  8839. Error error = Error::Success;
  8840. int ssl_error = 0;
  8841. uint64_t backend_error = 0;
  8842. };
  8843. // Establishes a client TLS session on an already connected socket. On failure
  8844. // the session is left for the caller to free: SSLClient frees it right away,
  8845. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  8846. inline bool setup_client_tls_session(
  8847. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  8848. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  8849. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  8850. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  8851. using namespace tls;
  8852. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  8853. if (out_error) {
  8854. out_error->error = error;
  8855. out_error->ssl_error = ssl_error;
  8856. out_error->backend_error = backend_error;
  8857. }
  8858. return false;
  8859. };
  8860. if (!ctx) {
  8861. session = nullptr;
  8862. return fail(Error::SSLConnection, 0, 0);
  8863. }
  8864. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8865. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  8866. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  8867. // verification happens during the handshake even for IP hosts; the
  8868. // certificate identity is verified post-handshake via verify_hostname().
  8869. set_verify_client(ctx, server_certificate_verification);
  8870. #endif
  8871. {
  8872. std::unique_lock<std::mutex> guard;
  8873. if (options.ctx_mutex) {
  8874. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  8875. }
  8876. session = create_session(ctx, sock);
  8877. }
  8878. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  8879. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  8880. // their identity is checked post-handshake below instead. On Mbed TLS and
  8881. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  8882. // options.server_hostname_verification is threaded through here.
  8883. if (!is_ip_address(host)) {
  8884. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  8885. return fail(Error::SSLConnection, 0, get_error());
  8886. }
  8887. }
  8888. TlsError tls_err;
  8889. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  8890. &tls_err)) {
  8891. auto error = Error::SSLConnection;
  8892. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  8893. error = Error::SSLServerVerification;
  8894. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  8895. error = Error::SSLServerHostnameVerification;
  8896. }
  8897. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  8898. }
  8899. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  8900. if (options.session_verifier) {
  8901. verification_status = options.session_verifier(session);
  8902. }
  8903. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  8904. return fail(Error::SSLServerVerification, 0, get_error());
  8905. }
  8906. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  8907. server_certificate_verification) {
  8908. auto verify_result = get_verify_result(session);
  8909. if (verify_result != 0) {
  8910. return fail(Error::SSLServerVerification, 0,
  8911. static_cast<uint64_t>(verify_result));
  8912. }
  8913. auto server_cert = get_peer_cert(session);
  8914. if (!server_cert) {
  8915. return fail(Error::SSLServerVerification, 0, get_error());
  8916. }
  8917. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  8918. // Identity check against the peer certificate, post-handshake for all
  8919. // backends. For IP hosts this is the only identity verification, since no
  8920. // hostname is bound during the handshake.
  8921. if (options.server_hostname_verification) {
  8922. if (!verify_hostname(server_cert, host.c_str())) {
  8923. return fail(Error::SSLServerHostnameVerification, 0,
  8924. hostname_mismatch_code());
  8925. }
  8926. }
  8927. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  8928. // Additional Windows Schannel verification.
  8929. // This provides real-time certificate validation with Windows Update
  8930. // integration, working with both OpenSSL and MbedTLS backends.
  8931. if (options.windows_cert_verification) {
  8932. std::vector<unsigned char> der;
  8933. if (get_cert_der(server_cert, der)) {
  8934. uint64_t wincrypt_error = 0;
  8935. if (!verify_cert_with_windows_schannel(
  8936. der, host, options.server_hostname_verification,
  8937. wincrypt_error)) {
  8938. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  8939. }
  8940. }
  8941. }
  8942. #endif
  8943. }
  8944. return true;
  8945. }
  8946. } // namespace detail
  8947. #endif // CPPHTTPLIB_SSL_ENABLED
  8948. /*
  8949. * Group 3: httplib namespace - Non-SSL public API implementations
  8950. */
  8951. inline void default_socket_options(socket_t sock) {
  8952. set_socket_opt(sock, SOL_SOCKET,
  8953. #ifdef SO_REUSEPORT
  8954. SO_REUSEPORT,
  8955. #else
  8956. SO_REUSEADDR,
  8957. #endif
  8958. 1);
  8959. }
  8960. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  8961. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  8962. sizeof(optval));
  8963. }
  8964. inline std::string get_bearer_token_auth(const Request &req) {
  8965. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  8966. // than the prefix carries no token.
  8967. constexpr const char bearer_prefix[] = "Bearer ";
  8968. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  8969. auto value = req.get_header_value("Authorization");
  8970. if (value.size() >= bearer_prefix_len &&
  8971. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  8972. bearer_prefix)) {
  8973. return value.substr(bearer_prefix_len);
  8974. }
  8975. return "";
  8976. }
  8977. inline const char *status_message(int status) {
  8978. switch (status) {
  8979. case StatusCode::Continue_100: return "Continue";
  8980. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  8981. case StatusCode::Processing_102: return "Processing";
  8982. case StatusCode::EarlyHints_103: return "Early Hints";
  8983. case StatusCode::OK_200: return "OK";
  8984. case StatusCode::Created_201: return "Created";
  8985. case StatusCode::Accepted_202: return "Accepted";
  8986. case StatusCode::NonAuthoritativeInformation_203:
  8987. return "Non-Authoritative Information";
  8988. case StatusCode::NoContent_204: return "No Content";
  8989. case StatusCode::ResetContent_205: return "Reset Content";
  8990. case StatusCode::PartialContent_206: return "Partial Content";
  8991. case StatusCode::MultiStatus_207: return "Multi-Status";
  8992. case StatusCode::AlreadyReported_208: return "Already Reported";
  8993. case StatusCode::IMUsed_226: return "IM Used";
  8994. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  8995. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  8996. case StatusCode::Found_302: return "Found";
  8997. case StatusCode::SeeOther_303: return "See Other";
  8998. case StatusCode::NotModified_304: return "Not Modified";
  8999. case StatusCode::UseProxy_305: return "Use Proxy";
  9000. case StatusCode::unused_306: return "unused";
  9001. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9002. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9003. case StatusCode::BadRequest_400: return "Bad Request";
  9004. case StatusCode::Unauthorized_401: return "Unauthorized";
  9005. case StatusCode::PaymentRequired_402: return "Payment Required";
  9006. case StatusCode::Forbidden_403: return "Forbidden";
  9007. case StatusCode::NotFound_404: return "Not Found";
  9008. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9009. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9010. case StatusCode::ProxyAuthenticationRequired_407:
  9011. return "Proxy Authentication Required";
  9012. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9013. case StatusCode::Conflict_409: return "Conflict";
  9014. case StatusCode::Gone_410: return "Gone";
  9015. case StatusCode::LengthRequired_411: return "Length Required";
  9016. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9017. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9018. case StatusCode::UriTooLong_414: return "URI Too Long";
  9019. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9020. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9021. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9022. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9023. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9024. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9025. case StatusCode::Locked_423: return "Locked";
  9026. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9027. case StatusCode::TooEarly_425: return "Too Early";
  9028. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9029. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9030. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9031. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9032. return "Request Header Fields Too Large";
  9033. case StatusCode::UnavailableForLegalReasons_451:
  9034. return "Unavailable For Legal Reasons";
  9035. case StatusCode::NotImplemented_501: return "Not Implemented";
  9036. case StatusCode::BadGateway_502: return "Bad Gateway";
  9037. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9038. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9039. case StatusCode::HttpVersionNotSupported_505:
  9040. return "HTTP Version Not Supported";
  9041. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9042. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9043. case StatusCode::LoopDetected_508: return "Loop Detected";
  9044. case StatusCode::NotExtended_510: return "Not Extended";
  9045. case StatusCode::NetworkAuthenticationRequired_511:
  9046. return "Network Authentication Required";
  9047. default:
  9048. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9049. }
  9050. }
  9051. inline std::string to_string(const Error error) {
  9052. switch (error) {
  9053. case Error::Success: return "Success (no error)";
  9054. case Error::Unknown: return "Unknown";
  9055. case Error::Connection: return "Could not establish connection";
  9056. case Error::BindIPAddress: return "Failed to bind IP address";
  9057. case Error::Read: return "Failed to read connection";
  9058. case Error::Write: return "Failed to write connection";
  9059. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9060. case Error::Canceled: return "Connection handling canceled";
  9061. case Error::SSLConnection: return "SSL connection failed";
  9062. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9063. case Error::SSLServerVerification: return "SSL server verification failed";
  9064. case Error::SSLServerHostnameVerification:
  9065. return "SSL server hostname verification failed";
  9066. case Error::UnsupportedMultipartBoundaryChars:
  9067. return "Unsupported HTTP multipart boundary characters";
  9068. case Error::Compression: return "Compression failed";
  9069. case Error::ConnectionTimeout: return "Connection timed out";
  9070. case Error::ProxyConnection: return "Proxy connection failed";
  9071. case Error::ConnectionClosed: return "Connection closed by server";
  9072. case Error::Timeout: return "Read timeout";
  9073. case Error::ResourceExhaustion: return "Resource exhaustion";
  9074. case Error::TooManyFormDataFiles: return "Too many form data files";
  9075. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9076. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9077. case Error::ExceedMaxSocketDescriptorCount:
  9078. return "Exceeded maximum socket descriptor count";
  9079. case Error::InvalidRequestLine: return "Invalid request line";
  9080. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9081. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9082. case Error::InvalidHeaders: return "Invalid headers";
  9083. case Error::MultipartParsing: return "Multipart parsing failed";
  9084. case Error::OpenFile: return "Failed to open file";
  9085. case Error::Listen: return "Failed to listen on socket";
  9086. case Error::GetSockName: return "Failed to get socket name";
  9087. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9088. case Error::HTTPParsing: return "HTTP parsing failed";
  9089. case Error::InvalidRangeHeader: return "Invalid Range header";
  9090. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9091. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9092. case Error::UserCallbackException: return "User callback threw an exception";
  9093. default: break;
  9094. }
  9095. return "Invalid";
  9096. }
  9097. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9098. os << to_string(obj);
  9099. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9100. return os;
  9101. }
  9102. inline std::string hosted_at(const std::string &hostname) {
  9103. std::vector<std::string> addrs;
  9104. hosted_at(hostname, addrs);
  9105. if (addrs.empty()) { return std::string(); }
  9106. return addrs[0];
  9107. }
  9108. inline void hosted_at(const std::string &hostname,
  9109. std::vector<std::string> &addrs) {
  9110. struct addrinfo hints;
  9111. struct addrinfo *result;
  9112. memset(&hints, 0, sizeof(struct addrinfo));
  9113. hints.ai_family = AF_UNSPEC;
  9114. hints.ai_socktype = SOCK_STREAM;
  9115. hints.ai_protocol = 0;
  9116. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9117. &result, 0)) {
  9118. #if defined __linux__ && !defined __ANDROID__
  9119. res_init();
  9120. #endif
  9121. return;
  9122. }
  9123. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9124. for (auto rp = result; rp; rp = rp->ai_next) {
  9125. const auto &addr =
  9126. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9127. std::string ip;
  9128. auto dummy = -1;
  9129. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9130. dummy)) {
  9131. addrs.emplace_back(std::move(ip));
  9132. }
  9133. }
  9134. }
  9135. inline std::string encode_uri_component(const std::string &value) {
  9136. std::ostringstream escaped;
  9137. escaped.fill('0');
  9138. escaped << std::hex;
  9139. for (auto c : value) {
  9140. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9141. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9142. escaped << c;
  9143. } else {
  9144. escaped << std::uppercase;
  9145. escaped << '%' << std::setw(2)
  9146. << static_cast<int>(static_cast<unsigned char>(c));
  9147. escaped << std::nouppercase;
  9148. }
  9149. }
  9150. return escaped.str();
  9151. }
  9152. inline std::string encode_uri(const std::string &value) {
  9153. std::ostringstream escaped;
  9154. escaped.fill('0');
  9155. escaped << std::hex;
  9156. for (auto c : value) {
  9157. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9158. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9159. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9160. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9161. escaped << c;
  9162. } else {
  9163. escaped << std::uppercase;
  9164. escaped << '%' << std::setw(2)
  9165. << static_cast<int>(static_cast<unsigned char>(c));
  9166. escaped << std::nouppercase;
  9167. }
  9168. }
  9169. return escaped.str();
  9170. }
  9171. inline std::string decode_uri_component(const std::string &value) {
  9172. std::string result;
  9173. for (size_t i = 0; i < value.size(); i++) {
  9174. if (value[i] == '%' && i + 2 < value.size()) {
  9175. auto val = 0;
  9176. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9177. result += static_cast<char>(val);
  9178. i += 2;
  9179. } else {
  9180. result += value[i];
  9181. }
  9182. } else {
  9183. result += value[i];
  9184. }
  9185. }
  9186. return result;
  9187. }
  9188. inline std::string decode_uri(const std::string &value) {
  9189. std::string result;
  9190. for (size_t i = 0; i < value.size(); i++) {
  9191. if (value[i] == '%' && i + 2 < value.size()) {
  9192. auto val = 0;
  9193. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9194. auto c = static_cast<char>(val);
  9195. // Keep escapes of the reserved characters that encode_uri leaves
  9196. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9197. // delimiter is not promoted into a real one (as with JS decodeURI).
  9198. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9199. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9200. c == '#') {
  9201. result += value[i];
  9202. result += value[i + 1];
  9203. result += value[i + 2];
  9204. } else {
  9205. result += c;
  9206. }
  9207. i += 2;
  9208. } else {
  9209. result += value[i];
  9210. }
  9211. } else {
  9212. result += value[i];
  9213. }
  9214. }
  9215. return result;
  9216. }
  9217. inline std::string encode_path_component(const std::string &component) {
  9218. std::string result;
  9219. result.reserve(component.size() * 3);
  9220. for (size_t i = 0; i < component.size(); i++) {
  9221. auto c = static_cast<unsigned char>(component[i]);
  9222. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9223. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9224. c == '_' || c == '~') {
  9225. result += static_cast<char>(c);
  9226. }
  9227. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9228. // "," / ";" / "="
  9229. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9230. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9231. c == '=') {
  9232. result += static_cast<char>(c);
  9233. }
  9234. // Colon is allowed in path segments except first segment
  9235. else if (c == ':') {
  9236. result += static_cast<char>(c);
  9237. }
  9238. // @ is allowed in path
  9239. else if (c == '@') {
  9240. result += static_cast<char>(c);
  9241. } else {
  9242. result += '%';
  9243. char hex[3];
  9244. snprintf(hex, sizeof(hex), "%02X", c);
  9245. result.append(hex, 2);
  9246. }
  9247. }
  9248. return result;
  9249. }
  9250. inline std::string decode_path_component(const std::string &component) {
  9251. std::string result;
  9252. result.reserve(component.size());
  9253. for (size_t i = 0; i < component.size(); i++) {
  9254. if (component[i] == '%' && i + 1 < component.size()) {
  9255. if (component[i + 1] == 'u') {
  9256. // Unicode %uXXXX encoding
  9257. auto val = 0;
  9258. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9259. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9260. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9261. char buff[4];
  9262. size_t len = detail::to_utf8(val, buff);
  9263. if (len > 0) { result.append(buff, len); }
  9264. i += 5; // 'u0000'
  9265. } else {
  9266. result += component[i];
  9267. }
  9268. } else {
  9269. // Standard %XX encoding
  9270. auto val = 0;
  9271. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9272. // 2 digits hex codes
  9273. result += static_cast<char>(val);
  9274. i += 2; // 'XX'
  9275. } else {
  9276. result += component[i];
  9277. }
  9278. }
  9279. } else {
  9280. result += component[i];
  9281. }
  9282. }
  9283. return result;
  9284. }
  9285. inline std::string encode_query_component(const std::string &component,
  9286. bool space_as_plus) {
  9287. std::string result;
  9288. result.reserve(component.size() * 3);
  9289. for (size_t i = 0; i < component.size(); i++) {
  9290. auto c = static_cast<unsigned char>(component[i]);
  9291. // Unreserved characters per RFC 3986
  9292. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9293. c == '_' || c == '~') {
  9294. result += static_cast<char>(c);
  9295. }
  9296. // Space handling
  9297. else if (c == ' ') {
  9298. if (space_as_plus) {
  9299. result += '+';
  9300. } else {
  9301. result += "%20";
  9302. }
  9303. }
  9304. // Plus sign handling
  9305. else if (c == '+') {
  9306. if (space_as_plus) {
  9307. result += "%2B";
  9308. } else {
  9309. result += static_cast<char>(c);
  9310. }
  9311. }
  9312. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9313. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9314. c == '*' || c == ',' || c == ';') {
  9315. result += static_cast<char>(c);
  9316. }
  9317. // Colon and @ are allowed in query
  9318. else if (c == ':' || c == '@') {
  9319. result += static_cast<char>(c);
  9320. }
  9321. // Forward slash is allowed in query values
  9322. else if (c == '/') {
  9323. result += static_cast<char>(c);
  9324. }
  9325. // Question mark is allowed in query values (after first ?)
  9326. else if (c == '?') {
  9327. result += static_cast<char>(c);
  9328. } else {
  9329. result += '%';
  9330. char hex[3];
  9331. snprintf(hex, sizeof(hex), "%02X", c);
  9332. result.append(hex, 2);
  9333. }
  9334. }
  9335. return result;
  9336. }
  9337. inline std::string decode_query_component(const std::string &component,
  9338. bool plus_as_space) {
  9339. std::string result;
  9340. result.reserve(component.size());
  9341. for (size_t i = 0; i < component.size(); i++) {
  9342. if (component[i] == '%' && i + 2 < component.size()) {
  9343. auto val = 0;
  9344. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9345. result += static_cast<char>(val);
  9346. i += 2;
  9347. } else {
  9348. result += component[i];
  9349. }
  9350. } else if (component[i] == '+' && plus_as_space) {
  9351. result += ' '; // + becomes space in form-urlencoded
  9352. } else {
  9353. result += component[i];
  9354. }
  9355. }
  9356. return result;
  9357. }
  9358. inline std::string sanitize_filename(const std::string &filename) {
  9359. // Extract basename: find the last path separator (/ or \)
  9360. auto pos = filename.find_last_of("/\\");
  9361. auto result =
  9362. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9363. // Strip null bytes
  9364. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9365. // Trim whitespace
  9366. {
  9367. auto start = result.find_first_not_of(" \t");
  9368. auto end = result.find_last_not_of(" \t");
  9369. result = (start == std::string::npos)
  9370. ? ""
  9371. : result.substr(start, end - start + 1);
  9372. }
  9373. // Reject . and ..
  9374. if (result == "." || result == "..") { return ""; }
  9375. return result;
  9376. }
  9377. inline std::string append_query_params(const std::string &path,
  9378. const Params &params) {
  9379. std::string path_with_query = path;
  9380. thread_local const std::regex re("[^?]+\\?.*");
  9381. auto delm = std::regex_match(path, re) ? '&' : '?';
  9382. path_with_query += delm + detail::params_to_query_str(params);
  9383. return path_with_query;
  9384. }
  9385. // Header utilities
  9386. inline std::pair<std::string, std::string>
  9387. make_range_header(const Ranges &ranges) {
  9388. std::string field = "bytes=";
  9389. auto i = 0;
  9390. for (const auto &r : ranges) {
  9391. if (i != 0) { field += ", "; }
  9392. if (r.first != -1) { field += std::to_string(r.first); }
  9393. field += '-';
  9394. if (r.second != -1) { field += std::to_string(r.second); }
  9395. i++;
  9396. }
  9397. return std::make_pair("Range", std::move(field));
  9398. }
  9399. inline std::pair<std::string, std::string>
  9400. make_basic_authentication_header(const std::string &username,
  9401. const std::string &password, bool is_proxy) {
  9402. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9403. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9404. return std::make_pair(key, std::move(field));
  9405. }
  9406. inline std::pair<std::string, std::string>
  9407. make_bearer_token_authentication_header(const std::string &token,
  9408. bool is_proxy = false) {
  9409. auto field = "Bearer " + token;
  9410. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9411. return std::make_pair(key, std::move(field));
  9412. }
  9413. // Request implementation
  9414. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9415. size_t id) const {
  9416. return detail::get_header_value_u64(headers, key, def, id);
  9417. }
  9418. inline bool Request::has_header(const std::string &key) const {
  9419. return detail::has_header(headers, key);
  9420. }
  9421. inline std::string Request::get_header_value(const std::string &key,
  9422. const char *def, size_t id) const {
  9423. return detail::get_header_value(headers, key, def, id);
  9424. }
  9425. inline size_t Request::get_header_value_count(const std::string &key) const {
  9426. return detail::get_header_value_count(headers, key);
  9427. }
  9428. inline void Request::set_header(const std::string &key,
  9429. const std::string &val) {
  9430. detail::set_header(headers, key, val);
  9431. }
  9432. inline bool Request::has_trailer(const std::string &key) const {
  9433. return trailers.find(key) != trailers.end();
  9434. }
  9435. inline std::string Request::get_trailer_value(const std::string &key,
  9436. size_t id) const {
  9437. return detail::get_multimap_value(trailers, key, id);
  9438. }
  9439. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9440. return trailers.count(key);
  9441. }
  9442. inline bool Request::has_param(const std::string &key) const {
  9443. return params.find(key) != params.end();
  9444. }
  9445. inline std::string Request::get_param_value(const std::string &key,
  9446. size_t id) const {
  9447. return detail::get_multimap_value(params, key, id);
  9448. }
  9449. inline std::vector<std::string>
  9450. Request::get_param_values(const std::string &key) const {
  9451. auto rng = params.equal_range(key);
  9452. std::vector<std::string> values;
  9453. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9454. for (auto it = rng.first; it != rng.second; ++it) {
  9455. values.push_back(it->second);
  9456. }
  9457. return values;
  9458. }
  9459. inline size_t Request::get_param_value_count(const std::string &key) const {
  9460. return params.count(key);
  9461. }
  9462. inline bool Request::is_multipart_form_data() const {
  9463. const auto &content_type = get_header_value("Content-Type");
  9464. return detail::extract_media_type(content_type) == "multipart/form-data";
  9465. }
  9466. // Multipart FormData implementation
  9467. inline std::string MultipartFormData::get_field(const std::string &key,
  9468. size_t id) const {
  9469. auto rng = fields.equal_range(key);
  9470. auto it = rng.first;
  9471. std::advance(it, static_cast<ssize_t>(id));
  9472. if (it != rng.second) { return it->second.content; }
  9473. return std::string();
  9474. }
  9475. inline std::vector<std::string>
  9476. MultipartFormData::get_fields(const std::string &key) const {
  9477. std::vector<std::string> values;
  9478. auto rng = fields.equal_range(key);
  9479. for (auto it = rng.first; it != rng.second; it++) {
  9480. values.push_back(it->second.content);
  9481. }
  9482. return values;
  9483. }
  9484. inline bool MultipartFormData::has_field(const std::string &key) const {
  9485. return fields.find(key) != fields.end();
  9486. }
  9487. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9488. return fields.count(key);
  9489. }
  9490. inline FormData MultipartFormData::get_file(const std::string &key,
  9491. size_t id) const {
  9492. return detail::get_multimap_value(files, key, id);
  9493. }
  9494. inline std::vector<FormData>
  9495. MultipartFormData::get_files(const std::string &key) const {
  9496. std::vector<FormData> values;
  9497. auto rng = files.equal_range(key);
  9498. for (auto it = rng.first; it != rng.second; it++) {
  9499. values.push_back(it->second);
  9500. }
  9501. return values;
  9502. }
  9503. inline bool MultipartFormData::has_file(const std::string &key) const {
  9504. return files.find(key) != files.end();
  9505. }
  9506. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9507. return files.count(key);
  9508. }
  9509. // Multipart FormData writer implementation
  9510. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9511. return detail::is_multipart_boundary_chars_valid(boundary);
  9512. }
  9513. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9514. : boundary_(detail::make_multipart_data_boundary()) {}
  9515. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9516. : boundary_(std::move(boundary)) {}
  9517. inline const std::string &MultipartFormDataWriter::boundary() const {
  9518. return boundary_;
  9519. }
  9520. inline std::string MultipartFormDataWriter::content_type() const {
  9521. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9522. }
  9523. inline std::string
  9524. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9525. return detail::serialize_multipart_formdata(items, boundary_);
  9526. }
  9527. inline size_t MultipartFormDataWriter::content_length(
  9528. const UploadFormDataItems &items) const {
  9529. return detail::get_multipart_content_length(items, boundary_);
  9530. }
  9531. inline std::string
  9532. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9533. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9534. }
  9535. inline std::string MultipartFormDataWriter::item_end() {
  9536. return detail::serialize_multipart_formdata_item_end();
  9537. }
  9538. inline std::string MultipartFormDataWriter::finish() const {
  9539. return detail::serialize_multipart_formdata_finish(boundary_);
  9540. }
  9541. // Response implementation
  9542. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9543. size_t id) const {
  9544. return detail::get_header_value_u64(headers, key, def, id);
  9545. }
  9546. inline bool Response::has_header(const std::string &key) const {
  9547. return headers.find(key) != headers.end();
  9548. }
  9549. inline std::string Response::get_header_value(const std::string &key,
  9550. const char *def,
  9551. size_t id) const {
  9552. return detail::get_header_value(headers, key, def, id);
  9553. }
  9554. inline size_t Response::get_header_value_count(const std::string &key) const {
  9555. return detail::get_header_value_count(headers, key);
  9556. }
  9557. inline void Response::set_header(const std::string &key,
  9558. const std::string &val) {
  9559. detail::set_header(headers, key, val);
  9560. }
  9561. inline bool Response::has_trailer(const std::string &key) const {
  9562. return trailers.find(key) != trailers.end();
  9563. }
  9564. inline std::string Response::get_trailer_value(const std::string &key,
  9565. size_t id) const {
  9566. return detail::get_multimap_value(trailers, key, id);
  9567. }
  9568. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9569. return trailers.count(key);
  9570. }
  9571. inline void Response::set_redirect(const std::string &url, int stat) {
  9572. if (detail::fields::is_field_value(url)) {
  9573. set_header("Location", url);
  9574. if (300 <= stat && stat < 400) {
  9575. this->status = stat;
  9576. } else {
  9577. this->status = StatusCode::Found_302;
  9578. }
  9579. }
  9580. }
  9581. inline void Response::set_content(const char *s, size_t n,
  9582. const std::string &content_type) {
  9583. body.assign(s, n);
  9584. auto rng = headers.equal_range("Content-Type");
  9585. headers.erase(rng.first, rng.second);
  9586. set_header("Content-Type", content_type);
  9587. }
  9588. inline void Response::set_content(const std::string &s,
  9589. const std::string &content_type) {
  9590. set_content(s.data(), s.size(), content_type);
  9591. }
  9592. inline void Response::set_content(std::string &&s,
  9593. const std::string &content_type) {
  9594. body = std::move(s);
  9595. auto rng = headers.equal_range("Content-Type");
  9596. headers.erase(rng.first, rng.second);
  9597. set_header("Content-Type", content_type);
  9598. }
  9599. inline void Response::set_content_provider(
  9600. size_t in_length, const std::string &content_type, ContentProvider provider,
  9601. ContentProviderResourceReleaser resource_releaser) {
  9602. set_header("Content-Type", content_type);
  9603. content_length_ = in_length;
  9604. if (in_length > 0) { content_provider_ = std::move(provider); }
  9605. content_provider_resource_releaser_ = std::move(resource_releaser);
  9606. is_chunked_content_provider_ = false;
  9607. }
  9608. inline void Response::set_content_provider(
  9609. const std::string &content_type, ContentProviderWithoutLength provider,
  9610. ContentProviderResourceReleaser resource_releaser) {
  9611. set_header("Content-Type", content_type);
  9612. content_length_ = 0;
  9613. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9614. content_provider_resource_releaser_ = std::move(resource_releaser);
  9615. is_chunked_content_provider_ = false;
  9616. }
  9617. inline void Response::set_chunked_content_provider(
  9618. const std::string &content_type, ContentProviderWithoutLength provider,
  9619. ContentProviderResourceReleaser resource_releaser) {
  9620. set_header("Content-Type", content_type);
  9621. content_length_ = 0;
  9622. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9623. content_provider_resource_releaser_ = std::move(resource_releaser);
  9624. is_chunked_content_provider_ = true;
  9625. }
  9626. inline void Response::set_file_content(const std::string &path,
  9627. const std::string &content_type) {
  9628. file_content_path_ = path;
  9629. file_content_content_type_ = content_type;
  9630. }
  9631. inline void Response::set_file_content(const std::string &path) {
  9632. file_content_path_ = path;
  9633. }
  9634. // Result implementation
  9635. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9636. size_t def,
  9637. size_t id) const {
  9638. return detail::get_header_value_u64(request_headers_, key, def, id);
  9639. }
  9640. inline bool Result::has_request_header(const std::string &key) const {
  9641. return request_headers_.find(key) != request_headers_.end();
  9642. }
  9643. inline std::string Result::get_request_header_value(const std::string &key,
  9644. const char *def,
  9645. size_t id) const {
  9646. return detail::get_header_value(request_headers_, key, def, id);
  9647. }
  9648. inline size_t
  9649. Result::get_request_header_value_count(const std::string &key) const {
  9650. return request_headers_.count(key);
  9651. }
  9652. // Stream implementation
  9653. inline ssize_t Stream::write(const char *ptr) {
  9654. return write(ptr, strlen(ptr));
  9655. }
  9656. inline ssize_t Stream::write(const std::string &s) {
  9657. return write(s.data(), s.size());
  9658. }
  9659. // BodyReader implementation
  9660. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9661. if (!stream) {
  9662. last_error = Error::Connection;
  9663. return -1;
  9664. }
  9665. if (eof) { return 0; }
  9666. if (!chunked) {
  9667. // Content-Length based reading
  9668. if (has_content_length && bytes_read >= content_length) {
  9669. eof = true;
  9670. return 0;
  9671. }
  9672. auto to_read = len;
  9673. if (has_content_length) {
  9674. auto remaining = content_length - bytes_read;
  9675. to_read = (std::min)(len, remaining);
  9676. }
  9677. auto n = stream->read(buf, to_read);
  9678. if (n < 0) {
  9679. last_error = stream->get_error();
  9680. if (last_error == Error::Success) { last_error = Error::Read; }
  9681. eof = true;
  9682. return n;
  9683. }
  9684. if (n == 0) {
  9685. // Unexpected EOF before content_length
  9686. last_error = stream->get_error();
  9687. if (last_error == Error::Success) { last_error = Error::Read; }
  9688. eof = true;
  9689. return 0;
  9690. }
  9691. bytes_read += static_cast<size_t>(n);
  9692. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9693. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9694. last_error = Error::ExceedMaxPayloadSize;
  9695. eof = true;
  9696. return -1;
  9697. }
  9698. return n;
  9699. }
  9700. // Chunked transfer encoding: delegate to shared decoder instance.
  9701. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9702. size_t chunk_offset = 0;
  9703. size_t chunk_total = 0;
  9704. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9705. if (n < 0) {
  9706. last_error = stream->get_error();
  9707. if (last_error == Error::Success) { last_error = Error::Read; }
  9708. eof = true;
  9709. return n;
  9710. }
  9711. if (n == 0) {
  9712. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  9713. eof = true;
  9714. return 0;
  9715. }
  9716. bytes_read += static_cast<size_t>(n);
  9717. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9718. last_error = Error::ExceedMaxPayloadSize;
  9719. eof = true;
  9720. return -1;
  9721. }
  9722. return n;
  9723. }
  9724. // ThreadPool implementation
  9725. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  9726. time_t idle_timeout_sec)
  9727. : base_thread_count_(n), max_queued_requests_(mqr),
  9728. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  9729. shutdown_(false) {
  9730. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9731. if (max_n != 0 && max_n < n) {
  9732. std::string msg = "max_threads must be >= base_threads";
  9733. throw std::invalid_argument(msg);
  9734. }
  9735. #endif
  9736. max_thread_count_ = max_n == 0 ? n : max_n;
  9737. threads_.reserve(base_thread_count_);
  9738. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9739. try {
  9740. #endif
  9741. for (size_t i = 0; i < base_thread_count_; i++) {
  9742. threads_.emplace_back(std::thread([this]() { worker(false); }));
  9743. }
  9744. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9745. } catch (...) {
  9746. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  9747. // signal the workers we already spawned to exit and join them so the
  9748. // vector destructor does not see joinable threads (which would call
  9749. // std::terminate). Then rethrow so the caller learns of the failure.
  9750. {
  9751. std::unique_lock<std::mutex> lock(mutex_);
  9752. shutdown_ = true;
  9753. }
  9754. cond_.notify_all();
  9755. for (auto &t : threads_) {
  9756. if (t.joinable()) { t.join(); }
  9757. }
  9758. throw;
  9759. }
  9760. #endif
  9761. }
  9762. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  9763. {
  9764. std::unique_lock<std::mutex> lock(mutex_);
  9765. if (shutdown_) { return false; }
  9766. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  9767. return false;
  9768. }
  9769. jobs_.push_back(std::move(fn));
  9770. // Spawn a dynamic thread if no idle threads and under max
  9771. if (idle_thread_count_ == 0 &&
  9772. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  9773. cleanup_finished_threads();
  9774. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  9775. }
  9776. }
  9777. cond_.notify_one();
  9778. return true;
  9779. }
  9780. inline void ThreadPool::shutdown() {
  9781. {
  9782. std::unique_lock<std::mutex> lock(mutex_);
  9783. shutdown_ = true;
  9784. }
  9785. cond_.notify_all();
  9786. for (auto &t : threads_) {
  9787. if (t.joinable()) { t.join(); }
  9788. }
  9789. // Move dynamic_threads_ to a local list under the lock to avoid racing
  9790. // with worker threads that call move_to_finished() concurrently.
  9791. std::list<std::thread> remaining_dynamic;
  9792. {
  9793. std::unique_lock<std::mutex> lock(mutex_);
  9794. remaining_dynamic = std::move(dynamic_threads_);
  9795. }
  9796. for (auto &t : remaining_dynamic) {
  9797. if (t.joinable()) { t.join(); }
  9798. }
  9799. std::unique_lock<std::mutex> lock(mutex_);
  9800. cleanup_finished_threads();
  9801. }
  9802. inline void ThreadPool::move_to_finished(std::thread::id id) {
  9803. // Must be called with mutex_ held
  9804. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  9805. if (it->get_id() == id) {
  9806. finished_threads_.push_back(std::move(*it));
  9807. dynamic_threads_.erase(it);
  9808. return;
  9809. }
  9810. }
  9811. }
  9812. inline void ThreadPool::cleanup_finished_threads() {
  9813. // Must be called with mutex_ held
  9814. for (auto &t : finished_threads_) {
  9815. if (t.joinable()) { t.join(); }
  9816. }
  9817. finished_threads_.clear();
  9818. }
  9819. inline void ThreadPool::worker(bool is_dynamic) {
  9820. for (;;) {
  9821. std::function<void()> fn;
  9822. {
  9823. std::unique_lock<std::mutex> lock(mutex_);
  9824. idle_thread_count_++;
  9825. if (is_dynamic) {
  9826. auto has_work =
  9827. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  9828. [&] { return !jobs_.empty() || shutdown_; });
  9829. if (!has_work) {
  9830. // Timed out with no work - exit this dynamic thread
  9831. idle_thread_count_--;
  9832. move_to_finished(std::this_thread::get_id());
  9833. break;
  9834. }
  9835. } else {
  9836. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  9837. }
  9838. idle_thread_count_--;
  9839. if (shutdown_ && jobs_.empty()) { break; }
  9840. fn = std::move(jobs_.front());
  9841. jobs_.pop_front();
  9842. }
  9843. assert(true == static_cast<bool>(fn));
  9844. fn();
  9845. }
  9846. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  9847. !defined(LIBRESSL_VERSION_NUMBER)
  9848. OPENSSL_thread_stop();
  9849. #endif
  9850. }
  9851. /*
  9852. * Group 1 (continued): detail namespace - Stream implementations
  9853. */
  9854. namespace detail {
  9855. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  9856. time_t timeout_sec, time_t timeout_usec,
  9857. time_t &actual_timeout_sec,
  9858. time_t &actual_timeout_usec) {
  9859. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  9860. auto actual_timeout_msec =
  9861. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  9862. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  9863. actual_timeout_sec = actual_timeout_msec / 1000;
  9864. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  9865. }
  9866. // Socket stream implementation
  9867. inline SocketStream::SocketStream(
  9868. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  9869. time_t write_timeout_sec, time_t write_timeout_usec,
  9870. time_t max_timeout_msec,
  9871. std::chrono::time_point<std::chrono::steady_clock> start_time)
  9872. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  9873. read_timeout_usec_(read_timeout_usec),
  9874. write_timeout_sec_(write_timeout_sec),
  9875. write_timeout_usec_(write_timeout_usec),
  9876. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  9877. read_buff_(read_buff_size_, 0) {}
  9878. inline SocketStream::~SocketStream() = default;
  9879. inline bool SocketStream::is_readable() const {
  9880. return read_buff_off_ < read_buff_content_size_;
  9881. }
  9882. inline bool SocketStream::wait_readable() const {
  9883. if (max_timeout_msec_ <= 0) {
  9884. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  9885. }
  9886. time_t read_timeout_sec;
  9887. time_t read_timeout_usec;
  9888. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  9889. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  9890. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  9891. }
  9892. inline bool SocketStream::wait_writable() const {
  9893. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  9894. }
  9895. inline bool SocketStream::ensure_readable() {
  9896. if (readable_hint_) {
  9897. readable_hint_ = false;
  9898. return true;
  9899. }
  9900. return wait_readable();
  9901. }
  9902. inline const char *SocketStream::buffered_data(size_t &size) const {
  9903. size = read_buff_content_size_ - read_buff_off_;
  9904. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  9905. }
  9906. inline void SocketStream::consume_buffered(size_t size) {
  9907. assert(size <= read_buff_content_size_ - read_buff_off_);
  9908. read_buff_off_ += size;
  9909. }
  9910. inline bool SocketStream::is_peer_alive() const {
  9911. return detail::is_socket_alive(sock_);
  9912. }
  9913. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  9914. #ifdef _WIN32
  9915. size =
  9916. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  9917. #else
  9918. size = (std::min)(size,
  9919. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  9920. #endif
  9921. if (read_buff_off_ < read_buff_content_size_) {
  9922. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  9923. if (size <= remaining_size) {
  9924. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  9925. read_buff_off_ += size;
  9926. return static_cast<ssize_t>(size);
  9927. } else {
  9928. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  9929. read_buff_off_ += remaining_size;
  9930. return static_cast<ssize_t>(remaining_size);
  9931. }
  9932. }
  9933. if (!ensure_readable()) {
  9934. error_ = Error::Timeout;
  9935. return -1;
  9936. }
  9937. read_buff_off_ = 0;
  9938. read_buff_content_size_ = 0;
  9939. if (size < read_buff_size_) {
  9940. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  9941. CPPHTTPLIB_RECV_FLAGS);
  9942. if (n <= 0) {
  9943. if (n == 0) {
  9944. error_ = Error::ConnectionClosed;
  9945. } else {
  9946. error_ = Error::Read;
  9947. }
  9948. return n;
  9949. } else if (n <= static_cast<ssize_t>(size)) {
  9950. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  9951. return n;
  9952. } else {
  9953. memcpy(ptr, read_buff_.data(), size);
  9954. read_buff_off_ = size;
  9955. read_buff_content_size_ = static_cast<size_t>(n);
  9956. return static_cast<ssize_t>(size);
  9957. }
  9958. } else {
  9959. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  9960. if (n <= 0) {
  9961. if (n == 0) {
  9962. error_ = Error::ConnectionClosed;
  9963. } else {
  9964. error_ = Error::Read;
  9965. }
  9966. }
  9967. return n;
  9968. }
  9969. }
  9970. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  9971. if (!wait_writable()) { return -1; }
  9972. #if defined(_WIN32) && !defined(_WIN64)
  9973. size =
  9974. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  9975. #endif
  9976. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  9977. }
  9978. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  9979. int &port) const {
  9980. return detail::get_remote_ip_and_port(sock_, ip, port);
  9981. }
  9982. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  9983. int &port) const {
  9984. return detail::get_local_ip_and_port(sock_, ip, port);
  9985. }
  9986. inline socket_t SocketStream::socket() const { return sock_; }
  9987. inline time_t SocketStream::duration() const {
  9988. return std::chrono::duration_cast<std::chrono::milliseconds>(
  9989. std::chrono::steady_clock::now() - start_time_)
  9990. .count();
  9991. }
  9992. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  9993. read_timeout_sec_ = sec;
  9994. read_timeout_usec_ = usec;
  9995. }
  9996. // Buffer stream implementation
  9997. inline bool BufferStream::is_readable() const { return true; }
  9998. inline bool BufferStream::wait_readable() const { return true; }
  9999. inline bool BufferStream::wait_writable() const { return true; }
  10000. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10001. #if defined(_MSC_VER) && _MSC_VER < 1910
  10002. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10003. #else
  10004. auto len_read = buffer.copy(ptr, size, position);
  10005. #endif
  10006. position += static_cast<size_t>(len_read);
  10007. return static_cast<ssize_t>(len_read);
  10008. }
  10009. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10010. buffer.append(ptr, size);
  10011. return static_cast<ssize_t>(size);
  10012. }
  10013. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10014. int & /*port*/) const {}
  10015. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10016. int & /*port*/) const {}
  10017. inline socket_t BufferStream::socket() const { return 0; }
  10018. inline time_t BufferStream::duration() const { return 0; }
  10019. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10020. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10021. : MatcherBase(pattern) {
  10022. constexpr const char marker[] = "/:";
  10023. // One past the last ending position of a path param substring
  10024. std::size_t last_param_end = 0;
  10025. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10026. // Needed to ensure that parameter names are unique during matcher
  10027. // construction
  10028. // If exceptions are disabled, only last duplicate path
  10029. // parameter will be set
  10030. std::unordered_set<std::string> param_name_set;
  10031. #endif
  10032. while (true) {
  10033. const auto marker_pos = pattern.find(
  10034. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10035. if (marker_pos == std::string::npos) { break; }
  10036. static_fragments_.push_back(
  10037. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10038. const auto param_name_start = marker_pos + str_len(marker);
  10039. auto sep_pos = pattern.find(separator, param_name_start);
  10040. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10041. auto param_name =
  10042. pattern.substr(param_name_start, sep_pos - param_name_start);
  10043. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10044. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10045. std::string msg = "Encountered path parameter '" + param_name +
  10046. "' multiple times in route pattern '" + pattern + "'.";
  10047. throw std::invalid_argument(msg);
  10048. }
  10049. #endif
  10050. param_names_.push_back(std::move(param_name));
  10051. last_param_end = sep_pos + 1;
  10052. }
  10053. if (last_param_end < pattern.length()) {
  10054. static_fragments_.push_back(pattern.substr(last_param_end));
  10055. }
  10056. }
  10057. inline bool PathParamsMatcher::match(Request &request) const {
  10058. request.matches = std::smatch();
  10059. request.path_params.clear();
  10060. // A pattern without parameters is just a literal path to compare against
  10061. if (param_names_.empty()) { return request.path == pattern(); }
  10062. request.path_params.reserve(param_names_.size());
  10063. // One past the position at which the path matched the pattern last time
  10064. std::size_t starting_pos = 0;
  10065. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10066. const auto &fragment = static_fragments_[i];
  10067. if (starting_pos + fragment.length() > request.path.length()) {
  10068. return false;
  10069. }
  10070. // Avoid unnecessary allocation by using strncmp instead of substr +
  10071. // comparison
  10072. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10073. fragment.length()) != 0) {
  10074. return false;
  10075. }
  10076. starting_pos += fragment.length();
  10077. // Should only happen when we have a static fragment after a param
  10078. // Example: '/users/:id/subscriptions'
  10079. // The 'subscriptions' fragment here does not have a corresponding param
  10080. if (i >= param_names_.size()) { continue; }
  10081. auto sep_pos = request.path.find(separator, starting_pos);
  10082. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10083. const auto &param_name = param_names_[i];
  10084. request.path_params.emplace(
  10085. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10086. // Mark everything up to '/' as matched
  10087. starting_pos = sep_pos + 1;
  10088. }
  10089. // Returns false if the path is longer than the pattern
  10090. return starting_pos >= request.path.length();
  10091. }
  10092. inline bool RegexMatcher::match(Request &request) const {
  10093. request.path_params.clear();
  10094. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10095. // a non-match rather than risking a stack overflow in std::regex_match.
  10096. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10097. return false;
  10098. }
  10099. return std::regex_match(request.path, request.matches, regex_);
  10100. }
  10101. // Enclose IPv6 address in brackets if needed
  10102. inline std::string prepare_host_string(const std::string &host) {
  10103. // Enclose IPv6 address in brackets (but not if already enclosed)
  10104. if (host.find(':') == std::string::npos ||
  10105. (!host.empty() && host[0] == '[')) {
  10106. // IPv4, hostname, or already bracketed IPv6
  10107. return host;
  10108. } else {
  10109. // IPv6 address without brackets
  10110. return "[" + host + "]";
  10111. }
  10112. }
  10113. inline std::string make_host_and_port_string(const std::string &host, int port,
  10114. bool is_ssl) {
  10115. auto result = prepare_host_string(host);
  10116. // Append port if not default
  10117. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10118. ; // do nothing
  10119. } else {
  10120. result += ":" + std::to_string(port);
  10121. }
  10122. return result;
  10123. }
  10124. // Create "host:port" string always including port number (for CONNECT method)
  10125. inline std::string
  10126. make_host_and_port_string_always_port(const std::string &host, int port) {
  10127. return prepare_host_string(host) + ":" + std::to_string(port);
  10128. }
  10129. // Value for the Host header a client sends when the caller supplied none.
  10130. // Only the value: callers decide where in their header list it goes.
  10131. inline std::string make_default_host_header_value(const std::string &host,
  10132. int port, bool is_ssl,
  10133. int address_family) {
  10134. if (address_family == AF_UNIX) { return "localhost"; }
  10135. return make_host_and_port_string(host, port, is_ssl);
  10136. }
  10137. inline void add_default_user_agent_header(Request &req) {
  10138. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10139. if (!req.has_header("User-Agent")) {
  10140. req.set_header("User-Agent",
  10141. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10142. }
  10143. #else
  10144. (void)req;
  10145. #endif
  10146. }
  10147. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10148. NormalizedTarget normalize_target(const std::string &host);
  10149. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10150. bool host_matches_no_proxy(const NormalizedTarget &target,
  10151. const std::vector<NoProxyEntry> &entries);
  10152. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10153. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10154. if (prefix_bits == 0) { return true; }
  10155. int full_bytes = prefix_bits / 8;
  10156. int rem_bits = prefix_bits % 8;
  10157. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10158. static_cast<size_t>(full_bytes)) != 0) {
  10159. return false;
  10160. }
  10161. if (rem_bits == 0) { return true; }
  10162. auto i = static_cast<size_t>(full_bytes);
  10163. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10164. return (ip[i] & mask) == (net[i] & mask);
  10165. }
  10166. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10167. if (token.empty()) { return false; }
  10168. if (token == "*") {
  10169. out.kind = NoProxyKind::Wildcard;
  10170. return true;
  10171. }
  10172. auto slash = token.find('/');
  10173. std::string addr_part =
  10174. (slash == std::string::npos) ? token : token.substr(0, slash);
  10175. std::string prefix_part =
  10176. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10177. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10178. // don't silently treat it as a /32 (or /128).
  10179. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10180. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10181. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10182. // when brackets are present.
  10183. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10184. addr_part.back() == ']';
  10185. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10186. if (!bracketed) {
  10187. struct in_addr v4;
  10188. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10189. int prefix = 32;
  10190. if (!prefix_part.empty()) {
  10191. auto r = from_chars(prefix_part.data(),
  10192. prefix_part.data() + prefix_part.size(), prefix);
  10193. if (r.ec != std::errc{} ||
  10194. r.ptr != prefix_part.data() + prefix_part.size()) {
  10195. return false;
  10196. }
  10197. if (prefix < 0 || prefix > 32) { return false; }
  10198. }
  10199. out.kind = NoProxyKind::IPv4Cidr;
  10200. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10201. out.prefix_bits = prefix;
  10202. return true;
  10203. }
  10204. }
  10205. struct in6_addr v6;
  10206. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10207. int prefix = 128;
  10208. if (!prefix_part.empty()) {
  10209. auto r = from_chars(prefix_part.data(),
  10210. prefix_part.data() + prefix_part.size(), prefix);
  10211. if (r.ec != std::errc{} ||
  10212. r.ptr != prefix_part.data() + prefix_part.size()) {
  10213. return false;
  10214. }
  10215. if (prefix < 0 || prefix > 128) { return false; }
  10216. }
  10217. out.kind = NoProxyKind::IPv6Cidr;
  10218. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10219. out.prefix_bits = prefix;
  10220. return true;
  10221. }
  10222. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10223. // the entry is malformed — don't fall through to the hostname branch.
  10224. if (bracketed) { return false; }
  10225. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10226. if (slash != std::string::npos) { return false; }
  10227. // Port-specific entries (host:port) are not supported.
  10228. if (token.find(':') != std::string::npos) { return false; }
  10229. std::string hostname = case_ignore::to_lower(token);
  10230. while (!hostname.empty() && hostname.front() == '.') {
  10231. hostname.erase(hostname.begin());
  10232. }
  10233. while (!hostname.empty() && hostname.back() == '.') {
  10234. hostname.pop_back();
  10235. }
  10236. if (hostname.empty()) { return false; }
  10237. out.kind = NoProxyKind::HostnameSuffix;
  10238. out.hostname_pattern = std::move(hostname);
  10239. return true;
  10240. }
  10241. inline NormalizedTarget normalize_target(const std::string &host) {
  10242. NormalizedTarget t;
  10243. std::string h = host;
  10244. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10245. h = h.substr(1, h.size() - 2);
  10246. }
  10247. // Strip a single trailing dot so "example.com." canonicalizes to
  10248. // "example.com".
  10249. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10250. t.hostname = case_ignore::to_lower(h);
  10251. if (!t.hostname.empty()) {
  10252. struct in_addr v4;
  10253. struct in6_addr v6;
  10254. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10255. t.is_ipv4 = true;
  10256. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10257. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10258. t.is_ipv6 = true;
  10259. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10260. }
  10261. }
  10262. return t;
  10263. }
  10264. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10265. const std::vector<NoProxyEntry> &entries) {
  10266. if (target.hostname.empty()) { return false; }
  10267. for (const auto &e : entries) {
  10268. switch (e.kind) {
  10269. case NoProxyKind::Wildcard: return true;
  10270. case NoProxyKind::IPv4Cidr:
  10271. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10272. return true;
  10273. }
  10274. break;
  10275. case NoProxyKind::IPv6Cidr:
  10276. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10277. return true;
  10278. }
  10279. break;
  10280. case NoProxyKind::HostnameSuffix:
  10281. if (target.is_ipv4 || target.is_ipv6) { break; }
  10282. if (target.hostname == e.hostname_pattern) { return true; }
  10283. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10284. // an entry of "example.com".
  10285. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10286. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10287. if (target.hostname[offset - 1] == '.' &&
  10288. target.hostname.compare(offset, e.hostname_pattern.size(),
  10289. e.hostname_pattern) == 0) {
  10290. return true;
  10291. }
  10292. }
  10293. break;
  10294. }
  10295. }
  10296. return false;
  10297. }
  10298. template <typename T>
  10299. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10300. T header_writer, Error &error) {
  10301. for (const auto &h : headers) {
  10302. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10303. error = Error::InvalidHeaders;
  10304. return false;
  10305. }
  10306. }
  10307. if (header_writer(strm, headers) <= 0) {
  10308. error = Error::Write;
  10309. return false;
  10310. }
  10311. return true;
  10312. }
  10313. } // namespace detail
  10314. /*
  10315. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10316. */
  10317. #ifdef CPPHTTPLIB_SSL_ENABLED
  10318. namespace detail {
  10319. // SSL socket stream implementation
  10320. inline SSLSocketStream::SSLSocketStream(
  10321. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10322. time_t read_timeout_usec, time_t write_timeout_sec,
  10323. time_t write_timeout_usec, time_t max_timeout_msec,
  10324. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10325. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10326. read_timeout_usec_(read_timeout_usec),
  10327. write_timeout_sec_(write_timeout_sec),
  10328. write_timeout_usec_(write_timeout_usec),
  10329. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10330. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10331. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10332. // Note: create_session() also clears this, but SSLClient currently
  10333. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10334. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10335. // SSL session was created.
  10336. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10337. #endif
  10338. }
  10339. inline SSLSocketStream::~SSLSocketStream() = default;
  10340. inline bool SSLSocketStream::is_readable() const {
  10341. return tls::pending(session_) > 0;
  10342. }
  10343. inline bool SSLSocketStream::wait_readable() const {
  10344. if (max_timeout_msec_ <= 0) {
  10345. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10346. }
  10347. time_t read_timeout_sec;
  10348. time_t read_timeout_usec;
  10349. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10350. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10351. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10352. }
  10353. inline bool SSLSocketStream::wait_writable() const {
  10354. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10355. !tls::is_peer_closed(session_, sock_);
  10356. }
  10357. inline bool SSLSocketStream::ensure_readable() {
  10358. if (readable_hint_) {
  10359. readable_hint_ = false;
  10360. return true;
  10361. }
  10362. return wait_readable();
  10363. }
  10364. inline bool SSLSocketStream::is_peer_alive() const {
  10365. return !tls::is_peer_closed(session_, sock_);
  10366. }
  10367. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10368. if (tls::pending(session_) > 0) {
  10369. tls::TlsError err;
  10370. auto ret = tls::read(session_, ptr, size, err);
  10371. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10372. error_ = Error::ConnectionClosed;
  10373. }
  10374. return ret;
  10375. } else if (ensure_readable()) {
  10376. tls::TlsError err;
  10377. auto ret = tls::read(session_, ptr, size, err);
  10378. if (ret < 0) {
  10379. auto n = 1000;
  10380. #ifdef _WIN32
  10381. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10382. (err.code == tls::ErrorCode::SyscallError &&
  10383. WSAGetLastError() == WSAETIMEDOUT))) {
  10384. #else
  10385. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10386. #endif
  10387. if (tls::pending(session_) > 0) {
  10388. return tls::read(session_, ptr, size, err);
  10389. } else if (wait_readable()) {
  10390. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10391. ret = tls::read(session_, ptr, size, err);
  10392. if (ret >= 0) { return ret; }
  10393. } else {
  10394. break;
  10395. }
  10396. }
  10397. assert(ret < 0);
  10398. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10399. error_ = Error::ConnectionClosed;
  10400. }
  10401. return ret;
  10402. } else {
  10403. error_ = Error::Timeout;
  10404. return -1;
  10405. }
  10406. }
  10407. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10408. if (wait_writable()) {
  10409. auto handle_size =
  10410. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10411. tls::TlsError err;
  10412. auto ret = tls::write(session_, ptr, handle_size, err);
  10413. if (ret < 0) {
  10414. auto n = 1000;
  10415. #ifdef _WIN32
  10416. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10417. (err.code == tls::ErrorCode::SyscallError &&
  10418. WSAGetLastError() == WSAETIMEDOUT))) {
  10419. #else
  10420. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10421. #endif
  10422. if (wait_writable()) {
  10423. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10424. ret = tls::write(session_, ptr, handle_size, err);
  10425. if (ret >= 0) { return ret; }
  10426. } else {
  10427. break;
  10428. }
  10429. }
  10430. assert(ret < 0);
  10431. }
  10432. return ret;
  10433. }
  10434. return -1;
  10435. }
  10436. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10437. int &port) const {
  10438. detail::get_remote_ip_and_port(sock_, ip, port);
  10439. }
  10440. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10441. int &port) const {
  10442. detail::get_local_ip_and_port(sock_, ip, port);
  10443. }
  10444. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10445. inline time_t SSLSocketStream::duration() const {
  10446. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10447. std::chrono::steady_clock::now() - start_time_)
  10448. .count();
  10449. }
  10450. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10451. read_timeout_sec_ = sec;
  10452. read_timeout_usec_ = usec;
  10453. }
  10454. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10455. tls::session_t session,
  10456. time_t read_timeout_sec,
  10457. time_t read_timeout_usec,
  10458. time_t write_timeout_sec,
  10459. time_t write_timeout_usec)
  10460. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10461. read_timeout_usec_(read_timeout_usec),
  10462. write_timeout_sec_(write_timeout_sec),
  10463. write_timeout_usec_(write_timeout_usec),
  10464. start_time_(std::chrono::steady_clock::now()) {
  10465. // The receive and send paths run on different threads, so each TLS call is
  10466. // driven in non-blocking mode and readiness is awaited with select()
  10467. // outside the session lock. Set the socket non-blocking once here; it is
  10468. // never flipped back, so no thread races on the flag.
  10469. detail::set_nonblocking(sock_, true);
  10470. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10471. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10472. #endif
  10473. }
  10474. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10475. inline bool WebSocketSSLStream::is_readable() const {
  10476. std::lock_guard<std::mutex> guard(session_mutex_);
  10477. return tls::pending(session_) > 0;
  10478. }
  10479. inline bool WebSocketSSLStream::wait_readable() const {
  10480. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10481. }
  10482. inline bool WebSocketSSLStream::wait_writable() const {
  10483. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10484. // that probe toggles the socket's blocking flag, which would race with the
  10485. // concurrent reader on a permanently non-blocking socket.
  10486. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10487. }
  10488. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10489. tls::TlsError err;
  10490. auto n = 1000;
  10491. while (--n >= 0) {
  10492. {
  10493. std::lock_guard<std::mutex> guard(session_mutex_);
  10494. auto ret = tls::read(session_, ptr, size, err);
  10495. if (ret > 0) { return ret; }
  10496. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10497. error_ = Error::ConnectionClosed;
  10498. return ret;
  10499. }
  10500. }
  10501. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10502. // direction: the send path shares this session, so output it left pending
  10503. // has to be flushed before more input can be decrypted. Anything else is
  10504. // a hard error.
  10505. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10506. #ifdef _WIN32
  10507. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10508. needs_readable =
  10509. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10510. WSAGetLastError() == WSAETIMEDOUT);
  10511. #endif
  10512. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) { return -1; }
  10513. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10514. error_ = Error::Timeout;
  10515. return -1;
  10516. }
  10517. }
  10518. return -1;
  10519. }
  10520. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10521. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10522. tls::TlsError err;
  10523. auto n = 1000;
  10524. while (--n >= 0) {
  10525. {
  10526. std::lock_guard<std::mutex> guard(session_mutex_);
  10527. auto ret = tls::write(session_, ptr, handle_size, err);
  10528. if (ret >= 0) { return ret; }
  10529. }
  10530. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10531. // or a post-handshake message must be consumed before the record goes
  10532. // out. Anything else is a hard error.
  10533. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10534. #ifdef _WIN32
  10535. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10536. needs_writable =
  10537. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10538. WSAGetLastError() == WSAETIMEDOUT);
  10539. #endif
  10540. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10541. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10542. }
  10543. return -1;
  10544. }
  10545. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10546. int &port) const {
  10547. detail::get_remote_ip_and_port(sock_, ip, port);
  10548. }
  10549. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10550. int &port) const {
  10551. detail::get_local_ip_and_port(sock_, ip, port);
  10552. }
  10553. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10554. inline time_t WebSocketSSLStream::duration() const {
  10555. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10556. std::chrono::steady_clock::now() - start_time_)
  10557. .count();
  10558. }
  10559. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10560. read_timeout_sec_ = sec;
  10561. read_timeout_usec_ = usec;
  10562. }
  10563. } // namespace detail
  10564. #endif // CPPHTTPLIB_SSL_ENABLED
  10565. /*
  10566. * Group 4: Server implementation
  10567. */
  10568. // HTTP server implementation
  10569. inline Server::Server()
  10570. : new_task_queue([] {
  10571. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10572. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10573. }) {
  10574. #ifndef _WIN32
  10575. signal(SIGPIPE, SIG_IGN);
  10576. #endif
  10577. }
  10578. inline Server::~Server() = default;
  10579. inline std::unique_ptr<detail::MatcherBase>
  10580. Server::make_matcher(const std::string &pattern) {
  10581. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10582. // a path params pattern
  10583. if (pattern.find("/:") != std::string::npos) {
  10584. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10585. }
  10586. // A pattern with no regex metacharacter only has to be compared literally,
  10587. // which is what PathParamsMatcher already does when it captures no
  10588. // parameter, so std::regex is only worth building for the patterns that
  10589. // actually need it
  10590. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10591. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10592. }
  10593. return detail::make_unique<detail::RegexMatcher>(pattern);
  10594. }
  10595. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10596. return add_handler(get_handlers_, pattern, std::move(handler));
  10597. }
  10598. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10599. return add_handler(post_handlers_, pattern, std::move(handler));
  10600. }
  10601. inline Server &Server::Post(const std::string &pattern,
  10602. HandlerWithContentReader handler) {
  10603. return add_handler(post_handlers_for_content_reader_, pattern,
  10604. std::move(handler));
  10605. }
  10606. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10607. return add_handler(put_handlers_, pattern, std::move(handler));
  10608. }
  10609. inline Server &Server::Put(const std::string &pattern,
  10610. HandlerWithContentReader handler) {
  10611. return add_handler(put_handlers_for_content_reader_, pattern,
  10612. std::move(handler));
  10613. }
  10614. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10615. return add_handler(patch_handlers_, pattern, std::move(handler));
  10616. }
  10617. inline Server &Server::Patch(const std::string &pattern,
  10618. HandlerWithContentReader handler) {
  10619. return add_handler(patch_handlers_for_content_reader_, pattern,
  10620. std::move(handler));
  10621. }
  10622. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10623. return add_handler(delete_handlers_, pattern, std::move(handler));
  10624. }
  10625. inline Server &Server::Delete(const std::string &pattern,
  10626. HandlerWithContentReader handler) {
  10627. return add_handler(delete_handlers_for_content_reader_, pattern,
  10628. std::move(handler));
  10629. }
  10630. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10631. return add_handler(options_handlers_, pattern, std::move(handler));
  10632. }
  10633. inline const std::set<std::string> &Server::builtin_methods() {
  10634. thread_local const std::set<std::string> methods{
  10635. "GET", "HEAD", "POST", "PUT", "DELETE",
  10636. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10637. return methods;
  10638. }
  10639. inline Server::CustomHandlerEntry *
  10640. Server::custom_entry_for_registration(const std::string &method) {
  10641. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10642. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10643. // routing() before the custom tables are consulted, so a route registered
  10644. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10645. // there and would be reachable, but they carry protocol-level meaning
  10646. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10647. // library does not route.
  10648. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10649. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10650. has_invalid_registration_ = true;
  10651. return nullptr;
  10652. }
  10653. return &custom_handlers_[method];
  10654. }
  10655. inline Server &Server::CustomRoute(const std::string &method,
  10656. const std::string &pattern,
  10657. Handler handler) {
  10658. auto *entry = custom_entry_for_registration(method);
  10659. if (!entry) { return *this; }
  10660. return add_handler(entry->handlers, pattern, std::move(handler));
  10661. }
  10662. inline Server &Server::CustomRoute(const std::string &method,
  10663. const std::string &pattern,
  10664. HandlerWithContentReader handler) {
  10665. auto *entry = custom_entry_for_registration(method);
  10666. if (!entry) { return *this; }
  10667. return add_handler(entry->handlers_for_content_reader, pattern,
  10668. std::move(handler));
  10669. }
  10670. inline const Server::CustomHandlerEntry *
  10671. Server::find_custom_entry(const std::string &method) const {
  10672. // find() alone would be correct here. The empty() check is what keeps the
  10673. // per-request cost off servers that never call CustomRoute(), which is the
  10674. // overwhelmingly common case; keep it rather than walking into the tree.
  10675. if (custom_handlers_.empty()) { return nullptr; }
  10676. auto it = custom_handlers_.find(method);
  10677. return it == custom_handlers_.end() ? nullptr : &it->second;
  10678. }
  10679. inline Server &Server::WebSocket(const std::string &pattern,
  10680. WebSocketHandler handler) {
  10681. websocket_handlers_.push_back(
  10682. {make_matcher(pattern), std::move(handler), nullptr});
  10683. return *this;
  10684. }
  10685. inline Server &Server::WebSocket(const std::string &pattern,
  10686. WebSocketHandler handler,
  10687. SubProtocolSelector sub_protocol_selector) {
  10688. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10689. std::move(sub_protocol_selector)});
  10690. return *this;
  10691. }
  10692. inline bool Server::set_base_dir(const std::string &dir,
  10693. const std::string &mount_point) {
  10694. return set_mount_point(mount_point, dir);
  10695. }
  10696. inline bool Server::set_mount_point(const std::string &mount_point,
  10697. const std::string &dir, Headers headers) {
  10698. detail::FileStat stat(dir);
  10699. if (stat.is_dir()) {
  10700. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10701. if (!mnt.empty() && mnt[0] == '/') {
  10702. std::string resolved_base;
  10703. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  10704. #if defined(_WIN32)
  10705. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  10706. resolved_base += '\\';
  10707. }
  10708. #else
  10709. if (resolved_base.back() != '/') { resolved_base += '/'; }
  10710. #endif
  10711. }
  10712. base_dirs_.push_back(
  10713. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  10714. return true;
  10715. }
  10716. }
  10717. return false;
  10718. }
  10719. inline bool Server::remove_mount_point(const std::string &mount_point) {
  10720. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  10721. if (it->mount_point == mount_point) {
  10722. base_dirs_.erase(it);
  10723. return true;
  10724. }
  10725. }
  10726. return false;
  10727. }
  10728. inline Server &
  10729. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  10730. const std::string &mime) {
  10731. file_extension_and_mimetype_map_[ext] = mime;
  10732. return *this;
  10733. }
  10734. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  10735. default_file_mimetype_ = mime;
  10736. return *this;
  10737. }
  10738. inline Server &Server::set_file_request_handler(Handler handler) {
  10739. file_request_handler_ = std::move(handler);
  10740. return *this;
  10741. }
  10742. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  10743. std::true_type) {
  10744. error_handler_ = std::move(handler);
  10745. return *this;
  10746. }
  10747. inline Server &Server::set_error_handler_core(Handler handler,
  10748. std::false_type) {
  10749. error_handler_ = [handler](const Request &req, Response &res) {
  10750. handler(req, res);
  10751. return HandlerResponse::Handled;
  10752. };
  10753. return *this;
  10754. }
  10755. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  10756. exception_handler_ = std::move(handler);
  10757. return *this;
  10758. }
  10759. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  10760. pre_routing_handler_ = std::move(handler);
  10761. return *this;
  10762. }
  10763. inline Server &Server::set_post_routing_handler(Handler handler) {
  10764. post_routing_handler_ = std::move(handler);
  10765. return *this;
  10766. }
  10767. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  10768. pre_request_handler_ = std::move(handler);
  10769. return *this;
  10770. }
  10771. inline Server &Server::set_logger(Logger logger) {
  10772. logger_ = std::move(logger);
  10773. return *this;
  10774. }
  10775. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  10776. error_logger_ = std::move(error_logger);
  10777. return *this;
  10778. }
  10779. inline Server &Server::set_pre_compression_logger(Logger logger) {
  10780. pre_compression_logger_ = std::move(logger);
  10781. return *this;
  10782. }
  10783. inline Server &
  10784. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  10785. expect_100_continue_handler_ = std::move(handler);
  10786. return *this;
  10787. }
  10788. inline Server &Server::set_start_handler(StartHandler handler) {
  10789. start_handler_ = std::move(handler);
  10790. return *this;
  10791. }
  10792. inline Server &Server::set_address_family(int family) {
  10793. address_family_ = family;
  10794. return *this;
  10795. }
  10796. inline Server &Server::set_tcp_nodelay(bool on) {
  10797. tcp_nodelay_ = on;
  10798. return *this;
  10799. }
  10800. inline Server &Server::set_ipv6_v6only(bool on) {
  10801. ipv6_v6only_ = on;
  10802. return *this;
  10803. }
  10804. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  10805. socket_options_ = std::move(socket_options);
  10806. return *this;
  10807. }
  10808. inline Server &Server::set_default_headers(Headers headers) {
  10809. default_headers_ = std::move(headers);
  10810. return *this;
  10811. }
  10812. inline Server &Server::set_header_writer(
  10813. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  10814. header_writer_ = writer;
  10815. return *this;
  10816. }
  10817. inline Server &
  10818. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  10819. trusted_proxies_ = proxies;
  10820. return *this;
  10821. }
  10822. inline Server &Server::set_keep_alive_max_count(size_t count) {
  10823. keep_alive_max_count_ = count;
  10824. return *this;
  10825. }
  10826. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  10827. keep_alive_timeout_sec_ = sec;
  10828. return *this;
  10829. }
  10830. template <class Rep, class Period>
  10831. inline Server &Server::set_keep_alive_timeout(
  10832. const std::chrono::duration<Rep, Period> &duration) {
  10833. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  10834. set_keep_alive_timeout(sec);
  10835. });
  10836. return *this;
  10837. }
  10838. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  10839. read_timeout_sec_ = sec;
  10840. read_timeout_usec_ = usec;
  10841. return *this;
  10842. }
  10843. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  10844. write_timeout_sec_ = sec;
  10845. write_timeout_usec_ = usec;
  10846. return *this;
  10847. }
  10848. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  10849. idle_interval_sec_ = sec;
  10850. idle_interval_usec_ = usec;
  10851. return *this;
  10852. }
  10853. inline Server &Server::set_payload_max_length(size_t length) {
  10854. payload_max_length_ = length;
  10855. return *this;
  10856. }
  10857. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  10858. websocket_max_missed_pongs_ = count;
  10859. return *this;
  10860. }
  10861. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  10862. websocket_ping_interval_sec_ = sec;
  10863. return *this;
  10864. }
  10865. template <class Rep, class Period>
  10866. inline Server &Server::set_websocket_ping_interval(
  10867. const std::chrono::duration<Rep, Period> &duration) {
  10868. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  10869. set_websocket_ping_interval(sec);
  10870. });
  10871. return *this;
  10872. }
  10873. inline bool Server::bind_to_port(const std::string &host, int port,
  10874. int socket_flags) {
  10875. auto ret = bind_internal(host, port, socket_flags);
  10876. if (ret == -1) { is_decommissioned = true; }
  10877. return ret >= 0;
  10878. }
  10879. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  10880. auto ret = bind_internal(host, 0, socket_flags);
  10881. if (ret == -1) { is_decommissioned = true; }
  10882. return ret;
  10883. }
  10884. inline bool Server::listen_after_bind() { return listen_internal(); }
  10885. inline bool Server::listen(const std::string &host, int port,
  10886. int socket_flags) {
  10887. return bind_to_port(host, port, socket_flags) && listen_internal();
  10888. }
  10889. inline bool Server::is_running() const { return is_running_; }
  10890. inline void Server::wait_until_ready() const {
  10891. while (!is_running_ && !is_decommissioned) {
  10892. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  10893. }
  10894. }
  10895. inline void Server::stop() noexcept {
  10896. // Release the listening socket whether or not the accept loop is running:
  10897. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  10898. // exchange is what makes this safe to call concurrently with the accept loop.
  10899. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  10900. if (sock != INVALID_SOCKET) {
  10901. detail::shutdown_socket(sock);
  10902. detail::close_socket(sock);
  10903. }
  10904. is_decommissioned = false;
  10905. }
  10906. inline void Server::decommission() { is_decommissioned = true; }
  10907. inline bool Server::parse_request_line(const char *s, Request &req) const {
  10908. auto len = strlen(s);
  10909. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  10910. len -= 2;
  10911. {
  10912. size_t count = 0;
  10913. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  10914. switch (count) {
  10915. case 0: req.method = std::string(b, e); break;
  10916. case 1: req.target = std::string(b, e); break;
  10917. case 2: req.version = std::string(b, e); break;
  10918. default: break;
  10919. }
  10920. count++;
  10921. });
  10922. if (count != 3) { return false; }
  10923. }
  10924. // A method outside the built-in set is accepted only when a handler has been
  10925. // registered for it with CustomRoute().
  10926. const auto &methods = builtin_methods();
  10927. if (methods.find(req.method) == methods.end() &&
  10928. !find_custom_entry(req.method)) {
  10929. output_error_log(Error::InvalidHTTPMethod, &req);
  10930. return false;
  10931. }
  10932. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  10933. output_error_log(Error::InvalidHTTPVersion, &req);
  10934. return false;
  10935. }
  10936. {
  10937. // Skip URL fragment
  10938. for (size_t i = 0; i < req.target.size(); i++) {
  10939. if (req.target[i] == '#') {
  10940. req.target.erase(i);
  10941. break;
  10942. }
  10943. }
  10944. detail::divide(req.target, '?',
  10945. [&](const char *lhs_data, std::size_t lhs_size,
  10946. const char *rhs_data, std::size_t rhs_size) {
  10947. req.path =
  10948. decode_path_component(std::string(lhs_data, lhs_size));
  10949. detail::parse_query_text(rhs_data, rhs_size, req.params);
  10950. });
  10951. }
  10952. return true;
  10953. }
  10954. inline bool Server::write_response(Stream &strm, bool close_connection,
  10955. Request &req, Response &res) {
  10956. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  10957. // incorrectly to the error content.
  10958. req.ranges.clear();
  10959. return write_response_core(strm, close_connection, req, res, false);
  10960. }
  10961. inline bool Server::write_response_with_content(Stream &strm,
  10962. bool close_connection,
  10963. const Request &req,
  10964. Response &res) {
  10965. return write_response_core(strm, close_connection, req, res, true);
  10966. }
  10967. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  10968. const Request &req, Response &res,
  10969. bool need_apply_ranges) {
  10970. assert(res.status != -1);
  10971. if (400 <= res.status && error_handler_ &&
  10972. error_handler_(req, res) == HandlerResponse::Handled) {
  10973. need_apply_ranges = true;
  10974. }
  10975. std::string content_type;
  10976. std::string boundary;
  10977. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  10978. // Prepare additional headers
  10979. if (close_connection ||
  10980. detail::has_header_token(req.headers, "Connection", "close") ||
  10981. 400 <= res.status) { // Don't leave connections open after errors
  10982. res.set_header("Connection", "close");
  10983. } else {
  10984. std::string s = "timeout=";
  10985. s += std::to_string(keep_alive_timeout_sec_);
  10986. s += ", max=";
  10987. s += std::to_string(keep_alive_max_count_);
  10988. res.set_header("Keep-Alive", s);
  10989. }
  10990. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  10991. !res.has_header("Content-Type")) {
  10992. res.set_header("Content-Type", "text/plain");
  10993. }
  10994. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  10995. !res.has_header("Content-Length")) {
  10996. res.set_header("Content-Length", "0");
  10997. }
  10998. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  10999. res.set_header("Accept-Ranges", "bytes");
  11000. }
  11001. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11002. // Response line and headers
  11003. detail::BufferStream bstrm;
  11004. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11005. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11006. // Combine small body with headers to reduce write syscalls
  11007. if (req.method != "HEAD" && !res.body.empty() && !res.content_provider_) {
  11008. bstrm.write(res.body.data(), res.body.size());
  11009. }
  11010. // Log before writing to avoid race condition with client-side code that
  11011. // accesses logger-captured data immediately after receiving the response.
  11012. output_log(req, res);
  11013. // Flush buffer
  11014. auto &data = bstrm.get_buffer();
  11015. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11016. // Streaming body
  11017. auto ret = true;
  11018. if (req.method != "HEAD" && res.content_provider_) {
  11019. if (write_content_with_provider(strm, req, res, boundary, content_type)) {
  11020. res.content_provider_success_ = true;
  11021. } else {
  11022. ret = false;
  11023. }
  11024. }
  11025. return ret;
  11026. }
  11027. inline bool
  11028. Server::write_content_with_provider(Stream &strm, const Request &req,
  11029. Response &res, const std::string &boundary,
  11030. const std::string &content_type) {
  11031. auto is_shutting_down = [this]() {
  11032. return this->svr_sock_ == INVALID_SOCKET;
  11033. };
  11034. if (res.content_length_ > 0) {
  11035. // Only a 206 response is served as a partial representation, matching the
  11036. // condition `apply_ranges()` used to decide the Content-Length and the
  11037. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11038. // only for a 2xx status, slicing under any other status would write a body
  11039. // that disagrees with the header already sent, from an unchecked offset.
  11040. auto is_partial =
  11041. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11042. if (!is_partial) {
  11043. return detail::write_content(strm, res.content_provider_, 0,
  11044. res.content_length_, is_shutting_down);
  11045. } else if (req.ranges.size() == 1) {
  11046. auto offset_and_length = detail::get_range_offset_and_length(
  11047. req.ranges[0], res.content_length_);
  11048. return detail::write_content(strm, res.content_provider_,
  11049. offset_and_length.first,
  11050. offset_and_length.second, is_shutting_down);
  11051. } else {
  11052. return detail::write_multipart_ranges_data(
  11053. strm, req, res, boundary, content_type, res.content_length_,
  11054. is_shutting_down);
  11055. }
  11056. } else {
  11057. if (res.is_chunked_content_provider_) {
  11058. auto type = detail::encoding_type(req, res);
  11059. auto compressor = detail::make_compressor(type);
  11060. if (!compressor) {
  11061. compressor = detail::make_unique<detail::nocompressor>();
  11062. }
  11063. return detail::write_content_chunked(strm, res.content_provider_,
  11064. is_shutting_down, *compressor);
  11065. } else {
  11066. return detail::write_content_without_length(strm, res.content_provider_,
  11067. is_shutting_down);
  11068. }
  11069. }
  11070. }
  11071. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11072. FormFields::iterator cur_field;
  11073. FormFiles::iterator cur_file;
  11074. auto is_text_field = false;
  11075. size_t count = 0;
  11076. if (read_content_core(
  11077. strm, req, res,
  11078. // Regular
  11079. [&](const char *buf, size_t n) {
  11080. // Prevent arithmetic overflow when checking sizes.
  11081. // Avoid computing (req.body.size() + n) directly because
  11082. // adding two unsigned `size_t` values can wrap around and
  11083. // produce a small result instead of indicating overflow.
  11084. // Instead, check using subtraction: ensure `n` does not
  11085. // exceed the remaining capacity `max_size() - size()`.
  11086. if (req.body.size() >= req.body.max_size() ||
  11087. n > req.body.max_size() - req.body.size()) {
  11088. return false;
  11089. }
  11090. // Limit decompressed body size to payload_max_length_ to protect
  11091. // against "zip bomb" attacks where a small compressed payload
  11092. // decompresses to a massive size.
  11093. if (payload_max_length_ > 0 &&
  11094. (req.body.size() >= payload_max_length_ ||
  11095. n > payload_max_length_ - req.body.size())) {
  11096. return false;
  11097. }
  11098. req.body.append(buf, n);
  11099. return true;
  11100. },
  11101. // Multipart FormData
  11102. [&](const FormData &file) {
  11103. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11104. output_error_log(Error::TooManyFormDataFiles, &req);
  11105. return false;
  11106. }
  11107. if (file.filename.empty()) {
  11108. cur_field = req.form.fields.emplace(
  11109. file.name, FormField{file.name, file.content, file.headers});
  11110. is_text_field = true;
  11111. } else {
  11112. cur_file = req.form.files.emplace(file.name, file);
  11113. is_text_field = false;
  11114. }
  11115. return true;
  11116. },
  11117. [&](const char *buf, size_t n) {
  11118. if (is_text_field) {
  11119. auto &content = cur_field->second.content;
  11120. if (content.size() + n > content.max_size()) { return false; }
  11121. content.append(buf, n);
  11122. } else {
  11123. auto &content = cur_file->second.content;
  11124. if (content.size() + n > content.max_size()) { return false; }
  11125. content.append(buf, n);
  11126. }
  11127. return true;
  11128. })) {
  11129. const auto &content_type = req.get_header_value("Content-Type");
  11130. if (detail::extract_media_type(content_type) ==
  11131. "application/x-www-form-urlencoded") {
  11132. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11133. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11134. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11135. return false;
  11136. }
  11137. detail::parse_query_text(req.body, req.params);
  11138. }
  11139. return true;
  11140. }
  11141. return false;
  11142. }
  11143. inline bool Server::read_content_with_content_receiver(
  11144. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11145. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11146. return read_content_core(strm, req, res, std::move(receiver),
  11147. std::move(multipart_header),
  11148. std::move(multipart_receiver));
  11149. }
  11150. inline bool Server::read_content_core(
  11151. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11152. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11153. detail::FormDataParser multipart_form_data_parser;
  11154. ContentReceiverWithProgress out;
  11155. if (req.is_multipart_form_data()) {
  11156. const auto &content_type = req.get_header_value("Content-Type");
  11157. std::string boundary;
  11158. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11159. res.status = StatusCode::BadRequest_400;
  11160. output_error_log(Error::MultipartParsing, &req);
  11161. return false;
  11162. }
  11163. multipart_form_data_parser.set_boundary(std::move(boundary));
  11164. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11165. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11166. multipart_receiver);
  11167. };
  11168. } else {
  11169. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11170. size_t /*len*/) { return receiver(buf, n); };
  11171. }
  11172. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11173. // For non-SSL builds we still scan non-persistent connections for stray
  11174. // body bytes so the payload limit is enforced (413). On keep-alive,
  11175. // pending bytes may be the next request (issue #2450), so skip.
  11176. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11177. if (!req.has_header("Content-Length") &&
  11178. !detail::is_chunked_transfer_encoding(req.headers)) {
  11179. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11180. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11181. auto has_data = strm.is_readable();
  11182. if (!has_data) {
  11183. auto s = strm.socket();
  11184. if (s != INVALID_SOCKET) {
  11185. has_data = detail::select_read(s, 0, 0) > 0;
  11186. }
  11187. }
  11188. if (has_data) {
  11189. // Route through the same decompressing reader used by the
  11190. // length-framed and chunked paths below, so payload_max_length_ is
  11191. // enforced on the decompressed size here too instead of only on the
  11192. // compressed wire bytes.
  11193. return detail::read_content(strm, req, payload_max_length_, res.status,
  11194. nullptr, out, true);
  11195. }
  11196. }
  11197. return true;
  11198. }
  11199. #else
  11200. if (!req.has_header("Content-Length") &&
  11201. !detail::is_chunked_transfer_encoding(req.headers)) {
  11202. return true;
  11203. }
  11204. #endif
  11205. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11206. out, true)) {
  11207. return false;
  11208. }
  11209. req.body_consumed_ = true;
  11210. if (req.is_multipart_form_data()) {
  11211. if (!multipart_form_data_parser.is_valid()) {
  11212. res.status = StatusCode::BadRequest_400;
  11213. output_error_log(Error::MultipartParsing, &req);
  11214. return false;
  11215. }
  11216. }
  11217. return true;
  11218. }
  11219. inline bool Server::handle_file_request(Request &req, Response &res) {
  11220. for (const auto &entry : base_dirs_) {
  11221. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11222. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11223. // One that already ends in '/' (the root mount among them) carries its own
  11224. // boundary; set_mount_point() guarantees the mount point is not empty.
  11225. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11226. (entry.mount_point.back() == '/' ||
  11227. req.path.size() == entry.mount_point.size() ||
  11228. req.path[entry.mount_point.size()] == '/')) {
  11229. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11230. if (detail::is_valid_path(sub_path)) {
  11231. auto path = entry.base_dir + sub_path;
  11232. if (path.back() == '/') { path += "index.html"; }
  11233. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11234. // but symlinks/junctions can still escape the base directory.
  11235. if (!entry.resolved_base_dir.empty()) {
  11236. std::string resolved_path;
  11237. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11238. !detail::is_path_within_base(resolved_path,
  11239. entry.resolved_base_dir)) {
  11240. res.status = StatusCode::Forbidden_403;
  11241. return true;
  11242. }
  11243. }
  11244. detail::FileStat stat(path);
  11245. if (stat.is_dir()) {
  11246. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11247. return true;
  11248. }
  11249. if (stat.is_file()) {
  11250. for (const auto &kv : entry.headers) {
  11251. res.set_header(kv.first, kv.second);
  11252. }
  11253. auto etag = detail::compute_etag(stat);
  11254. if (!etag.empty()) { res.set_header("ETag", etag); }
  11255. auto mtime = stat.mtime();
  11256. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11257. if (!last_modified.empty()) {
  11258. res.set_header("Last-Modified", last_modified);
  11259. }
  11260. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11261. check_if_range(req, etag, mtime);
  11262. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11263. if (!mm->is_open()) {
  11264. output_error_log(Error::OpenFile, &req);
  11265. return false;
  11266. }
  11267. res.set_content_provider(
  11268. mm->size(),
  11269. detail::find_content_type(path, file_extension_and_mimetype_map_,
  11270. default_file_mimetype_),
  11271. [mm](size_t offset, size_t length, DataSink &sink) -> bool {
  11272. sink.write(mm->data() + offset, length);
  11273. return true;
  11274. });
  11275. if (req.method != "HEAD" && file_request_handler_) {
  11276. file_request_handler_(req, res);
  11277. }
  11278. return true;
  11279. } else {
  11280. output_error_log(Error::OpenFile, &req);
  11281. }
  11282. }
  11283. }
  11284. }
  11285. return false;
  11286. }
  11287. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11288. const std::string &etag,
  11289. time_t mtime) const {
  11290. // Handle conditional GET:
  11291. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11292. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11293. if (req.has_header("If-None-Match")) {
  11294. if (!etag.empty()) {
  11295. auto val =
  11296. detail::get_combined_header_value(req.headers, "If-None-Match");
  11297. // NOTE: We use exact string matching here. This works correctly
  11298. // because our server always generates weak ETags (W/"..."), and
  11299. // clients typically send back the same ETag they received.
  11300. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11301. // If-None-Match, where W/"x" and "x" would match, but this
  11302. // simplified implementation requires exact matches.
  11303. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11304. [&](const char *b, const char *e) {
  11305. auto seg_len = static_cast<size_t>(e - b);
  11306. return (seg_len == 1 && *b == '*') ||
  11307. (seg_len == etag.size() &&
  11308. std::equal(b, e, etag.begin()));
  11309. });
  11310. if (ret) {
  11311. res.status = StatusCode::NotModified_304;
  11312. return true;
  11313. }
  11314. }
  11315. } else if (req.has_header("If-Modified-Since")) {
  11316. auto val = req.get_header_value("If-Modified-Since");
  11317. auto t = detail::parse_http_date(val);
  11318. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11319. res.status = StatusCode::NotModified_304;
  11320. return true;
  11321. }
  11322. }
  11323. return false;
  11324. }
  11325. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11326. time_t mtime) const {
  11327. // Handle If-Range for partial content requests (RFC 9110
  11328. // Section 13.1.5). If-Range is only evaluated when Range header is
  11329. // present. If the validator matches, serve partial content; otherwise
  11330. // serve full content.
  11331. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11332. auto val = req.get_header_value("If-Range");
  11333. auto is_valid_range = [&]() {
  11334. if (detail::is_strong_etag(val)) {
  11335. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11336. // comparison.
  11337. return (!etag.empty() && val == etag);
  11338. } else if (detail::is_weak_etag(val)) {
  11339. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11340. return false;
  11341. } else {
  11342. // HTTP-date comparison
  11343. auto t = detail::parse_http_date(val);
  11344. return (t != static_cast<time_t>(-1) && mtime <= t);
  11345. }
  11346. };
  11347. if (!is_valid_range()) {
  11348. // Validator doesn't match: ignore Range and serve full content
  11349. req.ranges.clear();
  11350. return false;
  11351. }
  11352. }
  11353. return true;
  11354. }
  11355. inline socket_t
  11356. Server::create_server_socket(const std::string &host, int port,
  11357. int socket_flags,
  11358. SocketOptions socket_options) const {
  11359. return detail::create_socket(
  11360. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11361. ipv6_v6only_, std::move(socket_options),
  11362. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11363. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11364. output_error_log(Error::BindIPAddress, nullptr);
  11365. return false;
  11366. }
  11367. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11368. output_error_log(Error::Listen, nullptr);
  11369. return false;
  11370. }
  11371. return true;
  11372. });
  11373. }
  11374. inline int Server::bind_internal(const std::string &host, int port,
  11375. int socket_flags) {
  11376. if (is_decommissioned) { return -1; }
  11377. if (!is_valid()) { return -1; }
  11378. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11379. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11380. if (port == 0) {
  11381. struct sockaddr_storage addr;
  11382. socklen_t addr_len = sizeof(addr);
  11383. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11384. &addr_len) == -1) {
  11385. output_error_log(Error::GetSockName, nullptr);
  11386. return -1;
  11387. }
  11388. if (addr.ss_family == AF_INET) {
  11389. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11390. } else if (addr.ss_family == AF_INET6) {
  11391. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11392. } else {
  11393. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11394. return -1;
  11395. }
  11396. } else {
  11397. return port;
  11398. }
  11399. }
  11400. inline bool Server::listen_internal() {
  11401. // A stop() between bind and listen leaves nothing to accept on. Report
  11402. // failure instead of returning success without ever serving, and mark the
  11403. // server decommissioned the way any failed listen does so that a concurrent
  11404. // wait_until_ready() wakes up instead of spinning forever.
  11405. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11406. is_decommissioned = true;
  11407. return false;
  11408. }
  11409. auto ret = true;
  11410. is_running_ = true;
  11411. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11412. if (start_handler_) { start_handler_(); }
  11413. {
  11414. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11415. while (svr_sock_ != INVALID_SOCKET) {
  11416. #ifndef _WIN32
  11417. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11418. #endif
  11419. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11420. idle_interval_usec_);
  11421. if (val == 0) { // Timeout
  11422. task_queue->on_idle();
  11423. continue;
  11424. }
  11425. #ifndef _WIN32
  11426. }
  11427. #endif
  11428. #if defined _WIN32
  11429. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11430. // OVERLAPPED
  11431. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11432. #elif defined SOCK_CLOEXEC
  11433. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11434. #else
  11435. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11436. #endif
  11437. if (sock == INVALID_SOCKET) {
  11438. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11439. // touches the CRT errno, so the two have to be asked platform by
  11440. // platform rather than by testing errno here.
  11441. if (detail::is_accept_resource_error()) {
  11442. // The per-process descriptor limit or the network stack's buffer
  11443. // space has been reached. Try to accept new connections after a
  11444. // short sleep.
  11445. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11446. continue;
  11447. } else if (detail::is_accept_transient_error()) {
  11448. continue;
  11449. }
  11450. // Take the descriptor out of svr_sock_ before closing it: a later
  11451. // stop() would otherwise shutdown()/close() a value the OS may have
  11452. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11453. // gone. The exchange also settles the race with a concurrent stop(),
  11454. // since whichever side takes the descriptor closes it exactly once.
  11455. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11456. if (listen_sock != INVALID_SOCKET) {
  11457. detail::close_socket(listen_sock);
  11458. ret = false;
  11459. output_error_log(Error::Connection, nullptr);
  11460. } else {
  11461. ; // The server socket was closed by user.
  11462. }
  11463. break;
  11464. }
  11465. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11466. read_timeout_sec_, read_timeout_usec_);
  11467. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11468. write_timeout_sec_, write_timeout_usec_);
  11469. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11470. if (!task_queue->enqueue(
  11471. [this, sock]() { process_and_close_socket(sock); })) {
  11472. output_error_log(Error::ResourceExhaustion, nullptr);
  11473. detail::shutdown_socket(sock);
  11474. detail::close_socket(sock);
  11475. }
  11476. }
  11477. task_queue->shutdown();
  11478. }
  11479. is_decommissioned = !ret;
  11480. return ret;
  11481. }
  11482. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11483. if (pre_routing_handler_ &&
  11484. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11485. return true;
  11486. }
  11487. // File handler
  11488. if ((req.method == "GET" || req.method == "HEAD") &&
  11489. handle_file_request(req, res)) {
  11490. return true;
  11491. }
  11492. const auto *custom = find_custom_entry(req.method);
  11493. // The second clause mirrors what expect_content() does unconditionally for
  11494. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11495. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11496. // `allprop`) would skip its handler and fall through to 404.
  11497. if (detail::expect_content(req) ||
  11498. (custom && !custom->handlers_for_content_reader.empty())) {
  11499. // Content reader handler
  11500. {
  11501. // Track whether the ContentReader was aborted due to the decompressed
  11502. // payload exceeding `payload_max_length_`.
  11503. // The user handler runs after the lambda returns, so we must restore the
  11504. // 413 status if the handler overwrites it.
  11505. bool content_reader_payload_too_large = false;
  11506. ContentReader reader(
  11507. [&](ContentReceiver receiver) {
  11508. auto result = read_content_with_content_receiver(
  11509. strm, req, res, std::move(receiver), nullptr, nullptr);
  11510. if (!result) {
  11511. output_error_log(Error::Read, &req);
  11512. if (res.status == StatusCode::PayloadTooLarge_413) {
  11513. content_reader_payload_too_large = true;
  11514. }
  11515. }
  11516. return result;
  11517. },
  11518. [&](FormDataHeader header, ContentReceiver receiver) {
  11519. auto result = read_content_with_content_receiver(
  11520. strm, req, res, nullptr, std::move(header),
  11521. std::move(receiver));
  11522. if (!result) {
  11523. output_error_log(Error::Read, &req);
  11524. if (res.status == StatusCode::PayloadTooLarge_413) {
  11525. content_reader_payload_too_large = true;
  11526. }
  11527. }
  11528. return result;
  11529. });
  11530. bool dispatched = false;
  11531. if (req.method == "POST") {
  11532. dispatched = dispatch_request_for_content_reader(
  11533. req, res, std::move(reader), post_handlers_for_content_reader_);
  11534. } else if (req.method == "PUT") {
  11535. dispatched = dispatch_request_for_content_reader(
  11536. req, res, std::move(reader), put_handlers_for_content_reader_);
  11537. } else if (req.method == "PATCH") {
  11538. dispatched = dispatch_request_for_content_reader(
  11539. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11540. } else if (req.method == "DELETE") {
  11541. dispatched = dispatch_request_for_content_reader(
  11542. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11543. } else if (custom) {
  11544. dispatched = dispatch_request_for_content_reader(
  11545. req, res, std::move(reader), custom->handlers_for_content_reader);
  11546. }
  11547. if (dispatched) {
  11548. if (content_reader_payload_too_large) {
  11549. // Enforce the limit: override any status the handler may have set
  11550. // and return false so the error path sends a plain 413 response.
  11551. res.status = StatusCode::PayloadTooLarge_413;
  11552. res.body.clear();
  11553. res.content_length_ = 0;
  11554. res.content_provider_ = nullptr;
  11555. return false;
  11556. }
  11557. return true;
  11558. }
  11559. }
  11560. // NOTE: `req.body` is not read here. For a regular handler the body is
  11561. // read inside dispatch_request(), after the route has matched and the
  11562. // pre-request handler has approved the request, so that a rejected
  11563. // request (e.g. failed authentication) never forces us to buffer a
  11564. // potentially large body.
  11565. }
  11566. // Regular handler
  11567. if (req.method == "GET" || req.method == "HEAD") {
  11568. return dispatch_request(req, res, get_handlers_, strm);
  11569. } else if (req.method == "POST") {
  11570. return dispatch_request(req, res, post_handlers_, strm);
  11571. } else if (req.method == "PUT") {
  11572. return dispatch_request(req, res, put_handlers_, strm);
  11573. } else if (req.method == "DELETE") {
  11574. return dispatch_request(req, res, delete_handlers_, strm);
  11575. } else if (req.method == "OPTIONS") {
  11576. return dispatch_request(req, res, options_handlers_, strm);
  11577. } else if (req.method == "PATCH") {
  11578. return dispatch_request(req, res, patch_handlers_, strm);
  11579. } else if (custom) {
  11580. return dispatch_request(req, res, custom->handlers, strm);
  11581. }
  11582. res.status = StatusCode::BadRequest_400;
  11583. return false;
  11584. }
  11585. inline bool Server::dispatch_request(Request &req, Response &res,
  11586. const Handlers &handlers, Stream &strm) {
  11587. for (const auto &x : handlers) {
  11588. const auto &matcher = x.first;
  11589. const auto &handler = x.second;
  11590. if (matcher->match(req)) {
  11591. req.matched_route = matcher->pattern();
  11592. // Run the pre-request handler before reading the body so a rejected
  11593. // request (e.g. failed authentication) never forces us to buffer a
  11594. // potentially large body. `req.matched_route` is available here.
  11595. if (pre_request_handler_ &&
  11596. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11597. return true;
  11598. }
  11599. // The route matched and the request was approved; read the body now.
  11600. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11601. output_error_log(Error::Read, &req);
  11602. return false;
  11603. }
  11604. handler(req, res);
  11605. return true;
  11606. }
  11607. }
  11608. return false;
  11609. }
  11610. inline void Server::apply_ranges(const Request &req, Response &res,
  11611. std::string &content_type,
  11612. std::string &boundary) const {
  11613. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  11614. auto it = res.headers.find("Content-Type");
  11615. if (it != res.headers.end()) {
  11616. content_type = it->second;
  11617. res.headers.erase(it);
  11618. }
  11619. boundary = detail::make_multipart_data_boundary();
  11620. res.set_header("Content-Type",
  11621. "multipart/byteranges; boundary=" + boundary);
  11622. }
  11623. auto type = detail::encoding_type(req, res);
  11624. if (res.body.empty()) {
  11625. if (res.content_length_ > 0) {
  11626. size_t length = 0;
  11627. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11628. length = res.content_length_;
  11629. } else if (req.ranges.size() == 1) {
  11630. auto offset_and_length = detail::get_range_offset_and_length(
  11631. req.ranges[0], res.content_length_);
  11632. length = offset_and_length.second;
  11633. auto content_range = detail::make_content_range_header_field(
  11634. offset_and_length, res.content_length_);
  11635. res.set_header("Content-Range", content_range);
  11636. } else {
  11637. length = detail::get_multipart_ranges_data_length(
  11638. req, boundary, content_type, res.content_length_);
  11639. }
  11640. res.set_header("Content-Length", std::to_string(length));
  11641. } else {
  11642. if (res.content_provider_) {
  11643. if (res.is_chunked_content_provider_) {
  11644. res.set_header("Transfer-Encoding", "chunked");
  11645. if (type != detail::EncodingType::None) {
  11646. res.set_header("Content-Encoding", detail::encoding_name(type));
  11647. res.set_header("Vary", "Accept-Encoding");
  11648. }
  11649. }
  11650. }
  11651. }
  11652. } else {
  11653. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11654. ;
  11655. } else if (req.ranges.size() == 1) {
  11656. auto offset_and_length =
  11657. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  11658. auto offset = offset_and_length.first;
  11659. auto length = offset_and_length.second;
  11660. auto content_range = detail::make_content_range_header_field(
  11661. offset_and_length, res.body.size());
  11662. res.set_header("Content-Range", content_range);
  11663. assert(offset + length <= res.body.size());
  11664. res.body = res.body.substr(offset, length);
  11665. } else {
  11666. std::string data;
  11667. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  11668. res.body.size(), data);
  11669. res.body.swap(data);
  11670. }
  11671. if (type != detail::EncodingType::None) {
  11672. output_pre_compression_log(req, res);
  11673. if (auto compressor = detail::make_compressor(type)) {
  11674. std::string compressed;
  11675. if (compressor->compress(res.body.data(), res.body.size(), true,
  11676. [&](const char *data, size_t data_len) {
  11677. compressed.append(data, data_len);
  11678. return true;
  11679. })) {
  11680. res.body.swap(compressed);
  11681. res.set_header("Content-Encoding", detail::encoding_name(type));
  11682. res.set_header("Vary", "Accept-Encoding");
  11683. }
  11684. }
  11685. }
  11686. res.content_length_ = res.body.size();
  11687. res.set_header("Content-Length", std::to_string(res.content_length_));
  11688. }
  11689. }
  11690. inline bool Server::dispatch_request_for_content_reader(
  11691. Request &req, Response &res, ContentReader content_reader,
  11692. const HandlersForContentReader &handlers) const {
  11693. for (const auto &x : handlers) {
  11694. const auto &matcher = x.first;
  11695. const auto &handler = x.second;
  11696. if (matcher->match(req)) {
  11697. req.matched_route = matcher->pattern();
  11698. if (!pre_request_handler_ ||
  11699. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  11700. handler(req, res, content_reader);
  11701. }
  11702. return true;
  11703. }
  11704. }
  11705. return false;
  11706. }
  11707. inline std::string
  11708. get_client_ip(const std::string &x_forwarded_for,
  11709. const std::vector<std::string> &trusted_proxies) {
  11710. // X-Forwarded-For is a comma-separated list per RFC 7239
  11711. std::vector<std::string> ip_list;
  11712. detail::split(x_forwarded_for.data(),
  11713. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  11714. [&](const char *b, const char *e) {
  11715. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  11716. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  11717. });
  11718. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  11719. // no segments. Signal "no client IP derived" with an empty string so the
  11720. // caller can fall back to the connection-level remote address.
  11721. if (ip_list.empty()) { return std::string(); }
  11722. // Each hop appends the address it received the request from, so the rightmost
  11723. // entries are the ones written by our own infrastructure while the leftmost
  11724. // are whatever the original client chose to send. Walk from the right and
  11725. // skip trusted proxies; the first address that is not a trusted proxy is the
  11726. // furthest point still attributable to a real hop, i.e. the client. Scanning
  11727. // from the left instead lets a client forge an arbitrary address by following
  11728. // it with a trusted proxy's address, which the left-to-right scan then
  11729. // returned as the client.
  11730. for (size_t i = ip_list.size(); i-- > 0;) {
  11731. const auto &ip = ip_list[i];
  11732. auto is_trusted_proxy =
  11733. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  11734. [&](const std::string &proxy) { return ip == proxy; });
  11735. if (!is_trusted_proxy) { return ip; }
  11736. }
  11737. // Every hop was a trusted proxy; fall back to the first entry.
  11738. return ip_list.front();
  11739. }
  11740. inline bool
  11741. Server::process_request(Stream &strm, const std::string &remote_addr,
  11742. int remote_port, const std::string &local_addr,
  11743. int local_port, bool close_connection,
  11744. bool &connection_closed,
  11745. const std::function<void(Request &)> &setup_request,
  11746. bool *websocket_upgraded) {
  11747. std::array<char, 2048> buf{};
  11748. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  11749. // Connection has been closed on client
  11750. if (!line_reader.getline()) { return false; }
  11751. Request req;
  11752. req.start_time_ = std::chrono::steady_clock::now();
  11753. req.remote_addr = remote_addr;
  11754. req.remote_port = remote_port;
  11755. req.local_addr = local_addr;
  11756. req.local_port = local_port;
  11757. Response res;
  11758. res.version = "HTTP/1.1";
  11759. res.headers = default_headers_;
  11760. // Request line and headers
  11761. if (!parse_request_line(line_reader.ptr(), req)) {
  11762. res.status = StatusCode::BadRequest_400;
  11763. output_error_log(Error::InvalidRequestLine, &req);
  11764. return write_response(strm, close_connection, req, res);
  11765. }
  11766. // Request headers
  11767. if (!detail::read_headers(strm, req.headers)) {
  11768. res.status = StatusCode::BadRequest_400;
  11769. output_error_log(Error::InvalidHeaders, &req);
  11770. return write_response(strm, close_connection, req, res);
  11771. }
  11772. // RFC 9112 §6.3: Reject requests whose framing is ambiguous, which would
  11773. // otherwise let an intermediary and this parser disagree on where the body
  11774. // ends and enable request smuggling. Two cases: a non-zero Content-Length
  11775. // alongside any Transfer-Encoding (Content-Length: 0 is tolerated for
  11776. // compatibility with existing clients), and a Transfer-Encoding whose final
  11777. // coding is not chunked, which leaves the body length undeterminable. The
  11778. // latter must not fall through to the "no body" path, or the body bytes are
  11779. // parsed as the next request on a persistent connection.
  11780. if (req.has_header("Transfer-Encoding") &&
  11781. (req.get_header_value_u64("Content-Length") > 0 ||
  11782. !detail::is_chunked_transfer_encoding(req.headers))) {
  11783. connection_closed = true;
  11784. res.status = StatusCode::BadRequest_400;
  11785. return write_response(strm, close_connection, req, res);
  11786. }
  11787. // Check if the request URI doesn't exceed the limit
  11788. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  11789. connection_closed = true;
  11790. res.status = StatusCode::UriTooLong_414;
  11791. output_error_log(Error::ExceedUriMaxLength, &req);
  11792. return write_response(strm, close_connection, req, res);
  11793. }
  11794. if (detail::has_header_token(req.headers, "Connection", "close")) {
  11795. connection_closed = true;
  11796. }
  11797. if (req.version == "HTTP/1.0" &&
  11798. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  11799. connection_closed = true;
  11800. }
  11801. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  11802. // itself a trusted proxy. Otherwise any direct client could spoof
  11803. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  11804. auto is_trusted_peer = std::any_of(
  11805. trusted_proxies_.begin(), trusted_proxies_.end(),
  11806. [&](const std::string &proxy) { return proxy == remote_addr; });
  11807. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  11808. // Some proxies append the address they observed as a separate
  11809. // X-Forwarded-For field line instead of extending the one the client sent
  11810. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  11811. // be scanned. Reading only the first occurrence would hand back the
  11812. // client-supplied, and therefore forgeable, value.
  11813. auto x_forwarded_for =
  11814. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  11815. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  11816. req.remote_addr = derived.empty() ? remote_addr : derived;
  11817. } else {
  11818. req.remote_addr = remote_addr;
  11819. }
  11820. req.remote_port = remote_port;
  11821. req.local_addr = local_addr;
  11822. req.local_port = local_port;
  11823. if (req.has_header("Accept")) {
  11824. auto accept_header =
  11825. detail::get_combined_header_value(req.headers, "Accept");
  11826. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  11827. connection_closed = true;
  11828. res.status = StatusCode::BadRequest_400;
  11829. output_error_log(Error::HTTPParsing, &req);
  11830. return write_response(strm, close_connection, req, res);
  11831. }
  11832. }
  11833. if (req.has_header("Range")) {
  11834. const auto &range_header_value = req.get_header_value("Range");
  11835. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  11836. connection_closed = true;
  11837. res.status = StatusCode::RangeNotSatisfiable_416;
  11838. output_error_log(Error::InvalidRangeHeader, &req);
  11839. return write_response(strm, close_connection, req, res);
  11840. }
  11841. }
  11842. if (setup_request) { setup_request(req); }
  11843. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  11844. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  11845. // must be ignored. An expectation we do not recognize is left alone; the
  11846. // 417 the section allows for one is a MAY, not a requirement.
  11847. if (req.version != "HTTP/1.0" &&
  11848. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  11849. int status = StatusCode::Continue_100;
  11850. if (expect_100_continue_handler_) {
  11851. status = expect_100_continue_handler_(req, res);
  11852. }
  11853. switch (status) {
  11854. case StatusCode::Continue_100:
  11855. case StatusCode::ExpectationFailed_417:
  11856. detail::write_response_line(strm, status);
  11857. strm.write("\r\n");
  11858. break;
  11859. default:
  11860. connection_closed = true;
  11861. return write_response(strm, true, req, res);
  11862. }
  11863. }
  11864. // Setup `is_connection_closed` method
  11865. auto sock = strm.socket();
  11866. req.is_connection_closed = [sock]() {
  11867. return !detail::is_socket_alive(sock);
  11868. };
  11869. // WebSocket upgrade
  11870. // Check pre_routing_handler_ before upgrading so that authentication
  11871. // and other middleware can reject the request with an HTTP response
  11872. // (e.g., 401) before the protocol switches.
  11873. if (detail::is_websocket_upgrade(req)) {
  11874. if (pre_routing_handler_ &&
  11875. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11876. if (res.status == -1) { res.status = StatusCode::OK_200; }
  11877. return write_response(strm, close_connection, req, res);
  11878. }
  11879. // Find matching WebSocket handler
  11880. for (const auto &entry : websocket_handlers_) {
  11881. if (entry.matcher->match(req)) {
  11882. // Compute accept key
  11883. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  11884. auto accept_key = detail::websocket_accept_key(client_key);
  11885. // Negotiate subprotocol
  11886. std::string selected_subprotocol;
  11887. if (entry.sub_protocol_selector) {
  11888. auto protocol_header = detail::get_combined_header_value(
  11889. req.headers, "Sec-WebSocket-Protocol");
  11890. if (!protocol_header.empty()) {
  11891. std::vector<std::string> protocols;
  11892. detail::split(protocol_header.data(),
  11893. protocol_header.data() + protocol_header.size(), ',',
  11894. [&](const char *b, const char *e) {
  11895. protocols.emplace_back(b, e);
  11896. });
  11897. selected_subprotocol = entry.sub_protocol_selector(protocols);
  11898. }
  11899. }
  11900. // Send 101 Switching Protocols
  11901. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  11902. "Upgrade: websocket\r\n"
  11903. "Connection: Upgrade\r\n"
  11904. "Sec-WebSocket-Accept: " +
  11905. accept_key + "\r\n";
  11906. if (!selected_subprotocol.empty()) {
  11907. if (!detail::fields::is_field_value(selected_subprotocol)) {
  11908. return false;
  11909. }
  11910. handshake_response +=
  11911. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  11912. }
  11913. handshake_response += "\r\n";
  11914. if (strm.write(handshake_response.data(), handshake_response.size()) <
  11915. 0) {
  11916. return false;
  11917. }
  11918. connection_closed = true;
  11919. if (websocket_upgraded) { *websocket_upgraded = true; }
  11920. {
  11921. #ifdef CPPHTTPLIB_SSL_ENABLED
  11922. if (req.ssl) {
  11923. // wss: the heartbeat ping thread and the read path enter the same
  11924. // TLS session from different threads. Hand the WebSocket a stream
  11925. // that serializes every TLS call, so the shared SSLSocketStream on
  11926. // the plain HTTP/HTTPS paths stays untouched.
  11927. auto ws_strm =
  11928. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  11929. strm.socket(), const_cast<tls::session_t>(req.ssl),
  11930. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND, 0,
  11931. write_timeout_sec_, write_timeout_usec_));
  11932. ws::WebSocket ws(std::move(ws_strm), req, true,
  11933. websocket_ping_interval_sec_,
  11934. websocket_max_missed_pongs_);
  11935. entry.handler(req, ws);
  11936. return true;
  11937. }
  11938. #endif
  11939. // Use WebSocket-specific read timeout instead of HTTP timeout
  11940. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND, 0);
  11941. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  11942. websocket_max_missed_pongs_);
  11943. entry.handler(req, ws);
  11944. }
  11945. return true;
  11946. }
  11947. }
  11948. // No matching handler - fall through to 404
  11949. }
  11950. // Routing
  11951. auto routed = false;
  11952. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  11953. routed = routing(req, res, strm);
  11954. #else
  11955. try {
  11956. routed = routing(req, res, strm);
  11957. } catch (std::exception &) {
  11958. if (exception_handler_) {
  11959. auto ep = std::current_exception();
  11960. exception_handler_(req, res, ep);
  11961. routed = true;
  11962. } else {
  11963. res.status = StatusCode::InternalServerError_500;
  11964. }
  11965. } catch (...) {
  11966. if (exception_handler_) {
  11967. auto ep = std::current_exception();
  11968. exception_handler_(req, res, ep);
  11969. routed = true;
  11970. } else {
  11971. res.status = StatusCode::InternalServerError_500;
  11972. }
  11973. }
  11974. #endif
  11975. auto ret = false;
  11976. if (routed) {
  11977. if (res.status == -1) {
  11978. res.status = req.ranges.empty() ? StatusCode::OK_200
  11979. : StatusCode::PartialContent_206;
  11980. }
  11981. // Serve file content by using a content provider
  11982. auto file_open_error = false;
  11983. if (!res.file_content_path_.empty()) {
  11984. const auto &path = res.file_content_path_;
  11985. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11986. if (!mm->is_open()) {
  11987. res.body.clear();
  11988. res.content_length_ = 0;
  11989. res.content_provider_ = nullptr;
  11990. res.status = StatusCode::NotFound_404;
  11991. output_error_log(Error::OpenFile, &req);
  11992. file_open_error = true;
  11993. } else {
  11994. auto content_type = res.file_content_content_type_;
  11995. if (content_type.empty()) {
  11996. content_type = detail::find_content_type(
  11997. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11998. }
  11999. res.set_content_provider(
  12000. mm->size(), content_type,
  12001. [mm](size_t offset, size_t length, DataSink &sink) -> bool {
  12002. sink.write(mm->data() + offset, length);
  12003. return true;
  12004. });
  12005. }
  12006. }
  12007. if (file_open_error) {
  12008. ret = write_response(strm, close_connection, req, res);
  12009. } else if (detail::range_error(req, res)) {
  12010. res.body.clear();
  12011. res.content_length_ = 0;
  12012. res.content_provider_ = nullptr;
  12013. res.status = StatusCode::RangeNotSatisfiable_416;
  12014. ret = write_response(strm, close_connection, req, res);
  12015. } else {
  12016. ret = write_response_with_content(strm, close_connection, req, res);
  12017. }
  12018. } else {
  12019. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12020. ret = write_response(strm, close_connection, req, res);
  12021. }
  12022. // Drain any unconsumed framed body to prevent request smuggling on
  12023. // keep-alive. Without framing there is no body to drain — reading would
  12024. // consume the next request (issue #2450). If the response has committed the
  12025. // connection to close, there is no next request to protect.
  12026. if (!req.body_consumed_ && detail::has_framed_body(req)) {
  12027. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12028. connection_closed = true;
  12029. } else {
  12030. int dummy_status;
  12031. if (!detail::read_content(
  12032. strm, req, payload_max_length_, dummy_status, nullptr,
  12033. [](const char *, size_t, size_t, size_t) { return true; },
  12034. false)) {
  12035. connection_closed = true;
  12036. }
  12037. }
  12038. }
  12039. return ret;
  12040. }
  12041. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12042. inline bool Server::process_and_close_socket(socket_t sock) {
  12043. std::string remote_addr;
  12044. int remote_port = 0;
  12045. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12046. std::string local_addr;
  12047. int local_port = 0;
  12048. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12049. bool websocket_upgraded = false;
  12050. auto ret = serve_guarded([&]() {
  12051. return detail::process_server_socket(
  12052. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12053. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12054. write_timeout_usec_,
  12055. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12056. return process_request(strm, remote_addr, remote_port, local_addr,
  12057. local_port, close_connection,
  12058. connection_closed, nullptr,
  12059. &websocket_upgraded);
  12060. });
  12061. });
  12062. detail::drain_and_close_socket(sock);
  12063. return ret;
  12064. }
  12065. inline void Server::output_log(const Request &req, const Response &res) const {
  12066. if (logger_) {
  12067. std::lock_guard<std::mutex> guard(logger_mutex_);
  12068. logger_(req, res);
  12069. }
  12070. }
  12071. inline void Server::output_pre_compression_log(const Request &req,
  12072. const Response &res) const {
  12073. if (pre_compression_logger_) {
  12074. std::lock_guard<std::mutex> guard(logger_mutex_);
  12075. pre_compression_logger_(req, res);
  12076. }
  12077. }
  12078. inline void Server::output_error_log(const Error &err,
  12079. const Request *req) const {
  12080. if (error_logger_) {
  12081. std::lock_guard<std::mutex> guard(logger_mutex_);
  12082. error_logger_(err, req);
  12083. }
  12084. }
  12085. /*
  12086. * Group 5: ClientImpl and Client (Universal) implementation
  12087. */
  12088. // HTTP client implementation
  12089. inline ClientImpl::ClientImpl(const std::string &host)
  12090. : ClientImpl(host, 80, std::string(), std::string()) {}
  12091. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12092. : ClientImpl(host, port, std::string(), std::string()) {}
  12093. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12094. const std::string &client_cert_path,
  12095. const std::string &client_key_path)
  12096. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12097. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12098. inline ClientImpl::~ClientImpl() {
  12099. // Wait until all the requests in flight are handled.
  12100. size_t retry_count = 10;
  12101. while (retry_count-- > 0) {
  12102. {
  12103. std::lock_guard<std::mutex> guard(socket_mutex_);
  12104. if (socket_requests_in_flight_ == 0) { break; }
  12105. }
  12106. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12107. }
  12108. std::lock_guard<std::mutex> guard(socket_mutex_);
  12109. shutdown_socket(socket_);
  12110. close_socket(socket_);
  12111. }
  12112. inline bool ClientImpl::is_valid() const { return true; }
  12113. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12114. client_cert_path_ = rhs.client_cert_path_;
  12115. client_key_path_ = rhs.client_key_path_;
  12116. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12117. read_timeout_sec_ = rhs.read_timeout_sec_;
  12118. read_timeout_usec_ = rhs.read_timeout_usec_;
  12119. write_timeout_sec_ = rhs.write_timeout_sec_;
  12120. write_timeout_usec_ = rhs.write_timeout_usec_;
  12121. max_timeout_msec_ = rhs.max_timeout_msec_;
  12122. basic_auth_username_ = rhs.basic_auth_username_;
  12123. basic_auth_password_ = rhs.basic_auth_password_;
  12124. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12125. keep_alive_ = rhs.keep_alive_;
  12126. follow_location_ = rhs.follow_location_;
  12127. path_encode_ = rhs.path_encode_;
  12128. address_family_ = rhs.address_family_;
  12129. tcp_nodelay_ = rhs.tcp_nodelay_;
  12130. ipv6_v6only_ = rhs.ipv6_v6only_;
  12131. socket_options_ = rhs.socket_options_;
  12132. compress_ = rhs.compress_;
  12133. decompress_ = rhs.decompress_;
  12134. payload_max_length_ = rhs.payload_max_length_;
  12135. has_payload_max_length_ = rhs.has_payload_max_length_;
  12136. interface_ = rhs.interface_;
  12137. proxy_host_ = rhs.proxy_host_;
  12138. proxy_port_ = rhs.proxy_port_;
  12139. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12140. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12141. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12142. no_proxy_entries_ = rhs.no_proxy_entries_;
  12143. logger_ = rhs.logger_;
  12144. error_logger_ = rhs.error_logger_;
  12145. #ifdef CPPHTTPLIB_SSL_ENABLED
  12146. digest_auth_username_ = rhs.digest_auth_username_;
  12147. digest_auth_password_ = rhs.digest_auth_password_;
  12148. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12149. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12150. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12151. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12152. server_certificate_verification_ = rhs.server_certificate_verification_;
  12153. server_hostname_verification_ = rhs.server_hostname_verification_;
  12154. system_ca_mode_ = rhs.system_ca_mode_;
  12155. #endif
  12156. }
  12157. inline bool
  12158. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12159. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12160. if (no_proxy_entries_.empty()) { return true; }
  12161. // host_ is const so its normalized form is invariant; cache it. The
  12162. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12163. if (host == host_) {
  12164. if (!host_normalized_valid_) {
  12165. host_normalized_ = detail::normalize_target(host_);
  12166. host_normalized_valid_ = true;
  12167. }
  12168. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12169. }
  12170. auto target = detail::normalize_target(host);
  12171. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12172. }
  12173. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12174. if (is_proxy_enabled_for_host(host_)) {
  12175. return detail::create_client_socket(
  12176. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12177. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12178. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12179. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12180. }
  12181. // Check is custom IP or hostname specified for host_
  12182. std::string connect_host;
  12183. std::string ip;
  12184. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12185. return detail::create_client_socket(
  12186. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12187. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12188. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12189. write_timeout_usec_, interface_, error);
  12190. }
  12191. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12192. Error &error) {
  12193. auto sock = create_client_socket(error);
  12194. if (sock == INVALID_SOCKET) { return false; }
  12195. socket.sock = sock;
  12196. return true;
  12197. }
  12198. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12199. return create_and_connect_socket(socket, error);
  12200. }
  12201. inline bool ClientImpl::setup_proxy_connection(
  12202. Socket & /*socket*/,
  12203. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12204. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12205. return true;
  12206. }
  12207. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12208. bool /*shutdown_gracefully*/) {
  12209. // If there are any requests in flight from threads other than us, then it's
  12210. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12211. assert(socket_requests_in_flight_ == 0 ||
  12212. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12213. }
  12214. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12215. if (socket.sock == INVALID_SOCKET) { return; }
  12216. detail::shutdown_socket(socket.sock);
  12217. }
  12218. inline void ClientImpl::close_socket(Socket &socket) {
  12219. // If there are requests in flight in another thread, usually closing
  12220. // the socket will be fine and they will simply receive an error when
  12221. // using the closed socket, but it is still a bug since rarely the OS
  12222. // may reassign the socket id to be used for a new socket, and then
  12223. // suddenly they will be operating on a live socket that is different
  12224. // than the one they intended!
  12225. assert(socket_requests_in_flight_ == 0 ||
  12226. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12227. // It is also a bug if this happens while SSL is still active
  12228. #ifdef CPPHTTPLIB_SSL_ENABLED
  12229. assert(socket.ssl == nullptr);
  12230. #endif
  12231. if (socket.sock == INVALID_SOCKET) { return; }
  12232. detail::close_socket(socket.sock);
  12233. socket.sock = INVALID_SOCKET;
  12234. }
  12235. inline void ClientImpl::disconnect(bool gracefully) {
  12236. shutdown_ssl(socket_, gracefully);
  12237. shutdown_socket(socket_);
  12238. close_socket(socket_);
  12239. }
  12240. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12241. Response &res,
  12242. bool skip_100_continue) const {
  12243. std::array<char, 2048> buf{};
  12244. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12245. if (!line_reader.getline()) { return false; }
  12246. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12247. res.reason)) {
  12248. return req.method == "CONNECT";
  12249. }
  12250. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12251. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12252. if (!line_reader.getline()) { return false; } // CRLF
  12253. if (!line_reader.getline()) { return false; } // next response line
  12254. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12255. res.reason)) {
  12256. return false;
  12257. }
  12258. }
  12259. return true;
  12260. }
  12261. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12262. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12263. auto ret = send_(req, res, error);
  12264. if (error == Error::SSLPeerCouldBeClosed_) {
  12265. assert(!ret);
  12266. ret = send_(req, res, error);
  12267. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12268. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12269. }
  12270. return ret;
  12271. }
  12272. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12273. {
  12274. std::lock_guard<std::mutex> guard(socket_mutex_);
  12275. // Set this to false immediately - if it ever gets set to true by the end
  12276. // of the request, we know another thread instructed us to close the
  12277. // socket.
  12278. socket_should_be_closed_when_request_is_done_ = false;
  12279. auto is_alive = false;
  12280. if (socket_.is_open()) {
  12281. is_alive = detail::is_socket_alive(socket_.sock);
  12282. #ifdef CPPHTTPLIB_SSL_ENABLED
  12283. if (is_alive && is_ssl()) {
  12284. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12285. is_alive = false;
  12286. }
  12287. }
  12288. #endif
  12289. if (!is_alive) {
  12290. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12291. disconnect(/*gracefully=*/false);
  12292. }
  12293. }
  12294. if (!is_alive) {
  12295. if (!ensure_socket_connection(socket_, error)) {
  12296. output_error_log(error, &req);
  12297. return false;
  12298. }
  12299. {
  12300. auto success = true;
  12301. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12302. error)) {
  12303. if (!success) { output_error_log(error, &req); }
  12304. return success;
  12305. }
  12306. }
  12307. }
  12308. // Mark the current socket as being in use so that it cannot be closed by
  12309. // anyone else while this request is ongoing, even though we will be
  12310. // releasing the mutex.
  12311. if (socket_requests_in_flight_ > 1) {
  12312. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12313. }
  12314. socket_requests_in_flight_ += 1;
  12315. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12316. }
  12317. for (const auto &header : default_headers_) {
  12318. if (req.headers.find(header.first) == req.headers.end()) {
  12319. req.headers.insert(header);
  12320. }
  12321. }
  12322. auto ret = false;
  12323. auto close_connection = !keep_alive_;
  12324. auto se = detail::scope_exit([&]() {
  12325. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12326. std::lock_guard<std::mutex> guard(socket_mutex_);
  12327. socket_requests_in_flight_ -= 1;
  12328. if (socket_requests_in_flight_ <= 0) {
  12329. assert(socket_requests_in_flight_ == 0);
  12330. socket_requests_are_from_thread_ = std::thread::id();
  12331. }
  12332. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12333. !ret) {
  12334. disconnect(/*gracefully=*/true);
  12335. }
  12336. });
  12337. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12338. return handle_request(strm, req, res, close_connection, error);
  12339. });
  12340. if (!ret) {
  12341. if (error == Error::Success) {
  12342. error = Error::Unknown;
  12343. output_error_log(error, &req);
  12344. }
  12345. }
  12346. return ret;
  12347. }
  12348. inline Result ClientImpl::send(const Request &req) {
  12349. auto req2 = req;
  12350. return send_(std::move(req2));
  12351. }
  12352. inline Result ClientImpl::send_(Request &&req) {
  12353. auto res = detail::make_unique<Response>();
  12354. auto error = Error::Success;
  12355. auto ret = send(req, *res, error);
  12356. #ifdef CPPHTTPLIB_SSL_ENABLED
  12357. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12358. last_ssl_error_, last_backend_error_};
  12359. #else
  12360. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12361. #endif
  12362. }
  12363. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12364. const std::string &ct) {
  12365. (void)for_stream;
  12366. for (const auto &header : default_headers_) {
  12367. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12368. }
  12369. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12370. // prepend it rather than appending it after the caller's own fields.
  12371. if (!r.has_header("Host")) {
  12372. r.headers.emplace_front(
  12373. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12374. address_family_));
  12375. }
  12376. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12377. if (!r.content_receiver) {
  12378. if (!r.has_header("Accept-Encoding")) {
  12379. std::string accept_encoding;
  12380. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12381. accept_encoding = "br";
  12382. #endif
  12383. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12384. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12385. accept_encoding += "gzip, deflate";
  12386. #endif
  12387. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12388. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12389. accept_encoding += "zstd";
  12390. #endif
  12391. r.set_header("Accept-Encoding", accept_encoding);
  12392. }
  12393. detail::add_default_user_agent_header(r);
  12394. }
  12395. if (!r.body.empty()) {
  12396. if (!ct.empty() && !r.has_header("Content-Type")) {
  12397. r.headers.emplace("Content-Type", ct);
  12398. }
  12399. if (!r.has_header("Content-Length")) {
  12400. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12401. }
  12402. }
  12403. }
  12404. inline ClientImpl::StreamHandle
  12405. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12406. const Params &params, const Headers &headers,
  12407. const std::string &body,
  12408. const std::string &content_type) {
  12409. StreamHandle handle;
  12410. handle.response = detail::make_unique<Response>();
  12411. handle.error = Error::Success;
  12412. // Encode the target exactly like the buffered send path does, so that the
  12413. // same `path` produces the same request line through either API.
  12414. auto raw_query_path =
  12415. params.empty() ? path : append_query_params(path, params);
  12416. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12417. handle.connection_ = detail::make_unique<ClientConnection>();
  12418. {
  12419. std::lock_guard<std::mutex> guard(socket_mutex_);
  12420. auto is_alive = false;
  12421. if (socket_.is_open()) {
  12422. is_alive = detail::is_socket_alive(socket_.sock);
  12423. #ifdef CPPHTTPLIB_SSL_ENABLED
  12424. if (is_alive && is_ssl()) {
  12425. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12426. is_alive = false;
  12427. }
  12428. }
  12429. #endif
  12430. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12431. }
  12432. if (!is_alive) {
  12433. if (!ensure_socket_connection(socket_, handle.error)) {
  12434. handle.response.reset();
  12435. return handle;
  12436. }
  12437. {
  12438. auto success = true;
  12439. auto start_time = std::chrono::steady_clock::now();
  12440. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12441. success, handle.error)) {
  12442. if (!success) { handle.response.reset(); }
  12443. return handle;
  12444. }
  12445. }
  12446. }
  12447. transfer_socket_ownership_to_handle(handle);
  12448. }
  12449. #ifdef CPPHTTPLIB_SSL_ENABLED
  12450. if (is_ssl() && handle.connection_->session) {
  12451. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12452. handle.connection_->sock, handle.connection_->session,
  12453. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12454. write_timeout_usec_);
  12455. } else {
  12456. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12457. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12458. write_timeout_sec_, write_timeout_usec_);
  12459. }
  12460. #else
  12461. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12462. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12463. write_timeout_sec_, write_timeout_usec_);
  12464. #endif
  12465. handle.stream_ = handle.socket_stream_.get();
  12466. Request req;
  12467. req.method = method;
  12468. req.path = query_path;
  12469. req.headers = headers;
  12470. req.body = body;
  12471. prepare_default_headers(req, true, content_type);
  12472. auto &strm = *handle.stream_;
  12473. if (detail::write_request_line(strm, req.method, req.path) < 0) {
  12474. handle.error = Error::Write;
  12475. handle.response.reset();
  12476. return handle;
  12477. }
  12478. if (!detail::check_and_write_headers(strm, req.headers, header_writer_,
  12479. handle.error)) {
  12480. handle.response.reset();
  12481. return handle;
  12482. }
  12483. if (!body.empty()) {
  12484. if (strm.write(body.data(), body.size()) < 0) {
  12485. handle.error = Error::Write;
  12486. handle.response.reset();
  12487. return handle;
  12488. }
  12489. }
  12490. if (!read_response_line(strm, req, *handle.response) ||
  12491. !detail::read_headers(strm, handle.response->headers)) {
  12492. handle.error = Error::Read;
  12493. handle.response.reset();
  12494. return handle;
  12495. }
  12496. handle.body_reader_.stream = handle.stream_;
  12497. handle.body_reader_.payload_max_length = payload_max_length_;
  12498. if (handle.response->has_header("Content-Length")) {
  12499. bool is_invalid = false;
  12500. auto content_length = detail::get_header_value_u64(
  12501. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12502. if (is_invalid) {
  12503. handle.error = Error::Read;
  12504. handle.response.reset();
  12505. return handle;
  12506. }
  12507. handle.body_reader_.has_content_length = true;
  12508. handle.body_reader_.content_length = content_length;
  12509. }
  12510. handle.body_reader_.chunked =
  12511. detail::is_chunked_transfer_encoding(handle.response->headers);
  12512. auto content_encoding = detail::get_combined_header_value(
  12513. handle.response->headers, "Content-Encoding");
  12514. if (!content_encoding.empty()) {
  12515. // Same policy as prepare_content_receiver(): reject a coding we know about
  12516. // but were not built with, pass an unrecognized one through as-is.
  12517. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12518. if (!handle.decompressor_) {
  12519. if (detail::is_known_content_encoding(content_encoding)) {
  12520. handle.error = Error::UnsupportedContentEncoding;
  12521. handle.response.reset();
  12522. return handle;
  12523. }
  12524. } else if (!handle.decompressor_->is_valid()) {
  12525. handle.error = Error::Compression;
  12526. handle.response.reset();
  12527. return handle;
  12528. }
  12529. }
  12530. return handle;
  12531. }
  12532. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  12533. if (!is_valid() || !response) { return -1; }
  12534. if (decompressor_) { return read_with_decompression(buf, len); }
  12535. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  12536. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  12537. trailers_parsed_ = true;
  12538. if (body_reader_.chunked_decoder) {
  12539. if (!body_reader_.chunked_decoder->parse_trailers_into(
  12540. response->trailers, response->headers)) {
  12541. return n;
  12542. }
  12543. } else {
  12544. detail::ChunkedDecoder dec(*stream_);
  12545. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  12546. return n;
  12547. }
  12548. }
  12549. }
  12550. return n;
  12551. }
  12552. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  12553. size_t len) {
  12554. if (decompress_offset_ < decompress_buffer_.size()) {
  12555. auto available = decompress_buffer_.size() - decompress_offset_;
  12556. auto to_copy = (std::min)(len, available);
  12557. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  12558. decompress_offset_ += to_copy;
  12559. decompressed_bytes_read_ += to_copy;
  12560. return static_cast<ssize_t>(to_copy);
  12561. }
  12562. decompress_buffer_.clear();
  12563. decompress_offset_ = 0;
  12564. constexpr size_t kDecompressionBufferSize = 8192;
  12565. char compressed_buf[kDecompressionBufferSize];
  12566. while (true) {
  12567. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  12568. sizeof(compressed_buf));
  12569. if (n <= 0) { return n; }
  12570. bool decompress_ok = decompressor_->decompress(
  12571. compressed_buf, static_cast<size_t>(n),
  12572. [this](const char *data, size_t data_len) {
  12573. decompress_buffer_.append(data, data_len);
  12574. auto limit = body_reader_.payload_max_length;
  12575. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  12576. return false;
  12577. }
  12578. return true;
  12579. });
  12580. if (!decompress_ok) {
  12581. body_reader_.last_error = Error::Read;
  12582. return -1;
  12583. }
  12584. if (!decompress_buffer_.empty()) { break; }
  12585. }
  12586. auto to_copy = (std::min)(len, decompress_buffer_.size());
  12587. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  12588. decompress_offset_ = to_copy;
  12589. decompressed_bytes_read_ += to_copy;
  12590. return static_cast<ssize_t>(to_copy);
  12591. }
  12592. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  12593. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  12594. return;
  12595. }
  12596. trailers_parsed_ = true;
  12597. const auto bufsiz = 128;
  12598. char line_buf[bufsiz];
  12599. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  12600. if (!line_reader.getline()) { return; }
  12601. if (!detail::parse_trailers(line_reader, response->trailers,
  12602. response->headers)) {
  12603. return;
  12604. }
  12605. }
  12606. namespace detail {
  12607. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  12608. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  12609. size_t &out_chunk_offset,
  12610. size_t &out_chunk_total) {
  12611. if (finished) { return 0; }
  12612. if (chunk_remaining == 0) {
  12613. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12614. if (!lr.getline()) { return -1; }
  12615. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  12616. const char *p = lr.ptr();
  12617. int v = 0;
  12618. if (!is_hex(*p, v)) { return -1; }
  12619. size_t chunk_len = 0;
  12620. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  12621. for (; is_hex(*p, v); ++p) {
  12622. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  12623. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  12624. }
  12625. while (is_space_or_tab(*p)) {
  12626. ++p;
  12627. }
  12628. if (*p != '\0' && *p != ';' && *p != '\r' && *p != '\n') { return -1; }
  12629. if (chunk_len == 0) {
  12630. chunk_remaining = 0;
  12631. finished = true;
  12632. out_chunk_offset = 0;
  12633. out_chunk_total = 0;
  12634. return 0;
  12635. }
  12636. chunk_remaining = chunk_len;
  12637. last_chunk_total = chunk_remaining;
  12638. last_chunk_offset = 0;
  12639. }
  12640. auto to_read = (std::min)(chunk_remaining, len);
  12641. auto n = strm.read(buf, to_read);
  12642. if (n <= 0) { return -1; }
  12643. auto offset_before = last_chunk_offset;
  12644. last_chunk_offset += static_cast<size_t>(n);
  12645. chunk_remaining -= static_cast<size_t>(n);
  12646. out_chunk_offset = offset_before;
  12647. out_chunk_total = last_chunk_total;
  12648. if (chunk_remaining == 0) {
  12649. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12650. if (!lr.getline()) { return -1; }
  12651. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  12652. }
  12653. return n;
  12654. }
  12655. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  12656. const Headers &src_headers) {
  12657. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12658. if (!lr.getline()) { return false; }
  12659. return parse_trailers(lr, dest, src_headers);
  12660. }
  12661. } // namespace detail
  12662. inline void
  12663. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  12664. handle.connection_->sock = socket_.sock;
  12665. #ifdef CPPHTTPLIB_SSL_ENABLED
  12666. handle.connection_->session = socket_.ssl;
  12667. socket_.ssl = nullptr;
  12668. #endif
  12669. socket_.sock = INVALID_SOCKET;
  12670. }
  12671. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  12672. Response &res, bool close_connection,
  12673. Error &error) {
  12674. if (req.path.empty()) {
  12675. error = Error::Connection;
  12676. output_error_log(error, &req);
  12677. return false;
  12678. }
  12679. auto req_save = req;
  12680. bool ret;
  12681. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  12682. auto req2 = req;
  12683. req2.path = "http://" +
  12684. detail::make_host_and_port_string(host_, port_, false) +
  12685. req.path;
  12686. ret = process_request(strm, req2, res, close_connection, error);
  12687. req = std::move(req2);
  12688. req.path = req_save.path;
  12689. } else {
  12690. ret = process_request(strm, req, res, close_connection, error);
  12691. }
  12692. if (!ret) { return false; }
  12693. if (detail::has_header_token(res.headers, "Connection", "close") ||
  12694. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  12695. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  12696. // for this to be safe.
  12697. // This is safe to call because handle_request is only called by send_
  12698. // which locks the request mutex during the process. It would be a bug
  12699. // to call it from a different thread since it's a thread-safety issue
  12700. // to do these things to the socket if another thread is using the socket.
  12701. std::lock_guard<std::mutex> guard(socket_mutex_);
  12702. disconnect(/*gracefully=*/true);
  12703. }
  12704. if (300 < res.status && res.status < 400 && follow_location_) {
  12705. req = std::move(req_save);
  12706. ret = redirect(req, res, error);
  12707. }
  12708. #ifdef CPPHTTPLIB_SSL_ENABLED
  12709. if ((res.status == StatusCode::Unauthorized_401 ||
  12710. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  12711. req.authorization_count_ < 5) {
  12712. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  12713. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  12714. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  12715. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  12716. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  12717. return ret;
  12718. }
  12719. const auto &username =
  12720. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  12721. const auto &password =
  12722. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  12723. if (!username.empty() && !password.empty()) {
  12724. std::map<std::string, std::string> auth;
  12725. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  12726. Request new_req = req;
  12727. new_req.authorization_count_ += 1;
  12728. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  12729. : "Authorization");
  12730. new_req.headers.insert(detail::make_digest_authentication_header(
  12731. req, auth, new_req.authorization_count_, detail::random_string(10),
  12732. username, password, is_proxy));
  12733. Response new_res;
  12734. ret = send(new_req, new_res, error);
  12735. if (ret) { res = std::move(new_res); }
  12736. }
  12737. }
  12738. }
  12739. #endif
  12740. return ret;
  12741. }
  12742. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  12743. if (req.redirect_count_ == 0) {
  12744. error = Error::ExceedRedirectCount;
  12745. output_error_log(error, &req);
  12746. return false;
  12747. }
  12748. auto location = res.get_header_value("location");
  12749. if (location.empty()) { return false; }
  12750. detail::UrlComponents uc;
  12751. if (!detail::parse_url(location, uc)) { return false; }
  12752. // Only follow http/https redirects
  12753. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  12754. return false;
  12755. }
  12756. auto scheme = is_ssl() ? "https" : "http";
  12757. auto next_scheme = std::move(uc.scheme);
  12758. auto next_host = std::move(uc.host);
  12759. auto port_str = std::move(uc.port);
  12760. auto next_path = std::move(uc.path);
  12761. auto next_query = std::move(uc.query);
  12762. auto next_port = port_;
  12763. if (!port_str.empty()) {
  12764. if (!detail::parse_port(port_str, next_port)) { return false; }
  12765. } else if (!next_scheme.empty()) {
  12766. next_port = next_scheme == "https" ? 443 : 80;
  12767. }
  12768. if (next_scheme.empty()) { next_scheme = scheme; }
  12769. if (next_host.empty()) { next_host = host_; }
  12770. if (next_path.empty()) { next_path = "/"; }
  12771. auto path = decode_path_component(next_path) + next_query;
  12772. // Same host redirect - use current client
  12773. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  12774. return detail::redirect(*this, req, res, path, location, error);
  12775. }
  12776. // Cross-host/scheme redirect - create new client with robust setup
  12777. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  12778. path, location, error);
  12779. }
  12780. // New method for robust redirect client creation
  12781. inline bool ClientImpl::create_redirect_client(
  12782. const std::string &scheme, const std::string &host, int port, Request &req,
  12783. Response &res, const std::string &path, const std::string &location,
  12784. Error &error) {
  12785. // Determine if we need SSL
  12786. auto need_ssl = (scheme == "https");
  12787. // Clean up request headers that are host/client specific
  12788. // Remove headers that should not be carried over to new host
  12789. auto headers_to_remove = std::vector<std::string>{
  12790. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  12791. for (const auto &header_name : headers_to_remove) {
  12792. auto it = req.headers.find(header_name);
  12793. while (it != req.headers.end()) {
  12794. it = req.headers.erase(it);
  12795. it = req.headers.find(header_name);
  12796. }
  12797. }
  12798. // Create appropriate client type and handle redirect
  12799. if (need_ssl) {
  12800. #ifdef CPPHTTPLIB_SSL_ENABLED
  12801. // Create SSL client for HTTPS redirect
  12802. SSLClient redirect_client(host, port);
  12803. // Setup basic client configuration first
  12804. setup_redirect_client(redirect_client);
  12805. redirect_client.enable_server_certificate_verification(
  12806. server_certificate_verification_);
  12807. redirect_client.enable_server_hostname_verification(
  12808. server_hostname_verification_);
  12809. redirect_client.system_ca_mode_ = system_ca_mode_;
  12810. // Transfer CA certificate to redirect client
  12811. if (!ca_cert_pem_.empty()) {
  12812. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  12813. ca_cert_pem_.size());
  12814. }
  12815. if (!ca_cert_file_path_.empty()) {
  12816. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  12817. }
  12818. // Client certificates are set through constructor for SSLClient
  12819. // NOTE: SSLClient constructor already takes client_cert_path and
  12820. // client_key_path so we need to create it properly if client certs are
  12821. // needed
  12822. // Execute the redirect
  12823. return detail::redirect(redirect_client, req, res, path, location, error);
  12824. #else
  12825. // SSL not supported - set appropriate error
  12826. error = Error::SSLConnection;
  12827. output_error_log(error, &req);
  12828. return false;
  12829. #endif
  12830. } else {
  12831. // HTTP redirect
  12832. ClientImpl redirect_client(host, port);
  12833. // Setup client with robust configuration
  12834. setup_redirect_client(redirect_client);
  12835. // Execute the redirect
  12836. return detail::redirect(redirect_client, req, res, path, location, error);
  12837. }
  12838. }
  12839. // New method for robust client setup (based on basic_manual_redirect.cpp
  12840. // logic)
  12841. template <typename ClientType>
  12842. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  12843. // Copy basic settings first
  12844. client.set_connection_timeout(connection_timeout_sec_);
  12845. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  12846. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  12847. client.set_keep_alive(keep_alive_);
  12848. client.set_follow_location(
  12849. true); // Enable redirects to handle multi-step redirects
  12850. client.set_path_encode(path_encode_);
  12851. client.set_compress(compress_);
  12852. client.set_decompress(decompress_);
  12853. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  12854. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  12855. // 15.4, credentials must not be forwarded when redirecting to a different
  12856. // host. This function is only called for cross-host redirects; same-host
  12857. // redirects are handled directly in ClientImpl::redirect().
  12858. // Copy the proxy configuration unconditionally; the per-target bypass is
  12859. // re-evaluated at send time, so a later hop to a non-bypassed host can
  12860. // still use the proxy.
  12861. client.no_proxy_entries_ = no_proxy_entries_;
  12862. if (!proxy_host_.empty() && proxy_port_ != -1) {
  12863. client.set_proxy(proxy_host_, proxy_port_);
  12864. if (!proxy_basic_auth_username_.empty()) {
  12865. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  12866. proxy_basic_auth_password_);
  12867. }
  12868. if (!proxy_bearer_token_auth_token_.empty()) {
  12869. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  12870. }
  12871. #ifdef CPPHTTPLIB_SSL_ENABLED
  12872. if (!proxy_digest_auth_username_.empty()) {
  12873. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  12874. proxy_digest_auth_password_);
  12875. }
  12876. #endif
  12877. }
  12878. // Copy network and socket settings
  12879. client.set_address_family(address_family_);
  12880. client.set_tcp_nodelay(tcp_nodelay_);
  12881. client.set_ipv6_v6only(ipv6_v6only_);
  12882. if (socket_options_) { client.set_socket_options(socket_options_); }
  12883. if (!interface_.empty()) { client.set_interface(interface_); }
  12884. // Copy logging and headers
  12885. if (logger_) { client.set_logger(logger_); }
  12886. if (error_logger_) { client.set_error_logger(error_logger_); }
  12887. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  12888. // Each new client should generate its own headers based on its target host
  12889. }
  12890. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  12891. const Request &req,
  12892. Error &error) const {
  12893. auto is_shutting_down = []() { return false; };
  12894. if (req.is_chunked_content_provider_) {
  12895. auto compressor = compress_ ? detail::create_compressor().first
  12896. : std::unique_ptr<detail::compressor>();
  12897. if (!compressor) {
  12898. compressor = detail::make_unique<detail::nocompressor>();
  12899. }
  12900. return detail::write_content_chunked(strm, req.content_provider_,
  12901. is_shutting_down, *compressor, error);
  12902. } else {
  12903. return detail::write_content_with_progress(
  12904. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  12905. req.upload_progress, error);
  12906. }
  12907. }
  12908. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  12909. bool close_connection, Error &error,
  12910. bool skip_body) {
  12911. // Prepare additional headers
  12912. if (close_connection) {
  12913. if (!req.has_header("Connection")) {
  12914. req.set_header("Connection", "close");
  12915. }
  12916. }
  12917. std::string ct_for_defaults;
  12918. if (!req.has_header("Content-Type") && !req.body.empty()) {
  12919. ct_for_defaults = "text/plain";
  12920. }
  12921. prepare_default_headers(req, false, ct_for_defaults);
  12922. if (req.body.empty()) {
  12923. if (req.content_provider_) {
  12924. if (!req.is_chunked_content_provider_) {
  12925. if (!req.has_header("Content-Length")) {
  12926. auto length = std::to_string(req.content_length_);
  12927. req.set_header("Content-Length", length);
  12928. }
  12929. }
  12930. } else {
  12931. if (req.method == "POST" || req.method == "PUT" ||
  12932. req.method == "PATCH") {
  12933. req.set_header("Content-Length", "0");
  12934. }
  12935. }
  12936. }
  12937. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  12938. if (!req.has_header("Authorization")) {
  12939. req.headers.insert(make_basic_authentication_header(
  12940. basic_auth_username_, basic_auth_password_, false));
  12941. }
  12942. }
  12943. if (!bearer_token_auth_token_.empty()) {
  12944. if (!req.has_header("Authorization")) {
  12945. req.headers.insert(make_bearer_token_authentication_header(
  12946. bearer_token_auth_token_, false));
  12947. }
  12948. }
  12949. // Proxy-Authorization is only sent when the proxy is actually used for
  12950. // this target — otherwise NO_PROXY-matched requests would leak proxy
  12951. // credentials directly to the destination server.
  12952. if (is_proxy_enabled_for_host(host_)) {
  12953. if (!proxy_basic_auth_username_.empty() &&
  12954. !proxy_basic_auth_password_.empty() &&
  12955. !req.has_header("Proxy-Authorization")) {
  12956. req.headers.insert(make_basic_authentication_header(
  12957. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  12958. }
  12959. if (!proxy_bearer_token_auth_token_.empty() &&
  12960. !req.has_header("Proxy-Authorization")) {
  12961. req.headers.insert(make_bearer_token_authentication_header(
  12962. proxy_bearer_token_auth_token_, true));
  12963. }
  12964. }
  12965. // Request line and headers
  12966. {
  12967. detail::BufferStream bstrm;
  12968. // Extract the query from req.path. The encoding itself is delegated to
  12969. // `encode_request_target`; the raw query is still needed here to decide
  12970. // between populating `req.params` from it and falling back to building a
  12971. // query out of caller-supplied `req.params`.
  12972. auto query_pos = req.path.find('?');
  12973. auto query_part = query_pos == std::string::npos
  12974. ? std::string()
  12975. : req.path.substr(query_pos + 1);
  12976. auto path_with_query =
  12977. detail::encode_request_target(req.path, path_encode_);
  12978. if (!query_part.empty()) {
  12979. // The query already came in through `req.path`; still populate
  12980. // `req.params` for handlers/users who read them.
  12981. detail::parse_query_text(query_part, req.params);
  12982. } else if (!req.params.empty()) {
  12983. // No query in `req.path`; build one from `req.params` so existing
  12984. // callers that pass `Params` separately continue to work.
  12985. path_with_query = append_query_params(path_with_query, req.params);
  12986. }
  12987. // Write request line and headers
  12988. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  12989. // A rejected target (e.g. CR/LF smuggled in via a decoded redirect
  12990. // Location under set_path_encode(false)) must fail the request cleanly
  12991. // instead of emitting a request-line-less, header-injecting request.
  12992. error = Error::Write;
  12993. output_error_log(error, &req);
  12994. return false;
  12995. }
  12996. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  12997. error)) {
  12998. output_error_log(error, &req);
  12999. return false;
  13000. }
  13001. // Flush buffer
  13002. auto &data = bstrm.get_buffer();
  13003. if (!detail::write_data(strm, data.data(), data.size())) {
  13004. error = Error::Write;
  13005. output_error_log(error, &req);
  13006. return false;
  13007. }
  13008. }
  13009. // After sending request line and headers, wait briefly for an early server
  13010. // response (e.g. 4xx) and avoid sending a potentially large request body
  13011. // unnecessarily. This workaround is only enabled on Windows because Unix
  13012. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13013. // buffering can accept large writes even when the peer already responded.
  13014. // Check the stream first (which covers SSL via `is_readable()`), then
  13015. // fall back to select on the socket. Only perform the wait for very large
  13016. // request bodies to avoid interfering with normal small requests and
  13017. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13018. // response. Skip this check when using Expect: 100-continue, as the protocol
  13019. // handles early responses properly.
  13020. #if defined(_WIN32)
  13021. if (!skip_body &&
  13022. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13023. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13024. auto start = std::chrono::high_resolution_clock::now();
  13025. for (;;) {
  13026. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13027. // from SSL internals. If the underlying socket is readable, assume an
  13028. // early response may be present.
  13029. auto sock = strm.socket();
  13030. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13031. return false;
  13032. }
  13033. // Fallback to stream-level check for non-socket streams or when the
  13034. // socket isn't reporting readable. Avoid using `is_readable()` for
  13035. // SSL, since `SSL_pending()` may report buffered records that do not
  13036. // indicate a complete application-level response yet.
  13037. if (!is_ssl() && strm.is_readable()) { return false; }
  13038. auto now = std::chrono::high_resolution_clock::now();
  13039. auto elapsed =
  13040. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13041. .count();
  13042. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13043. break;
  13044. }
  13045. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13046. }
  13047. }
  13048. #endif
  13049. // Body
  13050. if (skip_body) { return true; }
  13051. return write_request_body(strm, req, error);
  13052. }
  13053. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13054. Error &error) {
  13055. if (req.body.empty()) {
  13056. return write_content_with_provider(strm, req, error);
  13057. }
  13058. if (req.upload_progress) {
  13059. auto body_size = req.body.size();
  13060. size_t written = 0;
  13061. auto data = req.body.data();
  13062. while (written < body_size) {
  13063. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13064. if (!detail::write_data(strm, data + written, to_write)) {
  13065. error = Error::Write;
  13066. output_error_log(error, &req);
  13067. return false;
  13068. }
  13069. written += to_write;
  13070. if (!req.upload_progress(written, body_size)) {
  13071. error = Error::Canceled;
  13072. output_error_log(error, &req);
  13073. return false;
  13074. }
  13075. }
  13076. } else {
  13077. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13078. error = Error::Write;
  13079. output_error_log(error, &req);
  13080. return false;
  13081. }
  13082. }
  13083. return true;
  13084. }
  13085. inline std::unique_ptr<Response>
  13086. ClientImpl::send_with_content_provider_and_receiver(
  13087. Request &req, const char *body, size_t content_length,
  13088. ContentProvider content_provider,
  13089. ContentProviderWithoutLength content_provider_without_length,
  13090. const std::string &content_type, ContentReceiver content_receiver,
  13091. Error &error) {
  13092. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13093. auto enc = compress_
  13094. ? detail::create_compressor()
  13095. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13096. nullptr, nullptr);
  13097. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13098. if (enc.first && !content_provider_without_length) {
  13099. auto &compressor = enc.first;
  13100. if (content_provider) {
  13101. auto ok = true;
  13102. auto finished = false;
  13103. size_t offset = 0;
  13104. DataSink data_sink;
  13105. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13106. if (ok) {
  13107. auto last = offset + data_len == content_length;
  13108. auto ret = compressor->compress(
  13109. data, data_len, last,
  13110. [&](const char *compressed_data, size_t compressed_data_len) {
  13111. req.body.append(compressed_data, compressed_data_len);
  13112. return true;
  13113. });
  13114. if (ret) {
  13115. offset += data_len;
  13116. } else {
  13117. ok = false;
  13118. }
  13119. }
  13120. return ok;
  13121. };
  13122. // As in detail::write_content_with_progress(): the body is framed by
  13123. // content_length, so a provider that finishes early has truncated it.
  13124. // Stop and report that instead of calling the provider forever.
  13125. data_sink.done = [&]() { finished = true; };
  13126. while (ok && !finished && offset < content_length) {
  13127. if (!content_provider(offset, content_length - offset, data_sink)) {
  13128. error = Error::Canceled;
  13129. output_error_log(error, &req);
  13130. return nullptr;
  13131. }
  13132. }
  13133. // A short body here means either the provider stopped early or the
  13134. // compressor gave up. The branch below reports a failing compressor as
  13135. // Error::Compression, so keep the two distinguishable.
  13136. if (offset < content_length) {
  13137. error = ok ? Error::Write : Error::Compression;
  13138. output_error_log(error, &req);
  13139. return nullptr;
  13140. }
  13141. } else {
  13142. if (!compressor->compress(body, content_length, true,
  13143. [&](const char *data, size_t data_len) {
  13144. req.body.append(data, data_len);
  13145. return true;
  13146. })) {
  13147. error = Error::Compression;
  13148. output_error_log(error, &req);
  13149. return nullptr;
  13150. }
  13151. }
  13152. } else {
  13153. if (content_provider) {
  13154. req.content_length_ = content_length;
  13155. req.content_provider_ = std::move(content_provider);
  13156. req.is_chunked_content_provider_ = false;
  13157. } else if (content_provider_without_length) {
  13158. req.content_length_ = 0;
  13159. req.content_provider_ = detail::ContentProviderAdapter(
  13160. std::move(content_provider_without_length));
  13161. req.is_chunked_content_provider_ = true;
  13162. req.set_header("Transfer-Encoding", "chunked");
  13163. } else {
  13164. req.body.assign(body, content_length);
  13165. }
  13166. }
  13167. if (content_receiver) {
  13168. req.content_receiver =
  13169. [content_receiver](const char *data, size_t data_length,
  13170. size_t /*offset*/, size_t /*total_length*/) {
  13171. return content_receiver(data, data_length);
  13172. };
  13173. }
  13174. auto res = detail::make_unique<Response>();
  13175. return send(req, *res, error) ? std::move(res) : nullptr;
  13176. }
  13177. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13178. const std::string &method, const std::string &path, const Headers &headers,
  13179. const char *body, size_t content_length, ContentProvider content_provider,
  13180. ContentProviderWithoutLength content_provider_without_length,
  13181. const std::string &content_type, ContentReceiver content_receiver,
  13182. UploadProgress progress) {
  13183. Request req;
  13184. req.method = method;
  13185. req.headers = headers;
  13186. req.path = path;
  13187. req.upload_progress = std::move(progress);
  13188. if (max_timeout_msec_ > 0) {
  13189. req.start_time_ = std::chrono::steady_clock::now();
  13190. }
  13191. auto error = Error::Success;
  13192. auto res = send_with_content_provider_and_receiver(
  13193. req, body, content_length, std::move(content_provider),
  13194. std::move(content_provider_without_length), content_type,
  13195. std::move(content_receiver), error);
  13196. #ifdef CPPHTTPLIB_SSL_ENABLED
  13197. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13198. last_backend_error_};
  13199. #else
  13200. return Result{std::move(res), error, std::move(req.headers)};
  13201. #endif
  13202. }
  13203. inline void ClientImpl::output_log(const Request &req,
  13204. const Response &res) const {
  13205. if (logger_) {
  13206. std::lock_guard<std::mutex> guard(logger_mutex_);
  13207. logger_(req, res);
  13208. }
  13209. }
  13210. inline void ClientImpl::output_error_log(const Error &err,
  13211. const Request *req) const {
  13212. if (error_logger_) {
  13213. std::lock_guard<std::mutex> guard(logger_mutex_);
  13214. error_logger_(err, req);
  13215. }
  13216. }
  13217. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13218. Response &res, bool close_connection,
  13219. Error &error) {
  13220. // Auto-add Expect: 100-continue for large bodies
  13221. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13222. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13223. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13224. req.set_header("Expect", "100-continue");
  13225. }
  13226. }
  13227. // Check for Expect: 100-continue
  13228. auto expect_100_continue =
  13229. detail::has_header_token(req.headers, "Expect", "100-continue");
  13230. // Send request (skip body if using Expect: 100-continue)
  13231. auto write_request_success =
  13232. write_request(strm, req, close_connection, error, expect_100_continue);
  13233. #ifdef CPPHTTPLIB_SSL_ENABLED
  13234. if (is_ssl() && !expect_100_continue) {
  13235. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13236. if (!is_proxy_enabled) {
  13237. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13238. error = Error::SSLPeerCouldBeClosed_;
  13239. output_error_log(error, &req);
  13240. return false;
  13241. }
  13242. }
  13243. }
  13244. #endif
  13245. // Handle Expect: 100-continue.
  13246. //
  13247. // Wait for an interim/early response by attempting to read the status line
  13248. // under a short timeout, instead of trusting raw socket readability. Over
  13249. // TLS, post-handshake records (e.g. session tickets) make the socket
  13250. // readable without any HTTP response being available; relying on
  13251. // `select_read` there caused the body to be withheld forever and the
  13252. // request to fail with `Read` (#2458). If no status line arrives within the
  13253. // timeout, send the body anyway (matching curl's behavior).
  13254. auto status_line_read = false;
  13255. if (expect_100_continue && write_request_success) {
  13256. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13257. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13258. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13259. strm.set_read_timeout(sec, usec);
  13260. status_line_read = read_response_line(strm, req, res, false);
  13261. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13262. }
  13263. if (!status_line_read) {
  13264. // No interim response within the timeout: send the body and handle the
  13265. // response as usual.
  13266. if (!write_request_body(strm, req, error)) { return false; }
  13267. expect_100_continue = false; // Switch to normal response handling
  13268. }
  13269. }
  13270. // Receive response and headers
  13271. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13272. if ((!status_line_read &&
  13273. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13274. !detail::read_headers(strm, res.headers)) {
  13275. if (write_request_success) { error = Error::Read; }
  13276. output_error_log(error, &req);
  13277. return false;
  13278. }
  13279. if (!write_request_success) { return false; }
  13280. // Handle Expect: 100-continue response
  13281. if (expect_100_continue) {
  13282. if (res.status == StatusCode::Continue_100) {
  13283. // Server accepted, send the body
  13284. if (!write_request_body(strm, req, error)) { return false; }
  13285. // Read the actual response
  13286. res.headers.clear();
  13287. res.body.clear();
  13288. if (!read_response_line(strm, req, res) ||
  13289. !detail::read_headers(strm, res.headers)) {
  13290. error = Error::Read;
  13291. output_error_log(error, &req);
  13292. return false;
  13293. }
  13294. }
  13295. // If not 100 Continue, server returned an error; proceed with that response
  13296. }
  13297. // Body
  13298. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13299. req.method != "CONNECT") {
  13300. auto redirect = 300 < res.status && res.status < 400 &&
  13301. res.status != StatusCode::NotModified_304 &&
  13302. follow_location_;
  13303. if (req.response_handler && !redirect) {
  13304. if (!req.response_handler(res)) {
  13305. error = Error::Canceled;
  13306. output_error_log(error, &req);
  13307. return false;
  13308. }
  13309. }
  13310. auto out =
  13311. req.content_receiver
  13312. ? static_cast<ContentReceiverWithProgress>(
  13313. [&](const char *buf, size_t n, size_t off, size_t len) {
  13314. if (redirect) { return true; }
  13315. auto ret = req.content_receiver(buf, n, off, len);
  13316. if (!ret) {
  13317. error = Error::Canceled;
  13318. output_error_log(error, &req);
  13319. }
  13320. return ret;
  13321. })
  13322. : static_cast<ContentReceiverWithProgress>(
  13323. [&](const char *buf, size_t n, size_t /*off*/,
  13324. size_t /*len*/) {
  13325. assert(res.body.size() + n <= res.body.max_size());
  13326. if (payload_max_length_ > 0 &&
  13327. (res.body.size() >= payload_max_length_ ||
  13328. n > payload_max_length_ - res.body.size())) {
  13329. return false;
  13330. }
  13331. res.body.append(buf, n);
  13332. return true;
  13333. });
  13334. auto progress = [&](size_t current, size_t total) {
  13335. if (!req.download_progress || redirect) { return true; }
  13336. auto ret = req.download_progress(current, total);
  13337. if (!ret) {
  13338. error = Error::Canceled;
  13339. output_error_log(error, &req);
  13340. }
  13341. return ret;
  13342. };
  13343. if (res.has_header("Content-Length")) {
  13344. if (!req.content_receiver) {
  13345. auto len = res.get_header_value_u64("Content-Length");
  13346. if (len > res.body.max_size()) {
  13347. error = Error::Read;
  13348. output_error_log(error, &req);
  13349. return false;
  13350. }
  13351. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13352. // hostile or malformed server sends an enormous Content-Length.
  13353. // The actual body read below is bounded by payload_max_length_,
  13354. // so reserving more than that is never useful.
  13355. auto reserve_len = static_cast<size_t>(len);
  13356. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13357. reserve_len = payload_max_length_;
  13358. }
  13359. res.body.reserve(reserve_len);
  13360. }
  13361. }
  13362. if (res.status != StatusCode::NotModified_304) {
  13363. auto content_status = 0;
  13364. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13365. ? (std::numeric_limits<size_t>::max)()
  13366. : payload_max_length_;
  13367. if (!detail::read_content(strm, res, max_length, content_status,
  13368. std::move(progress), std::move(out),
  13369. decompress_)) {
  13370. if (error != Error::Canceled) {
  13371. // Tell the caller apart from a plain read failure when the body could
  13372. // not be decoded because of its Content-Encoding.
  13373. switch (content_status) {
  13374. case StatusCode::UnsupportedMediaType_415:
  13375. error = Error::UnsupportedContentEncoding;
  13376. break;
  13377. case StatusCode::InternalServerError_500:
  13378. error = Error::Compression;
  13379. break;
  13380. default: error = Error::Read; break;
  13381. }
  13382. }
  13383. output_error_log(error, &req);
  13384. return false;
  13385. }
  13386. }
  13387. }
  13388. // Log
  13389. output_log(req, res);
  13390. return true;
  13391. }
  13392. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13393. const std::string &boundary, const UploadFormDataItems &items,
  13394. const FormDataProviderItems &provider_items) const {
  13395. size_t cur_item = 0;
  13396. size_t cur_start = 0;
  13397. // cur_item and cur_start are copied to within the std::function and
  13398. // maintain state between successive calls
  13399. return [&, cur_item, cur_start](size_t offset,
  13400. DataSink &sink) mutable -> bool {
  13401. if (!offset && !items.empty()) {
  13402. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13403. return true;
  13404. } else if (cur_item < provider_items.size()) {
  13405. if (!cur_start) {
  13406. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13407. provider_items[cur_item], boundary);
  13408. offset += begin.size();
  13409. cur_start = offset;
  13410. sink.os << begin;
  13411. }
  13412. DataSink cur_sink;
  13413. auto has_data = true;
  13414. cur_sink.write = sink.write;
  13415. // Forward is_writable so a provider item asking whether it may keep
  13416. // going gets the outer sink's answer rather than the default `true`.
  13417. cur_sink.is_writable = sink.is_writable;
  13418. cur_sink.done = [&]() { has_data = false; };
  13419. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13420. return false;
  13421. }
  13422. if (!has_data) {
  13423. sink.os << detail::serialize_multipart_formdata_item_end();
  13424. cur_item++;
  13425. cur_start = 0;
  13426. }
  13427. return true;
  13428. } else {
  13429. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13430. sink.done();
  13431. return true;
  13432. }
  13433. };
  13434. }
  13435. inline bool ClientImpl::process_socket(
  13436. const Socket &socket,
  13437. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13438. std::function<bool(Stream &strm)> callback) {
  13439. return detail::process_client_socket(
  13440. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13441. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13442. }
  13443. inline bool ClientImpl::is_ssl() const { return false; }
  13444. inline Result ClientImpl::Get(const std::string &path,
  13445. DownloadProgress progress) {
  13446. return Get(path, Headers(), std::move(progress));
  13447. }
  13448. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13449. DownloadProgress progress) {
  13450. return Get(path, params, Headers(), std::move(progress));
  13451. }
  13452. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13453. const Headers &headers,
  13454. DownloadProgress progress) {
  13455. if (params.empty()) { return Get(path, headers); }
  13456. std::string path_with_query = append_query_params(path, params);
  13457. return Get(path_with_query, headers, std::move(progress));
  13458. }
  13459. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13460. DownloadProgress progress) {
  13461. Request req;
  13462. req.method = "GET";
  13463. req.path = path;
  13464. req.headers = headers;
  13465. req.download_progress = std::move(progress);
  13466. if (max_timeout_msec_ > 0) {
  13467. req.start_time_ = std::chrono::steady_clock::now();
  13468. }
  13469. return send_(std::move(req));
  13470. }
  13471. inline Result ClientImpl::Get(const std::string &path,
  13472. ContentReceiver content_receiver,
  13473. DownloadProgress progress) {
  13474. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13475. std::move(progress));
  13476. }
  13477. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13478. ContentReceiver content_receiver,
  13479. DownloadProgress progress) {
  13480. return Get(path, headers, nullptr, std::move(content_receiver),
  13481. std::move(progress));
  13482. }
  13483. inline Result ClientImpl::Get(const std::string &path,
  13484. ResponseHandler response_handler,
  13485. ContentReceiver content_receiver,
  13486. DownloadProgress progress) {
  13487. return Get(path, Headers(), std::move(response_handler),
  13488. std::move(content_receiver), std::move(progress));
  13489. }
  13490. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13491. ResponseHandler response_handler,
  13492. ContentReceiver content_receiver,
  13493. DownloadProgress progress) {
  13494. Request req;
  13495. req.method = "GET";
  13496. req.path = path;
  13497. req.headers = headers;
  13498. req.response_handler = std::move(response_handler);
  13499. req.content_receiver =
  13500. [content_receiver](const char *data, size_t data_length,
  13501. size_t /*offset*/, size_t /*total_length*/) {
  13502. return content_receiver(data, data_length);
  13503. };
  13504. req.download_progress = std::move(progress);
  13505. if (max_timeout_msec_ > 0) {
  13506. req.start_time_ = std::chrono::steady_clock::now();
  13507. }
  13508. return send_(std::move(req));
  13509. }
  13510. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13511. const Headers &headers,
  13512. ContentReceiver content_receiver,
  13513. DownloadProgress progress) {
  13514. return Get(path, params, headers, nullptr, std::move(content_receiver),
  13515. std::move(progress));
  13516. }
  13517. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13518. const Headers &headers,
  13519. ResponseHandler response_handler,
  13520. ContentReceiver content_receiver,
  13521. DownloadProgress progress) {
  13522. if (params.empty()) {
  13523. return Get(path, headers, std::move(response_handler),
  13524. std::move(content_receiver), std::move(progress));
  13525. }
  13526. std::string path_with_query = append_query_params(path, params);
  13527. return Get(path_with_query, headers, std::move(response_handler),
  13528. std::move(content_receiver), std::move(progress));
  13529. }
  13530. inline Result ClientImpl::Head(const std::string &path) {
  13531. return Head(path, Headers());
  13532. }
  13533. inline Result ClientImpl::Head(const std::string &path,
  13534. const Headers &headers) {
  13535. Request req;
  13536. req.method = "HEAD";
  13537. req.headers = headers;
  13538. req.path = path;
  13539. if (max_timeout_msec_ > 0) {
  13540. req.start_time_ = std::chrono::steady_clock::now();
  13541. }
  13542. return send_(std::move(req));
  13543. }
  13544. inline Result ClientImpl::Post(const std::string &path) {
  13545. return Post(path, std::string(), std::string());
  13546. }
  13547. inline Result ClientImpl::Post(const std::string &path,
  13548. const Headers &headers) {
  13549. return Post(path, headers, nullptr, 0, std::string());
  13550. }
  13551. inline Result ClientImpl::Post(const std::string &path, const char *body,
  13552. size_t content_length,
  13553. const std::string &content_type,
  13554. UploadProgress progress) {
  13555. return Post(path, Headers(), body, content_length, content_type, progress);
  13556. }
  13557. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  13558. const std::string &content_type,
  13559. UploadProgress progress) {
  13560. return Post(path, Headers(), body, content_type, progress);
  13561. }
  13562. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  13563. return Post(path, Headers(), params);
  13564. }
  13565. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13566. ContentProvider content_provider,
  13567. const std::string &content_type,
  13568. UploadProgress progress) {
  13569. return Post(path, Headers(), content_length, std::move(content_provider),
  13570. content_type, progress);
  13571. }
  13572. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13573. ContentProvider content_provider,
  13574. const std::string &content_type,
  13575. ContentReceiver content_receiver,
  13576. UploadProgress progress) {
  13577. return Post(path, Headers(), content_length, std::move(content_provider),
  13578. content_type, std::move(content_receiver), progress);
  13579. }
  13580. inline Result ClientImpl::Post(const std::string &path,
  13581. ContentProviderWithoutLength content_provider,
  13582. const std::string &content_type,
  13583. UploadProgress progress) {
  13584. return Post(path, Headers(), std::move(content_provider), content_type,
  13585. progress);
  13586. }
  13587. inline Result ClientImpl::Post(const std::string &path,
  13588. ContentProviderWithoutLength content_provider,
  13589. const std::string &content_type,
  13590. ContentReceiver content_receiver,
  13591. UploadProgress progress) {
  13592. return Post(path, Headers(), std::move(content_provider), content_type,
  13593. std::move(content_receiver), progress);
  13594. }
  13595. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13596. const Params &params) {
  13597. auto query = detail::params_to_query_str(params);
  13598. return Post(path, headers, query, "application/x-www-form-urlencoded");
  13599. }
  13600. inline Result ClientImpl::Post(const std::string &path,
  13601. const UploadFormDataItems &items,
  13602. UploadProgress progress) {
  13603. return Post(path, Headers(), items, progress);
  13604. }
  13605. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13606. const UploadFormDataItems &items,
  13607. UploadProgress progress) {
  13608. const auto &boundary = detail::make_multipart_data_boundary();
  13609. const auto &content_type =
  13610. detail::serialize_multipart_formdata_get_content_type(boundary);
  13611. auto content_length = detail::get_multipart_content_length(items, boundary);
  13612. return Post(path, headers, content_length,
  13613. detail::make_multipart_content_provider(items, boundary),
  13614. content_type, progress);
  13615. }
  13616. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13617. const UploadFormDataItems &items,
  13618. const std::string &boundary,
  13619. UploadProgress progress) {
  13620. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  13621. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  13622. }
  13623. const auto &content_type =
  13624. detail::serialize_multipart_formdata_get_content_type(boundary);
  13625. auto content_length = detail::get_multipart_content_length(items, boundary);
  13626. return Post(path, headers, content_length,
  13627. detail::make_multipart_content_provider(items, boundary),
  13628. content_type, progress);
  13629. }
  13630. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13631. const char *body, size_t content_length,
  13632. const std::string &content_type,
  13633. UploadProgress progress) {
  13634. return send_with_content_provider_and_receiver(
  13635. "POST", path, headers, body, content_length, nullptr, nullptr,
  13636. content_type, nullptr, progress);
  13637. }
  13638. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13639. const std::string &body,
  13640. const std::string &content_type,
  13641. UploadProgress progress) {
  13642. return send_with_content_provider_and_receiver(
  13643. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  13644. content_type, nullptr, progress);
  13645. }
  13646. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13647. size_t content_length,
  13648. ContentProvider content_provider,
  13649. const std::string &content_type,
  13650. UploadProgress progress) {
  13651. return send_with_content_provider_and_receiver(
  13652. "POST", path, headers, nullptr, content_length,
  13653. std::move(content_provider), nullptr, content_type, nullptr, progress);
  13654. }
  13655. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13656. size_t content_length,
  13657. ContentProvider content_provider,
  13658. const std::string &content_type,
  13659. ContentReceiver content_receiver,
  13660. DownloadProgress progress) {
  13661. return send_with_content_provider_and_receiver(
  13662. "POST", path, headers, nullptr, content_length,
  13663. std::move(content_provider), nullptr, content_type,
  13664. std::move(content_receiver), std::move(progress));
  13665. }
  13666. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13667. ContentProviderWithoutLength content_provider,
  13668. const std::string &content_type,
  13669. UploadProgress progress) {
  13670. return send_with_content_provider_and_receiver(
  13671. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13672. content_type, nullptr, progress);
  13673. }
  13674. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13675. ContentProviderWithoutLength content_provider,
  13676. const std::string &content_type,
  13677. ContentReceiver content_receiver,
  13678. DownloadProgress progress) {
  13679. return send_with_content_provider_and_receiver(
  13680. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13681. content_type, std::move(content_receiver), std::move(progress));
  13682. }
  13683. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13684. const UploadFormDataItems &items,
  13685. const FormDataProviderItems &provider_items,
  13686. UploadProgress progress) {
  13687. const auto &boundary = detail::make_multipart_data_boundary();
  13688. const auto &content_type =
  13689. detail::serialize_multipart_formdata_get_content_type(boundary);
  13690. return send_with_content_provider_and_receiver(
  13691. "POST", path, headers, nullptr, 0, nullptr,
  13692. get_multipart_content_provider(boundary, items, provider_items),
  13693. content_type, nullptr, progress);
  13694. }
  13695. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13696. const std::string &body,
  13697. const std::string &content_type,
  13698. ContentReceiver content_receiver,
  13699. DownloadProgress progress) {
  13700. Request req;
  13701. req.method = "POST";
  13702. req.path = path;
  13703. req.headers = headers;
  13704. req.body = body;
  13705. req.content_receiver =
  13706. [content_receiver](const char *data, size_t data_length,
  13707. size_t /*offset*/, size_t /*total_length*/) {
  13708. return content_receiver(data, data_length);
  13709. };
  13710. req.download_progress = std::move(progress);
  13711. if (max_timeout_msec_ > 0) {
  13712. req.start_time_ = std::chrono::steady_clock::now();
  13713. }
  13714. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13715. return send_(std::move(req));
  13716. }
  13717. inline Result ClientImpl::Put(const std::string &path) {
  13718. return Put(path, std::string(), std::string());
  13719. }
  13720. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  13721. return Put(path, headers, nullptr, 0, std::string());
  13722. }
  13723. inline Result ClientImpl::Put(const std::string &path, const char *body,
  13724. size_t content_length,
  13725. const std::string &content_type,
  13726. UploadProgress progress) {
  13727. return Put(path, Headers(), body, content_length, content_type, progress);
  13728. }
  13729. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  13730. const std::string &content_type,
  13731. UploadProgress progress) {
  13732. return Put(path, Headers(), body, content_type, progress);
  13733. }
  13734. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  13735. return Put(path, Headers(), params);
  13736. }
  13737. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  13738. ContentProvider content_provider,
  13739. const std::string &content_type,
  13740. UploadProgress progress) {
  13741. return Put(path, Headers(), content_length, std::move(content_provider),
  13742. content_type, progress);
  13743. }
  13744. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  13745. ContentProvider content_provider,
  13746. const std::string &content_type,
  13747. ContentReceiver content_receiver,
  13748. UploadProgress progress) {
  13749. return Put(path, Headers(), content_length, std::move(content_provider),
  13750. content_type, std::move(content_receiver), progress);
  13751. }
  13752. inline Result ClientImpl::Put(const std::string &path,
  13753. ContentProviderWithoutLength content_provider,
  13754. const std::string &content_type,
  13755. UploadProgress progress) {
  13756. return Put(path, Headers(), std::move(content_provider), content_type,
  13757. progress);
  13758. }
  13759. inline Result ClientImpl::Put(const std::string &path,
  13760. ContentProviderWithoutLength content_provider,
  13761. const std::string &content_type,
  13762. ContentReceiver content_receiver,
  13763. UploadProgress progress) {
  13764. return Put(path, Headers(), std::move(content_provider), content_type,
  13765. std::move(content_receiver), progress);
  13766. }
  13767. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13768. const Params &params) {
  13769. auto query = detail::params_to_query_str(params);
  13770. return Put(path, headers, query, "application/x-www-form-urlencoded");
  13771. }
  13772. inline Result ClientImpl::Put(const std::string &path,
  13773. const UploadFormDataItems &items,
  13774. UploadProgress progress) {
  13775. return Put(path, Headers(), items, progress);
  13776. }
  13777. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13778. const UploadFormDataItems &items,
  13779. UploadProgress progress) {
  13780. const auto &boundary = detail::make_multipart_data_boundary();
  13781. const auto &content_type =
  13782. detail::serialize_multipart_formdata_get_content_type(boundary);
  13783. auto content_length = detail::get_multipart_content_length(items, boundary);
  13784. return Put(path, headers, content_length,
  13785. detail::make_multipart_content_provider(items, boundary),
  13786. content_type, progress);
  13787. }
  13788. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13789. const UploadFormDataItems &items,
  13790. const std::string &boundary,
  13791. UploadProgress progress) {
  13792. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  13793. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  13794. }
  13795. const auto &content_type =
  13796. detail::serialize_multipart_formdata_get_content_type(boundary);
  13797. auto content_length = detail::get_multipart_content_length(items, boundary);
  13798. return Put(path, headers, content_length,
  13799. detail::make_multipart_content_provider(items, boundary),
  13800. content_type, progress);
  13801. }
  13802. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13803. const char *body, size_t content_length,
  13804. const std::string &content_type,
  13805. UploadProgress progress) {
  13806. return send_with_content_provider_and_receiver(
  13807. "PUT", path, headers, body, content_length, nullptr, nullptr,
  13808. content_type, nullptr, progress);
  13809. }
  13810. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13811. const std::string &body,
  13812. const std::string &content_type,
  13813. UploadProgress progress) {
  13814. return send_with_content_provider_and_receiver(
  13815. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  13816. content_type, nullptr, progress);
  13817. }
  13818. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13819. size_t content_length,
  13820. ContentProvider content_provider,
  13821. const std::string &content_type,
  13822. UploadProgress progress) {
  13823. return send_with_content_provider_and_receiver(
  13824. "PUT", path, headers, nullptr, content_length,
  13825. std::move(content_provider), nullptr, content_type, nullptr, progress);
  13826. }
  13827. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13828. size_t content_length,
  13829. ContentProvider content_provider,
  13830. const std::string &content_type,
  13831. ContentReceiver content_receiver,
  13832. UploadProgress progress) {
  13833. return send_with_content_provider_and_receiver(
  13834. "PUT", path, headers, nullptr, content_length,
  13835. std::move(content_provider), nullptr, content_type,
  13836. std::move(content_receiver), progress);
  13837. }
  13838. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13839. ContentProviderWithoutLength content_provider,
  13840. const std::string &content_type,
  13841. UploadProgress progress) {
  13842. return send_with_content_provider_and_receiver(
  13843. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13844. content_type, nullptr, progress);
  13845. }
  13846. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13847. ContentProviderWithoutLength content_provider,
  13848. const std::string &content_type,
  13849. ContentReceiver content_receiver,
  13850. UploadProgress progress) {
  13851. return send_with_content_provider_and_receiver(
  13852. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13853. content_type, std::move(content_receiver), progress);
  13854. }
  13855. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13856. const UploadFormDataItems &items,
  13857. const FormDataProviderItems &provider_items,
  13858. UploadProgress progress) {
  13859. const auto &boundary = detail::make_multipart_data_boundary();
  13860. const auto &content_type =
  13861. detail::serialize_multipart_formdata_get_content_type(boundary);
  13862. return send_with_content_provider_and_receiver(
  13863. "PUT", path, headers, nullptr, 0, nullptr,
  13864. get_multipart_content_provider(boundary, items, provider_items),
  13865. content_type, nullptr, progress);
  13866. }
  13867. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13868. const std::string &body,
  13869. const std::string &content_type,
  13870. ContentReceiver content_receiver,
  13871. DownloadProgress progress) {
  13872. Request req;
  13873. req.method = "PUT";
  13874. req.path = path;
  13875. req.headers = headers;
  13876. req.body = body;
  13877. req.content_receiver =
  13878. [content_receiver](const char *data, size_t data_length,
  13879. size_t /*offset*/, size_t /*total_length*/) {
  13880. return content_receiver(data, data_length);
  13881. };
  13882. req.download_progress = std::move(progress);
  13883. if (max_timeout_msec_ > 0) {
  13884. req.start_time_ = std::chrono::steady_clock::now();
  13885. }
  13886. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13887. return send_(std::move(req));
  13888. }
  13889. inline Result ClientImpl::Patch(const std::string &path) {
  13890. return Patch(path, std::string(), std::string());
  13891. }
  13892. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  13893. UploadProgress progress) {
  13894. return Patch(path, headers, nullptr, 0, std::string(), progress);
  13895. }
  13896. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  13897. size_t content_length,
  13898. const std::string &content_type,
  13899. UploadProgress progress) {
  13900. return Patch(path, Headers(), body, content_length, content_type, progress);
  13901. }
  13902. inline Result ClientImpl::Patch(const std::string &path,
  13903. const std::string &body,
  13904. const std::string &content_type,
  13905. UploadProgress progress) {
  13906. return Patch(path, Headers(), body, content_type, progress);
  13907. }
  13908. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  13909. return Patch(path, Headers(), params);
  13910. }
  13911. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  13912. ContentProvider content_provider,
  13913. const std::string &content_type,
  13914. UploadProgress progress) {
  13915. return Patch(path, Headers(), content_length, std::move(content_provider),
  13916. content_type, progress);
  13917. }
  13918. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  13919. ContentProvider content_provider,
  13920. const std::string &content_type,
  13921. ContentReceiver content_receiver,
  13922. UploadProgress progress) {
  13923. return Patch(path, Headers(), content_length, std::move(content_provider),
  13924. content_type, std::move(content_receiver), progress);
  13925. }
  13926. inline Result ClientImpl::Patch(const std::string &path,
  13927. ContentProviderWithoutLength content_provider,
  13928. const std::string &content_type,
  13929. UploadProgress progress) {
  13930. return Patch(path, Headers(), std::move(content_provider), content_type,
  13931. progress);
  13932. }
  13933. inline Result ClientImpl::Patch(const std::string &path,
  13934. ContentProviderWithoutLength content_provider,
  13935. const std::string &content_type,
  13936. ContentReceiver content_receiver,
  13937. UploadProgress progress) {
  13938. return Patch(path, Headers(), std::move(content_provider), content_type,
  13939. std::move(content_receiver), progress);
  13940. }
  13941. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  13942. const Params &params) {
  13943. auto query = detail::params_to_query_str(params);
  13944. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  13945. }
  13946. inline Result ClientImpl::Patch(const std::string &path,
  13947. const UploadFormDataItems &items,
  13948. UploadProgress progress) {
  13949. return Patch(path, Headers(), items, progress);
  13950. }
  13951. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  13952. const UploadFormDataItems &items,
  13953. UploadProgress progress) {
  13954. const auto &boundary = detail::make_multipart_data_boundary();
  13955. const auto &content_type =
  13956. detail::serialize_multipart_formdata_get_content_type(boundary);
  13957. auto content_length = detail::get_multipart_content_length(items, boundary);
  13958. return Patch(path, headers, content_length,
  13959. detail::make_multipart_content_provider(items, boundary),
  13960. content_type, progress);
  13961. }
  13962. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  13963. const UploadFormDataItems &items,
  13964. const std::string &boundary,
  13965. UploadProgress progress) {
  13966. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  13967. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  13968. }
  13969. const auto &content_type =
  13970. detail::serialize_multipart_formdata_get_content_type(boundary);
  13971. auto content_length = detail::get_multipart_content_length(items, boundary);
  13972. return Patch(path, headers, content_length,
  13973. detail::make_multipart_content_provider(items, boundary),
  13974. content_type, progress);
  13975. }
  13976. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  13977. const char *body, size_t content_length,
  13978. const std::string &content_type,
  13979. UploadProgress progress) {
  13980. return send_with_content_provider_and_receiver(
  13981. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  13982. content_type, nullptr, progress);
  13983. }
  13984. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  13985. const std::string &body,
  13986. const std::string &content_type,
  13987. UploadProgress progress) {
  13988. return send_with_content_provider_and_receiver(
  13989. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  13990. content_type, nullptr, progress);
  13991. }
  13992. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  13993. size_t content_length,
  13994. ContentProvider content_provider,
  13995. const std::string &content_type,
  13996. UploadProgress progress) {
  13997. return send_with_content_provider_and_receiver(
  13998. "PATCH", path, headers, nullptr, content_length,
  13999. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14000. }
  14001. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14002. size_t content_length,
  14003. ContentProvider content_provider,
  14004. const std::string &content_type,
  14005. ContentReceiver content_receiver,
  14006. UploadProgress progress) {
  14007. return send_with_content_provider_and_receiver(
  14008. "PATCH", path, headers, nullptr, content_length,
  14009. std::move(content_provider), nullptr, content_type,
  14010. std::move(content_receiver), progress);
  14011. }
  14012. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14013. ContentProviderWithoutLength content_provider,
  14014. const std::string &content_type,
  14015. UploadProgress progress) {
  14016. return send_with_content_provider_and_receiver(
  14017. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14018. content_type, nullptr, progress);
  14019. }
  14020. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14021. ContentProviderWithoutLength content_provider,
  14022. const std::string &content_type,
  14023. ContentReceiver content_receiver,
  14024. UploadProgress progress) {
  14025. return send_with_content_provider_and_receiver(
  14026. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14027. content_type, std::move(content_receiver), progress);
  14028. }
  14029. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14030. const UploadFormDataItems &items,
  14031. const FormDataProviderItems &provider_items,
  14032. UploadProgress progress) {
  14033. const auto &boundary = detail::make_multipart_data_boundary();
  14034. const auto &content_type =
  14035. detail::serialize_multipart_formdata_get_content_type(boundary);
  14036. return send_with_content_provider_and_receiver(
  14037. "PATCH", path, headers, nullptr, 0, nullptr,
  14038. get_multipart_content_provider(boundary, items, provider_items),
  14039. content_type, nullptr, progress);
  14040. }
  14041. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14042. const std::string &body,
  14043. const std::string &content_type,
  14044. ContentReceiver content_receiver,
  14045. DownloadProgress progress) {
  14046. Request req;
  14047. req.method = "PATCH";
  14048. req.path = path;
  14049. req.headers = headers;
  14050. req.body = body;
  14051. req.content_receiver =
  14052. [content_receiver](const char *data, size_t data_length,
  14053. size_t /*offset*/, size_t /*total_length*/) {
  14054. return content_receiver(data, data_length);
  14055. };
  14056. req.download_progress = std::move(progress);
  14057. if (max_timeout_msec_ > 0) {
  14058. req.start_time_ = std::chrono::steady_clock::now();
  14059. }
  14060. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14061. return send_(std::move(req));
  14062. }
  14063. inline Result ClientImpl::Delete(const std::string &path,
  14064. DownloadProgress progress) {
  14065. return Delete(path, Headers(), std::string(), std::string(), progress);
  14066. }
  14067. inline Result ClientImpl::Delete(const std::string &path,
  14068. const Headers &headers,
  14069. DownloadProgress progress) {
  14070. return Delete(path, headers, std::string(), std::string(), progress);
  14071. }
  14072. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14073. size_t content_length,
  14074. const std::string &content_type,
  14075. DownloadProgress progress) {
  14076. return Delete(path, Headers(), body, content_length, content_type, progress);
  14077. }
  14078. inline Result ClientImpl::Delete(const std::string &path,
  14079. const std::string &body,
  14080. const std::string &content_type,
  14081. DownloadProgress progress) {
  14082. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14083. progress);
  14084. }
  14085. inline Result ClientImpl::Delete(const std::string &path,
  14086. const Headers &headers,
  14087. const std::string &body,
  14088. const std::string &content_type,
  14089. DownloadProgress progress) {
  14090. return Delete(path, headers, body.data(), body.size(), content_type,
  14091. progress);
  14092. }
  14093. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14094. DownloadProgress progress) {
  14095. return Delete(path, Headers(), params, progress);
  14096. }
  14097. inline Result ClientImpl::Delete(const std::string &path,
  14098. const Headers &headers, const Params &params,
  14099. DownloadProgress progress) {
  14100. auto query = detail::params_to_query_str(params);
  14101. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14102. progress);
  14103. }
  14104. inline Result ClientImpl::Delete(const std::string &path,
  14105. const Headers &headers, const char *body,
  14106. size_t content_length,
  14107. const std::string &content_type,
  14108. DownloadProgress progress) {
  14109. Request req;
  14110. req.method = "DELETE";
  14111. req.headers = headers;
  14112. req.path = path;
  14113. req.download_progress = std::move(progress);
  14114. if (max_timeout_msec_ > 0) {
  14115. req.start_time_ = std::chrono::steady_clock::now();
  14116. }
  14117. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14118. req.body.assign(body, content_length);
  14119. return send_(std::move(req));
  14120. }
  14121. inline Result ClientImpl::Options(const std::string &path) {
  14122. return Options(path, Headers());
  14123. }
  14124. inline Result ClientImpl::Options(const std::string &path,
  14125. const Headers &headers) {
  14126. Request req;
  14127. req.method = "OPTIONS";
  14128. req.headers = headers;
  14129. req.path = path;
  14130. if (max_timeout_msec_ > 0) {
  14131. req.start_time_ = std::chrono::steady_clock::now();
  14132. }
  14133. return send_(std::move(req));
  14134. }
  14135. inline void ClientImpl::stop() {
  14136. std::lock_guard<std::mutex> guard(socket_mutex_);
  14137. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14138. // do is to shutdown_socket, so that threads using this socket suddenly
  14139. // discover they can't read/write any more and error out. Everything else
  14140. // (closing the socket, shutting ssl down) is unsafe because these actions
  14141. // are not thread-safe.
  14142. if (socket_requests_in_flight_ > 0) {
  14143. shutdown_socket(socket_);
  14144. // Aside from that, we set a flag for the socket to be closed when we're
  14145. // done.
  14146. socket_should_be_closed_when_request_is_done_ = true;
  14147. return;
  14148. }
  14149. disconnect(/*gracefully=*/true);
  14150. }
  14151. inline std::string ClientImpl::host() const { return host_; }
  14152. inline int ClientImpl::port() const { return port_; }
  14153. inline size_t ClientImpl::is_socket_open() const {
  14154. std::lock_guard<std::mutex> guard(socket_mutex_);
  14155. return socket_.is_open();
  14156. }
  14157. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14158. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14159. connection_timeout_sec_ = sec;
  14160. connection_timeout_usec_ = usec;
  14161. }
  14162. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14163. read_timeout_sec_ = sec;
  14164. read_timeout_usec_ = usec;
  14165. }
  14166. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14167. write_timeout_sec_ = sec;
  14168. write_timeout_usec_ = usec;
  14169. }
  14170. inline void ClientImpl::set_max_timeout(time_t msec) {
  14171. max_timeout_msec_ = msec;
  14172. }
  14173. inline void ClientImpl::set_basic_auth(const std::string &username,
  14174. const std::string &password) {
  14175. basic_auth_username_ = username;
  14176. basic_auth_password_ = password;
  14177. }
  14178. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14179. bearer_token_auth_token_ = token;
  14180. }
  14181. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14182. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14183. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14184. inline void
  14185. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14186. addr_map_ = std::move(addr_map);
  14187. }
  14188. inline void ClientImpl::set_default_headers(Headers headers) {
  14189. default_headers_ = std::move(headers);
  14190. }
  14191. inline void ClientImpl::set_header_writer(
  14192. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14193. header_writer_ = writer;
  14194. }
  14195. inline void ClientImpl::set_address_family(int family) {
  14196. address_family_ = family;
  14197. }
  14198. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14199. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14200. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14201. socket_options_ = std::move(socket_options);
  14202. }
  14203. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14204. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14205. inline void ClientImpl::set_payload_max_length(size_t length) {
  14206. payload_max_length_ = length;
  14207. has_payload_max_length_ = true;
  14208. }
  14209. inline void ClientImpl::set_interface(const std::string &intf) {
  14210. interface_ = intf;
  14211. }
  14212. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14213. proxy_host_ = host;
  14214. proxy_port_ = port;
  14215. std::lock_guard<std::mutex> guard(socket_mutex_);
  14216. disconnect(/*gracefully=*/true);
  14217. }
  14218. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14219. const std::string &password) {
  14220. proxy_basic_auth_username_ = username;
  14221. proxy_basic_auth_password_ = password;
  14222. }
  14223. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14224. proxy_bearer_token_auth_token_ = token;
  14225. }
  14226. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14227. std::vector<detail::NoProxyEntry> parsed;
  14228. parsed.reserve(patterns.size());
  14229. for (const auto &p : patterns) {
  14230. auto trimmed = detail::trim_copy(p);
  14231. if (trimmed.empty()) { continue; }
  14232. detail::NoProxyEntry entry;
  14233. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14234. parsed.push_back(std::move(entry));
  14235. }
  14236. }
  14237. no_proxy_entries_ = std::move(parsed);
  14238. std::lock_guard<std::mutex> guard(socket_mutex_);
  14239. disconnect(/*gracefully=*/true);
  14240. }
  14241. #ifdef CPPHTTPLIB_SSL_ENABLED
  14242. inline void ClientImpl::set_digest_auth(const std::string &username,
  14243. const std::string &password) {
  14244. digest_auth_username_ = username;
  14245. digest_auth_password_ = password;
  14246. }
  14247. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14248. const std::string &ca_cert_dir_path) {
  14249. ca_cert_file_path_ = ca_cert_file_path;
  14250. ca_cert_dir_path_ = ca_cert_dir_path;
  14251. }
  14252. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14253. const std::string &password) {
  14254. proxy_digest_auth_username_ = username;
  14255. proxy_digest_auth_password_ = password;
  14256. }
  14257. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14258. server_certificate_verification_ = enabled;
  14259. }
  14260. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14261. server_hostname_verification_ = enabled;
  14262. }
  14263. inline void ClientImpl::enable_system_ca(bool enabled) {
  14264. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14265. }
  14266. #endif
  14267. inline void ClientImpl::set_logger(Logger logger) {
  14268. logger_ = std::move(logger);
  14269. }
  14270. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14271. error_logger_ = std::move(error_logger);
  14272. }
  14273. /*
  14274. * SSL/TLS Common Implementation
  14275. */
  14276. inline ClientConnection::~ClientConnection() {
  14277. #ifdef CPPHTTPLIB_SSL_ENABLED
  14278. if (session) {
  14279. tls::shutdown(session, true);
  14280. tls::free_session(session);
  14281. session = nullptr;
  14282. }
  14283. #endif
  14284. if (sock != INVALID_SOCKET) {
  14285. detail::close_socket(sock);
  14286. sock = INVALID_SOCKET;
  14287. }
  14288. }
  14289. // Universal client implementation
  14290. inline Client::Client(const std::string &scheme_host_port)
  14291. : Client(scheme_host_port, std::string(), std::string()) {}
  14292. inline Client::Client(const std::string &scheme_host_port,
  14293. const std::string &client_cert_path,
  14294. const std::string &client_key_path) {
  14295. detail::UrlComponents uc;
  14296. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14297. auto &scheme = uc.scheme;
  14298. #ifdef CPPHTTPLIB_SSL_ENABLED
  14299. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14300. #else
  14301. if (!scheme.empty() && scheme != "http") {
  14302. #endif
  14303. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14304. std::string msg = "'" + scheme + "' scheme is not supported.";
  14305. throw std::invalid_argument(msg);
  14306. #endif
  14307. return;
  14308. }
  14309. auto is_ssl = scheme == "https";
  14310. auto host = std::move(uc.host);
  14311. auto port = is_ssl ? 443 : 80;
  14312. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14313. if (is_ssl) {
  14314. #ifdef CPPHTTPLIB_SSL_ENABLED
  14315. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14316. client_key_path);
  14317. is_ssl_ = is_ssl;
  14318. #endif
  14319. } else {
  14320. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14321. client_key_path);
  14322. }
  14323. } else {
  14324. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14325. // if port param below changes.
  14326. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14327. client_cert_path, client_key_path);
  14328. }
  14329. }
  14330. inline Client::Client(const std::string &host, int port)
  14331. : Client(host, port, std::string(), std::string()) {}
  14332. inline Client::Client(const std::string &host, int port,
  14333. const std::string &client_cert_path,
  14334. const std::string &client_key_path)
  14335. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14336. client_key_path)) {}
  14337. inline Client::~Client() = default;
  14338. inline bool Client::is_valid() const {
  14339. return cli_ != nullptr && cli_->is_valid();
  14340. }
  14341. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14342. return cli_->Get(path, std::move(progress));
  14343. }
  14344. inline Result Client::Get(const std::string &path, const Headers &headers,
  14345. DownloadProgress progress) {
  14346. return cli_->Get(path, headers, std::move(progress));
  14347. }
  14348. inline Result Client::Get(const std::string &path,
  14349. ContentReceiver content_receiver,
  14350. DownloadProgress progress) {
  14351. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14352. }
  14353. inline Result Client::Get(const std::string &path, const Headers &headers,
  14354. ContentReceiver content_receiver,
  14355. DownloadProgress progress) {
  14356. return cli_->Get(path, headers, std::move(content_receiver),
  14357. std::move(progress));
  14358. }
  14359. inline Result Client::Get(const std::string &path,
  14360. ResponseHandler response_handler,
  14361. ContentReceiver content_receiver,
  14362. DownloadProgress progress) {
  14363. return cli_->Get(path, std::move(response_handler),
  14364. std::move(content_receiver), std::move(progress));
  14365. }
  14366. inline Result Client::Get(const std::string &path, const Headers &headers,
  14367. ResponseHandler response_handler,
  14368. ContentReceiver content_receiver,
  14369. DownloadProgress progress) {
  14370. return cli_->Get(path, headers, std::move(response_handler),
  14371. std::move(content_receiver), std::move(progress));
  14372. }
  14373. inline Result Client::Get(const std::string &path, const Params &params,
  14374. DownloadProgress progress) {
  14375. return cli_->Get(path, params, std::move(progress));
  14376. }
  14377. inline Result Client::Get(const std::string &path, const Params &params,
  14378. const Headers &headers, DownloadProgress progress) {
  14379. return cli_->Get(path, params, headers, std::move(progress));
  14380. }
  14381. inline Result Client::Get(const std::string &path, const Params &params,
  14382. const Headers &headers,
  14383. ContentReceiver content_receiver,
  14384. DownloadProgress progress) {
  14385. return cli_->Get(path, params, headers, std::move(content_receiver),
  14386. std::move(progress));
  14387. }
  14388. inline Result Client::Get(const std::string &path, const Params &params,
  14389. const Headers &headers,
  14390. ResponseHandler response_handler,
  14391. ContentReceiver content_receiver,
  14392. DownloadProgress progress) {
  14393. return cli_->Get(path, params, headers, std::move(response_handler),
  14394. std::move(content_receiver), std::move(progress));
  14395. }
  14396. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14397. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14398. return cli_->Head(path, headers);
  14399. }
  14400. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14401. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14402. return cli_->Post(path, headers);
  14403. }
  14404. inline Result Client::Post(const std::string &path, const char *body,
  14405. size_t content_length,
  14406. const std::string &content_type,
  14407. UploadProgress progress) {
  14408. return cli_->Post(path, body, content_length, content_type, progress);
  14409. }
  14410. inline Result Client::Post(const std::string &path, const Headers &headers,
  14411. const char *body, size_t content_length,
  14412. const std::string &content_type,
  14413. UploadProgress progress) {
  14414. return cli_->Post(path, headers, body, content_length, content_type,
  14415. progress);
  14416. }
  14417. inline Result Client::Post(const std::string &path, const std::string &body,
  14418. const std::string &content_type,
  14419. UploadProgress progress) {
  14420. return cli_->Post(path, body, content_type, progress);
  14421. }
  14422. inline Result Client::Post(const std::string &path, const Headers &headers,
  14423. const std::string &body,
  14424. const std::string &content_type,
  14425. UploadProgress progress) {
  14426. return cli_->Post(path, headers, body, content_type, progress);
  14427. }
  14428. inline Result Client::Post(const std::string &path, size_t content_length,
  14429. ContentProvider content_provider,
  14430. const std::string &content_type,
  14431. UploadProgress progress) {
  14432. return cli_->Post(path, content_length, std::move(content_provider),
  14433. content_type, progress);
  14434. }
  14435. inline Result Client::Post(const std::string &path, size_t content_length,
  14436. ContentProvider content_provider,
  14437. const std::string &content_type,
  14438. ContentReceiver content_receiver,
  14439. UploadProgress progress) {
  14440. return cli_->Post(path, content_length, std::move(content_provider),
  14441. content_type, std::move(content_receiver), progress);
  14442. }
  14443. inline Result Client::Post(const std::string &path,
  14444. ContentProviderWithoutLength content_provider,
  14445. const std::string &content_type,
  14446. UploadProgress progress) {
  14447. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14448. }
  14449. inline Result Client::Post(const std::string &path,
  14450. ContentProviderWithoutLength content_provider,
  14451. const std::string &content_type,
  14452. ContentReceiver content_receiver,
  14453. UploadProgress progress) {
  14454. return cli_->Post(path, std::move(content_provider), content_type,
  14455. std::move(content_receiver), progress);
  14456. }
  14457. inline Result Client::Post(const std::string &path, const Headers &headers,
  14458. size_t content_length,
  14459. ContentProvider content_provider,
  14460. const std::string &content_type,
  14461. UploadProgress progress) {
  14462. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14463. content_type, progress);
  14464. }
  14465. inline Result Client::Post(const std::string &path, const Headers &headers,
  14466. size_t content_length,
  14467. ContentProvider content_provider,
  14468. const std::string &content_type,
  14469. ContentReceiver content_receiver,
  14470. DownloadProgress progress) {
  14471. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14472. content_type, std::move(content_receiver), progress);
  14473. }
  14474. inline Result Client::Post(const std::string &path, const Headers &headers,
  14475. ContentProviderWithoutLength content_provider,
  14476. const std::string &content_type,
  14477. UploadProgress progress) {
  14478. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14479. progress);
  14480. }
  14481. inline Result Client::Post(const std::string &path, const Headers &headers,
  14482. ContentProviderWithoutLength content_provider,
  14483. const std::string &content_type,
  14484. ContentReceiver content_receiver,
  14485. DownloadProgress progress) {
  14486. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14487. std::move(content_receiver), progress);
  14488. }
  14489. inline Result Client::Post(const std::string &path, const Params &params) {
  14490. return cli_->Post(path, params);
  14491. }
  14492. inline Result Client::Post(const std::string &path, const Headers &headers,
  14493. const Params &params) {
  14494. return cli_->Post(path, headers, params);
  14495. }
  14496. inline Result Client::Post(const std::string &path,
  14497. const UploadFormDataItems &items,
  14498. UploadProgress progress) {
  14499. return cli_->Post(path, items, progress);
  14500. }
  14501. inline Result Client::Post(const std::string &path, const Headers &headers,
  14502. const UploadFormDataItems &items,
  14503. UploadProgress progress) {
  14504. return cli_->Post(path, headers, items, progress);
  14505. }
  14506. inline Result Client::Post(const std::string &path, const Headers &headers,
  14507. const UploadFormDataItems &items,
  14508. const std::string &boundary,
  14509. UploadProgress progress) {
  14510. return cli_->Post(path, headers, items, boundary, progress);
  14511. }
  14512. inline Result Client::Post(const std::string &path, const Headers &headers,
  14513. const UploadFormDataItems &items,
  14514. const FormDataProviderItems &provider_items,
  14515. UploadProgress progress) {
  14516. return cli_->Post(path, headers, items, provider_items, progress);
  14517. }
  14518. inline Result Client::Post(const std::string &path, const Headers &headers,
  14519. const std::string &body,
  14520. const std::string &content_type,
  14521. ContentReceiver content_receiver,
  14522. DownloadProgress progress) {
  14523. return cli_->Post(path, headers, body, content_type,
  14524. std::move(content_receiver), progress);
  14525. }
  14526. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  14527. inline Result Client::Put(const std::string &path, const Headers &headers) {
  14528. return cli_->Put(path, headers);
  14529. }
  14530. inline Result Client::Put(const std::string &path, const char *body,
  14531. size_t content_length,
  14532. const std::string &content_type,
  14533. UploadProgress progress) {
  14534. return cli_->Put(path, body, content_length, content_type, progress);
  14535. }
  14536. inline Result Client::Put(const std::string &path, const Headers &headers,
  14537. const char *body, size_t content_length,
  14538. const std::string &content_type,
  14539. UploadProgress progress) {
  14540. return cli_->Put(path, headers, body, content_length, content_type, progress);
  14541. }
  14542. inline Result Client::Put(const std::string &path, const std::string &body,
  14543. const std::string &content_type,
  14544. UploadProgress progress) {
  14545. return cli_->Put(path, body, content_type, progress);
  14546. }
  14547. inline Result Client::Put(const std::string &path, const Headers &headers,
  14548. const std::string &body,
  14549. const std::string &content_type,
  14550. UploadProgress progress) {
  14551. return cli_->Put(path, headers, body, content_type, progress);
  14552. }
  14553. inline Result Client::Put(const std::string &path, size_t content_length,
  14554. ContentProvider content_provider,
  14555. const std::string &content_type,
  14556. UploadProgress progress) {
  14557. return cli_->Put(path, content_length, std::move(content_provider),
  14558. content_type, progress);
  14559. }
  14560. inline Result Client::Put(const std::string &path, size_t content_length,
  14561. ContentProvider content_provider,
  14562. const std::string &content_type,
  14563. ContentReceiver content_receiver,
  14564. UploadProgress progress) {
  14565. return cli_->Put(path, content_length, std::move(content_provider),
  14566. content_type, std::move(content_receiver), progress);
  14567. }
  14568. inline Result Client::Put(const std::string &path,
  14569. ContentProviderWithoutLength content_provider,
  14570. const std::string &content_type,
  14571. UploadProgress progress) {
  14572. return cli_->Put(path, std::move(content_provider), content_type, progress);
  14573. }
  14574. inline Result Client::Put(const std::string &path,
  14575. ContentProviderWithoutLength content_provider,
  14576. const std::string &content_type,
  14577. ContentReceiver content_receiver,
  14578. UploadProgress progress) {
  14579. return cli_->Put(path, std::move(content_provider), content_type,
  14580. std::move(content_receiver), progress);
  14581. }
  14582. inline Result Client::Put(const std::string &path, const Headers &headers,
  14583. size_t content_length,
  14584. ContentProvider content_provider,
  14585. const std::string &content_type,
  14586. UploadProgress progress) {
  14587. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14588. content_type, progress);
  14589. }
  14590. inline Result Client::Put(const std::string &path, const Headers &headers,
  14591. size_t content_length,
  14592. ContentProvider content_provider,
  14593. const std::string &content_type,
  14594. ContentReceiver content_receiver,
  14595. UploadProgress progress) {
  14596. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14597. content_type, std::move(content_receiver), progress);
  14598. }
  14599. inline Result Client::Put(const std::string &path, const Headers &headers,
  14600. ContentProviderWithoutLength content_provider,
  14601. const std::string &content_type,
  14602. UploadProgress progress) {
  14603. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14604. progress);
  14605. }
  14606. inline Result Client::Put(const std::string &path, const Headers &headers,
  14607. ContentProviderWithoutLength content_provider,
  14608. const std::string &content_type,
  14609. ContentReceiver content_receiver,
  14610. UploadProgress progress) {
  14611. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14612. std::move(content_receiver), progress);
  14613. }
  14614. inline Result Client::Put(const std::string &path, const Params &params) {
  14615. return cli_->Put(path, params);
  14616. }
  14617. inline Result Client::Put(const std::string &path, const Headers &headers,
  14618. const Params &params) {
  14619. return cli_->Put(path, headers, params);
  14620. }
  14621. inline Result Client::Put(const std::string &path,
  14622. const UploadFormDataItems &items,
  14623. UploadProgress progress) {
  14624. return cli_->Put(path, items, progress);
  14625. }
  14626. inline Result Client::Put(const std::string &path, const Headers &headers,
  14627. const UploadFormDataItems &items,
  14628. UploadProgress progress) {
  14629. return cli_->Put(path, headers, items, progress);
  14630. }
  14631. inline Result Client::Put(const std::string &path, const Headers &headers,
  14632. const UploadFormDataItems &items,
  14633. const std::string &boundary,
  14634. UploadProgress progress) {
  14635. return cli_->Put(path, headers, items, boundary, progress);
  14636. }
  14637. inline Result Client::Put(const std::string &path, const Headers &headers,
  14638. const UploadFormDataItems &items,
  14639. const FormDataProviderItems &provider_items,
  14640. UploadProgress progress) {
  14641. return cli_->Put(path, headers, items, provider_items, progress);
  14642. }
  14643. inline Result Client::Put(const std::string &path, const Headers &headers,
  14644. const std::string &body,
  14645. const std::string &content_type,
  14646. ContentReceiver content_receiver,
  14647. DownloadProgress progress) {
  14648. return cli_->Put(path, headers, body, content_type, content_receiver,
  14649. progress);
  14650. }
  14651. inline Result Client::Patch(const std::string &path) {
  14652. return cli_->Patch(path);
  14653. }
  14654. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  14655. return cli_->Patch(path, headers);
  14656. }
  14657. inline Result Client::Patch(const std::string &path, const char *body,
  14658. size_t content_length,
  14659. const std::string &content_type,
  14660. UploadProgress progress) {
  14661. return cli_->Patch(path, body, content_length, content_type, progress);
  14662. }
  14663. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14664. const char *body, size_t content_length,
  14665. const std::string &content_type,
  14666. UploadProgress progress) {
  14667. return cli_->Patch(path, headers, body, content_length, content_type,
  14668. progress);
  14669. }
  14670. inline Result Client::Patch(const std::string &path, const std::string &body,
  14671. const std::string &content_type,
  14672. UploadProgress progress) {
  14673. return cli_->Patch(path, body, content_type, progress);
  14674. }
  14675. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14676. const std::string &body,
  14677. const std::string &content_type,
  14678. UploadProgress progress) {
  14679. return cli_->Patch(path, headers, body, content_type, progress);
  14680. }
  14681. inline Result Client::Patch(const std::string &path, size_t content_length,
  14682. ContentProvider content_provider,
  14683. const std::string &content_type,
  14684. UploadProgress progress) {
  14685. return cli_->Patch(path, content_length, std::move(content_provider),
  14686. content_type, progress);
  14687. }
  14688. inline Result Client::Patch(const std::string &path, size_t content_length,
  14689. ContentProvider content_provider,
  14690. const std::string &content_type,
  14691. ContentReceiver content_receiver,
  14692. UploadProgress progress) {
  14693. return cli_->Patch(path, content_length, std::move(content_provider),
  14694. content_type, std::move(content_receiver), progress);
  14695. }
  14696. inline Result Client::Patch(const std::string &path,
  14697. ContentProviderWithoutLength content_provider,
  14698. const std::string &content_type,
  14699. UploadProgress progress) {
  14700. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  14701. }
  14702. inline Result Client::Patch(const std::string &path,
  14703. ContentProviderWithoutLength content_provider,
  14704. const std::string &content_type,
  14705. ContentReceiver content_receiver,
  14706. UploadProgress progress) {
  14707. return cli_->Patch(path, std::move(content_provider), content_type,
  14708. std::move(content_receiver), progress);
  14709. }
  14710. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14711. size_t content_length,
  14712. ContentProvider content_provider,
  14713. const std::string &content_type,
  14714. UploadProgress progress) {
  14715. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  14716. content_type, progress);
  14717. }
  14718. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14719. size_t content_length,
  14720. ContentProvider content_provider,
  14721. const std::string &content_type,
  14722. ContentReceiver content_receiver,
  14723. UploadProgress progress) {
  14724. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  14725. content_type, std::move(content_receiver), progress);
  14726. }
  14727. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14728. ContentProviderWithoutLength content_provider,
  14729. const std::string &content_type,
  14730. UploadProgress progress) {
  14731. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  14732. progress);
  14733. }
  14734. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14735. ContentProviderWithoutLength content_provider,
  14736. const std::string &content_type,
  14737. ContentReceiver content_receiver,
  14738. UploadProgress progress) {
  14739. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  14740. std::move(content_receiver), progress);
  14741. }
  14742. inline Result Client::Patch(const std::string &path, const Params &params) {
  14743. return cli_->Patch(path, params);
  14744. }
  14745. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14746. const Params &params) {
  14747. return cli_->Patch(path, headers, params);
  14748. }
  14749. inline Result Client::Patch(const std::string &path,
  14750. const UploadFormDataItems &items,
  14751. UploadProgress progress) {
  14752. return cli_->Patch(path, items, progress);
  14753. }
  14754. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14755. const UploadFormDataItems &items,
  14756. UploadProgress progress) {
  14757. return cli_->Patch(path, headers, items, progress);
  14758. }
  14759. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14760. const UploadFormDataItems &items,
  14761. const std::string &boundary,
  14762. UploadProgress progress) {
  14763. return cli_->Patch(path, headers, items, boundary, progress);
  14764. }
  14765. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14766. const UploadFormDataItems &items,
  14767. const FormDataProviderItems &provider_items,
  14768. UploadProgress progress) {
  14769. return cli_->Patch(path, headers, items, provider_items, progress);
  14770. }
  14771. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14772. const std::string &body,
  14773. const std::string &content_type,
  14774. ContentReceiver content_receiver,
  14775. DownloadProgress progress) {
  14776. return cli_->Patch(path, headers, body, content_type, content_receiver,
  14777. progress);
  14778. }
  14779. inline Result Client::Delete(const std::string &path,
  14780. DownloadProgress progress) {
  14781. return cli_->Delete(path, progress);
  14782. }
  14783. inline Result Client::Delete(const std::string &path, const Headers &headers,
  14784. DownloadProgress progress) {
  14785. return cli_->Delete(path, headers, progress);
  14786. }
  14787. inline Result Client::Delete(const std::string &path, const char *body,
  14788. size_t content_length,
  14789. const std::string &content_type,
  14790. DownloadProgress progress) {
  14791. return cli_->Delete(path, body, content_length, content_type, progress);
  14792. }
  14793. inline Result Client::Delete(const std::string &path, const Headers &headers,
  14794. const char *body, size_t content_length,
  14795. const std::string &content_type,
  14796. DownloadProgress progress) {
  14797. return cli_->Delete(path, headers, body, content_length, content_type,
  14798. progress);
  14799. }
  14800. inline Result Client::Delete(const std::string &path, const std::string &body,
  14801. const std::string &content_type,
  14802. DownloadProgress progress) {
  14803. return cli_->Delete(path, body, content_type, progress);
  14804. }
  14805. inline Result Client::Delete(const std::string &path, const Headers &headers,
  14806. const std::string &body,
  14807. const std::string &content_type,
  14808. DownloadProgress progress) {
  14809. return cli_->Delete(path, headers, body, content_type, progress);
  14810. }
  14811. inline Result Client::Delete(const std::string &path, const Params &params,
  14812. DownloadProgress progress) {
  14813. return cli_->Delete(path, params, progress);
  14814. }
  14815. inline Result Client::Delete(const std::string &path, const Headers &headers,
  14816. const Params &params, DownloadProgress progress) {
  14817. return cli_->Delete(path, headers, params, progress);
  14818. }
  14819. inline Result Client::Options(const std::string &path) {
  14820. return cli_->Options(path);
  14821. }
  14822. inline Result Client::Options(const std::string &path, const Headers &headers) {
  14823. return cli_->Options(path, headers);
  14824. }
  14825. inline ClientImpl::StreamHandle
  14826. Client::open_stream(const std::string &method, const std::string &path,
  14827. const Params &params, const Headers &headers,
  14828. const std::string &body, const std::string &content_type) {
  14829. return cli_->open_stream(method, path, params, headers, body, content_type);
  14830. }
  14831. inline bool Client::send(Request &req, Response &res, Error &error) {
  14832. return cli_->send(req, res, error);
  14833. }
  14834. inline Result Client::send(const Request &req) { return cli_->send(req); }
  14835. inline void Client::stop() { cli_->stop(); }
  14836. inline std::string Client::host() const { return cli_->host(); }
  14837. inline int Client::port() const { return cli_->port(); }
  14838. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  14839. inline socket_t Client::socket() const { return cli_->socket(); }
  14840. inline void
  14841. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14842. cli_->set_hostname_addr_map(std::move(addr_map));
  14843. }
  14844. inline void Client::set_default_headers(Headers headers) {
  14845. cli_->set_default_headers(std::move(headers));
  14846. }
  14847. inline void Client::set_header_writer(
  14848. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14849. cli_->set_header_writer(writer);
  14850. }
  14851. inline void Client::set_address_family(int family) {
  14852. cli_->set_address_family(family);
  14853. }
  14854. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  14855. inline void Client::set_socket_options(SocketOptions socket_options) {
  14856. cli_->set_socket_options(std::move(socket_options));
  14857. }
  14858. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  14859. cli_->set_connection_timeout(sec, usec);
  14860. }
  14861. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  14862. cli_->set_read_timeout(sec, usec);
  14863. }
  14864. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  14865. cli_->set_write_timeout(sec, usec);
  14866. }
  14867. inline void Client::set_basic_auth(const std::string &username,
  14868. const std::string &password) {
  14869. cli_->set_basic_auth(username, password);
  14870. }
  14871. inline void Client::set_bearer_token_auth(const std::string &token) {
  14872. cli_->set_bearer_token_auth(token);
  14873. }
  14874. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  14875. inline void Client::set_follow_location(bool on) {
  14876. cli_->set_follow_location(on);
  14877. }
  14878. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  14879. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  14880. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  14881. inline void Client::set_payload_max_length(size_t length) {
  14882. cli_->set_payload_max_length(length);
  14883. }
  14884. inline void Client::set_interface(const std::string &intf) {
  14885. cli_->set_interface(intf);
  14886. }
  14887. inline void Client::set_proxy(const std::string &host, int port) {
  14888. cli_->set_proxy(host, port);
  14889. }
  14890. inline void Client::set_proxy_basic_auth(const std::string &username,
  14891. const std::string &password) {
  14892. cli_->set_proxy_basic_auth(username, password);
  14893. }
  14894. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  14895. cli_->set_proxy_bearer_token_auth(token);
  14896. }
  14897. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  14898. cli_->set_no_proxy(patterns);
  14899. }
  14900. inline void Client::set_logger(Logger logger) {
  14901. cli_->set_logger(std::move(logger));
  14902. }
  14903. inline void Client::set_error_logger(ErrorLogger error_logger) {
  14904. cli_->set_error_logger(std::move(error_logger));
  14905. }
  14906. /*
  14907. * Group 6: SSL Server and Client implementation
  14908. */
  14909. #ifdef CPPHTTPLIB_SSL_ENABLED
  14910. // SSL HTTP server implementation
  14911. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  14912. const char *client_ca_cert_file_path,
  14913. const char *client_ca_cert_dir_path,
  14914. const char *private_key_password) {
  14915. using namespace tls;
  14916. ctx_ = create_server_context();
  14917. if (!ctx_) { return; }
  14918. // Load server certificate and private key
  14919. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  14920. private_key_password)) {
  14921. last_ssl_error_ = static_cast<int>(get_error());
  14922. free_context(ctx_);
  14923. ctx_ = nullptr;
  14924. return;
  14925. }
  14926. // Load client CA certificates for client authentication
  14927. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  14928. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  14929. client_ca_cert_dir_path)) {
  14930. last_ssl_error_ = static_cast<int>(get_error());
  14931. free_context(ctx_);
  14932. ctx_ = nullptr;
  14933. return;
  14934. }
  14935. // Enable client certificate verification
  14936. set_verify_client(ctx_, true);
  14937. }
  14938. }
  14939. inline SSLServer::SSLServer(const PemMemory &pem) {
  14940. using namespace tls;
  14941. ctx_ = create_server_context();
  14942. if (ctx_) {
  14943. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  14944. pem.private_key_password)) {
  14945. last_ssl_error_ = static_cast<int>(get_error());
  14946. free_context(ctx_);
  14947. ctx_ = nullptr;
  14948. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  14949. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  14950. last_ssl_error_ = static_cast<int>(get_error());
  14951. free_context(ctx_);
  14952. ctx_ = nullptr;
  14953. } else {
  14954. set_verify_client(ctx_, true);
  14955. }
  14956. }
  14957. }
  14958. }
  14959. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  14960. using namespace tls;
  14961. ctx_ = create_server_context();
  14962. if (ctx_) {
  14963. if (!setup_callback(ctx_)) {
  14964. free_context(ctx_);
  14965. ctx_ = nullptr;
  14966. }
  14967. }
  14968. }
  14969. inline SSLServer::~SSLServer() {
  14970. if (ctx_) { tls::free_context(ctx_); }
  14971. }
  14972. inline bool SSLServer::is_valid() const {
  14973. return ctx_ != nullptr && Server::is_valid();
  14974. }
  14975. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  14976. using namespace tls;
  14977. // Create TLS session with mutex protection
  14978. session_t session = nullptr;
  14979. {
  14980. std::lock_guard<std::mutex> guard(ctx_mutex_);
  14981. session = create_session(static_cast<ctx_t>(ctx_), sock);
  14982. }
  14983. if (!session) {
  14984. last_ssl_error_ = static_cast<int>(get_error());
  14985. detail::shutdown_socket(sock);
  14986. detail::close_socket(sock);
  14987. return false;
  14988. }
  14989. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  14990. bool handshake_done = false;
  14991. bool ret = false;
  14992. bool websocket_upgraded = false;
  14993. auto cleanup = detail::scope_exit([&] {
  14994. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  14995. free_session(session);
  14996. detail::shutdown_socket(sock);
  14997. detail::close_socket(sock);
  14998. });
  14999. // Perform TLS accept handshake with timeout
  15000. TlsError tls_err;
  15001. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15002. &tls_err)) {
  15003. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15004. // Map TlsError to legacy ssl_error for backward compatibility
  15005. if (tls_err.code == ErrorCode::WantRead) {
  15006. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15007. } else if (tls_err.code == ErrorCode::WantWrite) {
  15008. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15009. } else {
  15010. last_ssl_error_ = SSL_ERROR_SSL;
  15011. }
  15012. #else
  15013. last_ssl_error_ = static_cast<int>(get_error());
  15014. #endif
  15015. return false;
  15016. }
  15017. handshake_done = true;
  15018. std::string remote_addr;
  15019. int remote_port = 0;
  15020. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15021. std::string local_addr;
  15022. int local_port = 0;
  15023. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15024. ret = serve_guarded([&]() {
  15025. return detail::process_server_socket_ssl(
  15026. svr_sock_, session, sock, keep_alive_max_count_,
  15027. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15028. write_timeout_sec_, write_timeout_usec_,
  15029. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15030. return process_request(
  15031. strm, remote_addr, remote_port, local_addr, local_port,
  15032. close_connection, connection_closed,
  15033. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15034. });
  15035. });
  15036. return ret;
  15037. }
  15038. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15039. const char *key_pem,
  15040. const char *client_ca_pem,
  15041. const char *password) {
  15042. if (!ctx_) { return false; }
  15043. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15044. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15045. return false;
  15046. }
  15047. if (client_ca_pem) {
  15048. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15049. }
  15050. return true;
  15051. }
  15052. // SSL HTTP client implementation
  15053. inline SSLClient::~SSLClient() {
  15054. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15055. // base function rather than the derived function once we get to the
  15056. // base class destructor, and won't free the SSL (causing a leak).
  15057. // This must happen before the context is freed below: some backends
  15058. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15059. // context, so freeing the context first leaves close_notify reading
  15060. // freed memory.
  15061. shutdown_ssl_impl(socket_, true);
  15062. if (ctx_) {
  15063. tls::free_context(ctx_);
  15064. ctx_ = nullptr;
  15065. }
  15066. }
  15067. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15068. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15069. shutdown_ssl_impl(socket, shutdown_gracefully);
  15070. }
  15071. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15072. bool shutdown_gracefully) {
  15073. if (socket.sock == INVALID_SOCKET) {
  15074. assert(socket.ssl == nullptr);
  15075. return;
  15076. }
  15077. if (socket.ssl) {
  15078. tls::shutdown(socket.ssl, shutdown_gracefully);
  15079. {
  15080. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15081. tls::free_session(socket.ssl);
  15082. }
  15083. socket.ssl = nullptr;
  15084. }
  15085. assert(socket.ssl == nullptr);
  15086. }
  15087. inline bool SSLClient::process_socket(
  15088. const Socket &socket,
  15089. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15090. std::function<bool(Stream &strm)> callback) {
  15091. assert(socket.ssl);
  15092. return detail::process_client_socket_ssl(
  15093. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15094. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15095. std::move(callback));
  15096. }
  15097. inline bool SSLClient::is_ssl() const { return true; }
  15098. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15099. if (!is_valid()) {
  15100. error = Error::SSLConnection;
  15101. return false;
  15102. }
  15103. return ClientImpl::create_and_connect_socket(socket, error);
  15104. }
  15105. inline bool SSLClient::setup_proxy_connection(
  15106. Socket &socket,
  15107. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15108. Response &res, bool &success, Error &error) {
  15109. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15110. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15111. return false;
  15112. }
  15113. if (!initialize_ssl(socket, error)) {
  15114. success = false;
  15115. return false;
  15116. }
  15117. return true;
  15118. }
  15119. // Assumes that socket_mutex_ is locked and that there are no requests in
  15120. // flight
  15121. inline bool SSLClient::connect_with_proxy(
  15122. Socket &socket,
  15123. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15124. Response &res, bool &success, Error &error) {
  15125. success = true;
  15126. Response proxy_res;
  15127. if (!detail::process_client_socket(
  15128. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15129. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15130. start_time, [&](Stream &strm) {
  15131. Request req2;
  15132. req2.method = "CONNECT";
  15133. req2.path =
  15134. detail::make_host_and_port_string_always_port(host_, port_);
  15135. if (max_timeout_msec_ > 0) {
  15136. req2.start_time_ = std::chrono::steady_clock::now();
  15137. }
  15138. return process_request(strm, req2, proxy_res, false, error);
  15139. })) {
  15140. // Thread-safe to close everything because we are assuming there are no
  15141. // requests in flight
  15142. shutdown_ssl(socket, true);
  15143. shutdown_socket(socket);
  15144. close_socket(socket);
  15145. success = false;
  15146. return false;
  15147. }
  15148. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15149. if (!proxy_digest_auth_username_.empty() &&
  15150. !proxy_digest_auth_password_.empty()) {
  15151. std::map<std::string, std::string> auth;
  15152. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15153. // Close the current socket and create a new one for the authenticated
  15154. // request
  15155. shutdown_ssl(socket, true);
  15156. shutdown_socket(socket);
  15157. close_socket(socket);
  15158. // Create a new socket for the authenticated CONNECT request
  15159. if (!ensure_socket_connection(socket, error)) {
  15160. success = false;
  15161. output_error_log(error, nullptr);
  15162. return false;
  15163. }
  15164. proxy_res = Response();
  15165. if (!detail::process_client_socket(
  15166. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15167. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15168. start_time, [&](Stream &strm) {
  15169. Request req3;
  15170. req3.method = "CONNECT";
  15171. req3.path = detail::make_host_and_port_string_always_port(
  15172. host_, port_);
  15173. req3.headers.insert(detail::make_digest_authentication_header(
  15174. req3, auth, 1, detail::random_string(10),
  15175. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15176. true));
  15177. if (max_timeout_msec_ > 0) {
  15178. req3.start_time_ = std::chrono::steady_clock::now();
  15179. }
  15180. return process_request(strm, req3, proxy_res, false, error);
  15181. })) {
  15182. // Thread-safe to close everything because we are assuming there are
  15183. // no requests in flight
  15184. shutdown_ssl(socket, true);
  15185. shutdown_socket(socket);
  15186. close_socket(socket);
  15187. success = false;
  15188. return false;
  15189. }
  15190. }
  15191. }
  15192. }
  15193. // If status code is not 200, proxy request is failed.
  15194. // Set error to ProxyConnection and return proxy response
  15195. // as the response of the request
  15196. if (proxy_res.status != StatusCode::OK_200) {
  15197. error = Error::ProxyConnection;
  15198. output_error_log(error, nullptr);
  15199. res = std::move(proxy_res);
  15200. // Thread-safe to close everything because we are assuming there are
  15201. // no requests in flight
  15202. shutdown_ssl(socket, true);
  15203. shutdown_socket(socket);
  15204. close_socket(socket);
  15205. return false;
  15206. }
  15207. return true;
  15208. }
  15209. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15210. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15211. if (is_proxy_enabled_for_host(host_)) { return true; }
  15212. if (!initialize_ssl(socket, error)) {
  15213. shutdown_socket(socket);
  15214. close_socket(socket);
  15215. return false;
  15216. }
  15217. return true;
  15218. }
  15219. // SSL HTTP client implementation
  15220. inline SSLClient::SSLClient(const std::string &host)
  15221. : SSLClient(host, 443, std::string(), std::string()) {}
  15222. inline SSLClient::SSLClient(const std::string &host, int port)
  15223. : SSLClient(host, port, std::string(), std::string()) {}
  15224. inline void SSLClient::init_ctx() {
  15225. ctx_ = tls::create_client_context();
  15226. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15227. }
  15228. inline void SSLClient::reset_ctx_on_error() {
  15229. last_backend_error_ = tls::get_error();
  15230. tls::free_context(ctx_);
  15231. ctx_ = nullptr;
  15232. }
  15233. inline SSLClient::SSLClient(const std::string &host, int port,
  15234. const std::string &client_cert_path,
  15235. const std::string &client_key_path,
  15236. const std::string &private_key_password)
  15237. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15238. init_ctx();
  15239. if (!ctx_) { return; }
  15240. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15241. const char *password =
  15242. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15243. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15244. client_key_path.c_str(), password)) {
  15245. reset_ctx_on_error();
  15246. }
  15247. }
  15248. }
  15249. inline SSLClient::SSLClient(const std::string &host, int port,
  15250. const PemMemory &pem)
  15251. : ClientImpl(host, port) {
  15252. init_ctx();
  15253. if (!ctx_) { return; }
  15254. if (pem.cert_pem && pem.key_pem) {
  15255. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15256. pem.private_key_password)) {
  15257. reset_ctx_on_error();
  15258. }
  15259. }
  15260. }
  15261. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15262. if (ca_cert_store && ctx_) {
  15263. // set_ca_store takes ownership of ca_cert_store
  15264. tls::set_ca_store(ctx_, ca_cert_store);
  15265. ca_cert_store_set_ = true;
  15266. } else if (ca_cert_store) {
  15267. tls::free_ca_store(ca_cert_store);
  15268. }
  15269. }
  15270. inline void
  15271. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15272. if (!ctx_) { return; }
  15273. tls::set_verify_callback(ctx_, verifier);
  15274. }
  15275. inline void SSLClient::set_session_verifier(
  15276. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15277. session_verifier_ = std::move(verifier);
  15278. }
  15279. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15280. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15281. enable_windows_cert_verification_ = enabled;
  15282. }
  15283. #endif
  15284. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15285. std::size_t size) {
  15286. if (ctx_ && ca_cert && size > 0) {
  15287. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15288. tls::load_ca_pem(ctx_, ca_cert, size);
  15289. }
  15290. }
  15291. inline bool SSLClient::load_certs() {
  15292. auto ret = true;
  15293. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15294. // one client is shared across concurrent requests here.
  15295. std::call_once(initialize_cert_, [&]() {
  15296. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15297. ret = detail::load_client_ca_config(
  15298. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15299. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15300. last_backend_error_);
  15301. });
  15302. return ret;
  15303. }
  15304. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15305. // Load CA certificates if server verification is enabled
  15306. if (server_certificate_verification_) {
  15307. if (!load_certs()) {
  15308. error = Error::SSLLoadingCerts;
  15309. output_error_log(error, nullptr);
  15310. return false;
  15311. }
  15312. }
  15313. detail::ClientTlsSessionOptions options;
  15314. options.server_hostname_verification = server_hostname_verification_;
  15315. options.session_verifier = session_verifier_;
  15316. options.ctx_mutex = &ctx_mutex_;
  15317. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15318. // Skip Schannel when a custom CA cert is specified, as the Windows
  15319. // certificate store would not know about user-provided CA certificates.
  15320. // Also skip when system CA trust is explicitly disabled.
  15321. options.windows_cert_verification =
  15322. enable_windows_cert_verification_ &&
  15323. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15324. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15325. #endif
  15326. tls::session_t session = nullptr;
  15327. // Use scope_exit to ensure session is freed on error paths
  15328. bool success = false;
  15329. auto session_guard = detail::scope_exit([&] {
  15330. if (!success) { tls::free_session(session); }
  15331. });
  15332. detail::ClientTlsSessionError tls_error;
  15333. if (!detail::setup_client_tls_session(
  15334. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15335. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15336. options)) {
  15337. error = tls_error.error;
  15338. last_ssl_error_ = tls_error.ssl_error;
  15339. last_backend_error_ = tls_error.backend_error;
  15340. output_error_log(error, nullptr);
  15341. return false;
  15342. }
  15343. success = true;
  15344. socket.ssl = session;
  15345. return true;
  15346. }
  15347. inline void Client::set_digest_auth(const std::string &username,
  15348. const std::string &password) {
  15349. cli_->set_digest_auth(username, password);
  15350. }
  15351. inline void Client::set_proxy_digest_auth(const std::string &username,
  15352. const std::string &password) {
  15353. cli_->set_proxy_digest_auth(username, password);
  15354. }
  15355. inline void Client::enable_server_certificate_verification(bool enabled) {
  15356. cli_->enable_server_certificate_verification(enabled);
  15357. }
  15358. inline void Client::enable_server_hostname_verification(bool enabled) {
  15359. cli_->enable_server_hostname_verification(enabled);
  15360. }
  15361. inline void Client::enable_system_ca(bool enabled) {
  15362. cli_->enable_system_ca(enabled);
  15363. }
  15364. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15365. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15366. if (is_ssl_) {
  15367. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15368. enabled);
  15369. }
  15370. }
  15371. #endif
  15372. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15373. const std::string &ca_cert_dir_path) {
  15374. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15375. }
  15376. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15377. if (is_ssl_) {
  15378. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15379. } else if (ca_cert_store) {
  15380. tls::free_ca_store(ca_cert_store);
  15381. }
  15382. }
  15383. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15384. if (is_ssl_) {
  15385. // Use the PEM-based path so the CA data is retained for redirect transfer
  15386. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15387. }
  15388. }
  15389. inline void
  15390. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15391. if (is_ssl_) {
  15392. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15393. std::move(verifier));
  15394. }
  15395. }
  15396. inline void Client::set_session_verifier(
  15397. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15398. if (is_ssl_) {
  15399. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15400. }
  15401. }
  15402. inline tls::ctx_t Client::tls_context() const {
  15403. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15404. return nullptr;
  15405. }
  15406. #endif // CPPHTTPLIB_SSL_ENABLED
  15407. /*
  15408. * Group 7: TLS abstraction layer - Common API
  15409. */
  15410. #ifdef CPPHTTPLIB_SSL_ENABLED
  15411. namespace tls {
  15412. // Helper for PeerCert construction
  15413. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15414. return PeerCert(get_peer_cert(session));
  15415. }
  15416. namespace impl {
  15417. inline VerifyCallback &get_verify_callback() {
  15418. static thread_local VerifyCallback callback;
  15419. return callback;
  15420. }
  15421. inline VerifyCallback &get_mbedtls_verify_callback() {
  15422. static thread_local VerifyCallback callback;
  15423. return callback;
  15424. }
  15425. // Check if a string is an IPv4 address
  15426. inline bool is_ipv4_address(const std::string &str) {
  15427. int dots = 0;
  15428. for (char c : str) {
  15429. if (c == '.') {
  15430. dots++;
  15431. } else if (!detail::is_ascii_digit(c)) {
  15432. return false;
  15433. }
  15434. }
  15435. return dots == 3;
  15436. }
  15437. // Parse IPv4 address string to bytes
  15438. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15439. const char *p = str.c_str();
  15440. for (int i = 0; i < 4; i++) {
  15441. if (i > 0) {
  15442. if (*p != '.') { return false; }
  15443. p++;
  15444. }
  15445. int val = 0;
  15446. int digits = 0;
  15447. while (detail::is_ascii_digit(*p)) {
  15448. val = val * 10 + (*p - '0');
  15449. if (val > 255) { return false; }
  15450. p++;
  15451. digits++;
  15452. }
  15453. if (digits == 0) { return false; }
  15454. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15455. if (digits > 1 && *(p - digits) == '0') { return false; }
  15456. out[i] = static_cast<unsigned char>(val);
  15457. }
  15458. return *p == '\0';
  15459. }
  15460. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15461. // `out` must have room for at least 16 bytes. Returns the address length
  15462. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15463. // literal. Used to match a host against iPAddress SANs the same way the
  15464. // OpenSSL backend does via X509_check_ip.
  15465. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15466. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15467. struct in6_addr addr6 = {};
  15468. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15469. memcpy(out, &addr6, 16);
  15470. return 16;
  15471. }
  15472. return 0;
  15473. }
  15474. #ifdef _WIN32
  15475. // Enumerate Windows system certificates and call callback with DER data
  15476. template <typename Callback>
  15477. inline bool enumerate_windows_system_certs(Callback cb) {
  15478. bool loaded = false;
  15479. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15480. for (auto store_name : store_names) {
  15481. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15482. if (hStore) {
  15483. PCCERT_CONTEXT pContext = nullptr;
  15484. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15485. nullptr) {
  15486. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  15487. loaded = true;
  15488. }
  15489. }
  15490. CertCloseStore(hStore, 0);
  15491. }
  15492. }
  15493. return loaded;
  15494. }
  15495. #endif
  15496. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  15497. // Enumerate macOS Keychain certificates and call callback with DER data
  15498. template <typename Callback>
  15499. inline bool enumerate_macos_keychain_certs(Callback cb) {
  15500. bool loaded = false;
  15501. const SecTrustSettingsDomain domains[] = {
  15502. kSecTrustSettingsDomainSystem,
  15503. kSecTrustSettingsDomainAdmin,
  15504. kSecTrustSettingsDomainUser,
  15505. };
  15506. for (auto domain : domains) {
  15507. CFArrayRef certs = nullptr;
  15508. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  15509. if (status != errSecSuccess || !certs) {
  15510. if (certs) CFRelease(certs);
  15511. continue;
  15512. }
  15513. CFIndex count = CFArrayGetCount(certs);
  15514. for (CFIndex i = 0; i < count; i++) {
  15515. SecCertificateRef cert =
  15516. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  15517. CFDataRef data = SecCertificateCopyData(cert);
  15518. if (data) {
  15519. if (cb(CFDataGetBytePtr(data),
  15520. static_cast<size_t>(CFDataGetLength(data)))) {
  15521. loaded = true;
  15522. }
  15523. CFRelease(data);
  15524. }
  15525. }
  15526. CFRelease(certs);
  15527. }
  15528. return loaded;
  15529. }
  15530. #endif
  15531. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  15532. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  15533. // Common CA certificate file paths on Linux/Unix
  15534. inline const char **system_ca_paths() {
  15535. static const char *paths[] = {
  15536. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  15537. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  15538. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  15539. "/etc/pki/tls/cacert.pem", // OpenELEC
  15540. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  15541. nullptr};
  15542. return paths;
  15543. }
  15544. // Common CA certificate directory paths on Linux/Unix
  15545. inline const char **system_ca_dirs() {
  15546. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  15547. "/etc/pki/tls/certs", // RHEL/CentOS
  15548. "/usr/share/ca-certificates", // Other
  15549. nullptr};
  15550. return dirs;
  15551. }
  15552. #endif
  15553. } // namespace impl
  15554. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  15555. const char *ca_dir) {
  15556. if (!ctx) { return false; }
  15557. bool success = true;
  15558. if (ca_file && *ca_file) {
  15559. if (!load_ca_file(ctx, ca_file)) { success = false; }
  15560. }
  15561. if (ca_dir && *ca_dir) {
  15562. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  15563. }
  15564. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15565. // Set CA list for client certificate request (CertificateRequest message)
  15566. if (ca_file && *ca_file) {
  15567. auto list = SSL_load_client_CA_file(ca_file);
  15568. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  15569. }
  15570. #endif
  15571. return success;
  15572. }
  15573. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  15574. const char *password) {
  15575. return set_client_cert_pem(ctx, cert, key, password);
  15576. }
  15577. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  15578. const char *key_path, const char *password) {
  15579. return set_client_cert_file(ctx, cert_path, key_path, password);
  15580. }
  15581. // PeerCert implementation
  15582. inline PeerCert::PeerCert() = default;
  15583. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  15584. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  15585. other.cert_ = nullptr;
  15586. }
  15587. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  15588. if (this != &other) {
  15589. if (cert_) { free_cert(cert_); }
  15590. cert_ = other.cert_;
  15591. other.cert_ = nullptr;
  15592. }
  15593. return *this;
  15594. }
  15595. inline PeerCert::~PeerCert() {
  15596. if (cert_) { free_cert(cert_); }
  15597. }
  15598. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  15599. inline std::string PeerCert::subject_cn() const {
  15600. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  15601. }
  15602. inline std::string PeerCert::issuer_name() const {
  15603. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  15604. }
  15605. inline bool PeerCert::check_hostname(const char *hostname) const {
  15606. return cert_ ? verify_hostname(cert_, hostname) : false;
  15607. }
  15608. inline std::vector<SanEntry> PeerCert::sans() const {
  15609. std::vector<SanEntry> result;
  15610. if (cert_) { get_cert_sans(cert_, result); }
  15611. return result;
  15612. }
  15613. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  15614. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  15615. }
  15616. inline std::string PeerCert::serial() const {
  15617. return cert_ ? get_cert_serial(cert_) : std::string();
  15618. }
  15619. // VerifyContext method implementations
  15620. inline std::string VerifyContext::subject_cn() const {
  15621. return cert ? get_cert_subject_cn(cert) : std::string();
  15622. }
  15623. inline std::string VerifyContext::issuer_name() const {
  15624. return cert ? get_cert_issuer_name(cert) : std::string();
  15625. }
  15626. inline bool VerifyContext::check_hostname(const char *hostname) const {
  15627. return cert ? verify_hostname(cert, hostname) : false;
  15628. }
  15629. inline std::vector<SanEntry> VerifyContext::sans() const {
  15630. std::vector<SanEntry> result;
  15631. if (cert) { get_cert_sans(cert, result); }
  15632. return result;
  15633. }
  15634. inline bool VerifyContext::validity(time_t &not_before,
  15635. time_t &not_after) const {
  15636. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  15637. }
  15638. inline std::string VerifyContext::serial() const {
  15639. return cert ? get_cert_serial(cert) : std::string();
  15640. }
  15641. // TlsError static method implementation
  15642. inline std::string TlsError::verify_error_to_string(long error_code) {
  15643. return verify_error_string(error_code);
  15644. }
  15645. } // namespace tls
  15646. // Request::peer_cert() implementation
  15647. inline tls::PeerCert Request::peer_cert() const {
  15648. return tls::get_peer_cert_from_session(ssl);
  15649. }
  15650. // Request::sni() implementation
  15651. inline std::string Request::sni() const {
  15652. if (!ssl) { return std::string(); }
  15653. const char *s = tls::get_sni(ssl);
  15654. return s ? std::string(s) : std::string();
  15655. }
  15656. #endif // CPPHTTPLIB_SSL_ENABLED
  15657. /*
  15658. * Group 8: TLS abstraction layer - OpenSSL backend
  15659. */
  15660. /*
  15661. * OpenSSL Backend Implementation
  15662. */
  15663. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15664. namespace tls {
  15665. namespace impl {
  15666. // Helper to map OpenSSL SSL_get_error to ErrorCode
  15667. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  15668. switch (ssl_error) {
  15669. case SSL_ERROR_NONE: return ErrorCode::Success;
  15670. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  15671. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  15672. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  15673. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  15674. case SSL_ERROR_SSL:
  15675. default: return ErrorCode::Fatal;
  15676. }
  15677. }
  15678. // Helper: Create client CA list from PEM string
  15679. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  15680. // Caller takes ownership of returned list
  15681. inline STACK_OF(X509_NAME) *
  15682. create_client_ca_list_from_pem(const char *ca_pem) {
  15683. if (!ca_pem) { return nullptr; }
  15684. auto ca_list = sk_X509_NAME_new_null();
  15685. if (!ca_list) { return nullptr; }
  15686. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  15687. if (!bio) {
  15688. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  15689. return nullptr;
  15690. }
  15691. X509 *cert = nullptr;
  15692. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  15693. nullptr) {
  15694. const X509_NAME *name = X509_get_subject_name(cert);
  15695. if (name) {
  15696. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  15697. }
  15698. X509_free(cert);
  15699. }
  15700. BIO_free(bio);
  15701. return ca_list;
  15702. }
  15703. // OpenSSL verify callback wrapper
  15704. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  15705. auto &callback = get_verify_callback();
  15706. if (!callback) { return preverify_ok; }
  15707. // Get SSL object from X509_STORE_CTX
  15708. auto ssl = static_cast<SSL *>(
  15709. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  15710. if (!ssl) { return preverify_ok; }
  15711. // Get current certificate and depth
  15712. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  15713. int depth = X509_STORE_CTX_get_error_depth(ctx);
  15714. int error = X509_STORE_CTX_get_error(ctx);
  15715. // Build context
  15716. VerifyContext verify_ctx;
  15717. verify_ctx.session = static_cast<session_t>(ssl);
  15718. verify_ctx.cert = static_cast<cert_t>(cert);
  15719. verify_ctx.depth = depth;
  15720. verify_ctx.preverify_ok = (preverify_ok != 0);
  15721. verify_ctx.error_code = error;
  15722. verify_ctx.error_string =
  15723. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  15724. return callback(verify_ctx) ? 1 : 0;
  15725. }
  15726. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  15727. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  15728. // that must be released with release_store_objects
  15729. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  15730. OPENSSL_VERSION_NUMBER >= 0x30300000L
  15731. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  15732. #endif
  15733. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  15734. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  15735. return X509_STORE_get1_objects(store);
  15736. #else
  15737. return X509_STORE_get0_objects(store);
  15738. #endif
  15739. }
  15740. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  15741. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  15742. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  15743. #else
  15744. (void)objs; // get0 variant returns an internal pointer; nothing to free
  15745. #endif
  15746. }
  15747. } // namespace impl
  15748. inline ctx_t create_client_context() {
  15749. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  15750. if (ctx) {
  15751. // Disable auto-retry to properly handle non-blocking I/O
  15752. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  15753. // Set minimum TLS version
  15754. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  15755. }
  15756. return static_cast<ctx_t>(ctx);
  15757. }
  15758. inline void free_context(ctx_t ctx) {
  15759. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  15760. }
  15761. inline bool set_min_version(ctx_t ctx, Version version) {
  15762. if (!ctx) return false;
  15763. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  15764. static_cast<int>(version)) == 1;
  15765. }
  15766. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  15767. if (!ctx || !pem || len == 0) return false;
  15768. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  15769. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  15770. if (!store) return false;
  15771. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  15772. if (!bio) return false;
  15773. bool ok = true;
  15774. X509 *cert = nullptr;
  15775. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  15776. nullptr) {
  15777. if (X509_STORE_add_cert(store, cert) != 1) {
  15778. // Ignore duplicate errors
  15779. auto err = ERR_peek_last_error();
  15780. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  15781. ok = false;
  15782. }
  15783. }
  15784. X509_free(cert);
  15785. if (!ok) break;
  15786. }
  15787. BIO_free(bio);
  15788. // Clear any "no more certificates" errors
  15789. ERR_clear_error();
  15790. return ok;
  15791. }
  15792. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  15793. if (!ctx || !file_path) return false;
  15794. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  15795. nullptr) == 1;
  15796. }
  15797. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  15798. if (!ctx || !dir_path) return false;
  15799. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  15800. dir_path) == 1;
  15801. }
  15802. inline bool load_system_certs(ctx_t ctx) {
  15803. if (!ctx) return false;
  15804. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  15805. #ifdef _WIN32
  15806. // Windows: Load from system certificate store (ROOT and CA)
  15807. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  15808. if (!store) return false;
  15809. bool loaded_any = false;
  15810. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15811. for (auto store_name : store_names) {
  15812. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  15813. if (!hStore) continue;
  15814. PCCERT_CONTEXT pContext = nullptr;
  15815. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15816. nullptr) {
  15817. const unsigned char *data = pContext->pbCertEncoded;
  15818. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  15819. if (x509) {
  15820. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  15821. X509_free(x509);
  15822. }
  15823. }
  15824. CertCloseStore(hStore, 0);
  15825. }
  15826. return loaded_any;
  15827. #elif defined(__APPLE__)
  15828. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  15829. // macOS: Load from Keychain
  15830. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  15831. if (!store) return false;
  15832. bool loaded_any = false;
  15833. const SecTrustSettingsDomain domains[] = {
  15834. kSecTrustSettingsDomainSystem,
  15835. kSecTrustSettingsDomainAdmin,
  15836. kSecTrustSettingsDomainUser,
  15837. };
  15838. for (auto domain : domains) {
  15839. CFArrayRef certs = nullptr;
  15840. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  15841. !certs) {
  15842. if (certs) CFRelease(certs);
  15843. continue;
  15844. }
  15845. auto count = CFArrayGetCount(certs);
  15846. for (CFIndex i = 0; i < count; i++) {
  15847. auto cert = reinterpret_cast<SecCertificateRef>(
  15848. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  15849. CFDataRef der = SecCertificateCopyData(cert);
  15850. if (der) {
  15851. const unsigned char *data = CFDataGetBytePtr(der);
  15852. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  15853. if (x509) {
  15854. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  15855. X509_free(x509);
  15856. }
  15857. CFRelease(der);
  15858. }
  15859. }
  15860. CFRelease(certs);
  15861. }
  15862. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  15863. #else
  15864. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  15865. #endif
  15866. #else
  15867. // Other Unix: use default verify paths
  15868. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  15869. #endif
  15870. }
  15871. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  15872. const char *password) {
  15873. if (!ctx || !cert || !key) return false;
  15874. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  15875. // Load certificate
  15876. auto cert_bio = BIO_new_mem_buf(cert, -1);
  15877. if (!cert_bio) return false;
  15878. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  15879. BIO_free(cert_bio);
  15880. if (!x509) return false;
  15881. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  15882. X509_free(x509);
  15883. if (!cert_ok) return false;
  15884. // Load private key
  15885. auto key_bio = BIO_new_mem_buf(key, -1);
  15886. if (!key_bio) return false;
  15887. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  15888. password ? const_cast<char *>(password)
  15889. : nullptr);
  15890. BIO_free(key_bio);
  15891. if (!pkey) return false;
  15892. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  15893. EVP_PKEY_free(pkey);
  15894. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  15895. }
  15896. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  15897. const char *key_path, const char *password) {
  15898. if (!ctx || !cert_path || !key_path) return false;
  15899. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  15900. if (password && password[0] != '\0') {
  15901. SSL_CTX_set_default_passwd_cb_userdata(
  15902. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  15903. }
  15904. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  15905. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  15906. }
  15907. inline ctx_t create_server_context() {
  15908. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  15909. if (ctx) {
  15910. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  15911. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  15912. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  15913. }
  15914. return static_cast<ctx_t>(ctx);
  15915. }
  15916. inline void set_verify_client(ctx_t ctx, bool require) {
  15917. if (!ctx) return;
  15918. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  15919. require
  15920. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  15921. : SSL_VERIFY_NONE,
  15922. nullptr);
  15923. }
  15924. inline session_t create_session(ctx_t ctx, socket_t sock) {
  15925. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  15926. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  15927. SSL *ssl = SSL_new(ssl_ctx);
  15928. if (!ssl) return nullptr;
  15929. // Disable auto-retry for proper non-blocking I/O handling
  15930. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  15931. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  15932. if (!bio) {
  15933. SSL_free(ssl);
  15934. return nullptr;
  15935. }
  15936. SSL_set_bio(ssl, bio, bio);
  15937. return static_cast<session_t>(ssl);
  15938. }
  15939. inline void free_session(session_t session) {
  15940. if (session) { SSL_free(static_cast<SSL *>(session)); }
  15941. }
  15942. inline bool set_sni(session_t session, const char *hostname,
  15943. bool /*verify_hostname*/) {
  15944. if (!session || !hostname) return false;
  15945. auto ssl = static_cast<SSL *>(session);
  15946. // Set SNI (Server Name Indication) only - does not enable verification.
  15947. // OpenSSL never binds identity checking to SNI (that happens post-
  15948. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  15949. #if defined(OPENSSL_IS_BORINGSSL)
  15950. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  15951. #else
  15952. // Direct call instead of macro to suppress -Wold-style-cast warning
  15953. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  15954. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  15955. #endif
  15956. }
  15957. inline TlsError connect(session_t session) {
  15958. if (!session) { return TlsError(); }
  15959. auto ssl = static_cast<SSL *>(session);
  15960. auto ret = SSL_connect(ssl);
  15961. TlsError err;
  15962. if (ret == 1) {
  15963. err.code = ErrorCode::Success;
  15964. } else {
  15965. auto ssl_err = SSL_get_error(ssl, ret);
  15966. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  15967. err.backend_code = ERR_get_error();
  15968. }
  15969. return err;
  15970. }
  15971. inline TlsError accept(session_t session) {
  15972. if (!session) { return TlsError(); }
  15973. auto ssl = static_cast<SSL *>(session);
  15974. auto ret = SSL_accept(ssl);
  15975. TlsError err;
  15976. if (ret == 1) {
  15977. err.code = ErrorCode::Success;
  15978. } else {
  15979. auto ssl_err = SSL_get_error(ssl, ret);
  15980. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  15981. err.backend_code = ERR_get_error();
  15982. }
  15983. return err;
  15984. }
  15985. inline bool connect_nonblocking(session_t session, socket_t sock,
  15986. time_t timeout_sec, time_t timeout_usec,
  15987. TlsError *err) {
  15988. if (!session) {
  15989. if (err) { err->code = ErrorCode::Fatal; }
  15990. return false;
  15991. }
  15992. auto ssl = static_cast<SSL *>(session);
  15993. auto bio = SSL_get_rbio(ssl);
  15994. // Set non-blocking mode for handshake
  15995. detail::set_nonblocking(sock, true);
  15996. if (bio) { BIO_set_nbio(bio, 1); }
  15997. auto cleanup = detail::scope_exit([&]() {
  15998. // Restore blocking mode after handshake
  15999. if (bio) { BIO_set_nbio(bio, 0); }
  16000. detail::set_nonblocking(sock, false);
  16001. });
  16002. auto res = 0;
  16003. while ((res = SSL_connect(ssl)) != 1) {
  16004. auto ssl_err = SSL_get_error(ssl, res);
  16005. switch (ssl_err) {
  16006. case SSL_ERROR_WANT_READ:
  16007. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16008. continue;
  16009. }
  16010. break;
  16011. case SSL_ERROR_WANT_WRITE:
  16012. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16013. continue;
  16014. }
  16015. break;
  16016. default: break;
  16017. }
  16018. if (err) {
  16019. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16020. err->backend_code = ERR_get_error();
  16021. }
  16022. return false;
  16023. }
  16024. if (err) { err->code = ErrorCode::Success; }
  16025. return true;
  16026. }
  16027. inline bool accept_nonblocking(session_t session, socket_t sock,
  16028. time_t timeout_sec, time_t timeout_usec,
  16029. TlsError *err) {
  16030. if (!session) {
  16031. if (err) { err->code = ErrorCode::Fatal; }
  16032. return false;
  16033. }
  16034. auto ssl = static_cast<SSL *>(session);
  16035. auto bio = SSL_get_rbio(ssl);
  16036. // Set non-blocking mode for handshake
  16037. detail::set_nonblocking(sock, true);
  16038. if (bio) { BIO_set_nbio(bio, 1); }
  16039. auto cleanup = detail::scope_exit([&]() {
  16040. // Restore blocking mode after handshake
  16041. if (bio) { BIO_set_nbio(bio, 0); }
  16042. detail::set_nonblocking(sock, false);
  16043. });
  16044. auto res = 0;
  16045. while ((res = SSL_accept(ssl)) != 1) {
  16046. auto ssl_err = SSL_get_error(ssl, res);
  16047. switch (ssl_err) {
  16048. case SSL_ERROR_WANT_READ:
  16049. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16050. continue;
  16051. }
  16052. break;
  16053. case SSL_ERROR_WANT_WRITE:
  16054. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16055. continue;
  16056. }
  16057. break;
  16058. default: break;
  16059. }
  16060. if (err) {
  16061. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16062. err->backend_code = ERR_get_error();
  16063. }
  16064. return false;
  16065. }
  16066. if (err) { err->code = ErrorCode::Success; }
  16067. return true;
  16068. }
  16069. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16070. if (!session || !buf) {
  16071. err.code = ErrorCode::Fatal;
  16072. return -1;
  16073. }
  16074. auto ssl = static_cast<SSL *>(session);
  16075. constexpr auto max_len =
  16076. static_cast<size_t>((std::numeric_limits<int>::max)());
  16077. if (len > max_len) { len = max_len; }
  16078. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16079. if (ret > 0) {
  16080. err.code = ErrorCode::Success;
  16081. return ret;
  16082. }
  16083. auto ssl_err = SSL_get_error(ssl, ret);
  16084. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16085. if (err.code == ErrorCode::PeerClosed) {
  16086. return 0;
  16087. } // Gracefully handle the peer closed state.
  16088. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16089. return -1;
  16090. }
  16091. inline ssize_t write(session_t session, const void *buf, size_t len,
  16092. TlsError &err) {
  16093. if (!session || !buf) {
  16094. err.code = ErrorCode::Fatal;
  16095. return -1;
  16096. }
  16097. auto ssl = static_cast<SSL *>(session);
  16098. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16099. if (ret > 0) {
  16100. err.code = ErrorCode::Success;
  16101. return ret;
  16102. }
  16103. auto ssl_err = SSL_get_error(ssl, ret);
  16104. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16105. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16106. return -1;
  16107. }
  16108. inline int pending(const_session_t session) {
  16109. if (!session) return 0;
  16110. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16111. }
  16112. inline void shutdown(session_t session, bool graceful) {
  16113. if (!session) return;
  16114. auto ssl = static_cast<SSL *>(session);
  16115. if (graceful) {
  16116. // First call sends close_notify
  16117. if (SSL_shutdown(ssl) == 0) {
  16118. // Second call waits for peer's close_notify
  16119. SSL_shutdown(ssl);
  16120. }
  16121. }
  16122. }
  16123. inline bool is_peer_closed(session_t session, socket_t sock) {
  16124. if (!session) return true;
  16125. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16126. detail::set_nonblocking(sock, true);
  16127. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16128. auto ssl = static_cast<SSL *>(session);
  16129. char buf;
  16130. auto ret = SSL_peek(ssl, &buf, 1);
  16131. if (ret > 0) return false;
  16132. auto err = SSL_get_error(ssl, ret);
  16133. return err == SSL_ERROR_ZERO_RETURN;
  16134. }
  16135. inline cert_t get_peer_cert(const_session_t session) {
  16136. if (!session) return nullptr;
  16137. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16138. static_cast<SSL *>(const_cast<void *>(session))));
  16139. }
  16140. inline void free_cert(cert_t cert) {
  16141. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16142. }
  16143. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16144. if (!cert || !hostname) return false;
  16145. auto x509 = static_cast<X509 *>(cert);
  16146. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16147. if (detail::is_ip_address(hostname)) {
  16148. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16149. }
  16150. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16151. }
  16152. inline uint64_t hostname_mismatch_code() {
  16153. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16154. }
  16155. inline long get_verify_result(const_session_t session) {
  16156. if (!session) return X509_V_ERR_UNSPECIFIED;
  16157. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16158. }
  16159. inline std::string get_cert_subject_cn(cert_t cert) {
  16160. if (!cert) return "";
  16161. auto x509 = static_cast<X509 *>(cert);
  16162. auto subject_name = X509_get_subject_name(x509);
  16163. if (!subject_name) return "";
  16164. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16165. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16166. if (idx < 0) return "";
  16167. auto entry = X509_NAME_get_entry(subject_name, idx);
  16168. if (!entry) return "";
  16169. auto data = X509_NAME_ENTRY_get_data(entry);
  16170. if (!data) return "";
  16171. return std::string(
  16172. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16173. static_cast<size_t>(ASN1_STRING_length(data)));
  16174. }
  16175. inline std::string get_cert_issuer_name(cert_t cert) {
  16176. if (!cert) return "";
  16177. auto x509 = static_cast<X509 *>(cert);
  16178. auto issuer_name = X509_get_issuer_name(x509);
  16179. if (!issuer_name) return "";
  16180. char buf[256];
  16181. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16182. return std::string(buf);
  16183. }
  16184. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16185. sans.clear();
  16186. if (!cert) return false;
  16187. auto x509 = static_cast<X509 *>(cert);
  16188. auto names = static_cast<GENERAL_NAMES *>(
  16189. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16190. if (!names) return true; // No SANs is valid
  16191. auto count = sk_GENERAL_NAME_num(names);
  16192. for (decltype(count) i = 0; i < count; i++) {
  16193. auto gen = sk_GENERAL_NAME_value(names, i);
  16194. if (!gen) continue;
  16195. SanEntry entry;
  16196. switch (gen->type) {
  16197. case GEN_DNS:
  16198. entry.type = SanType::DNS;
  16199. if (gen->d.dNSName) {
  16200. entry.value = std::string(
  16201. reinterpret_cast<const char *>(
  16202. ASN1_STRING_get0_data(gen->d.dNSName)),
  16203. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16204. }
  16205. break;
  16206. case GEN_IPADD:
  16207. entry.type = SanType::IP;
  16208. if (gen->d.iPAddress) {
  16209. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16210. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16211. if (len == 4) {
  16212. // IPv4
  16213. char buf[INET_ADDRSTRLEN];
  16214. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16215. entry.value = buf;
  16216. } else if (len == 16) {
  16217. // IPv6
  16218. char buf[INET6_ADDRSTRLEN];
  16219. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16220. entry.value = buf;
  16221. }
  16222. }
  16223. break;
  16224. case GEN_EMAIL:
  16225. entry.type = SanType::EMAIL;
  16226. if (gen->d.rfc822Name) {
  16227. entry.value = std::string(
  16228. reinterpret_cast<const char *>(
  16229. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16230. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16231. }
  16232. break;
  16233. case GEN_URI:
  16234. entry.type = SanType::URI;
  16235. if (gen->d.uniformResourceIdentifier) {
  16236. entry.value = std::string(
  16237. reinterpret_cast<const char *>(
  16238. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16239. static_cast<size_t>(
  16240. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16241. }
  16242. break;
  16243. default: entry.type = SanType::OTHER; break;
  16244. }
  16245. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16246. }
  16247. GENERAL_NAMES_free(names);
  16248. return true;
  16249. }
  16250. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16251. time_t &not_after) {
  16252. if (!cert) return false;
  16253. auto x509 = static_cast<X509 *>(cert);
  16254. auto nb = X509_get0_notBefore(x509);
  16255. auto na = X509_get0_notAfter(x509);
  16256. if (!nb || !na) return false;
  16257. ASN1_TIME *epoch = ASN1_TIME_new();
  16258. if (!epoch) return false;
  16259. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16260. if (!ASN1_TIME_set(epoch, 0)) return false;
  16261. int pday, psec;
  16262. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16263. not_before = 86400 * (time_t)pday + psec;
  16264. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16265. not_after = 86400 * (time_t)pday + psec;
  16266. return true;
  16267. }
  16268. inline std::string get_cert_serial(cert_t cert) {
  16269. if (!cert) return "";
  16270. auto x509 = static_cast<X509 *>(cert);
  16271. auto serial = X509_get_serialNumber(x509);
  16272. if (!serial) return "";
  16273. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16274. if (!bn) return "";
  16275. auto hex = BN_bn2hex(bn);
  16276. BN_free(bn);
  16277. if (!hex) return "";
  16278. std::string result(hex);
  16279. OPENSSL_free(hex);
  16280. return result;
  16281. }
  16282. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16283. if (!cert) return false;
  16284. auto x509 = static_cast<X509 *>(cert);
  16285. auto len = i2d_X509(x509, nullptr);
  16286. if (len < 0) return false;
  16287. der.resize(static_cast<size_t>(len));
  16288. auto p = der.data();
  16289. i2d_X509(x509, &p);
  16290. return true;
  16291. }
  16292. inline const char *get_sni(const_session_t session) {
  16293. if (!session) return nullptr;
  16294. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16295. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16296. }
  16297. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16298. inline uint64_t get_error() { return ERR_get_error(); }
  16299. inline std::string error_string(uint64_t code) {
  16300. char buf[256];
  16301. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16302. return std::string(buf);
  16303. }
  16304. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16305. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16306. if (!mem) { return nullptr; }
  16307. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16308. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16309. if (!inf) { return nullptr; }
  16310. auto store = X509_STORE_new();
  16311. if (store) {
  16312. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16313. auto itmp = sk_X509_INFO_value(inf, i);
  16314. if (!itmp) { continue; }
  16315. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16316. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16317. }
  16318. }
  16319. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16320. return static_cast<ca_store_t>(store);
  16321. }
  16322. inline void free_ca_store(ca_store_t store) {
  16323. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16324. }
  16325. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16326. if (!ctx || !store) { return false; }
  16327. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16328. auto x509_store = static_cast<X509_STORE *>(store);
  16329. // Check if same store is already set
  16330. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16331. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16332. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16333. return true;
  16334. }
  16335. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16336. certs.clear();
  16337. if (!ctx) { return 0; }
  16338. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16339. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16340. if (!store) { return 0; }
  16341. auto objs = impl::get_store_objects(store);
  16342. if (!objs) { return 0; }
  16343. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16344. auto count = sk_X509_OBJECT_num(objs);
  16345. for (decltype(count) i = 0; i < count; i++) {
  16346. auto obj = sk_X509_OBJECT_value(objs, i);
  16347. if (!obj) { continue; }
  16348. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16349. auto x509 = X509_OBJECT_get0_X509(obj);
  16350. if (x509) {
  16351. // Increment reference count so caller can free it
  16352. X509_up_ref(x509);
  16353. certs.push_back(static_cast<cert_t>(x509));
  16354. }
  16355. }
  16356. }
  16357. return certs.size();
  16358. }
  16359. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16360. std::vector<std::string> names;
  16361. if (!ctx) { return names; }
  16362. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16363. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16364. if (!store) { return names; }
  16365. auto objs = impl::get_store_objects(store);
  16366. if (!objs) { return names; }
  16367. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16368. auto count = sk_X509_OBJECT_num(objs);
  16369. for (decltype(count) i = 0; i < count; i++) {
  16370. auto obj = sk_X509_OBJECT_value(objs, i);
  16371. if (!obj) { continue; }
  16372. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16373. auto x509 = X509_OBJECT_get0_X509(obj);
  16374. if (x509) {
  16375. auto subject = X509_get_subject_name(x509);
  16376. if (subject) {
  16377. char buf[512];
  16378. X509_NAME_oneline(subject, buf, sizeof(buf));
  16379. names.push_back(buf);
  16380. }
  16381. }
  16382. }
  16383. }
  16384. return names;
  16385. }
  16386. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16387. const char *key_pem, const char *password) {
  16388. if (!ctx || !cert_pem || !key_pem) { return false; }
  16389. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16390. // Load certificate from PEM
  16391. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16392. if (!cert_bio) { return false; }
  16393. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16394. BIO_free(cert_bio);
  16395. if (!cert) { return false; }
  16396. // Load private key from PEM
  16397. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16398. if (!key_bio) {
  16399. X509_free(cert);
  16400. return false;
  16401. }
  16402. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16403. password ? const_cast<char *>(password)
  16404. : nullptr);
  16405. BIO_free(key_bio);
  16406. if (!key) {
  16407. X509_free(cert);
  16408. return false;
  16409. }
  16410. // Update certificate and key
  16411. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16412. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16413. X509_free(cert);
  16414. EVP_PKEY_free(key);
  16415. return ret;
  16416. }
  16417. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16418. if (!ctx || !ca_pem) { return false; }
  16419. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16420. // Create new X509_STORE from PEM
  16421. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16422. if (!store) { return false; }
  16423. // SSL_CTX_set_cert_store takes ownership
  16424. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16425. // Set client CA list for client certificate request
  16426. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16427. if (ca_list) {
  16428. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16429. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16430. }
  16431. return true;
  16432. }
  16433. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16434. if (!ctx) { return false; }
  16435. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16436. impl::get_verify_callback() = std::move(callback);
  16437. if (impl::get_verify_callback()) {
  16438. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16439. } else {
  16440. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16441. }
  16442. return true;
  16443. }
  16444. inline long get_verify_error(const_session_t session) {
  16445. if (!session) { return -1; }
  16446. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16447. return SSL_get_verify_result(ssl);
  16448. }
  16449. inline std::string verify_error_string(long error_code) {
  16450. if (error_code == X509_V_OK) { return ""; }
  16451. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16452. return str ? str : "unknown error";
  16453. }
  16454. } // namespace tls
  16455. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16456. /*
  16457. * Group 9: TLS abstraction layer - Mbed TLS backend
  16458. */
  16459. /*
  16460. * Mbed TLS Backend Implementation
  16461. */
  16462. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16463. namespace tls {
  16464. namespace impl {
  16465. // Mbed TLS session wrapper
  16466. struct MbedTlsSession {
  16467. mbedtls_ssl_context ssl;
  16468. socket_t sock = INVALID_SOCKET;
  16469. std::string hostname; // For client: set via set_sni
  16470. std::string sni_hostname; // For server: received from client via SNI callback
  16471. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  16472. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  16473. // (e.g. a response that arrived while this side was still in its post-write
  16474. // check), the byte is pushed back here and served by the next read().
  16475. unsigned char peeked_byte = 0;
  16476. bool has_peeked_byte = false;
  16477. // Set by set_sni() when the caller disabled hostname verification, so the
  16478. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  16479. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  16480. // OpenSSL and wolfSSL keep them independent).
  16481. bool suppress_hostname_mismatch = false;
  16482. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  16483. // decide which verify callback to install when hostname verification is
  16484. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  16485. // wired for this context, or a self-contained one otherwise, so a session
  16486. // that never opted into a callback never consults the process-wide
  16487. // set_verify_callback() slot (which some other, unrelated client may have
  16488. // populated).
  16489. bool has_verify_callback = false;
  16490. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  16491. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  16492. MbedTlsSession(const MbedTlsSession &) = delete;
  16493. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  16494. };
  16495. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  16496. // queue)
  16497. inline int &mbedtls_last_error() {
  16498. static thread_local int err = 0;
  16499. return err;
  16500. }
  16501. // Helper to map Mbed TLS error to ErrorCode
  16502. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  16503. uint32_t verify_flags) {
  16504. if (ret == 0) { return ErrorCode::Success; }
  16505. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  16506. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  16507. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  16508. return ErrorCode::PeerClosed;
  16509. }
  16510. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  16511. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  16512. out_errno = errno;
  16513. return ErrorCode::SyscallError;
  16514. }
  16515. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  16516. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  16517. // the handshake's chain verification (see set_sni()); a mismatch there
  16518. // is reported the same way as any other verify_flags bit. Report it as
  16519. // HostnameMismatch, matching the other backends and the post-handshake
  16520. // identity check below, but only when naming is the sole problem -
  16521. // if the chain itself is also untrusted/expired/etc., that takes
  16522. // priority over the naming detail.
  16523. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  16524. return ErrorCode::HostnameMismatch;
  16525. }
  16526. return ErrorCode::CertVerifyFailed;
  16527. }
  16528. return ErrorCode::Fatal;
  16529. }
  16530. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  16531. // return value, including the verify-flags-dependent HostnameMismatch
  16532. // mapping; shared by connect() and connect_nonblocking() so the
  16533. // backend_code policy for that mapping only lives in one place.
  16534. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  16535. int ret) {
  16536. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  16537. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  16538. err.backend_code = err.code == ErrorCode::HostnameMismatch
  16539. ? static_cast<uint64_t>(verify_flags)
  16540. : static_cast<uint64_t>(-ret);
  16541. }
  16542. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  16543. // non-fatal notification delivered between records, not an error and not
  16544. // application data, so I/O calls that see it should just be retried. Kept in
  16545. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  16546. // splitting the closing brace across an #if.
  16547. inline bool mbedtls_is_session_ticket(int ret) {
  16548. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  16549. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  16550. #else
  16551. (void)ret;
  16552. return false;
  16553. #endif
  16554. }
  16555. // BIO-like send callback for Mbed TLS
  16556. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  16557. size_t len) {
  16558. auto sock = *static_cast<socket_t *>(ctx);
  16559. #ifdef _WIN32
  16560. auto ret =
  16561. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  16562. if (ret == SOCKET_ERROR) {
  16563. int err = WSAGetLastError();
  16564. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  16565. return MBEDTLS_ERR_NET_SEND_FAILED;
  16566. }
  16567. #else
  16568. auto ret = send(sock, buf, len, 0);
  16569. if (ret < 0) {
  16570. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16571. return MBEDTLS_ERR_SSL_WANT_WRITE;
  16572. }
  16573. return MBEDTLS_ERR_NET_SEND_FAILED;
  16574. }
  16575. #endif
  16576. return static_cast<int>(ret);
  16577. }
  16578. // BIO-like recv callback for Mbed TLS
  16579. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  16580. auto sock = *static_cast<socket_t *>(ctx);
  16581. #ifdef _WIN32
  16582. auto ret =
  16583. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  16584. if (ret == SOCKET_ERROR) {
  16585. int err = WSAGetLastError();
  16586. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  16587. return MBEDTLS_ERR_NET_RECV_FAILED;
  16588. }
  16589. #else
  16590. auto ret = recv(sock, buf, len, 0);
  16591. if (ret < 0) {
  16592. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16593. return MBEDTLS_ERR_SSL_WANT_READ;
  16594. }
  16595. return MBEDTLS_ERR_NET_RECV_FAILED;
  16596. }
  16597. #endif
  16598. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  16599. return static_cast<int>(ret);
  16600. }
  16601. // MbedTlsContext constructor/destructor implementations
  16602. inline MbedTlsContext::MbedTlsContext() {
  16603. mbedtls_ssl_config_init(&conf);
  16604. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16605. mbedtls_entropy_init(&entropy);
  16606. mbedtls_ctr_drbg_init(&ctr_drbg);
  16607. #endif
  16608. mbedtls_x509_crt_init(&ca_chain);
  16609. mbedtls_x509_crt_init(&own_cert);
  16610. mbedtls_pk_init(&own_key);
  16611. }
  16612. inline MbedTlsContext::~MbedTlsContext() {
  16613. mbedtls_pk_free(&own_key);
  16614. mbedtls_x509_crt_free(&own_cert);
  16615. mbedtls_x509_crt_free(&ca_chain);
  16616. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16617. mbedtls_ctr_drbg_free(&ctr_drbg);
  16618. mbedtls_entropy_free(&entropy);
  16619. #endif
  16620. mbedtls_ssl_config_free(&conf);
  16621. }
  16622. // Thread-local storage for SNI captured during handshake
  16623. // This is needed because the SNI callback doesn't have a way to pass
  16624. // session-specific data before the session is fully set up
  16625. inline std::string &mbedpending_sni() {
  16626. static thread_local std::string sni;
  16627. return sni;
  16628. }
  16629. // SNI callback for Mbed TLS server to capture client's SNI hostname
  16630. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  16631. const unsigned char *name, size_t name_len) {
  16632. (void)p_ctx;
  16633. (void)ssl;
  16634. // Store SNI name in thread-local storage
  16635. // It will be retrieved and stored in the session after handshake
  16636. if (name && name_len > 0) {
  16637. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  16638. } else {
  16639. mbedpending_sni().clear();
  16640. }
  16641. return 0; // Accept any SNI
  16642. }
  16643. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  16644. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  16645. }
  16646. // Verify callback used when hostname verification is disabled for a session
  16647. // that has no user-supplied verify callback of its own (MbedTlsSession::
  16648. // has_verify_callback is false). Deliberately does not consult
  16649. // get_verify_callback(): that slot is process-wide, so reading it here would
  16650. // pick up whatever another, unrelated client last installed there.
  16651. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  16652. mbedtls_x509_crt *, int,
  16653. uint32_t *flags) {
  16654. (void)data;
  16655. mbedtls_clear_cn_mismatch(flags);
  16656. return 0;
  16657. }
  16658. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16659. int cert_depth, uint32_t *flags);
  16660. // MbedTLS verify callback wrapper
  16661. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16662. int cert_depth, uint32_t *flags) {
  16663. // data points to the MbedTlsSession
  16664. auto *session = static_cast<MbedTlsSession *>(data);
  16665. // set_sni() disabled hostname verification for this session: drop the
  16666. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  16667. // the OpenSSL/wolfSSL backends where identity checking is independent of
  16668. // SNI. The final pass/fail decision still comes from the remaining flags
  16669. // (or, below, from the user's own verify callback).
  16670. if (session && session->suppress_hostname_mismatch) {
  16671. mbedtls_clear_cn_mismatch(flags);
  16672. }
  16673. auto &callback = get_verify_callback();
  16674. if (!callback) { return 0; } // Continue with default verification
  16675. // Build context
  16676. VerifyContext verify_ctx;
  16677. verify_ctx.session = static_cast<session_t>(session);
  16678. verify_ctx.cert = static_cast<cert_t>(crt);
  16679. verify_ctx.depth = cert_depth;
  16680. verify_ctx.preverify_ok = (*flags == 0);
  16681. verify_ctx.error_code = static_cast<long>(*flags);
  16682. // Convert Mbed TLS flags to error string
  16683. static thread_local char error_buf[256];
  16684. if (*flags != 0) {
  16685. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  16686. verify_ctx.error_string = error_buf;
  16687. } else {
  16688. verify_ctx.error_string = nullptr;
  16689. }
  16690. bool accepted = callback(verify_ctx);
  16691. if (accepted) {
  16692. *flags = 0; // Clear all error flags
  16693. return 0;
  16694. }
  16695. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  16696. }
  16697. } // namespace impl
  16698. inline ctx_t create_client_context() {
  16699. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  16700. if (!ctx) { return nullptr; }
  16701. ctx->is_server = false;
  16702. #ifdef CPPHTTPLIB_MBEDTLS_V4
  16703. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  16704. if (!detail::ensure_mbedtls_psa_crypto()) {
  16705. delete ctx;
  16706. return nullptr;
  16707. }
  16708. int ret;
  16709. #else
  16710. // Seed the random number generator
  16711. const char *pers = "httplib_client";
  16712. int ret = mbedtls_ctr_drbg_seed(
  16713. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  16714. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  16715. if (ret != 0) {
  16716. impl::mbedtls_last_error() = ret;
  16717. delete ctx;
  16718. return nullptr;
  16719. }
  16720. #endif
  16721. // Set up SSL config for client
  16722. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  16723. MBEDTLS_SSL_TRANSPORT_STREAM,
  16724. MBEDTLS_SSL_PRESET_DEFAULT);
  16725. if (ret != 0) {
  16726. impl::mbedtls_last_error() = ret;
  16727. delete ctx;
  16728. return nullptr;
  16729. }
  16730. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16731. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  16732. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  16733. #endif
  16734. // Default: verify peer certificate
  16735. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  16736. // Set minimum TLS version to 1.2
  16737. #ifdef CPPHTTPLIB_MBEDTLS_V3
  16738. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  16739. #else
  16740. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  16741. MBEDTLS_SSL_MINOR_VERSION_3);
  16742. #endif
  16743. return static_cast<ctx_t>(ctx);
  16744. }
  16745. inline ctx_t create_server_context() {
  16746. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  16747. if (!ctx) { return nullptr; }
  16748. ctx->is_server = true;
  16749. #ifdef CPPHTTPLIB_MBEDTLS_V4
  16750. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  16751. if (!detail::ensure_mbedtls_psa_crypto()) {
  16752. delete ctx;
  16753. return nullptr;
  16754. }
  16755. int ret;
  16756. #else
  16757. // Seed the random number generator
  16758. const char *pers = "httplib_server";
  16759. int ret = mbedtls_ctr_drbg_seed(
  16760. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  16761. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  16762. if (ret != 0) {
  16763. impl::mbedtls_last_error() = ret;
  16764. delete ctx;
  16765. return nullptr;
  16766. }
  16767. #endif
  16768. // Set up SSL config for server
  16769. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  16770. MBEDTLS_SSL_TRANSPORT_STREAM,
  16771. MBEDTLS_SSL_PRESET_DEFAULT);
  16772. if (ret != 0) {
  16773. impl::mbedtls_last_error() = ret;
  16774. delete ctx;
  16775. return nullptr;
  16776. }
  16777. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16778. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  16779. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  16780. #endif
  16781. // Default: don't verify client
  16782. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  16783. // Set minimum TLS version to 1.2
  16784. #ifdef CPPHTTPLIB_MBEDTLS_V3
  16785. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  16786. #else
  16787. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  16788. MBEDTLS_SSL_MINOR_VERSION_3);
  16789. #endif
  16790. // Set SNI callback to capture client's SNI hostname
  16791. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  16792. return static_cast<ctx_t>(ctx);
  16793. }
  16794. inline void free_context(ctx_t ctx) {
  16795. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  16796. }
  16797. inline bool set_min_version(ctx_t ctx, Version version) {
  16798. if (!ctx) { return false; }
  16799. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  16800. #ifdef CPPHTTPLIB_MBEDTLS_V3
  16801. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  16802. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  16803. if (version >= Version::TLS1_3) {
  16804. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  16805. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  16806. #endif
  16807. }
  16808. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  16809. #else
  16810. // Mbed TLS 2.x uses major/minor version numbers
  16811. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  16812. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  16813. if (version >= Version::TLS1_3) {
  16814. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  16815. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  16816. #else
  16817. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  16818. #endif
  16819. }
  16820. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  16821. #endif
  16822. return true;
  16823. }
  16824. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16825. if (!ctx || !pem) { return false; }
  16826. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  16827. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  16828. // Add null terminator if not present
  16829. std::string pem_str(pem, len);
  16830. int ret = mbedtls_x509_crt_parse(
  16831. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  16832. pem_str.size() + 1);
  16833. if (ret != 0) {
  16834. impl::mbedtls_last_error() = ret;
  16835. return false;
  16836. }
  16837. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  16838. return true;
  16839. }
  16840. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16841. if (!ctx || !file_path) { return false; }
  16842. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  16843. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  16844. if (ret != 0) {
  16845. impl::mbedtls_last_error() = ret;
  16846. return false;
  16847. }
  16848. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  16849. return true;
  16850. }
  16851. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16852. if (!ctx || !dir_path) { return false; }
  16853. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  16854. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  16855. if (ret < 0) { // Returns number of certs on success, negative on error
  16856. impl::mbedtls_last_error() = ret;
  16857. return false;
  16858. }
  16859. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  16860. return true;
  16861. }
  16862. inline bool load_system_certs(ctx_t ctx) {
  16863. if (!ctx) { return false; }
  16864. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  16865. bool loaded = false;
  16866. #ifdef _WIN32
  16867. loaded = impl::enumerate_windows_system_certs(
  16868. [&](const unsigned char *data, size_t len) {
  16869. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  16870. });
  16871. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  16872. loaded = impl::enumerate_macos_keychain_certs(
  16873. [&](const unsigned char *data, size_t len) {
  16874. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  16875. });
  16876. #else
  16877. for (auto path = impl::system_ca_paths(); *path; ++path) {
  16878. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  16879. loaded = true;
  16880. break;
  16881. }
  16882. }
  16883. if (!loaded) {
  16884. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  16885. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  16886. loaded = true;
  16887. break;
  16888. }
  16889. }
  16890. }
  16891. #endif
  16892. if (loaded) {
  16893. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  16894. }
  16895. return loaded;
  16896. }
  16897. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16898. const char *password) {
  16899. if (!ctx || !cert || !key) { return false; }
  16900. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  16901. // Parse certificate
  16902. std::string cert_str(cert);
  16903. int ret = mbedtls_x509_crt_parse(
  16904. &mctx->own_cert,
  16905. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  16906. cert_str.size() + 1);
  16907. if (ret != 0) {
  16908. impl::mbedtls_last_error() = ret;
  16909. return false;
  16910. }
  16911. // Parse private key
  16912. std::string key_str(key);
  16913. const unsigned char *pwd =
  16914. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  16915. size_t pwd_len = password ? strlen(password) : 0;
  16916. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  16917. ret = mbedtls_pk_parse_key(
  16918. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  16919. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  16920. &mctx->ctr_drbg);
  16921. #else
  16922. ret = mbedtls_pk_parse_key(
  16923. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  16924. key_str.size() + 1, pwd, pwd_len);
  16925. #endif
  16926. if (ret != 0) {
  16927. impl::mbedtls_last_error() = ret;
  16928. return false;
  16929. }
  16930. // Verify that the certificate and private key match.
  16931. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  16932. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  16933. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16934. #ifdef CPPHTTPLIB_MBEDTLS_V3
  16935. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  16936. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  16937. #else
  16938. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  16939. #endif
  16940. if (ret != 0) {
  16941. impl::mbedtls_last_error() = ret;
  16942. return false;
  16943. }
  16944. #endif
  16945. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  16946. if (ret != 0) {
  16947. impl::mbedtls_last_error() = ret;
  16948. return false;
  16949. }
  16950. return true;
  16951. }
  16952. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16953. const char *key_path, const char *password) {
  16954. if (!ctx || !cert_path || !key_path) { return false; }
  16955. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  16956. // Parse certificate file
  16957. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  16958. if (ret != 0) {
  16959. impl::mbedtls_last_error() = ret;
  16960. return false;
  16961. }
  16962. // Parse private key file
  16963. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  16964. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  16965. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  16966. #else
  16967. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  16968. #endif
  16969. if (ret != 0) {
  16970. impl::mbedtls_last_error() = ret;
  16971. return false;
  16972. }
  16973. // Verify that the certificate and private key match.
  16974. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  16975. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16976. #ifdef CPPHTTPLIB_MBEDTLS_V3
  16977. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  16978. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  16979. #else
  16980. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  16981. #endif
  16982. if (ret != 0) {
  16983. impl::mbedtls_last_error() = ret;
  16984. return false;
  16985. }
  16986. #endif
  16987. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  16988. if (ret != 0) {
  16989. impl::mbedtls_last_error() = ret;
  16990. return false;
  16991. }
  16992. return true;
  16993. }
  16994. inline void set_verify_client(ctx_t ctx, bool require) {
  16995. if (!ctx) { return; }
  16996. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  16997. mctx->verify_client = require;
  16998. if (require) {
  16999. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17000. } else {
  17001. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17002. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17003. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17004. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17005. : MBEDTLS_SSL_VERIFY_NONE);
  17006. }
  17007. }
  17008. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17009. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17010. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17011. auto session = new (std::nothrow) impl::MbedTlsSession();
  17012. if (!session) { return nullptr; }
  17013. session->sock = sock;
  17014. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17015. if (ret != 0) {
  17016. impl::mbedtls_last_error() = ret;
  17017. delete session;
  17018. return nullptr;
  17019. }
  17020. // Explicitly opt out of in-handshake hostname verification by default;
  17021. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17022. // fails outright when no hostname was set. set_sni() installs the real
  17023. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17024. // caller verifies the certificate identity post-handshake via
  17025. // verify_hostname().
  17026. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17027. // Set BIO callbacks
  17028. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17029. impl::mbedtls_net_recv_cb, nullptr);
  17030. // Set per-session verify callback with session pointer if callback is
  17031. // registered
  17032. session->has_verify_callback = mctx->has_verify_callback;
  17033. if (mctx->has_verify_callback) {
  17034. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17035. session);
  17036. }
  17037. return static_cast<session_t>(session);
  17038. }
  17039. inline void free_session(session_t session) {
  17040. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17041. }
  17042. inline bool set_sni(session_t session, const char *hostname,
  17043. bool verify_hostname) {
  17044. if (!session || !hostname) { return false; }
  17045. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17046. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17047. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17048. // independently, so a disabled hostname check is handled below by masking
  17049. // the resulting mismatch flag instead of skipping this call.
  17050. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17051. if (ret != 0) {
  17052. impl::mbedtls_last_error() = ret;
  17053. return false;
  17054. }
  17055. msession->hostname = hostname;
  17056. if (!verify_hostname) {
  17057. msession->suppress_hostname_mismatch = true;
  17058. // If a user verify callback is already wired for this session,
  17059. // mbedtls_verify_callback() masks the mismatch flag itself before
  17060. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17061. // here would be redundant. Otherwise install the self-contained masking
  17062. // callback, which never touches the process-wide callback slot.
  17063. if (!msession->has_verify_callback) {
  17064. mbedtls_ssl_set_verify(&msession->ssl,
  17065. impl::mbedtls_mask_hostname_mismatch_callback,
  17066. msession);
  17067. }
  17068. }
  17069. return true;
  17070. }
  17071. inline TlsError connect(session_t session) {
  17072. TlsError err;
  17073. if (!session) {
  17074. err.code = ErrorCode::Fatal;
  17075. return err;
  17076. }
  17077. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17078. int ret;
  17079. do {
  17080. ret = mbedtls_ssl_handshake(&msession->ssl);
  17081. } while (impl::mbedtls_is_session_ticket(ret));
  17082. if (ret == 0) {
  17083. err.code = ErrorCode::Success;
  17084. } else {
  17085. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17086. impl::mbedtls_last_error() = ret;
  17087. }
  17088. return err;
  17089. }
  17090. inline TlsError accept(session_t session) {
  17091. // Same as connect for Mbed TLS - handshake works for both client and server
  17092. auto result = connect(session);
  17093. // After successful handshake, capture SNI from thread-local storage
  17094. if (result.code == ErrorCode::Success && session) {
  17095. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17096. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17097. impl::mbedpending_sni().clear();
  17098. }
  17099. return result;
  17100. }
  17101. inline bool connect_nonblocking(session_t session, socket_t sock,
  17102. time_t timeout_sec, time_t timeout_usec,
  17103. TlsError *err) {
  17104. if (!session) {
  17105. if (err) { err->code = ErrorCode::Fatal; }
  17106. return false;
  17107. }
  17108. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17109. // Set socket to non-blocking mode
  17110. detail::set_nonblocking(sock, true);
  17111. auto cleanup =
  17112. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17113. int ret;
  17114. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17115. // Non-fatal TLS 1.3 ticket; retry immediately.
  17116. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17117. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17118. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17119. continue;
  17120. }
  17121. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17122. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17123. continue;
  17124. }
  17125. }
  17126. // TlsError or timeout
  17127. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17128. impl::mbedtls_last_error() = ret;
  17129. return false;
  17130. }
  17131. if (err) { err->code = ErrorCode::Success; }
  17132. return true;
  17133. }
  17134. inline bool accept_nonblocking(session_t session, socket_t sock,
  17135. time_t timeout_sec, time_t timeout_usec,
  17136. TlsError *err) {
  17137. // Same implementation as connect for Mbed TLS
  17138. bool result =
  17139. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17140. // After successful handshake, capture SNI from thread-local storage
  17141. if (result && session) {
  17142. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17143. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17144. impl::mbedpending_sni().clear();
  17145. }
  17146. return result;
  17147. }
  17148. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17149. if (!session || !buf) {
  17150. err.code = ErrorCode::Fatal;
  17151. return -1;
  17152. }
  17153. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17154. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17155. if (msession->has_peeked_byte) {
  17156. if (len == 0) { return 0; }
  17157. auto p = static_cast<unsigned char *>(buf);
  17158. p[0] = msession->peeked_byte;
  17159. msession->has_peeked_byte = false;
  17160. size_t n = 1;
  17161. // Top up with any already-decrypted bytes without risking a block.
  17162. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17163. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17164. if (extra > 0) { n += static_cast<size_t>(extra); }
  17165. }
  17166. err.code = ErrorCode::Success;
  17167. return static_cast<ssize_t>(n);
  17168. }
  17169. int ret;
  17170. do {
  17171. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17172. len);
  17173. } while (impl::mbedtls_is_session_ticket(ret));
  17174. if (ret > 0) {
  17175. err.code = ErrorCode::Success;
  17176. return static_cast<ssize_t>(ret);
  17177. }
  17178. if (ret == 0) {
  17179. err.code = ErrorCode::PeerClosed;
  17180. return 0;
  17181. }
  17182. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17183. err.backend_code = static_cast<uint64_t>(-ret);
  17184. impl::mbedtls_last_error() = ret;
  17185. // mbedTLS signals a clean close_notify via a negative error code rather
  17186. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17187. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17188. return -1;
  17189. }
  17190. inline ssize_t write(session_t session, const void *buf, size_t len,
  17191. TlsError &err) {
  17192. if (!session || !buf) {
  17193. err.code = ErrorCode::Fatal;
  17194. return -1;
  17195. }
  17196. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17197. int ret;
  17198. do {
  17199. ret = mbedtls_ssl_write(&msession->ssl,
  17200. static_cast<const unsigned char *>(buf), len);
  17201. } while (impl::mbedtls_is_session_ticket(ret));
  17202. if (ret > 0) {
  17203. err.code = ErrorCode::Success;
  17204. return static_cast<ssize_t>(ret);
  17205. }
  17206. if (ret == 0) {
  17207. err.code = ErrorCode::PeerClosed;
  17208. return 0;
  17209. }
  17210. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17211. err.backend_code = static_cast<uint64_t>(-ret);
  17212. impl::mbedtls_last_error() = ret;
  17213. return -1;
  17214. }
  17215. inline int pending(const_session_t session) {
  17216. if (!session) { return 0; }
  17217. auto msession =
  17218. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17219. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17220. (msession->has_peeked_byte ? 1 : 0);
  17221. }
  17222. inline void shutdown(session_t session, bool graceful) {
  17223. if (!session) { return; }
  17224. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17225. if (graceful) {
  17226. // Try to send close_notify, but don't block forever
  17227. int ret;
  17228. int attempts = 0;
  17229. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17230. attempts < 3) {
  17231. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17232. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17233. break;
  17234. }
  17235. attempts++;
  17236. }
  17237. }
  17238. }
  17239. inline bool is_peer_closed(session_t session, socket_t sock) {
  17240. if (!session || sock == INVALID_SOCKET) { return true; }
  17241. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17242. // Check if there's already decrypted or pushed-back data available.
  17243. // If so, the connection is definitely alive.
  17244. if (msession->has_peeked_byte ||
  17245. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17246. return false;
  17247. }
  17248. // Set socket to non-blocking to avoid blocking on read
  17249. detail::set_nonblocking(sock, true);
  17250. auto cleanup =
  17251. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17252. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17253. // on application data — e.g. a response that already arrived — push the
  17254. // byte back so the next read() delivers it instead of losing it.
  17255. unsigned char buf;
  17256. int ret;
  17257. do {
  17258. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17259. } while (impl::mbedtls_is_session_ticket(ret));
  17260. // If we got data or WANT_READ (would block), connection is alive
  17261. if (ret > 0) {
  17262. msession->peeked_byte = buf;
  17263. msession->has_peeked_byte = true;
  17264. return false;
  17265. }
  17266. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17267. // If we get a peer close notify or a connection reset, the peer is closed
  17268. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17269. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17270. }
  17271. inline cert_t get_peer_cert(const_session_t session) {
  17272. if (!session) { return nullptr; }
  17273. auto msession =
  17274. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17275. // Mbed TLS returns a pointer to the internal peer cert chain.
  17276. // WARNING: This pointer is only valid while the session is active.
  17277. // Do not use the certificate after calling free_session().
  17278. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17279. return const_cast<mbedtls_x509_crt *>(cert);
  17280. }
  17281. inline void free_cert(cert_t cert) {
  17282. // Mbed TLS: peer certificate is owned by the SSL context.
  17283. // No-op here, but callers should still call this for cross-backend
  17284. // portability.
  17285. (void)cert;
  17286. }
  17287. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17288. if (!cert || !hostname) { return false; }
  17289. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17290. std::string host_str(hostname);
  17291. // Check if hostname is an IP address (IPv4 or IPv6)
  17292. unsigned char ip_bytes[16];
  17293. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17294. auto is_ip = ip_len > 0;
  17295. // Check Subject Alternative Names (SAN)
  17296. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17297. // - DNS names: raw string bytes
  17298. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17299. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17300. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17301. const unsigned char *p = san->buf.p;
  17302. size_t len = san->buf.len;
  17303. if (is_ip) {
  17304. // For an IP host, only a matching iPAddress SAN of the same family
  17305. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17306. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17307. } else {
  17308. // Check if this SAN is a DNS name (printable ASCII string)
  17309. bool is_dns = len > 0;
  17310. for (size_t i = 0; i < len && is_dns; i++) {
  17311. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17312. }
  17313. if (is_dns) {
  17314. std::string san_name(reinterpret_cast<const char *>(p), len);
  17315. if (detail::match_hostname(san_name, host_str)) { return true; }
  17316. }
  17317. }
  17318. san = san->next;
  17319. }
  17320. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17321. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17322. // the OpenSSL backend's X509_check_ip behaves the same way).
  17323. if (!is_ip) {
  17324. char cn[256];
  17325. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17326. if (ret > 0) {
  17327. std::string cn_str(cn);
  17328. // Look for "CN=" in the DN string
  17329. size_t cn_pos = cn_str.find("CN=");
  17330. if (cn_pos != std::string::npos) {
  17331. size_t start = cn_pos + 3;
  17332. size_t end = cn_str.find(',', start);
  17333. std::string cn_value =
  17334. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17335. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17336. }
  17337. }
  17338. }
  17339. return false;
  17340. }
  17341. inline uint64_t hostname_mismatch_code() {
  17342. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17343. }
  17344. inline long get_verify_result(const_session_t session) {
  17345. if (!session) { return -1; }
  17346. auto msession =
  17347. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17348. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17349. // Return 0 (X509_V_OK equivalent) if verification passed
  17350. return flags == 0 ? 0 : static_cast<long>(flags);
  17351. }
  17352. inline std::string get_cert_subject_cn(cert_t cert) {
  17353. if (!cert) return "";
  17354. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17355. // Find the CN in the subject
  17356. const mbedtls_x509_name *name = &x509->subject;
  17357. while (name != nullptr) {
  17358. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17359. return std::string(reinterpret_cast<const char *>(name->val.p),
  17360. name->val.len);
  17361. }
  17362. name = name->next;
  17363. }
  17364. return "";
  17365. }
  17366. inline std::string get_cert_issuer_name(cert_t cert) {
  17367. if (!cert) return "";
  17368. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17369. // Build a human-readable issuer name string
  17370. char buf[512];
  17371. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17372. if (ret < 0) return "";
  17373. return std::string(buf);
  17374. }
  17375. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17376. sans.clear();
  17377. if (!cert) return false;
  17378. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17379. // Parse the Subject Alternative Name extension
  17380. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17381. while (cur != nullptr) {
  17382. if (cur->buf.len > 0) {
  17383. // Mbed TLS stores SAN as ASN.1 sequences
  17384. // The tag byte indicates the type
  17385. const unsigned char *p = cur->buf.p;
  17386. size_t len = cur->buf.len;
  17387. // First byte is the tag
  17388. unsigned char tag = *p;
  17389. p++;
  17390. len--;
  17391. // Parse length (simple single-byte length assumed)
  17392. if (len > 0 && *p < 0x80) {
  17393. size_t value_len = *p;
  17394. p++;
  17395. len--;
  17396. if (value_len <= len) {
  17397. SanEntry entry;
  17398. // ASN.1 context tags for GeneralName
  17399. switch (tag & 0x1F) {
  17400. case 2: // dNSName
  17401. entry.type = SanType::DNS;
  17402. entry.value =
  17403. std::string(reinterpret_cast<const char *>(p), value_len);
  17404. break;
  17405. case 7: // iPAddress
  17406. entry.type = SanType::IP;
  17407. if (value_len == 4) {
  17408. // IPv4
  17409. char buf[16];
  17410. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17411. entry.value = buf;
  17412. } else if (value_len == 16) {
  17413. // IPv6
  17414. char buf[64];
  17415. snprintf(buf, sizeof(buf),
  17416. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17417. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17418. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17419. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17420. entry.value = buf;
  17421. }
  17422. break;
  17423. case 1: // rfc822Name (email)
  17424. entry.type = SanType::EMAIL;
  17425. entry.value =
  17426. std::string(reinterpret_cast<const char *>(p), value_len);
  17427. break;
  17428. case 6: // uniformResourceIdentifier
  17429. entry.type = SanType::URI;
  17430. entry.value =
  17431. std::string(reinterpret_cast<const char *>(p), value_len);
  17432. break;
  17433. default: entry.type = SanType::OTHER; break;
  17434. }
  17435. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17436. }
  17437. }
  17438. }
  17439. cur = cur->next;
  17440. }
  17441. return true;
  17442. }
  17443. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17444. time_t &not_after) {
  17445. if (!cert) return false;
  17446. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17447. // Convert mbedtls_x509_time to time_t
  17448. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17449. struct tm tm_time = {};
  17450. tm_time.tm_year = t.year - 1900;
  17451. tm_time.tm_mon = t.mon - 1;
  17452. tm_time.tm_mday = t.day;
  17453. tm_time.tm_hour = t.hour;
  17454. tm_time.tm_min = t.min;
  17455. tm_time.tm_sec = t.sec;
  17456. #ifdef _WIN32
  17457. return _mkgmtime(&tm_time);
  17458. #else
  17459. return timegm(&tm_time);
  17460. #endif
  17461. };
  17462. not_before = to_time_t(x509->valid_from);
  17463. not_after = to_time_t(x509->valid_to);
  17464. return true;
  17465. }
  17466. inline std::string get_cert_serial(cert_t cert) {
  17467. if (!cert) return "";
  17468. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17469. // Convert serial number to hex string
  17470. std::string result;
  17471. result.reserve(x509->serial.len * 2);
  17472. for (size_t i = 0; i < x509->serial.len; i++) {
  17473. char hex[3];
  17474. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  17475. result += hex;
  17476. }
  17477. return result;
  17478. }
  17479. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17480. if (!cert) return false;
  17481. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  17482. if (!crt->raw.p || crt->raw.len == 0) return false;
  17483. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  17484. return true;
  17485. }
  17486. inline const char *get_sni(const_session_t session) {
  17487. if (!session) return nullptr;
  17488. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  17489. // For server: return SNI received from client during handshake
  17490. if (!msession->sni_hostname.empty()) {
  17491. return msession->sni_hostname.c_str();
  17492. }
  17493. // For client: return the hostname set via set_sni
  17494. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  17495. return nullptr;
  17496. }
  17497. inline uint64_t peek_error() {
  17498. // Mbed TLS doesn't have an error queue, return the last error
  17499. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  17500. }
  17501. inline uint64_t get_error() {
  17502. // Mbed TLS doesn't have an error queue, return and clear the last error
  17503. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  17504. impl::mbedtls_last_error() = 0;
  17505. return err;
  17506. }
  17507. inline std::string error_string(uint64_t code) {
  17508. char buf[256];
  17509. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  17510. return std::string(buf);
  17511. }
  17512. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17513. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  17514. if (!ca_chain) { return nullptr; }
  17515. mbedtls_x509_crt_init(ca_chain);
  17516. // mbedtls_x509_crt_parse expects null-terminated PEM
  17517. int ret = mbedtls_x509_crt_parse(ca_chain,
  17518. reinterpret_cast<const unsigned char *>(pem),
  17519. len + 1); // +1 for null terminator
  17520. if (ret != 0) {
  17521. // Try without +1 in case PEM is already null-terminated
  17522. ret = mbedtls_x509_crt_parse(
  17523. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  17524. if (ret != 0) {
  17525. mbedtls_x509_crt_free(ca_chain);
  17526. delete ca_chain;
  17527. return nullptr;
  17528. }
  17529. }
  17530. return static_cast<ca_store_t>(ca_chain);
  17531. }
  17532. inline void free_ca_store(ca_store_t store) {
  17533. if (store) {
  17534. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17535. mbedtls_x509_crt_free(ca_chain);
  17536. delete ca_chain;
  17537. }
  17538. }
  17539. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17540. if (!ctx || !store) { return false; }
  17541. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17542. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17543. // Free existing CA chain
  17544. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17545. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17546. // Copy the CA chain (deep copy)
  17547. // Parse from the raw data of the source cert
  17548. mbedtls_x509_crt *src = ca_chain;
  17549. while (src != nullptr) {
  17550. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  17551. src->raw.len);
  17552. if (ret != 0) {
  17553. free_ca_store(store);
  17554. return false;
  17555. }
  17556. src = src->next;
  17557. }
  17558. // This function takes ownership of the store; the chain was deep-copied
  17559. // above, so release the source
  17560. free_ca_store(store);
  17561. // Update the SSL config to use the new CA chain
  17562. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17563. return true;
  17564. }
  17565. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17566. certs.clear();
  17567. if (!ctx) { return 0; }
  17568. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17569. // Iterate through the CA chain
  17570. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17571. while (cert != nullptr && cert->raw.len > 0) {
  17572. // Create a copy of the certificate for the caller
  17573. auto *copy = new mbedtls_x509_crt;
  17574. mbedtls_x509_crt_init(copy);
  17575. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  17576. if (ret == 0) {
  17577. certs.push_back(static_cast<cert_t>(copy));
  17578. } else {
  17579. mbedtls_x509_crt_free(copy);
  17580. delete copy;
  17581. }
  17582. cert = cert->next;
  17583. }
  17584. return certs.size();
  17585. }
  17586. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17587. std::vector<std::string> names;
  17588. if (!ctx) { return names; }
  17589. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17590. // Iterate through the CA chain
  17591. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17592. while (cert != nullptr && cert->raw.len > 0) {
  17593. char buf[512];
  17594. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  17595. if (ret > 0) { names.push_back(buf); }
  17596. cert = cert->next;
  17597. }
  17598. return names;
  17599. }
  17600. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17601. const char *key_pem, const char *password) {
  17602. if (!ctx || !cert_pem || !key_pem) { return false; }
  17603. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17604. // Free existing certificate and key
  17605. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  17606. mbedtls_pk_free(&mbed_ctx->own_key);
  17607. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  17608. mbedtls_pk_init(&mbed_ctx->own_key);
  17609. // Parse certificate PEM
  17610. int ret = mbedtls_x509_crt_parse(
  17611. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  17612. strlen(cert_pem) + 1);
  17613. if (ret != 0) {
  17614. impl::mbedtls_last_error() = ret;
  17615. return false;
  17616. }
  17617. // Parse private key PEM
  17618. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17619. ret = mbedtls_pk_parse_key(
  17620. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17621. strlen(key_pem) + 1,
  17622. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17623. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  17624. &mbed_ctx->ctr_drbg);
  17625. #else
  17626. ret = mbedtls_pk_parse_key(
  17627. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17628. strlen(key_pem) + 1,
  17629. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17630. password ? strlen(password) : 0);
  17631. #endif
  17632. if (ret != 0) {
  17633. impl::mbedtls_last_error() = ret;
  17634. return false;
  17635. }
  17636. // Configure SSL to use the new certificate and key
  17637. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  17638. &mbed_ctx->own_key);
  17639. if (ret != 0) {
  17640. impl::mbedtls_last_error() = ret;
  17641. return false;
  17642. }
  17643. return true;
  17644. }
  17645. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17646. if (!ctx || !ca_pem) { return false; }
  17647. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17648. // Free existing CA chain
  17649. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17650. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17651. // Parse CA PEM
  17652. int ret = mbedtls_x509_crt_parse(
  17653. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  17654. strlen(ca_pem) + 1);
  17655. if (ret != 0) {
  17656. impl::mbedtls_last_error() = ret;
  17657. return false;
  17658. }
  17659. // Update SSL config to use new CA chain
  17660. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17661. return true;
  17662. }
  17663. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17664. if (!ctx) { return false; }
  17665. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17666. impl::get_verify_callback() = std::move(callback);
  17667. mbed_ctx->has_verify_callback =
  17668. static_cast<bool>(impl::get_verify_callback());
  17669. if (mbed_ctx->has_verify_callback) {
  17670. // Set OPTIONAL mode to ensure callback is called even when verification
  17671. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  17672. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  17673. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  17674. nullptr);
  17675. } else {
  17676. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  17677. }
  17678. return true;
  17679. }
  17680. inline long get_verify_error(const_session_t session) {
  17681. if (!session) { return -1; }
  17682. auto *msession =
  17683. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17684. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  17685. }
  17686. inline std::string verify_error_string(long error_code) {
  17687. if (error_code == 0) { return ""; }
  17688. char buf[256];
  17689. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  17690. static_cast<uint32_t>(error_code));
  17691. // Remove trailing newline if present
  17692. std::string result(buf);
  17693. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  17694. result.pop_back();
  17695. }
  17696. return result;
  17697. }
  17698. } // namespace tls
  17699. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  17700. /*
  17701. * Group 10: TLS abstraction layer - wolfSSL backend
  17702. */
  17703. /*
  17704. * wolfSSL Backend Implementation
  17705. */
  17706. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  17707. namespace tls {
  17708. namespace impl {
  17709. // wolfSSL session wrapper
  17710. struct WolfSSLSession {
  17711. WOLFSSL *ssl = nullptr;
  17712. socket_t sock = INVALID_SOCKET;
  17713. std::string hostname; // For client: set via set_sni
  17714. std::string sni_hostname; // For server: received from client via SNI callback
  17715. WolfSSLSession() = default;
  17716. ~WolfSSLSession() {
  17717. if (ssl) { wolfSSL_free(ssl); }
  17718. }
  17719. WolfSSLSession(const WolfSSLSession &) = delete;
  17720. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  17721. };
  17722. // Thread-local error code accessor for wolfSSL
  17723. inline uint64_t &wolfssl_last_error() {
  17724. static thread_local uint64_t err = 0;
  17725. return err;
  17726. }
  17727. // Helper to map wolfSSL error to ErrorCode.
  17728. // ssl_error is the value from wolfSSL_get_error().
  17729. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  17730. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  17731. int &out_errno) {
  17732. switch (ssl_error) {
  17733. case SSL_ERROR_NONE: return ErrorCode::Success;
  17734. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17735. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17736. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17737. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17738. default:
  17739. if (ssl) {
  17740. // wolfSSL stores the low-level error code as a negative value.
  17741. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  17742. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  17743. if (low_err == DOMAIN_NAME_MISMATCH) {
  17744. return ErrorCode::HostnameMismatch;
  17745. }
  17746. // Check verify result to distinguish cert verification from generic SSL
  17747. // errors.
  17748. long vr = wolfSSL_get_verify_result(ssl);
  17749. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  17750. }
  17751. return ErrorCode::Fatal;
  17752. }
  17753. }
  17754. // WolfSSLContext constructor/destructor implementations
  17755. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  17756. inline WolfSSLContext::~WolfSSLContext() {
  17757. if (ctx) { wolfSSL_CTX_free(ctx); }
  17758. }
  17759. // Thread-local storage for SNI captured during handshake
  17760. inline std::string &wolfssl_pending_sni() {
  17761. static thread_local std::string sni;
  17762. return sni;
  17763. }
  17764. // SNI callback for wolfSSL server to capture client's SNI hostname
  17765. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  17766. (void)ret;
  17767. (void)exArg;
  17768. void *name_data = nullptr;
  17769. unsigned short name_len =
  17770. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  17771. if (name_data && name_len > 0) {
  17772. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  17773. name_len);
  17774. } else {
  17775. wolfssl_pending_sni().clear();
  17776. }
  17777. return 0; // Continue regardless
  17778. }
  17779. // wolfSSL verify callback wrapper
  17780. inline int wolfssl_verify_callback(int preverify_ok,
  17781. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  17782. auto &callback = get_verify_callback();
  17783. if (!callback) { return preverify_ok; }
  17784. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  17785. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  17786. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  17787. // Get the WOLFSSL object from the X509_STORE_CTX
  17788. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  17789. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  17790. VerifyContext verify_ctx;
  17791. verify_ctx.session = static_cast<session_t>(ssl);
  17792. verify_ctx.cert = static_cast<cert_t>(cert);
  17793. verify_ctx.depth = depth;
  17794. verify_ctx.preverify_ok = (preverify_ok != 0);
  17795. verify_ctx.error_code = static_cast<long>(err);
  17796. if (err != 0) {
  17797. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  17798. } else {
  17799. verify_ctx.error_string = nullptr;
  17800. }
  17801. bool accepted = callback(verify_ctx);
  17802. return accepted ? 1 : 0;
  17803. }
  17804. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  17805. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  17806. wolfSSL_CTX_set_default_passwd_cb(
  17807. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  17808. auto *pwd = static_cast<const char *>(userdata);
  17809. if (!pwd) return 0;
  17810. auto len = static_cast<int>(strlen(pwd));
  17811. if (len > size) len = size;
  17812. memcpy(buf, pwd, static_cast<size_t>(len));
  17813. return len;
  17814. });
  17815. }
  17816. } // namespace impl
  17817. inline ctx_t create_client_context() {
  17818. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  17819. if (!ctx) { return nullptr; }
  17820. ctx->is_server = false;
  17821. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  17822. if (!method) {
  17823. delete ctx;
  17824. return nullptr;
  17825. }
  17826. ctx->ctx = wolfSSL_CTX_new(method);
  17827. if (!ctx->ctx) {
  17828. delete ctx;
  17829. return nullptr;
  17830. }
  17831. // Default: verify peer certificate
  17832. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  17833. return static_cast<ctx_t>(ctx);
  17834. }
  17835. inline ctx_t create_server_context() {
  17836. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  17837. if (!ctx) { return nullptr; }
  17838. ctx->is_server = true;
  17839. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  17840. if (!method) {
  17841. delete ctx;
  17842. return nullptr;
  17843. }
  17844. ctx->ctx = wolfSSL_CTX_new(method);
  17845. if (!ctx->ctx) {
  17846. delete ctx;
  17847. return nullptr;
  17848. }
  17849. // Default: don't verify client
  17850. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  17851. // Enable SNI on server
  17852. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  17853. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  17854. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  17855. return static_cast<ctx_t>(ctx);
  17856. }
  17857. inline void free_context(ctx_t ctx) {
  17858. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  17859. }
  17860. inline bool set_min_version(ctx_t ctx, Version version) {
  17861. if (!ctx) { return false; }
  17862. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  17863. int min_ver = WOLFSSL_TLSV1_2;
  17864. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  17865. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  17866. }
  17867. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17868. if (!ctx || !pem) { return false; }
  17869. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  17870. int ret = wolfSSL_CTX_load_verify_buffer(
  17871. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  17872. static_cast<long>(len), SSL_FILETYPE_PEM);
  17873. if (ret != SSL_SUCCESS) {
  17874. impl::wolfssl_last_error() =
  17875. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  17876. return false;
  17877. }
  17878. wctx->ca_pem_data_.append(pem, len);
  17879. return true;
  17880. }
  17881. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17882. if (!ctx || !file_path) { return false; }
  17883. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  17884. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  17885. if (ret != SSL_SUCCESS) {
  17886. impl::wolfssl_last_error() =
  17887. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  17888. return false;
  17889. }
  17890. return true;
  17891. }
  17892. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17893. if (!ctx || !dir_path) { return false; }
  17894. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  17895. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  17896. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  17897. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  17898. // immediately. Return true even on failure since the CA file may have
  17899. // already been loaded, matching OpenSSL's lenient behavior.
  17900. (void)ret;
  17901. return true;
  17902. }
  17903. inline bool load_system_certs(ctx_t ctx) {
  17904. if (!ctx) { return false; }
  17905. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  17906. bool loaded = false;
  17907. #ifdef _WIN32
  17908. loaded = impl::enumerate_windows_system_certs(
  17909. [&](const unsigned char *data, size_t len) {
  17910. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  17911. static_cast<long>(len),
  17912. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  17913. });
  17914. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17915. loaded = impl::enumerate_macos_keychain_certs(
  17916. [&](const unsigned char *data, size_t len) {
  17917. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  17918. static_cast<long>(len),
  17919. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  17920. });
  17921. #else
  17922. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17923. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  17924. SSL_SUCCESS) {
  17925. loaded = true;
  17926. break;
  17927. }
  17928. }
  17929. if (!loaded) {
  17930. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17931. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  17932. SSL_SUCCESS) {
  17933. loaded = true;
  17934. break;
  17935. }
  17936. }
  17937. }
  17938. #endif
  17939. return loaded;
  17940. }
  17941. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17942. const char *password) {
  17943. if (!ctx || !cert || !key) { return false; }
  17944. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  17945. // Load certificate
  17946. int ret = wolfSSL_CTX_use_certificate_buffer(
  17947. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  17948. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  17949. if (ret != SSL_SUCCESS) {
  17950. impl::wolfssl_last_error() =
  17951. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  17952. return false;
  17953. }
  17954. // Set password callback if password is provided
  17955. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  17956. // Load private key
  17957. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  17958. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  17959. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  17960. if (ret != SSL_SUCCESS) {
  17961. impl::wolfssl_last_error() =
  17962. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  17963. return false;
  17964. }
  17965. // Verify that the certificate and private key match
  17966. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  17967. }
  17968. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17969. const char *key_path, const char *password) {
  17970. if (!ctx || !cert_path || !key_path) { return false; }
  17971. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  17972. // Load certificate file
  17973. int ret =
  17974. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  17975. if (ret != SSL_SUCCESS) {
  17976. impl::wolfssl_last_error() =
  17977. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  17978. return false;
  17979. }
  17980. // Set password callback if password is provided
  17981. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  17982. // Load private key file
  17983. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  17984. if (ret != SSL_SUCCESS) {
  17985. impl::wolfssl_last_error() =
  17986. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  17987. return false;
  17988. }
  17989. // Verify that the certificate and private key match
  17990. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  17991. }
  17992. inline void set_verify_client(ctx_t ctx, bool require) {
  17993. if (!ctx) { return; }
  17994. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  17995. wctx->verify_client = require;
  17996. if (require) {
  17997. wolfSSL_CTX_set_verify(
  17998. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  17999. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18000. } else {
  18001. if (wctx->has_verify_callback) {
  18002. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18003. impl::wolfssl_verify_callback);
  18004. } else {
  18005. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18006. }
  18007. }
  18008. }
  18009. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18010. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18011. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18012. auto session = new (std::nothrow) impl::WolfSSLSession();
  18013. if (!session) { return nullptr; }
  18014. session->sock = sock;
  18015. session->ssl = wolfSSL_new(wctx->ctx);
  18016. if (!session->ssl) {
  18017. impl::wolfssl_last_error() =
  18018. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18019. delete session;
  18020. return nullptr;
  18021. }
  18022. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18023. return static_cast<session_t>(session);
  18024. }
  18025. inline void free_session(session_t session) {
  18026. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18027. }
  18028. inline bool set_sni(session_t session, const char *hostname,
  18029. bool verify_hostname) {
  18030. if (!session || !hostname) { return false; }
  18031. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18032. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18033. static_cast<word16>(strlen(hostname)));
  18034. if (ret != WOLFSSL_SUCCESS) {
  18035. impl::wolfssl_last_error() =
  18036. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18037. return false;
  18038. }
  18039. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18040. // separately from the SNI extension sent above; skip it when hostname
  18041. // verification is disabled so only the chain is checked, matching OpenSSL.
  18042. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18043. wsession->hostname = hostname;
  18044. return true;
  18045. }
  18046. inline TlsError connect(session_t session) {
  18047. TlsError err;
  18048. if (!session) {
  18049. err.code = ErrorCode::Fatal;
  18050. return err;
  18051. }
  18052. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18053. int ret = wolfSSL_connect(wsession->ssl);
  18054. if (ret == SSL_SUCCESS) {
  18055. err.code = ErrorCode::Success;
  18056. } else {
  18057. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18058. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18059. err.backend_code = static_cast<uint64_t>(ssl_error);
  18060. impl::wolfssl_last_error() = err.backend_code;
  18061. }
  18062. return err;
  18063. }
  18064. inline TlsError accept(session_t session) {
  18065. TlsError err;
  18066. if (!session) {
  18067. err.code = ErrorCode::Fatal;
  18068. return err;
  18069. }
  18070. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18071. int ret = wolfSSL_accept(wsession->ssl);
  18072. if (ret == SSL_SUCCESS) {
  18073. err.code = ErrorCode::Success;
  18074. // Capture SNI from thread-local storage after successful handshake
  18075. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18076. impl::wolfssl_pending_sni().clear();
  18077. } else {
  18078. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18079. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18080. err.backend_code = static_cast<uint64_t>(ssl_error);
  18081. impl::wolfssl_last_error() = err.backend_code;
  18082. }
  18083. return err;
  18084. }
  18085. inline bool connect_nonblocking(session_t session, socket_t sock,
  18086. time_t timeout_sec, time_t timeout_usec,
  18087. TlsError *err) {
  18088. if (!session) {
  18089. if (err) { err->code = ErrorCode::Fatal; }
  18090. return false;
  18091. }
  18092. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18093. // Set socket to non-blocking mode
  18094. detail::set_nonblocking(sock, true);
  18095. auto cleanup =
  18096. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18097. int ret;
  18098. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18099. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18100. if (ssl_error == SSL_ERROR_WANT_READ) {
  18101. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18102. continue;
  18103. }
  18104. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18105. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18106. continue;
  18107. }
  18108. }
  18109. // Error or timeout
  18110. if (err) {
  18111. err->code =
  18112. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18113. err->backend_code = static_cast<uint64_t>(ssl_error);
  18114. }
  18115. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18116. return false;
  18117. }
  18118. if (err) { err->code = ErrorCode::Success; }
  18119. return true;
  18120. }
  18121. inline bool accept_nonblocking(session_t session, socket_t sock,
  18122. time_t timeout_sec, time_t timeout_usec,
  18123. TlsError *err) {
  18124. if (!session) {
  18125. if (err) { err->code = ErrorCode::Fatal; }
  18126. return false;
  18127. }
  18128. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18129. // Set socket to non-blocking mode
  18130. detail::set_nonblocking(sock, true);
  18131. auto cleanup =
  18132. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18133. int ret;
  18134. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18135. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18136. if (ssl_error == SSL_ERROR_WANT_READ) {
  18137. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18138. continue;
  18139. }
  18140. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18141. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18142. continue;
  18143. }
  18144. }
  18145. // Error or timeout
  18146. if (err) {
  18147. err->code =
  18148. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18149. err->backend_code = static_cast<uint64_t>(ssl_error);
  18150. }
  18151. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18152. return false;
  18153. }
  18154. if (err) { err->code = ErrorCode::Success; }
  18155. // Capture SNI from thread-local storage after successful handshake
  18156. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18157. impl::wolfssl_pending_sni().clear();
  18158. return true;
  18159. }
  18160. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18161. if (!session || !buf) {
  18162. err.code = ErrorCode::Fatal;
  18163. return -1;
  18164. }
  18165. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18166. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18167. if (ret > 0) {
  18168. err.code = ErrorCode::Success;
  18169. return static_cast<ssize_t>(ret);
  18170. }
  18171. if (ret == 0) {
  18172. err.code = ErrorCode::PeerClosed;
  18173. return 0;
  18174. }
  18175. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18176. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18177. err.backend_code = static_cast<uint64_t>(ssl_error);
  18178. impl::wolfssl_last_error() = err.backend_code;
  18179. return -1;
  18180. }
  18181. inline ssize_t write(session_t session, const void *buf, size_t len,
  18182. TlsError &err) {
  18183. if (!session || !buf) {
  18184. err.code = ErrorCode::Fatal;
  18185. return -1;
  18186. }
  18187. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18188. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18189. if (ret > 0) {
  18190. err.code = ErrorCode::Success;
  18191. return static_cast<ssize_t>(ret);
  18192. }
  18193. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18194. // Treat this as an error (return -1) so callers don't spin in a
  18195. // write loop adding zero to the offset.
  18196. if (ret == 0) {
  18197. err.code = ErrorCode::PeerClosed;
  18198. return -1;
  18199. }
  18200. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18201. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18202. err.backend_code = static_cast<uint64_t>(ssl_error);
  18203. impl::wolfssl_last_error() = err.backend_code;
  18204. return -1;
  18205. }
  18206. inline int pending(const_session_t session) {
  18207. if (!session) { return 0; }
  18208. auto wsession =
  18209. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18210. return wolfSSL_pending(wsession->ssl);
  18211. }
  18212. inline void shutdown(session_t session, bool graceful) {
  18213. if (!session) { return; }
  18214. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18215. if (graceful) {
  18216. int ret;
  18217. int attempts = 0;
  18218. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18219. attempts < 3) {
  18220. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18221. if (ssl_error != SSL_ERROR_WANT_READ &&
  18222. ssl_error != SSL_ERROR_WANT_WRITE) {
  18223. break;
  18224. }
  18225. attempts++;
  18226. }
  18227. } else {
  18228. wolfSSL_shutdown(wsession->ssl);
  18229. }
  18230. }
  18231. inline bool is_peer_closed(session_t session, socket_t sock) {
  18232. if (!session || sock == INVALID_SOCKET) { return true; }
  18233. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18234. // Check if there's already decrypted data available
  18235. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18236. // Set socket to non-blocking to avoid blocking on read
  18237. detail::set_nonblocking(sock, true);
  18238. auto cleanup =
  18239. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18240. // Peek 1 byte to check connection status without consuming data
  18241. unsigned char buf;
  18242. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18243. // If we got data or WANT_READ (would block), connection is alive
  18244. if (ret > 0) { return false; }
  18245. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18246. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18247. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18248. ret == 0;
  18249. }
  18250. inline cert_t get_peer_cert(const_session_t session) {
  18251. if (!session) { return nullptr; }
  18252. auto wsession =
  18253. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18254. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18255. return static_cast<cert_t>(cert);
  18256. }
  18257. inline void free_cert(cert_t cert) {
  18258. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18259. }
  18260. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18261. if (!cert || !hostname) { return false; }
  18262. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18263. std::string host_str(hostname);
  18264. // Check if hostname is an IP address (IPv4 or IPv6)
  18265. unsigned char ip_bytes[16];
  18266. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18267. auto is_ip = ip_len > 0;
  18268. // Check Subject Alternative Names
  18269. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18270. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18271. if (san_names) {
  18272. int san_count = wolfSSL_sk_num(san_names);
  18273. for (int i = 0; i < san_count; i++) {
  18274. auto *names =
  18275. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18276. if (!names) continue;
  18277. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18278. // DNS name
  18279. unsigned char *dns_name = nullptr;
  18280. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18281. if (dns_name && dns_len > 0) {
  18282. std::string san_name(reinterpret_cast<char *>(dns_name),
  18283. static_cast<size_t>(dns_len));
  18284. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18285. if (detail::match_hostname(san_name, host_str)) {
  18286. wolfSSL_sk_free(san_names);
  18287. return true;
  18288. }
  18289. }
  18290. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18291. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18292. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18293. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18294. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18295. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18296. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18297. wolfSSL_sk_free(san_names);
  18298. return true;
  18299. }
  18300. }
  18301. }
  18302. wolfSSL_sk_free(san_names);
  18303. }
  18304. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18305. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18306. // the OpenSSL backend's X509_check_ip behaves the same way).
  18307. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18308. if (subject) {
  18309. char cn[256] = {};
  18310. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18311. sizeof(cn));
  18312. if (cn_len > 0) {
  18313. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18314. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18315. }
  18316. }
  18317. return false;
  18318. }
  18319. inline uint64_t hostname_mismatch_code() {
  18320. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18321. }
  18322. inline long get_verify_result(const_session_t session) {
  18323. if (!session) { return -1; }
  18324. auto wsession =
  18325. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18326. long result = wolfSSL_get_verify_result(wsession->ssl);
  18327. return result;
  18328. }
  18329. inline std::string get_cert_subject_cn(cert_t cert) {
  18330. if (!cert) return "";
  18331. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18332. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18333. if (!subject) return "";
  18334. char cn[256] = {};
  18335. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18336. sizeof(cn));
  18337. if (cn_len <= 0) return "";
  18338. return std::string(cn, static_cast<size_t>(cn_len));
  18339. }
  18340. inline std::string get_cert_issuer_name(cert_t cert) {
  18341. if (!cert) return "";
  18342. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18343. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18344. if (!issuer) return "";
  18345. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18346. if (!name_str) return "";
  18347. std::string result(name_str);
  18348. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18349. return result;
  18350. }
  18351. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18352. sans.clear();
  18353. if (!cert) return false;
  18354. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18355. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18356. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18357. if (!san_names) return true; // No SANs is not an error
  18358. int count = wolfSSL_sk_num(san_names);
  18359. for (int i = 0; i < count; i++) {
  18360. auto *name =
  18361. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18362. if (!name) continue;
  18363. SanEntry entry;
  18364. switch (name->type) {
  18365. case WOLFSSL_GEN_DNS: {
  18366. entry.type = SanType::DNS;
  18367. unsigned char *dns_name = nullptr;
  18368. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18369. if (dns_name && dns_len > 0) {
  18370. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18371. static_cast<size_t>(dns_len));
  18372. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18373. }
  18374. break;
  18375. }
  18376. case WOLFSSL_GEN_IPADD: {
  18377. entry.type = SanType::IP;
  18378. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18379. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18380. if (ip_data && ip_len == 4) {
  18381. char buf[16];
  18382. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18383. ip_data[2], ip_data[3]);
  18384. entry.value = buf;
  18385. } else if (ip_data && ip_len == 16) {
  18386. char buf[64];
  18387. snprintf(buf, sizeof(buf),
  18388. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18389. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18390. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18391. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18392. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18393. ip_data[14], ip_data[15]);
  18394. entry.value = buf;
  18395. }
  18396. break;
  18397. }
  18398. case WOLFSSL_GEN_EMAIL:
  18399. entry.type = SanType::EMAIL;
  18400. {
  18401. unsigned char *email = nullptr;
  18402. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18403. if (email && email_len > 0) {
  18404. entry.value = std::string(reinterpret_cast<char *>(email),
  18405. static_cast<size_t>(email_len));
  18406. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18407. }
  18408. }
  18409. break;
  18410. case WOLFSSL_GEN_URI:
  18411. entry.type = SanType::URI;
  18412. {
  18413. unsigned char *uri = nullptr;
  18414. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18415. &uri, name->d.uniformResourceIdentifier);
  18416. if (uri && uri_len > 0) {
  18417. entry.value = std::string(reinterpret_cast<char *>(uri),
  18418. static_cast<size_t>(uri_len));
  18419. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18420. }
  18421. }
  18422. break;
  18423. default: entry.type = SanType::OTHER; break;
  18424. }
  18425. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18426. }
  18427. wolfSSL_sk_free(san_names);
  18428. return true;
  18429. }
  18430. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18431. time_t &not_after) {
  18432. if (!cert) return false;
  18433. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18434. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18435. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18436. if (!nb || !na) return false;
  18437. // wolfSSL_ASN1_TIME_to_tm is available
  18438. struct tm tm_nb = {}, tm_na = {};
  18439. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18440. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  18441. #ifdef _WIN32
  18442. not_before = _mkgmtime(&tm_nb);
  18443. not_after = _mkgmtime(&tm_na);
  18444. #else
  18445. not_before = timegm(&tm_nb);
  18446. not_after = timegm(&tm_na);
  18447. #endif
  18448. return true;
  18449. }
  18450. inline std::string get_cert_serial(cert_t cert) {
  18451. if (!cert) return "";
  18452. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18453. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  18454. if (!serial_asn1) return "";
  18455. // Get the serial number data
  18456. int len = serial_asn1->length;
  18457. unsigned char *data = serial_asn1->data;
  18458. if (!data || len <= 0) return "";
  18459. std::string result;
  18460. result.reserve(static_cast<size_t>(len) * 2);
  18461. for (int i = 0; i < len; i++) {
  18462. char hex[3];
  18463. snprintf(hex, sizeof(hex), "%02X", data[i]);
  18464. result += hex;
  18465. }
  18466. return result;
  18467. }
  18468. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18469. if (!cert) return false;
  18470. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18471. int der_len = 0;
  18472. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  18473. if (!der_data || der_len <= 0) return false;
  18474. der.assign(der_data, der_data + der_len);
  18475. return true;
  18476. }
  18477. inline const char *get_sni(const_session_t session) {
  18478. if (!session) return nullptr;
  18479. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  18480. // For server: return SNI received from client during handshake
  18481. if (!wsession->sni_hostname.empty()) {
  18482. return wsession->sni_hostname.c_str();
  18483. }
  18484. // For client: return the hostname set via set_sni
  18485. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  18486. return nullptr;
  18487. }
  18488. inline uint64_t peek_error() {
  18489. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18490. }
  18491. inline uint64_t get_error() {
  18492. uint64_t err = impl::wolfssl_last_error();
  18493. impl::wolfssl_last_error() = 0;
  18494. return err;
  18495. }
  18496. inline std::string error_string(uint64_t code) {
  18497. char buf[256];
  18498. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  18499. return std::string(buf);
  18500. }
  18501. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18502. if (!pem || len == 0) { return nullptr; }
  18503. // Validate by attempting to load into a temporary ctx
  18504. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  18505. if (!tmp_ctx) { return nullptr; }
  18506. int ret = wolfSSL_CTX_load_verify_buffer(
  18507. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  18508. static_cast<long>(len), SSL_FILETYPE_PEM);
  18509. wolfSSL_CTX_free(tmp_ctx);
  18510. if (ret != SSL_SUCCESS) { return nullptr; }
  18511. return static_cast<ca_store_t>(
  18512. new impl::WolfSSLCAStore{std::string(pem, len)});
  18513. }
  18514. inline void free_ca_store(ca_store_t store) {
  18515. delete static_cast<impl::WolfSSLCAStore *>(store);
  18516. }
  18517. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18518. if (!ctx || !store) { return false; }
  18519. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18520. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  18521. int ret = wolfSSL_CTX_load_verify_buffer(
  18522. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  18523. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  18524. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  18525. // This function takes ownership of the store; the PEM data was copied into
  18526. // the context, so release the source
  18527. free_ca_store(store);
  18528. return ret == SSL_SUCCESS;
  18529. }
  18530. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18531. certs.clear();
  18532. if (!ctx) { return 0; }
  18533. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18534. if (wctx->ca_pem_data_.empty()) { return 0; }
  18535. const std::string &pem = wctx->ca_pem_data_;
  18536. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18537. const std::string end_marker = "-----END CERTIFICATE-----";
  18538. size_t pos = 0;
  18539. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18540. size_t end_pos = pem.find(end_marker, pos);
  18541. if (end_pos == std::string::npos) { break; }
  18542. end_pos += end_marker.size();
  18543. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18544. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18545. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18546. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18547. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18548. pos = end_pos;
  18549. }
  18550. return certs.size();
  18551. }
  18552. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18553. std::vector<std::string> names;
  18554. if (!ctx) { return names; }
  18555. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18556. if (wctx->ca_pem_data_.empty()) { return names; }
  18557. const std::string &pem = wctx->ca_pem_data_;
  18558. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18559. const std::string end_marker = "-----END CERTIFICATE-----";
  18560. size_t pos = 0;
  18561. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18562. size_t end_pos = pem.find(end_marker, pos);
  18563. if (end_pos == std::string::npos) { break; }
  18564. end_pos += end_marker.size();
  18565. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18566. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18567. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18568. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18569. if (x509) {
  18570. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18571. if (subject) {
  18572. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  18573. if (name_str) {
  18574. names.push_back(name_str);
  18575. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18576. }
  18577. }
  18578. wolfSSL_X509_free(x509);
  18579. }
  18580. pos = end_pos;
  18581. }
  18582. return names;
  18583. }
  18584. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18585. const char *key_pem, const char *password) {
  18586. if (!ctx || !cert_pem || !key_pem) { return false; }
  18587. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18588. // Load new certificate
  18589. int ret = wolfSSL_CTX_use_certificate_buffer(
  18590. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  18591. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  18592. if (ret != SSL_SUCCESS) {
  18593. impl::wolfssl_last_error() =
  18594. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18595. return false;
  18596. }
  18597. // Set password if provided
  18598. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18599. // Load new private key
  18600. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18601. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  18602. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  18603. if (ret != SSL_SUCCESS) {
  18604. impl::wolfssl_last_error() =
  18605. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18606. return false;
  18607. }
  18608. return true;
  18609. }
  18610. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18611. if (!ctx || !ca_pem) { return false; }
  18612. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18613. int ret = wolfSSL_CTX_load_verify_buffer(
  18614. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  18615. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  18616. if (ret != SSL_SUCCESS) {
  18617. impl::wolfssl_last_error() =
  18618. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18619. return false;
  18620. }
  18621. return true;
  18622. }
  18623. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18624. if (!ctx) { return false; }
  18625. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18626. impl::get_verify_callback() = std::move(callback);
  18627. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  18628. if (wctx->has_verify_callback) {
  18629. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18630. impl::wolfssl_verify_callback);
  18631. } else {
  18632. wolfSSL_CTX_set_verify(
  18633. wctx->ctx,
  18634. wctx->verify_client
  18635. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  18636. : SSL_VERIFY_NONE,
  18637. nullptr);
  18638. }
  18639. return true;
  18640. }
  18641. inline long get_verify_error(const_session_t session) {
  18642. if (!session) { return -1; }
  18643. auto *wsession =
  18644. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18645. return wolfSSL_get_verify_result(wsession->ssl);
  18646. }
  18647. inline std::string verify_error_string(long error_code) {
  18648. if (error_code == 0) { return ""; }
  18649. const char *str =
  18650. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  18651. return str ? std::string(str) : std::string();
  18652. }
  18653. } // namespace tls
  18654. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  18655. // WebSocket implementation
  18656. namespace ws {
  18657. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  18658. bool fin) {
  18659. std::lock_guard<std::mutex> lock(write_mutex_);
  18660. if (closed_) { return false; }
  18661. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  18662. }
  18663. inline ReadResult WebSocket::read(std::string &msg) {
  18664. std::unique_lock<std::mutex> read_lock(read_mutex_);
  18665. while (!closed_) {
  18666. Opcode opcode;
  18667. std::string payload;
  18668. bool fin;
  18669. if (!impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  18670. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)) {
  18671. closed_ = true;
  18672. return Fail;
  18673. }
  18674. switch (opcode) {
  18675. case Opcode::Ping: {
  18676. std::lock_guard<std::mutex> lock(write_mutex_);
  18677. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  18678. payload.size(), true, !is_server_);
  18679. continue;
  18680. }
  18681. case Opcode::Pong: {
  18682. std::lock_guard<std::mutex> lock(ping_mutex_);
  18683. unacked_pings_ = 0;
  18684. continue;
  18685. }
  18686. case Opcode::Close: {
  18687. if (!closed_.exchange(true)) {
  18688. // Echo close frame back
  18689. std::lock_guard<std::mutex> lock(write_mutex_);
  18690. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  18691. payload.size(), true, !is_server_);
  18692. }
  18693. return Fail;
  18694. }
  18695. case Opcode::Text:
  18696. case Opcode::Binary: {
  18697. auto result = opcode == Opcode::Text ? Text : Binary;
  18698. msg = std::move(payload);
  18699. // Handle fragmentation
  18700. if (!fin) {
  18701. while (true) {
  18702. Opcode cont_opcode;
  18703. std::string cont_payload;
  18704. bool cont_fin;
  18705. if (!impl::read_websocket_frame(
  18706. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  18707. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)) {
  18708. closed_ = true;
  18709. return Fail;
  18710. }
  18711. if (cont_opcode == Opcode::Ping) {
  18712. std::lock_guard<std::mutex> lock(write_mutex_);
  18713. detail::write_websocket_frame(
  18714. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  18715. true, !is_server_);
  18716. continue;
  18717. }
  18718. if (cont_opcode == Opcode::Pong) {
  18719. std::lock_guard<std::mutex> lock(ping_mutex_);
  18720. unacked_pings_ = 0;
  18721. continue;
  18722. }
  18723. if (cont_opcode == Opcode::Close) {
  18724. if (!closed_.exchange(true)) {
  18725. std::lock_guard<std::mutex> lock(write_mutex_);
  18726. detail::write_websocket_frame(
  18727. strm_, Opcode::Close, cont_payload.data(),
  18728. cont_payload.size(), true, !is_server_);
  18729. }
  18730. return Fail;
  18731. }
  18732. // RFC 6455: continuation frames must use opcode 0x0
  18733. if (cont_opcode != Opcode::Continuation) {
  18734. closed_ = true;
  18735. return Fail;
  18736. }
  18737. msg += cont_payload;
  18738. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  18739. closed_ = true;
  18740. return Fail;
  18741. }
  18742. if (cont_fin) { break; }
  18743. }
  18744. }
  18745. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  18746. if (result == Text && !impl::is_valid_utf8(msg)) {
  18747. // close() takes the read lock to wait for the peer's Close reply, so
  18748. // it must not run while this thread still holds it.
  18749. read_lock.unlock();
  18750. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  18751. return Fail;
  18752. }
  18753. return result;
  18754. }
  18755. default: closed_ = true; return Fail;
  18756. }
  18757. }
  18758. return Fail;
  18759. }
  18760. inline bool WebSocket::send(const std::string &data) {
  18761. return send_frame(Opcode::Text, data.data(), data.size());
  18762. }
  18763. inline bool WebSocket::send(const char *data, size_t len) {
  18764. return send_frame(Opcode::Binary, data, len);
  18765. }
  18766. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  18767. if (closed_.exchange(true)) { return; }
  18768. ping_cv_.notify_all();
  18769. std::string payload;
  18770. auto code = static_cast<uint16_t>(status);
  18771. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  18772. payload.push_back(static_cast<char>(code & 0xFF));
  18773. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  18774. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  18775. payload += reason.substr(0, 123);
  18776. {
  18777. std::lock_guard<std::mutex> lock(write_mutex_);
  18778. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  18779. payload.size(), true, !is_server_);
  18780. }
  18781. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  18782. // Close response before closing the TCP connection.
  18783. //
  18784. // Wait only when no other thread is parsing frames. When one is, it is the
  18785. // thread positioned to see the peer's reply, and reading here would take
  18786. // bytes out of the message it is assembling. Bailing out also leaves the
  18787. // stream, including its read timeout, entirely to that thread.
  18788. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  18789. if (!read_lock.owns_lock()) { return; }
  18790. // Use a short timeout to avoid hanging if the peer doesn't respond.
  18791. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  18792. Opcode op;
  18793. std::string resp;
  18794. bool fin;
  18795. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125)) {
  18796. if (op == Opcode::Close) { break; }
  18797. }
  18798. }
  18799. inline WebSocket::~WebSocket() {
  18800. {
  18801. std::lock_guard<std::mutex> lock(ping_mutex_);
  18802. closed_ = true;
  18803. }
  18804. ping_cv_.notify_all();
  18805. if (ping_thread_.joinable()) { ping_thread_.join(); }
  18806. }
  18807. inline void WebSocket::start_heartbeat() {
  18808. if (ping_interval_sec_ == 0) { return; }
  18809. ping_thread_ = std::thread([this]() {
  18810. std::unique_lock<std::mutex> lock(ping_mutex_);
  18811. while (!closed_) {
  18812. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  18813. if (closed_) { break; }
  18814. // If the peer has failed to respond to the previous pings, give up.
  18815. // RFC 6455 does not define a pong-timeout mechanism; this is an
  18816. // opt-in liveness check controlled by max_missed_pongs_.
  18817. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  18818. lock.unlock();
  18819. close(CloseStatus::GoingAway, "pong timeout");
  18820. return;
  18821. }
  18822. lock.unlock();
  18823. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  18824. lock.lock();
  18825. closed_ = true;
  18826. break;
  18827. }
  18828. lock.lock();
  18829. unacked_pings_++;
  18830. }
  18831. });
  18832. }
  18833. inline const Request &WebSocket::request() const { return req_; }
  18834. inline bool WebSocket::is_open() const { return !closed_; }
  18835. // WebSocketClient implementation
  18836. inline WebSocketClient::WebSocketClient(
  18837. const std::string &scheme_host_port_path, const Headers &headers)
  18838. : headers_(headers) {
  18839. detail::UrlComponents uc;
  18840. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  18841. !uc.host.empty() && !uc.path.empty()) {
  18842. auto &scheme = uc.scheme;
  18843. #ifdef CPPHTTPLIB_SSL_ENABLED
  18844. if (scheme != "ws" && scheme != "wss") {
  18845. #else
  18846. if (scheme != "ws") {
  18847. #endif
  18848. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  18849. std::string msg = "'" + scheme + "' scheme is not supported.";
  18850. throw std::invalid_argument(msg);
  18851. #endif
  18852. return;
  18853. }
  18854. auto is_ssl = scheme == "wss";
  18855. host_ = std::move(uc.host);
  18856. port_ = is_ssl ? 443 : 80;
  18857. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  18858. path_ = std::move(uc.path);
  18859. if (!uc.query.empty()) { path_ += uc.query; }
  18860. #ifdef CPPHTTPLIB_SSL_ENABLED
  18861. is_ssl_ = is_ssl;
  18862. if (is_ssl_) {
  18863. // The context lives as long as the client so that CA configuration
  18864. // survives reconnects; sessions are created per connection.
  18865. tls_ctx_ = tls::create_client_context();
  18866. if (!tls_ctx_) { return; }
  18867. }
  18868. #else
  18869. if (is_ssl) { return; }
  18870. #endif
  18871. is_valid_ = true;
  18872. }
  18873. }
  18874. #ifdef CPPHTTPLIB_SSL_ENABLED
  18875. inline WebSocketClient::WebSocketClient(
  18876. const std::string &scheme_host_port_path, const PemMemory &pem,
  18877. const Headers &headers)
  18878. : WebSocketClient(scheme_host_port_path, headers) {
  18879. // For ws:// URLs the client certificate is silently ignored, consistent
  18880. // with the TLS-only setters such as set_ca_cert_path().
  18881. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  18882. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  18883. pem.private_key_password)) {
  18884. tls::free_context(tls_ctx_);
  18885. tls_ctx_ = nullptr;
  18886. is_valid_ = false;
  18887. }
  18888. }
  18889. }
  18890. #endif
  18891. inline WebSocketClient::~WebSocketClient() {
  18892. shutdown_and_close();
  18893. #ifdef CPPHTTPLIB_SSL_ENABLED
  18894. if (tls_ctx_) {
  18895. tls::free_context(tls_ctx_);
  18896. tls_ctx_ = nullptr;
  18897. }
  18898. #endif
  18899. }
  18900. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  18901. inline void WebSocketClient::shutdown_and_close() {
  18902. // Send the close frame while the TLS session is still alive: ws_ holds an
  18903. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  18904. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  18905. if (ws_ && ws_->is_open()) { ws_->close(); }
  18906. ws_.reset();
  18907. #ifdef CPPHTTPLIB_SSL_ENABLED
  18908. if (is_ssl_) {
  18909. if (tls_session_) {
  18910. tls::shutdown(tls_session_, true);
  18911. tls::free_session(tls_session_);
  18912. tls_session_ = nullptr;
  18913. }
  18914. }
  18915. #endif
  18916. if (sock_ != INVALID_SOCKET) {
  18917. detail::shutdown_socket(sock_);
  18918. detail::close_socket(sock_);
  18919. sock_ = INVALID_SOCKET;
  18920. }
  18921. }
  18922. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  18923. Error &error, int &ssl_error,
  18924. uint64_t &ssl_backend_error) {
  18925. #ifdef CPPHTTPLIB_SSL_ENABLED
  18926. if (is_ssl_) {
  18927. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  18928. // is not safe to call concurrently on one client to begin with, since
  18929. // nothing else here is guarded either.
  18930. if (server_certificate_verification_ && !certs_loaded_) {
  18931. uint64_t backend_error = 0;
  18932. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  18933. ca_cert_dir_path_, custom_ca_loaded_,
  18934. system_ca_mode_, backend_error);
  18935. certs_loaded_ = true;
  18936. }
  18937. detail::ClientTlsSessionOptions options;
  18938. options.server_hostname_verification = server_hostname_verification_;
  18939. detail::ClientTlsSessionError tls_error;
  18940. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  18941. server_certificate_verification_,
  18942. read_timeout_sec_, read_timeout_usec_,
  18943. &tls_error, options)) {
  18944. error = tls_error.error;
  18945. ssl_error = tls_error.ssl_error;
  18946. ssl_backend_error = tls_error.backend_error;
  18947. return false;
  18948. }
  18949. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  18950. sock_, tls_session_, read_timeout_sec_, read_timeout_usec_,
  18951. write_timeout_sec_, write_timeout_usec_));
  18952. return true;
  18953. }
  18954. #else
  18955. (void)error;
  18956. (void)ssl_error;
  18957. (void)ssl_backend_error;
  18958. #endif
  18959. strm = std::unique_ptr<Stream>(
  18960. new detail::SocketStream(sock_, read_timeout_sec_, read_timeout_usec_,
  18961. write_timeout_sec_, write_timeout_usec_));
  18962. return true;
  18963. }
  18964. inline void WebSocketClient::prepare_default_headers(Request &req) {
  18965. #ifdef CPPHTTPLIB_SSL_ENABLED
  18966. auto is_ssl = is_ssl_;
  18967. #else
  18968. auto is_ssl = false;
  18969. #endif
  18970. if (!req.has_header("Host")) {
  18971. req.headers.emplace("Host", detail::make_default_host_header_value(
  18972. host_, port_, is_ssl, address_family_));
  18973. }
  18974. detail::add_default_user_agent_header(req);
  18975. }
  18976. inline Result WebSocketClient::connect() {
  18977. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  18978. shutdown_and_close();
  18979. // Check is custom IP or hostname specified for host_
  18980. std::string connect_host;
  18981. std::string ip;
  18982. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  18983. auto error = Error::Success;
  18984. sock_ = detail::create_client_socket(
  18985. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  18986. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  18987. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  18988. write_timeout_usec_, interface_, error);
  18989. if (sock_ == INVALID_SOCKET) {
  18990. if (error == Error::Success) { error = Error::Connection; }
  18991. return Result{error, -1, Headers{}};
  18992. }
  18993. std::unique_ptr<Stream> strm;
  18994. auto stream_error = Error::SSLConnection;
  18995. int ssl_error = 0;
  18996. uint64_t ssl_backend_error = 0;
  18997. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  18998. shutdown_and_close();
  18999. #ifdef CPPHTTPLIB_SSL_ENABLED
  19000. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19001. #else
  19002. return Result{stream_error, -1, Headers{}};
  19003. #endif
  19004. }
  19005. Request req;
  19006. req.method = "GET";
  19007. req.path = path_;
  19008. req.headers = headers_;
  19009. prepare_default_headers(req);
  19010. detail::WebSocketUpgradeResponse upgrade;
  19011. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19012. shutdown_and_close();
  19013. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19014. }
  19015. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19016. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19017. websocket_ping_interval_sec_,
  19018. websocket_max_missed_pongs_));
  19019. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19020. }
  19021. inline ReadResult WebSocketClient::read(std::string &msg) {
  19022. if (!ws_) { return Fail; }
  19023. return ws_->read(msg);
  19024. }
  19025. inline bool WebSocketClient::send(const std::string &data) {
  19026. if (!ws_) { return false; }
  19027. return ws_->send(data);
  19028. }
  19029. inline bool WebSocketClient::send(const char *data, size_t len) {
  19030. if (!ws_) { return false; }
  19031. return ws_->send(data, len);
  19032. }
  19033. inline void WebSocketClient::close(CloseStatus status,
  19034. const std::string &reason) {
  19035. if (ws_) { ws_->close(status, reason); }
  19036. }
  19037. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19038. inline const std::string &WebSocketClient::subprotocol() const {
  19039. return subprotocol_;
  19040. }
  19041. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19042. read_timeout_sec_ = sec;
  19043. read_timeout_usec_ = usec;
  19044. }
  19045. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19046. write_timeout_sec_ = sec;
  19047. write_timeout_usec_ = usec;
  19048. }
  19049. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19050. websocket_ping_interval_sec_ = sec;
  19051. }
  19052. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19053. websocket_max_missed_pongs_ = count;
  19054. }
  19055. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19056. inline void WebSocketClient::set_address_family(int family) {
  19057. address_family_ = family;
  19058. }
  19059. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19060. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19061. socket_options_ = std::move(socket_options);
  19062. }
  19063. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19064. connection_timeout_sec_ = sec;
  19065. connection_timeout_usec_ = usec;
  19066. }
  19067. inline void WebSocketClient::set_interface(const std::string &intf) {
  19068. interface_ = intf;
  19069. }
  19070. inline void WebSocketClient::set_hostname_addr_map(
  19071. std::map<std::string, std::string> addr_map) {
  19072. addr_map_ = std::move(addr_map);
  19073. }
  19074. #ifdef CPPHTTPLIB_SSL_ENABLED
  19075. inline void
  19076. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19077. const std::string &ca_cert_dir_path) {
  19078. ca_cert_file_path_ = ca_cert_file_path;
  19079. ca_cert_dir_path_ = ca_cert_dir_path;
  19080. }
  19081. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19082. if (store && tls_ctx_) {
  19083. // set_ca_store takes ownership of store
  19084. tls::set_ca_store(tls_ctx_, store);
  19085. custom_ca_loaded_ = true;
  19086. } else if (store) {
  19087. tls::free_ca_store(store);
  19088. }
  19089. }
  19090. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19091. std::size_t size) {
  19092. if (tls_ctx_ && ca_cert && size > 0) {
  19093. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19094. custom_ca_loaded_ = true;
  19095. }
  19096. }
  19097. inline void
  19098. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19099. server_certificate_verification_ = enabled;
  19100. }
  19101. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19102. server_hostname_verification_ = enabled;
  19103. }
  19104. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19105. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19106. }
  19107. #endif // CPPHTTPLIB_SSL_ENABLED
  19108. } // namespace ws
  19109. // ----------------------------------------------------------------------------
  19110. } // namespace httplib
  19111. #endif // CPPHTTPLIB_HTTPLIB_H