httplib.h 774 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814
  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.54.1"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003601"
  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_STATIC_FILE_COMPRESSION_MIN_LENGTH
  106. // 1400 rather than a round number: a body that already fits in one 1500-byte
  107. // MTU gains nothing from being made smaller.
  108. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  109. #endif
  110. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  111. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  112. #endif
  113. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  114. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  115. #endif
  116. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  117. // recurses roughly once per matched character for quantified patterns such
  118. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  119. // a default ~8MB thread stack that has been observed to take on the order of
  120. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  121. // margin below that (well under the 8192-byte request URI limit) while still
  122. // fitting any realistic route segment; raise it if a route legitimately needs
  123. // longer paths. Regex routes are never applied to paths longer than this.
  124. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  125. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  126. #endif
  127. #ifndef CPPHTTPLIB_TCP_NODELAY
  128. #define CPPHTTPLIB_TCP_NODELAY false
  129. #endif
  130. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  131. #define CPPHTTPLIB_IPV6_V6ONLY false
  132. #endif
  133. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  134. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  135. #endif
  136. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  137. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  138. #endif
  139. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  140. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  141. #endif
  142. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  143. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  144. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  145. ? std::thread::hardware_concurrency() - 1 \
  146. : 0))
  147. #endif
  148. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  149. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  150. #endif
  151. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  152. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  153. #endif
  154. #ifndef CPPHTTPLIB_RECV_FLAGS
  155. #define CPPHTTPLIB_RECV_FLAGS 0
  156. #endif
  157. #ifndef CPPHTTPLIB_SEND_FLAGS
  158. #define CPPHTTPLIB_SEND_FLAGS 0
  159. #endif
  160. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  161. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  162. #endif
  163. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  164. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  165. #endif
  166. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  167. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  168. #endif
  169. // One macro used to set the read timeout for both sides. They want different
  170. // defaults: a client's read timeout is the caller's own tool (it waits forever
  171. // until asked not to), while a server keeps a ceiling that reclaims a worker
  172. // from a peer that has gone quiet. The old name still works and sets both.
  173. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  174. #pragma message( \
  175. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  176. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  177. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  178. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  179. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  180. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #endif
  182. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  183. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  184. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  185. #endif
  186. #endif
  187. // 0 waits forever. A read timeout is how a caller gets control back to send on
  188. // the same connection; it is not a liveness check (that is ping/pong).
  189. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  190. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  191. #endif
  192. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  194. #endif
  195. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  196. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  197. #endif
  198. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  199. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  200. #endif
  201. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  202. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  203. #endif
  204. /*
  205. * Headers
  206. */
  207. #ifdef _WIN32
  208. #ifndef _CRT_SECURE_NO_WARNINGS
  209. #define _CRT_SECURE_NO_WARNINGS
  210. #endif //_CRT_SECURE_NO_WARNINGS
  211. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  212. #define _CRT_NONSTDC_NO_DEPRECATE
  213. #endif //_CRT_NONSTDC_NO_DEPRECATE
  214. #if defined(_MSC_VER)
  215. #if _MSC_VER < 1900
  216. #error Sorry, Visual Studio versions prior to 2015 are not supported
  217. #endif
  218. #pragma comment(lib, "ws2_32.lib")
  219. #ifndef _SSIZE_T_DEFINED
  220. using ssize_t = __int64;
  221. #define _SSIZE_T_DEFINED
  222. #endif
  223. #endif // _MSC_VER
  224. #ifndef S_ISREG
  225. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  226. #endif // S_ISREG
  227. #ifndef S_ISDIR
  228. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  229. #endif // S_ISDIR
  230. #ifndef NOMINMAX
  231. #define NOMINMAX
  232. #endif // NOMINMAX
  233. #include <io.h>
  234. #include <winsock2.h>
  235. #include <ws2tcpip.h>
  236. #if defined(__has_include)
  237. #if __has_include(<afunix.h>)
  238. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  239. #include <afunix.h>
  240. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  241. #endif
  242. #endif
  243. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  244. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  245. #endif
  246. using nfds_t = unsigned long;
  247. using socket_t = SOCKET;
  248. using socklen_t = int;
  249. #else // not _WIN32
  250. #include <arpa/inet.h>
  251. #if !defined(_AIX) && !defined(__MVS__)
  252. #include <ifaddrs.h>
  253. #endif
  254. #ifdef __MVS__
  255. #include <strings.h>
  256. #ifndef NI_MAXHOST
  257. #define NI_MAXHOST 1025
  258. #endif
  259. #endif
  260. #include <net/if.h>
  261. #include <netdb.h>
  262. #include <netinet/in.h>
  263. #ifdef __linux__
  264. #include <resolv.h>
  265. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  266. #endif
  267. #include <csignal>
  268. #include <netinet/tcp.h>
  269. #include <poll.h>
  270. #include <pthread.h>
  271. #include <sys/mman.h>
  272. #include <sys/socket.h>
  273. #include <sys/un.h>
  274. #include <unistd.h>
  275. using socket_t = int;
  276. #ifndef INVALID_SOCKET
  277. #define INVALID_SOCKET (-1)
  278. #endif
  279. #endif //_WIN32
  280. #if defined(__APPLE__)
  281. #include <TargetConditionals.h>
  282. #endif
  283. #include <algorithm>
  284. #include <array>
  285. #include <atomic>
  286. #include <cassert>
  287. #include <chrono>
  288. #include <climits>
  289. #include <condition_variable>
  290. #include <cstdlib>
  291. #include <cstring>
  292. #include <errno.h>
  293. #include <exception>
  294. #include <fcntl.h>
  295. #include <fstream>
  296. #include <functional>
  297. #include <iomanip>
  298. #include <iostream>
  299. #include <iterator>
  300. #include <list>
  301. #include <map>
  302. #include <memory>
  303. #include <mutex>
  304. #include <random>
  305. #include <regex>
  306. #include <set>
  307. #include <sstream>
  308. #include <string>
  309. #include <sys/stat.h>
  310. #include <system_error>
  311. #include <thread>
  312. #include <type_traits>
  313. #include <unordered_map>
  314. #include <unordered_set>
  315. #include <utility>
  316. #include <vector>
  317. // On macOS with a TLS backend, enable Keychain root certificates by default
  318. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  319. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  320. // only; on those platforms the user must provide a CA bundle explicitly.
  321. #if defined(__APPLE__) && defined(__clang__) && \
  322. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  323. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  324. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  325. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  326. #if TARGET_OS_OSX
  327. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  328. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  329. #endif
  330. #endif
  331. #endif
  332. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  333. defined(__APPLE__) && !TARGET_OS_OSX
  334. #error \
  335. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  336. #endif
  337. // On Windows, enable Schannel certificate verification by default
  338. // unless the user explicitly opts out.
  339. #if defined(_WIN32) && \
  340. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  341. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  342. #endif
  343. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  344. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  345. #if TARGET_OS_MAC && defined(__clang__)
  346. #include <CFNetwork/CFHost.h>
  347. #include <CoreFoundation/CoreFoundation.h>
  348. #endif
  349. #endif
  350. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  351. #ifdef _WIN32
  352. #include <wincrypt.h>
  353. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  354. // used
  355. #undef X509_NAME
  356. #undef X509_CERT_PAIR
  357. #undef X509_EXTENSIONS
  358. #undef PKCS7_SIGNER_INFO
  359. #ifdef _MSC_VER
  360. #pragma comment(lib, "crypt32.lib")
  361. #endif
  362. #endif // _WIN32
  363. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  364. #if TARGET_OS_OSX
  365. #include <Security/Security.h>
  366. #endif
  367. #endif
  368. #include <openssl/err.h>
  369. #include <openssl/evp.h>
  370. #include <openssl/ssl.h>
  371. #include <openssl/x509v3.h>
  372. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  373. #include <openssl/applink.c>
  374. #endif
  375. #include <iostream>
  376. #include <sstream>
  377. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  378. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  379. #error Please use OpenSSL or a current version of BoringSSL
  380. #endif
  381. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  382. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  383. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  384. #endif
  385. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  386. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  387. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  388. // in with this first include group so the version gating below can use it.
  389. #include <mbedtls/error.h>
  390. #include <mbedtls/net_sockets.h>
  391. #include <mbedtls/oid.h>
  392. #include <mbedtls/pk.h>
  393. #include <mbedtls/ssl.h>
  394. #include <mbedtls/version.h>
  395. #include <mbedtls/x509_crt.h>
  396. #if MBEDTLS_VERSION_MAJOR >= 4
  397. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  398. #include <psa/crypto.h>
  399. #else
  400. #include <mbedtls/ctr_drbg.h>
  401. #include <mbedtls/entropy.h>
  402. #include <mbedtls/md5.h>
  403. #include <mbedtls/sha1.h>
  404. #include <mbedtls/sha256.h>
  405. #include <mbedtls/sha512.h>
  406. #endif
  407. #ifdef _WIN32
  408. #include <wincrypt.h>
  409. #ifdef _MSC_VER
  410. #pragma comment(lib, "crypt32.lib")
  411. #endif
  412. #endif // _WIN32
  413. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  414. #if TARGET_OS_OSX
  415. #include <Security/Security.h>
  416. #endif
  417. #endif
  418. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  419. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  420. #if MBEDTLS_VERSION_MAJOR >= 4
  421. #define CPPHTTPLIB_MBEDTLS_V4
  422. #endif
  423. #if MBEDTLS_VERSION_MAJOR >= 3
  424. #define CPPHTTPLIB_MBEDTLS_V3
  425. #endif
  426. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  427. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  428. #include <wolfssl/options.h>
  429. #include <wolfssl/openssl/x509v3.h>
  430. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  431. #ifndef WOLFSSL_GEN_EMAIL
  432. #define WOLFSSL_GEN_EMAIL 1
  433. #endif
  434. #ifndef WOLFSSL_GEN_DNS
  435. #define WOLFSSL_GEN_DNS 2
  436. #endif
  437. #ifndef WOLFSSL_GEN_URI
  438. #define WOLFSSL_GEN_URI 6
  439. #endif
  440. #ifndef WOLFSSL_GEN_IPADD
  441. #define WOLFSSL_GEN_IPADD 7
  442. #endif
  443. #include <wolfssl/ssl.h>
  444. #include <wolfssl/wolfcrypt/hash.h>
  445. #include <wolfssl/wolfcrypt/md5.h>
  446. #include <wolfssl/wolfcrypt/sha256.h>
  447. #include <wolfssl/wolfcrypt/sha512.h>
  448. #ifdef _WIN32
  449. #include <wincrypt.h>
  450. #ifdef _MSC_VER
  451. #pragma comment(lib, "crypt32.lib")
  452. #endif
  453. #endif // _WIN32
  454. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  455. #if TARGET_OS_OSX
  456. #include <Security/Security.h>
  457. #endif
  458. #endif
  459. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  460. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  461. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  462. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  463. #define CPPHTTPLIB_SSL_ENABLED
  464. #endif
  465. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  466. #include <zlib.h>
  467. #endif
  468. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  469. #include <brotli/decode.h>
  470. #include <brotli/encode.h>
  471. #endif
  472. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  473. #include <zstd.h>
  474. #endif
  475. /*
  476. * Declaration
  477. */
  478. namespace httplib {
  479. namespace ws {
  480. class WebSocket;
  481. } // namespace ws
  482. namespace detail {
  483. /*
  484. * Backport std::make_unique from C++14.
  485. *
  486. * NOTE: This code came up with the following stackoverflow post:
  487. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  488. *
  489. */
  490. template <class T, class... Args>
  491. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  492. make_unique(Args &&...args) {
  493. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  494. }
  495. template <class T>
  496. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  497. make_unique(std::size_t n) {
  498. typedef typename std::remove_extent<T>::type RT;
  499. return std::unique_ptr<T>(new RT[n]);
  500. }
  501. // Locale-independent ASCII character classification. The <cctype>
  502. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  503. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  504. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  505. // classified without regard to the locale.
  506. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  507. inline bool is_ascii_alpha(char c) {
  508. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  509. }
  510. inline bool is_ascii_alnum(char c) {
  511. return is_ascii_digit(c) || is_ascii_alpha(c);
  512. }
  513. namespace case_ignore {
  514. inline unsigned char to_lower(int c) {
  515. const static unsigned char table[256] = {
  516. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  517. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  518. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  519. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  520. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  521. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  522. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  523. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  524. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  525. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  526. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  527. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  528. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  529. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  530. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  531. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  532. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  533. 255,
  534. };
  535. return table[(unsigned char)(char)c];
  536. }
  537. inline std::string to_lower(const std::string &s) {
  538. std::string result = s;
  539. std::transform(
  540. result.begin(), result.end(), result.begin(),
  541. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  542. return result;
  543. }
  544. inline bool equal(const std::string &a, const std::string &b) {
  545. return a.size() == b.size() &&
  546. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  547. return to_lower(ca) == to_lower(cb);
  548. });
  549. }
  550. struct equal_to {
  551. bool operator()(const std::string &a, const std::string &b) const {
  552. return equal(a, b);
  553. }
  554. };
  555. struct hash {
  556. size_t operator()(const std::string &key) const {
  557. return hash_core(key.data(), key.size(), 0);
  558. }
  559. size_t hash_core(const char *s, size_t l, size_t h) const {
  560. return (l == 0) ? h
  561. : hash_core(s + 1, l - 1,
  562. // Unsets the 6 high bits of h, therefore no
  563. // overflow happens
  564. (((std::numeric_limits<size_t>::max)() >> 6) &
  565. h * 33) ^
  566. static_cast<unsigned char>(to_lower(*s)));
  567. }
  568. };
  569. template <typename T>
  570. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  571. detail::case_ignore::equal_to>;
  572. } // namespace case_ignore
  573. // This is based on
  574. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  575. struct scope_exit {
  576. explicit scope_exit(std::function<void(void)> &&f)
  577. : exit_function(std::move(f)), execute_on_destruction{true} {}
  578. scope_exit(scope_exit &&rhs) noexcept
  579. : exit_function(std::move(rhs.exit_function)),
  580. execute_on_destruction{rhs.execute_on_destruction} {
  581. rhs.release();
  582. }
  583. ~scope_exit() {
  584. if (execute_on_destruction) { this->exit_function(); }
  585. }
  586. void release() { this->execute_on_destruction = false; }
  587. private:
  588. scope_exit(const scope_exit &) = delete;
  589. void operator=(const scope_exit &) = delete;
  590. scope_exit &operator=(scope_exit &&) = delete;
  591. std::function<void(void)> exit_function;
  592. bool execute_on_destruction;
  593. };
  594. // Simple from_chars implementation for integer and double types (C++17
  595. // substitute)
  596. template <typename T> struct from_chars_result {
  597. const char *ptr;
  598. std::errc ec;
  599. };
  600. template <typename T>
  601. inline from_chars_result<T> from_chars(const char *first, const char *last,
  602. T &value, int base = 10) {
  603. value = 0;
  604. const char *p = first;
  605. bool negative = false;
  606. if (p != last && *p == '-') {
  607. negative = true;
  608. ++p;
  609. }
  610. if (p == last) { return {first, std::errc::invalid_argument}; }
  611. T result = 0;
  612. for (; p != last; ++p) {
  613. char c = *p;
  614. int digit = -1;
  615. if (is_ascii_digit(c)) {
  616. digit = c - '0';
  617. } else if ('a' <= c && c <= 'z') {
  618. digit = c - 'a' + 10;
  619. } else if ('A' <= c && c <= 'Z') {
  620. digit = c - 'A' + 10;
  621. } else {
  622. break;
  623. }
  624. if (digit < 0 || digit >= base) { break; }
  625. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  626. return {p, std::errc::result_out_of_range};
  627. }
  628. result = result * base + digit;
  629. }
  630. if (p == first || (negative && p == first + 1)) {
  631. return {first, std::errc::invalid_argument};
  632. }
  633. value = negative ? T(0) - result : result;
  634. return {p, std::errc{}};
  635. }
  636. // from_chars for double (hand-written, locale-independent)
  637. //
  638. // The only double consumed by this library is the HTTP quality value, whose
  639. // grammar is (RFC 9110 12.4.2):
  640. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  641. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  642. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  643. // '.' always the decimal separator (std::strtod would instead read it from the
  644. // global C locale, mis-parsing q-values once an embedder calls
  645. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  646. // the result to [0, 1], so inputs outside that range need not be distinguished
  647. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  648. // cases that exponent and wide-range handling would introduce.
  649. inline from_chars_result<double> from_chars(const char *first, const char *last,
  650. double &value) {
  651. value = 0.0;
  652. const char *p = first;
  653. // Each 1eN is exactly representable, so a single final division by the
  654. // matching entry yields a correctly-rounded result.
  655. static const double powers_of_ten[] = {
  656. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  657. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  658. const int max_frac_digits =
  659. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  660. // Accumulate digits into a 64-bit integer and remember how many were
  661. // fractional. Two independent caps keep this bounded and safe:
  662. // * accumulation saturates before mantissa could overflow uint64_t, and
  663. // * frac_digits is capped at max_frac_digits so it is always a valid index
  664. // into powers_of_ten (without this an input like "0.000...0" would never
  665. // grow mantissa, so the saturation cap alone would not bound it).
  666. // Both caps only drop digits far beyond the precision a q-value needs; any
  667. // value they would change is well outside [0, 1] and rejected by the caller.
  668. uint64_t mantissa = 0;
  669. int frac_digits = 0;
  670. bool seen_digit = false;
  671. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  672. auto accumulate = [&](char c) {
  673. if (mantissa <= limit) {
  674. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  675. return true;
  676. }
  677. return false;
  678. };
  679. for (; p != last && is_ascii_digit(*p); ++p) {
  680. seen_digit = true;
  681. accumulate(*p);
  682. }
  683. if (p != last && *p == '.') {
  684. ++p;
  685. for (; p != last && is_ascii_digit(*p); ++p) {
  686. seen_digit = true;
  687. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  688. }
  689. }
  690. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  691. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  692. return {p, std::errc{}};
  693. }
  694. inline bool parse_port(const char *s, size_t len, int &port) {
  695. int val = 0;
  696. auto r = from_chars(s, s + len, val);
  697. if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
  698. port = val;
  699. return true;
  700. }
  701. inline bool parse_port(const std::string &s, int &port) {
  702. return parse_port(s.data(), s.size(), port);
  703. }
  704. struct UrlComponents {
  705. std::string scheme;
  706. std::string host;
  707. std::string port;
  708. std::string path;
  709. std::string query;
  710. };
  711. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  712. uc = {};
  713. size_t pos = 0;
  714. auto sep = url.find("://");
  715. if (sep != std::string::npos) {
  716. uc.scheme = url.substr(0, sep);
  717. // Scheme must be [a-z]+ only
  718. if (uc.scheme.empty()) { return false; }
  719. for (auto c : uc.scheme) {
  720. if (c < 'a' || c > 'z') { return false; }
  721. }
  722. pos = sep + 3;
  723. } else if (url.compare(0, 2, "//") == 0) {
  724. pos = 2;
  725. }
  726. auto has_authority_prefix = pos > 0;
  727. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  728. url[0] != '?' && url[0] != '#');
  729. if (has_authority) {
  730. if (pos < url.size() && url[pos] == '[') {
  731. auto close = url.find(']', pos);
  732. if (close == std::string::npos) { return false; }
  733. uc.host = url.substr(pos + 1, close - pos - 1);
  734. // IPv6 host must be [a-fA-F0-9:]+ only
  735. if (uc.host.empty()) { return false; }
  736. for (auto c : uc.host) {
  737. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  738. (c >= 'A' && c <= 'F') || c == ':')) {
  739. return false;
  740. }
  741. }
  742. pos = close + 1;
  743. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  744. // path, query or fragment delimiter (or the end of input). Otherwise the
  745. // trailing bytes would be folded into the path while the connection
  746. // still targets the bracketed address.
  747. if (pos < url.size()) {
  748. auto c = url[pos];
  749. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  750. }
  751. } else {
  752. auto end = url.find_first_of(":/?#", pos);
  753. if (end == std::string::npos) { end = url.size(); }
  754. uc.host = url.substr(pos, end - pos);
  755. pos = end;
  756. }
  757. if (pos < url.size() && url[pos] == ':') {
  758. ++pos;
  759. auto end = url.find_first_of("/?#", pos);
  760. if (end == std::string::npos) { end = url.size(); }
  761. uc.port = url.substr(pos, end - pos);
  762. pos = end;
  763. }
  764. // Without :// or //, the entire input must be consumed as host[:port].
  765. // If there is leftover (path, query, etc.), this is not a valid
  766. // host[:port] string — clear and reparse as a plain path.
  767. if (!has_authority_prefix && pos < url.size()) {
  768. uc.host.clear();
  769. uc.port.clear();
  770. pos = 0;
  771. }
  772. }
  773. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  774. auto end = url.find_first_of("?#", pos);
  775. if (end == std::string::npos) { end = url.size(); }
  776. uc.path = url.substr(pos, end - pos);
  777. pos = end;
  778. }
  779. if (pos < url.size() && url[pos] == '?') {
  780. auto end = url.find('#', pos);
  781. if (end == std::string::npos) { end = url.size(); }
  782. uc.query = url.substr(pos, end - pos);
  783. }
  784. return true;
  785. }
  786. } // namespace detail
  787. enum class SSLVerifierResponse {
  788. // no decision has been made, use the built-in certificate verifier
  789. NoDecisionMade,
  790. // connection certificate is verified and accepted
  791. CertificateAccepted,
  792. // connection certificate was processed but is rejected
  793. CertificateRejected
  794. };
  795. // System CA loading policy for SSL clients. Auto (the default) loads system
  796. // CA certs only when no custom CA is configured; enable_system_ca() switches
  797. // to an explicit policy.
  798. enum class SystemCAMode { Auto, Enabled, Disabled };
  799. enum StatusCode {
  800. // Information responses
  801. Continue_100 = 100,
  802. SwitchingProtocol_101 = 101,
  803. Processing_102 = 102,
  804. EarlyHints_103 = 103,
  805. // Successful responses
  806. OK_200 = 200,
  807. Created_201 = 201,
  808. Accepted_202 = 202,
  809. NonAuthoritativeInformation_203 = 203,
  810. NoContent_204 = 204,
  811. ResetContent_205 = 205,
  812. PartialContent_206 = 206,
  813. MultiStatus_207 = 207,
  814. AlreadyReported_208 = 208,
  815. IMUsed_226 = 226,
  816. // Redirection messages
  817. MultipleChoices_300 = 300,
  818. MovedPermanently_301 = 301,
  819. Found_302 = 302,
  820. SeeOther_303 = 303,
  821. NotModified_304 = 304,
  822. UseProxy_305 = 305,
  823. unused_306 = 306,
  824. TemporaryRedirect_307 = 307,
  825. PermanentRedirect_308 = 308,
  826. // Client error responses
  827. BadRequest_400 = 400,
  828. Unauthorized_401 = 401,
  829. PaymentRequired_402 = 402,
  830. Forbidden_403 = 403,
  831. NotFound_404 = 404,
  832. MethodNotAllowed_405 = 405,
  833. NotAcceptable_406 = 406,
  834. ProxyAuthenticationRequired_407 = 407,
  835. RequestTimeout_408 = 408,
  836. Conflict_409 = 409,
  837. Gone_410 = 410,
  838. LengthRequired_411 = 411,
  839. PreconditionFailed_412 = 412,
  840. PayloadTooLarge_413 = 413,
  841. UriTooLong_414 = 414,
  842. UnsupportedMediaType_415 = 415,
  843. RangeNotSatisfiable_416 = 416,
  844. ExpectationFailed_417 = 417,
  845. ImATeapot_418 = 418,
  846. MisdirectedRequest_421 = 421,
  847. UnprocessableContent_422 = 422,
  848. Locked_423 = 423,
  849. FailedDependency_424 = 424,
  850. TooEarly_425 = 425,
  851. UpgradeRequired_426 = 426,
  852. PreconditionRequired_428 = 428,
  853. TooManyRequests_429 = 429,
  854. RequestHeaderFieldsTooLarge_431 = 431,
  855. UnavailableForLegalReasons_451 = 451,
  856. // Server error responses
  857. InternalServerError_500 = 500,
  858. NotImplemented_501 = 501,
  859. BadGateway_502 = 502,
  860. ServiceUnavailable_503 = 503,
  861. GatewayTimeout_504 = 504,
  862. HttpVersionNotSupported_505 = 505,
  863. VariantAlsoNegotiates_506 = 506,
  864. InsufficientStorage_507 = 507,
  865. LoopDetected_508 = 508,
  866. NotExtended_510 = 510,
  867. NetworkAuthenticationRequired_511 = 511,
  868. };
  869. namespace detail {
  870. // A multimap that keeps its entries in the order they were inserted.
  871. //
  872. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  873. // fields sharing a field name significant and forbids a proxy from reordering
  874. // them, and a query string's parameters are meaningful in the order the caller
  875. // wrote them. Neither standard container expresses it: std::unordered_multimap
  876. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  877. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  878. // key, which would drop control data such as Host behind whatever else the
  879. // message carries and alphabetise a query string.
  880. //
  881. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  882. // scan, which beats hashing for the handful of entries a message carries
  883. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  884. //
  885. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  886. // Params, whose parameter names are case-sensitive, not.
  887. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  888. public:
  889. using key_type = std::string;
  890. using mapped_type = Mapped;
  891. using value_type = std::pair<std::string, Mapped>;
  892. using size_type = std::size_t;
  893. using difference_type = std::ptrdiff_t;
  894. using reference = value_type &;
  895. using const_reference = const value_type &;
  896. private:
  897. static size_type npos() { return static_cast<size_type>(-1); }
  898. static bool keys_equal(const std::string &a, const std::string &b) {
  899. return KeyEqual()(a, b);
  900. }
  901. // Iterating yields every entry in insertion order, but equal_range() and
  902. // find() have to walk only the entries sharing one key, which are not
  903. // adjacent. Both are the same iterator type: key_idx_ selects between the
  904. // two traversals, and since equality compares only the position, an iterator
  905. // restricted to one key still compares equal to end().
  906. template <typename V> class iterator_t {
  907. public:
  908. using iterator_category = std::bidirectional_iterator_tag;
  909. using value_type = insertion_ordered_multimap::value_type;
  910. using difference_type = insertion_ordered_multimap::difference_type;
  911. using pointer = V *;
  912. using reference = V &;
  913. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  914. template <typename U,
  915. typename std::enable_if<std::is_convertible<U *, V *>::value,
  916. int>::type = 0>
  917. iterator_t(const iterator_t<U> &rhs)
  918. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  919. key_idx_(rhs.key_idx_) {}
  920. reference operator*() const { return data_[idx_]; }
  921. pointer operator->() const { return data_ + idx_; }
  922. iterator_t &operator++() {
  923. // Saturating, so that advancing past the last entry of a key (which
  924. // get_multimap_value() does when asked for an out-of-range id) stays at
  925. // end() instead of running off the container.
  926. if (idx_ >= size_) { return *this; }
  927. ++idx_;
  928. if (key_idx_ != npos()) {
  929. while (idx_ < size_ && !matches(idx_)) {
  930. ++idx_;
  931. }
  932. }
  933. return *this;
  934. }
  935. iterator_t operator++(int) {
  936. auto tmp = *this;
  937. ++*this;
  938. return tmp;
  939. }
  940. iterator_t &operator--() {
  941. if (idx_ == 0) { return *this; }
  942. --idx_;
  943. if (key_idx_ != npos()) {
  944. while (idx_ > 0 && !matches(idx_)) {
  945. --idx_;
  946. }
  947. }
  948. return *this;
  949. }
  950. iterator_t operator--(int) {
  951. auto tmp = *this;
  952. --*this;
  953. return tmp;
  954. }
  955. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  956. return idx_ == rhs.idx_;
  957. }
  958. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  959. return idx_ != rhs.idx_;
  960. }
  961. private:
  962. friend class insertion_ordered_multimap;
  963. template <typename> friend class iterator_t;
  964. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  965. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  966. bool matches(size_type i) const {
  967. return keys_equal(data_[i].first, data_[key_idx_].first);
  968. }
  969. V *data_;
  970. size_type idx_;
  971. size_type size_;
  972. size_type key_idx_;
  973. };
  974. public:
  975. using iterator = iterator_t<value_type>;
  976. using const_iterator = iterator_t<const value_type>;
  977. insertion_ordered_multimap() = default;
  978. insertion_ordered_multimap(std::initializer_list<value_type> il)
  979. : entries_(il) {}
  980. template <typename InputIt>
  981. insertion_ordered_multimap(InputIt first, InputIt last)
  982. : entries_(first, last) {}
  983. iterator begin() { return make_iter(0, npos()); }
  984. iterator end() { return make_iter(entries_.size(), npos()); }
  985. const_iterator begin() const { return make_citer(0, npos()); }
  986. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  987. const_iterator cbegin() const { return begin(); }
  988. const_iterator cend() const { return end(); }
  989. bool empty() const { return entries_.empty(); }
  990. size_type size() const { return entries_.size(); }
  991. void clear() { entries_.clear(); }
  992. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  993. iterator insert(const value_type &val) {
  994. entries_.push_back(val);
  995. return make_iter(entries_.size() - 1, npos());
  996. }
  997. iterator insert(value_type &&val) {
  998. entries_.push_back(std::move(val));
  999. return make_iter(entries_.size() - 1, npos());
  1000. }
  1001. template <typename... Args> iterator emplace(Args &&...args) {
  1002. entries_.emplace_back(std::forward<Args>(args)...);
  1003. return make_iter(entries_.size() - 1, npos());
  1004. }
  1005. // For entries that have to lead the message, such as the Host header field
  1006. // (RFC 9110 5.3 recommends sending control data first).
  1007. template <typename... Args> iterator emplace_front(Args &&...args) {
  1008. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1009. return make_iter(0, npos());
  1010. }
  1011. iterator find(const std::string &key) {
  1012. auto i = index_of(key);
  1013. return i == npos() ? end() : make_iter(i, i);
  1014. }
  1015. const_iterator find(const std::string &key) const {
  1016. auto i = index_of(key);
  1017. return i == npos() ? end() : make_citer(i, i);
  1018. }
  1019. size_type count(const std::string &key) const {
  1020. size_type n = 0;
  1021. for (const auto &entry : entries_) {
  1022. if (keys_equal(entry.first, key)) { n++; }
  1023. }
  1024. return n;
  1025. }
  1026. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1027. auto i = index_of(key);
  1028. return i == npos() ? std::make_pair(end(), end())
  1029. : std::make_pair(make_iter(i, i), end());
  1030. }
  1031. std::pair<const_iterator, const_iterator>
  1032. equal_range(const std::string &key) const {
  1033. auto i = index_of(key);
  1034. return i == npos() ? std::make_pair(end(), end())
  1035. : std::make_pair(make_citer(i, i), end());
  1036. }
  1037. size_type erase(const std::string &key) {
  1038. auto before = entries_.size();
  1039. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1040. [&](const value_type &entry) {
  1041. return keys_equal(entry.first, key);
  1042. }),
  1043. entries_.end());
  1044. return before - entries_.size();
  1045. }
  1046. iterator erase(const_iterator pos) {
  1047. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1048. return make_iter(pos.idx_, npos());
  1049. }
  1050. // Erases what iterating [first, last) would actually visit, so erasing an
  1051. // equal_range() removes only the entries with that key, not everything
  1052. // positioned between them.
  1053. iterator erase(const_iterator first, const_iterator last) {
  1054. auto from = first.idx_;
  1055. auto to = last.idx_;
  1056. if (from >= to) { return make_iter(from, npos()); }
  1057. auto begin_it = entries_.begin();
  1058. auto from_it = begin_it + static_cast<difference_type>(from);
  1059. auto to_it = begin_it + static_cast<difference_type>(to);
  1060. if (first.key_idx_ == npos()) {
  1061. entries_.erase(from_it, to_it);
  1062. } else {
  1063. auto key = entries_[first.key_idx_].first;
  1064. auto keep = from_it;
  1065. for (auto it = from_it; it != to_it; ++it) {
  1066. if (!keys_equal(it->first, key)) {
  1067. if (keep != it) { *keep = std::move(*it); }
  1068. ++keep;
  1069. }
  1070. }
  1071. if (keep != to_it) {
  1072. keep = std::move(to_it, entries_.end(), keep);
  1073. } else {
  1074. keep = entries_.end();
  1075. }
  1076. entries_.erase(keep, entries_.end());
  1077. }
  1078. return make_iter(from, npos());
  1079. }
  1080. friend bool operator==(const insertion_ordered_multimap &lhs,
  1081. const insertion_ordered_multimap &rhs) {
  1082. return lhs.entries_ == rhs.entries_;
  1083. }
  1084. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1085. const insertion_ordered_multimap &rhs) {
  1086. return !(lhs == rhs);
  1087. }
  1088. private:
  1089. size_type index_of(const std::string &key) const {
  1090. for (size_type i = 0; i < entries_.size(); i++) {
  1091. if (keys_equal(entries_[i].first, key)) { return i; }
  1092. }
  1093. return npos();
  1094. }
  1095. iterator make_iter(size_type idx, size_type key_idx) {
  1096. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1097. }
  1098. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1099. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1100. }
  1101. std::vector<value_type> entries_;
  1102. };
  1103. } // namespace detail
  1104. using Headers =
  1105. detail::insertion_ordered_multimap<std::string,
  1106. detail::case_ignore::equal_to>;
  1107. // Query parameter names are case-sensitive, unlike header field names.
  1108. using Params =
  1109. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1110. using Match = std::smatch;
  1111. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1112. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1113. /*
  1114. * detail: type-erased storage used by UserData.
  1115. * ABI-stable regardless of C++ standard — always uses this custom
  1116. * implementation instead of std::any.
  1117. */
  1118. namespace detail {
  1119. using any_type_id = const void *;
  1120. template <typename T> any_type_id any_typeid() noexcept {
  1121. static const char id = 0;
  1122. return &id;
  1123. }
  1124. struct any_storage {
  1125. virtual ~any_storage() = default;
  1126. virtual std::unique_ptr<any_storage> clone() const = 0;
  1127. virtual any_type_id type_id() const noexcept = 0;
  1128. };
  1129. template <typename T> struct any_value final : any_storage {
  1130. T value;
  1131. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1132. std::unique_ptr<any_storage> clone() const override {
  1133. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1134. }
  1135. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1136. };
  1137. } // namespace detail
  1138. class UserData {
  1139. public:
  1140. UserData() = default;
  1141. UserData(UserData &&) noexcept = default;
  1142. UserData &operator=(UserData &&) noexcept = default;
  1143. UserData(const UserData &o) {
  1144. for (const auto &e : o.entries_) {
  1145. if (e.second) { entries_[e.first] = e.second->clone(); }
  1146. }
  1147. }
  1148. UserData &operator=(const UserData &o) {
  1149. if (this != &o) {
  1150. entries_.clear();
  1151. for (const auto &e : o.entries_) {
  1152. if (e.second) { entries_[e.first] = e.second->clone(); }
  1153. }
  1154. }
  1155. return *this;
  1156. }
  1157. template <typename T> void set(const std::string &key, T &&value) {
  1158. using D = typename std::decay<T>::type;
  1159. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1160. }
  1161. template <typename T> T *get(const std::string &key) noexcept {
  1162. auto it = entries_.find(key);
  1163. if (it == entries_.end() || !it->second) { return nullptr; }
  1164. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1165. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1166. }
  1167. template <typename T> const T *get(const std::string &key) const noexcept {
  1168. auto it = entries_.find(key);
  1169. if (it == entries_.end() || !it->second) { return nullptr; }
  1170. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1171. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1172. }
  1173. bool has(const std::string &key) const noexcept {
  1174. return entries_.find(key) != entries_.end();
  1175. }
  1176. void erase(const std::string &key) { entries_.erase(key); }
  1177. void clear() noexcept { entries_.clear(); }
  1178. private:
  1179. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1180. entries_;
  1181. };
  1182. struct Response;
  1183. using ResponseHandler = std::function<bool(const Response &response)>;
  1184. struct FormData {
  1185. std::string name;
  1186. std::string content;
  1187. std::string filename;
  1188. std::string content_type;
  1189. Headers headers;
  1190. };
  1191. struct FormField {
  1192. std::string name;
  1193. std::string content;
  1194. Headers headers;
  1195. };
  1196. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1197. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1198. // should see the parts as they were sent. A std::multimap sorts by field name
  1199. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1200. // than the case-insensitive predicate Headers uses.
  1201. using FormFields =
  1202. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1203. using FormFiles =
  1204. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1205. struct MultipartFormData {
  1206. FormFields fields; // Text fields from multipart
  1207. FormFiles files; // Files from multipart
  1208. // Text field access
  1209. std::string get_field(const std::string &key, size_t id = 0) const;
  1210. std::vector<std::string> get_fields(const std::string &key) const;
  1211. bool has_field(const std::string &key) const;
  1212. size_t get_field_count(const std::string &key) const;
  1213. // File access
  1214. FormData get_file(const std::string &key, size_t id = 0) const;
  1215. std::vector<FormData> get_files(const std::string &key) const;
  1216. bool has_file(const std::string &key) const;
  1217. size_t get_file_count(const std::string &key) const;
  1218. };
  1219. struct UploadFormData {
  1220. std::string name;
  1221. std::string content;
  1222. std::string filename;
  1223. std::string content_type;
  1224. };
  1225. using UploadFormDataItems = std::vector<UploadFormData>;
  1226. class DataSink {
  1227. public:
  1228. DataSink() : os(&sb_), sb_(*this) {}
  1229. DataSink(const DataSink &) = delete;
  1230. DataSink &operator=(const DataSink &) = delete;
  1231. DataSink(DataSink &&) = delete;
  1232. DataSink &operator=(DataSink &&) = delete;
  1233. std::function<bool(const char *data, size_t data_len)> write;
  1234. // Only `write` is mandatory. The rest are defaulted so that a provider
  1235. // calling one on a writer that does not set it gets sensible behaviour
  1236. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1237. // `this` is safe: DataSink is neither copyable nor movable.
  1238. std::function<bool()> is_writable = []() { return true; };
  1239. std::function<void()> done = []() {};
  1240. std::function<void(const Headers &trailer)> done_with_trailer =
  1241. [this](const Headers & /*trailer*/) { done(); };
  1242. std::ostream os;
  1243. private:
  1244. class data_sink_streambuf final : public std::streambuf {
  1245. public:
  1246. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1247. protected:
  1248. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1249. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1250. return 0;
  1251. }
  1252. private:
  1253. DataSink &sink_;
  1254. };
  1255. data_sink_streambuf sb_;
  1256. };
  1257. using ContentProvider =
  1258. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1259. using ContentProviderWithoutLength =
  1260. std::function<bool(size_t offset, DataSink &sink)>;
  1261. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1262. struct FormDataProvider {
  1263. std::string name;
  1264. ContentProviderWithoutLength provider;
  1265. std::string filename;
  1266. std::string content_type;
  1267. };
  1268. using FormDataProviderItems = std::vector<FormDataProvider>;
  1269. inline FormDataProvider
  1270. make_file_provider(const std::string &name, const std::string &filepath,
  1271. const std::string &filename = std::string(),
  1272. const std::string &content_type = std::string()) {
  1273. FormDataProvider fdp;
  1274. fdp.name = name;
  1275. fdp.filename = filename.empty() ? filepath : filename;
  1276. fdp.content_type = content_type;
  1277. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1278. std::ifstream f(filepath, std::ios::binary);
  1279. if (!f) { return false; }
  1280. if (offset > 0) {
  1281. f.seekg(static_cast<std::streamoff>(offset));
  1282. if (!f.good()) {
  1283. sink.done();
  1284. return true;
  1285. }
  1286. }
  1287. char buf[8192];
  1288. f.read(buf, sizeof(buf));
  1289. auto n = static_cast<size_t>(f.gcount());
  1290. if (n > 0) { return sink.write(buf, n); }
  1291. sink.done(); // EOF
  1292. return true;
  1293. };
  1294. return fdp;
  1295. }
  1296. inline std::pair<size_t, ContentProvider>
  1297. make_file_body(const std::string &filepath) {
  1298. size_t size = 0;
  1299. {
  1300. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1301. if (!f) { return {0, ContentProvider{}}; }
  1302. size = static_cast<size_t>(f.tellg());
  1303. }
  1304. ContentProvider provider = [filepath](size_t offset, size_t length,
  1305. DataSink &sink) -> bool {
  1306. std::ifstream f(filepath, std::ios::binary);
  1307. if (!f) { return false; }
  1308. f.seekg(static_cast<std::streamoff>(offset));
  1309. if (!f.good()) { return false; }
  1310. char buf[8192];
  1311. while (length > 0) {
  1312. auto to_read = (std::min)(sizeof(buf), length);
  1313. f.read(buf, static_cast<std::streamsize>(to_read));
  1314. auto n = static_cast<size_t>(f.gcount());
  1315. // The file is shorter than the size make_file_body() measured, which the
  1316. // caller has already committed to as Content-Length. The body cannot be
  1317. // completed, so fail as every other error here does.
  1318. if (n == 0) { return false; }
  1319. if (!sink.write(buf, n)) { return false; }
  1320. length -= n;
  1321. }
  1322. return true;
  1323. };
  1324. return {size, std::move(provider)};
  1325. }
  1326. using ContentReceiverWithProgress = std::function<bool(
  1327. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1328. using ContentReceiver =
  1329. std::function<bool(const char *data, size_t data_length)>;
  1330. using FormDataHeader = std::function<bool(const FormData &file)>;
  1331. class ContentReader {
  1332. public:
  1333. using Reader = std::function<bool(ContentReceiver receiver)>;
  1334. using FormDataReader =
  1335. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1336. ContentReader(Reader reader, FormDataReader multipart_reader)
  1337. : reader_(std::move(reader)),
  1338. formdata_reader_(std::move(multipart_reader)) {}
  1339. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1340. return formdata_reader_(std::move(header), std::move(receiver));
  1341. }
  1342. bool operator()(ContentReceiver receiver) const {
  1343. return reader_(std::move(receiver));
  1344. }
  1345. Reader reader_;
  1346. FormDataReader formdata_reader_;
  1347. };
  1348. using Range = std::pair<ssize_t, ssize_t>;
  1349. using Ranges = std::vector<Range>;
  1350. #ifdef CPPHTTPLIB_SSL_ENABLED
  1351. // TLS abstraction layer - public type definitions and API
  1352. namespace tls {
  1353. // Opaque handles (defined as void* for abstraction)
  1354. using ctx_t = void *;
  1355. using session_t = void *;
  1356. using const_session_t = const void *; // For read-only session access
  1357. using cert_t = void *;
  1358. using ca_store_t = void *;
  1359. // TLS versions
  1360. enum class Version {
  1361. TLS1_2 = 0x0303,
  1362. TLS1_3 = 0x0304,
  1363. };
  1364. // Subject Alternative Names (SAN) entry types
  1365. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1366. // SAN entry structure
  1367. struct SanEntry {
  1368. SanType type;
  1369. std::string value;
  1370. };
  1371. // Verification context for certificate verification callback
  1372. struct VerifyContext {
  1373. session_t session; // TLS session handle
  1374. cert_t cert; // Current certificate being verified
  1375. int depth; // Certificate chain depth (0 = leaf)
  1376. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1377. long error_code; // Backend-specific error code (0 = no error)
  1378. const char *error_string; // Human-readable error description
  1379. // Certificate introspection methods
  1380. std::string subject_cn() const;
  1381. std::string issuer_name() const;
  1382. bool check_hostname(const char *hostname) const;
  1383. std::vector<SanEntry> sans() const;
  1384. bool validity(time_t &not_before, time_t &not_after) const;
  1385. std::string serial() const;
  1386. };
  1387. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1388. // TlsError codes for TLS operations (backend-independent)
  1389. enum class ErrorCode : int {
  1390. Success = 0,
  1391. WantRead, // Non-blocking: need to wait for read
  1392. WantWrite, // Non-blocking: need to wait for write
  1393. PeerClosed, // Peer closed the connection
  1394. Fatal, // Unrecoverable error
  1395. SyscallError, // System call error (check sys_errno)
  1396. CertVerifyFailed, // Certificate verification failed
  1397. HostnameMismatch, // Hostname verification failed
  1398. };
  1399. // TLS error information
  1400. struct TlsError {
  1401. ErrorCode code = ErrorCode::Fatal;
  1402. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1403. int sys_errno = 0; // errno when SyscallError
  1404. // Convert verification error code to human-readable string
  1405. static std::string verify_error_to_string(long error_code);
  1406. };
  1407. // RAII wrapper for peer certificate
  1408. class PeerCert {
  1409. public:
  1410. PeerCert();
  1411. PeerCert(PeerCert &&other) noexcept;
  1412. PeerCert &operator=(PeerCert &&other) noexcept;
  1413. ~PeerCert();
  1414. PeerCert(const PeerCert &) = delete;
  1415. PeerCert &operator=(const PeerCert &) = delete;
  1416. explicit operator bool() const;
  1417. std::string subject_cn() const;
  1418. std::string issuer_name() const;
  1419. bool check_hostname(const char *hostname) const;
  1420. std::vector<SanEntry> sans() const;
  1421. bool validity(time_t &not_before, time_t &not_after) const;
  1422. std::string serial() const;
  1423. private:
  1424. explicit PeerCert(cert_t cert);
  1425. cert_t cert_ = nullptr;
  1426. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1427. };
  1428. // Callback for TLS context setup (used by SSLServer constructor)
  1429. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1430. } // namespace tls
  1431. #endif
  1432. struct Request {
  1433. std::string method;
  1434. std::string path;
  1435. std::string matched_route;
  1436. Params params;
  1437. Headers headers;
  1438. Headers trailers;
  1439. std::string body;
  1440. std::string remote_addr;
  1441. int remote_port = -1;
  1442. std::string local_addr;
  1443. int local_port = -1;
  1444. // for server
  1445. std::string version;
  1446. std::string target;
  1447. MultipartFormData form;
  1448. Ranges ranges;
  1449. Match matches;
  1450. std::unordered_map<std::string, std::string> path_params;
  1451. std::function<bool()> is_connection_closed = []() { return true; };
  1452. // for client
  1453. std::vector<std::string> accept_content_types;
  1454. ResponseHandler response_handler;
  1455. ContentReceiverWithProgress content_receiver;
  1456. DownloadProgress download_progress;
  1457. UploadProgress upload_progress;
  1458. bool has_header(const std::string &key) const;
  1459. std::string get_header_value(const std::string &key, const char *def = "",
  1460. size_t id = 0) const;
  1461. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1462. size_t id = 0) const;
  1463. size_t get_header_value_count(const std::string &key) const;
  1464. void set_header(const std::string &key, const std::string &val);
  1465. bool has_trailer(const std::string &key) const;
  1466. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1467. size_t get_trailer_value_count(const std::string &key) const;
  1468. bool has_param(const std::string &key) const;
  1469. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1470. std::vector<std::string> get_param_values(const std::string &key) const;
  1471. size_t get_param_value_count(const std::string &key) const;
  1472. bool is_multipart_form_data() const;
  1473. // private members...
  1474. bool body_consumed_ = false;
  1475. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1476. size_t content_length_ = 0;
  1477. ContentProvider content_provider_;
  1478. bool is_chunked_content_provider_ = false;
  1479. size_t authorization_count_ = 0;
  1480. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1481. (std::chrono::steady_clock::time_point::min)();
  1482. #ifdef CPPHTTPLIB_SSL_ENABLED
  1483. tls::const_session_t ssl = nullptr;
  1484. tls::PeerCert peer_cert() const;
  1485. std::string sni() const;
  1486. #endif
  1487. };
  1488. namespace detail {
  1489. // Declared up here, away from the rest of the compression helpers, because
  1490. // `Response` stores one.
  1491. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1492. } // namespace detail
  1493. struct Response {
  1494. std::string version;
  1495. int status = -1;
  1496. std::string reason;
  1497. Headers headers;
  1498. Headers trailers;
  1499. std::string body;
  1500. std::string location; // Redirect location
  1501. // User-defined context — set by pre-routing/pre-request handlers and read
  1502. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1503. UserData user_data;
  1504. bool has_header(const std::string &key) const;
  1505. std::string get_header_value(const std::string &key, const char *def = "",
  1506. size_t id = 0) const;
  1507. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1508. size_t id = 0) const;
  1509. size_t get_header_value_count(const std::string &key) const;
  1510. void set_header(const std::string &key, const std::string &val);
  1511. bool has_trailer(const std::string &key) const;
  1512. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1513. size_t get_trailer_value_count(const std::string &key) const;
  1514. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1515. void set_content(const char *s, size_t n, const std::string &content_type);
  1516. void set_content(const std::string &s, const std::string &content_type);
  1517. void set_content(std::string &&s, const std::string &content_type);
  1518. void set_content_provider(
  1519. size_t length, const std::string &content_type, ContentProvider provider,
  1520. ContentProviderResourceReleaser resource_releaser = nullptr);
  1521. void set_content_provider(
  1522. const std::string &content_type, ContentProviderWithoutLength provider,
  1523. ContentProviderResourceReleaser resource_releaser = nullptr);
  1524. void set_chunked_content_provider(
  1525. const std::string &content_type, ContentProviderWithoutLength provider,
  1526. ContentProviderResourceReleaser resource_releaser = nullptr);
  1527. void set_file_content(const std::string &path,
  1528. const std::string &content_type);
  1529. void set_file_content(const std::string &path);
  1530. Response() = default;
  1531. Response(const Response &) = default;
  1532. Response &operator=(const Response &) = default;
  1533. Response(Response &&) = default;
  1534. Response &operator=(Response &&) = default;
  1535. ~Response() {
  1536. if (content_provider_resource_releaser_) {
  1537. content_provider_resource_releaser_(content_provider_success_);
  1538. }
  1539. }
  1540. // private members...
  1541. size_t content_length_ = 0;
  1542. ContentProvider content_provider_;
  1543. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1544. bool is_chunked_content_provider_ = false;
  1545. bool content_provider_success_ = false;
  1546. std::string file_content_path_;
  1547. std::string file_content_content_type_;
  1548. // Content coding chosen for the response body, decided once so that the
  1549. // headers and the body cannot disagree: where the file is opened for a
  1550. // file-backed content provider (keeping the ETag honest), and in
  1551. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1552. // for every other kind of response.
  1553. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1554. };
  1555. enum class Error {
  1556. Success = 0,
  1557. Unknown,
  1558. Connection,
  1559. BindIPAddress,
  1560. Read,
  1561. Write,
  1562. ExceedRedirectCount,
  1563. Canceled,
  1564. SSLConnection,
  1565. SSLLoadingCerts,
  1566. SSLServerVerification,
  1567. SSLServerHostnameVerification,
  1568. UnsupportedMultipartBoundaryChars,
  1569. Compression,
  1570. ConnectionTimeout,
  1571. ProxyConnection,
  1572. ConnectionClosed,
  1573. Timeout,
  1574. ResourceExhaustion,
  1575. TooManyFormDataFiles,
  1576. ExceedMaxPayloadSize,
  1577. ExceedUriMaxLength,
  1578. ExceedMaxSocketDescriptorCount,
  1579. InvalidRequestLine,
  1580. InvalidHTTPMethod,
  1581. InvalidHTTPVersion,
  1582. InvalidHeaders,
  1583. MultipartParsing,
  1584. OpenFile,
  1585. Listen,
  1586. GetSockName,
  1587. UnsupportedAddressFamily,
  1588. HTTPParsing,
  1589. InvalidRangeHeader,
  1590. UnsupportedContentEncoding,
  1591. WebSocketHandshake,
  1592. UserCallbackException,
  1593. // For internal use only
  1594. SSLPeerCouldBeClosed_,
  1595. };
  1596. std::string to_string(Error error);
  1597. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1598. class Stream {
  1599. public:
  1600. virtual ~Stream() = default;
  1601. virtual bool is_readable() const = 0;
  1602. virtual bool wait_readable() const = 0;
  1603. virtual bool wait_writable() const = 0;
  1604. virtual bool is_peer_alive() const { return wait_writable(); }
  1605. virtual ssize_t read(char *ptr, size_t size) = 0;
  1606. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1607. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1608. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1609. virtual socket_t socket() const = 0;
  1610. virtual time_t duration() const = 0;
  1611. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1612. (void)sec;
  1613. (void)usec;
  1614. }
  1615. // Bytes already pulled off the socket and sitting in this stream's own
  1616. // buffer. Exposing them lets a line reader scan for a terminator in one
  1617. // pass instead of asking for a byte at a time. A stream that does no
  1618. // buffering of its own reports none, and readers fall back to read().
  1619. virtual const char *buffered_data(size_t &size) const {
  1620. size = 0;
  1621. return nullptr;
  1622. }
  1623. // Discards `size` bytes previously returned by buffered_data().
  1624. virtual void consume_buffered(size_t size) { (void)size; }
  1625. ssize_t write(const char *ptr);
  1626. ssize_t write(const std::string &s);
  1627. Error get_error() const { return error_; }
  1628. protected:
  1629. Error error_ = Error::Success;
  1630. };
  1631. class TaskQueue {
  1632. public:
  1633. TaskQueue() = default;
  1634. virtual ~TaskQueue() = default;
  1635. virtual bool enqueue(std::function<void()> fn) = 0;
  1636. virtual void shutdown() = 0;
  1637. virtual void on_idle() {}
  1638. };
  1639. class ThreadPool final : public TaskQueue {
  1640. public:
  1641. explicit ThreadPool(
  1642. size_t n, size_t max_n = 0, size_t mqr = 0,
  1643. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1644. ThreadPool(const ThreadPool &) = delete;
  1645. ~ThreadPool() override = default;
  1646. bool enqueue(std::function<void()> fn) override;
  1647. void shutdown() override;
  1648. private:
  1649. void worker(bool is_dynamic);
  1650. void move_to_finished(std::thread::id id);
  1651. void cleanup_finished_threads();
  1652. size_t base_thread_count_;
  1653. size_t max_thread_count_;
  1654. size_t max_queued_requests_;
  1655. time_t idle_timeout_sec_;
  1656. size_t idle_thread_count_;
  1657. bool shutdown_;
  1658. std::list<std::function<void()>> jobs_;
  1659. std::vector<std::thread> threads_; // base threads
  1660. std::list<std::thread> dynamic_threads_; // dynamic threads
  1661. std::vector<std::thread>
  1662. finished_threads_; // exited dynamic threads awaiting join
  1663. std::condition_variable cond_;
  1664. std::mutex mutex_;
  1665. };
  1666. using Logger = std::function<void(const Request &, const Response &)>;
  1667. // Forward declaration for Error type
  1668. enum class Error;
  1669. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1670. using SocketOptions = std::function<void(socket_t sock)>;
  1671. void default_socket_options(socket_t sock);
  1672. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1673. const char *status_message(int status);
  1674. std::string to_string(Error error);
  1675. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1676. std::string get_bearer_token_auth(const Request &req);
  1677. namespace detail {
  1678. class MatcherBase {
  1679. public:
  1680. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1681. virtual ~MatcherBase() = default;
  1682. const std::string &pattern() const { return pattern_; }
  1683. // Match request path and populate its matches and
  1684. virtual bool match(Request &request) const = 0;
  1685. private:
  1686. std::string pattern_;
  1687. };
  1688. /**
  1689. * Captures parameters in request path and stores them in Request::path_params
  1690. *
  1691. * Capture name is a substring of a pattern from : to /.
  1692. * The rest of the pattern is matched against the request path directly
  1693. * Parameters are captured starting from the next character after
  1694. * the end of the last matched static pattern fragment until the next /.
  1695. *
  1696. * Example pattern:
  1697. * "/path/fragments/:capture/more/fragments/:second_capture"
  1698. * Static fragments:
  1699. * "/path/fragments/", "more/fragments/"
  1700. *
  1701. * Given the following request path:
  1702. * "/path/fragments/:1/more/fragments/:2"
  1703. * the resulting capture will be
  1704. * {{"capture", "1"}, {"second_capture", "2"}}
  1705. */
  1706. class PathParamsMatcher final : public MatcherBase {
  1707. public:
  1708. PathParamsMatcher(const std::string &pattern);
  1709. bool match(Request &request) const override;
  1710. private:
  1711. // Treat segment separators as the end of path parameter capture
  1712. // Does not need to handle query parameters as they are parsed before path
  1713. // matching
  1714. static constexpr char separator = '/';
  1715. // Contains static path fragments to match against, excluding the '/' after
  1716. // path params
  1717. // Fragments are separated by path params
  1718. std::vector<std::string> static_fragments_;
  1719. // Stores the names of the path parameters to be used as keys in the
  1720. // Request::path_params map
  1721. std::vector<std::string> param_names_;
  1722. };
  1723. /**
  1724. * Performs std::regex_match on request path
  1725. * and stores the result in Request::matches
  1726. *
  1727. * Note that regex match is performed directly on the whole request.
  1728. * This means that wildcard patterns may match multiple path segments with /:
  1729. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1730. */
  1731. class RegexMatcher final : public MatcherBase {
  1732. public:
  1733. RegexMatcher(const std::string &pattern)
  1734. : MatcherBase(pattern), regex_(pattern) {}
  1735. bool match(Request &request) const override;
  1736. private:
  1737. std::regex regex_;
  1738. };
  1739. int close_socket(socket_t sock) noexcept;
  1740. bool is_accept_resource_error();
  1741. bool is_accept_transient_error();
  1742. ssize_t write_headers(Stream &strm, const Headers &headers);
  1743. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1744. time_t usec);
  1745. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1746. const std::string &boundary);
  1747. ContentProvider
  1748. make_multipart_content_provider(const UploadFormDataItems &items,
  1749. const std::string &boundary);
  1750. } // namespace detail
  1751. bool is_valid_multipart_boundary(const std::string &boundary);
  1752. // Serializer for multipart/form-data request bodies. The boundary is owned
  1753. // by the writer so that per-part framing and the final terminator always
  1754. // agree. Field names and filenames are escaped following the WHATWG HTML
  1755. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1756. // in content types.
  1757. class MultipartFormDataWriter {
  1758. public:
  1759. MultipartFormDataWriter();
  1760. // precondition: is_valid_multipart_boundary(boundary)
  1761. explicit MultipartFormDataWriter(std::string boundary);
  1762. const std::string &boundary() const;
  1763. std::string content_type() const;
  1764. // In-memory items -> whole body (known length)
  1765. std::string serialize(const UploadFormDataItems &items) const;
  1766. size_t content_length(const UploadFormDataItems &items) const;
  1767. // Per-part framing for streaming via a content provider
  1768. std::string item_begin(const UploadFormData &item) const;
  1769. static std::string item_end();
  1770. std::string finish() const;
  1771. private:
  1772. std::string boundary_;
  1773. };
  1774. class Server {
  1775. public:
  1776. using Handler = std::function<void(const Request &, Response &)>;
  1777. using ExceptionHandler =
  1778. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1779. enum class HandlerResponse {
  1780. Handled,
  1781. Unhandled,
  1782. };
  1783. using HandlerWithResponse =
  1784. std::function<HandlerResponse(const Request &, Response &)>;
  1785. using HandlerWithContentReader = std::function<void(
  1786. const Request &, Response &, const ContentReader &content_reader)>;
  1787. using Expect100ContinueHandler =
  1788. std::function<int(const Request &, Response &)>;
  1789. using StartHandler = std::function<void()>;
  1790. using WebSocketHandler =
  1791. std::function<void(const Request &, ws::WebSocket &)>;
  1792. using SubProtocolSelector =
  1793. std::function<std::string(const std::vector<std::string> &protocols)>;
  1794. Server();
  1795. virtual ~Server();
  1796. virtual bool is_valid() const;
  1797. Server &Get(const std::string &pattern, Handler handler);
  1798. Server &Post(const std::string &pattern, Handler handler);
  1799. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1800. Server &Put(const std::string &pattern, Handler handler);
  1801. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1802. Server &Patch(const std::string &pattern, Handler handler);
  1803. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1804. Server &Delete(const std::string &pattern, Handler handler);
  1805. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1806. Server &Options(const std::string &pattern, Handler handler);
  1807. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1808. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1809. // server accept it; an unregistered method is still rejected with 400.
  1810. // `method` must be a valid HTTP method token and must not be one of the
  1811. // built-in methods, which have their own registration functions above. A
  1812. // rejected registration makes is_valid() return false, so listen() fails.
  1813. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1814. Handler handler);
  1815. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1816. HandlerWithContentReader handler);
  1817. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1818. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1819. SubProtocolSelector sub_protocol_selector);
  1820. bool set_base_dir(const std::string &dir,
  1821. const std::string &mount_point = std::string());
  1822. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1823. Headers headers = Headers());
  1824. bool remove_mount_point(const std::string &mount_point);
  1825. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1826. const std::string &mime);
  1827. Server &set_default_file_mimetype(const std::string &mime);
  1828. Server &set_file_request_handler(Handler handler);
  1829. template <class ErrorHandlerFunc>
  1830. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1831. return set_error_handler_core(
  1832. std::forward<ErrorHandlerFunc>(handler),
  1833. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1834. }
  1835. Server &set_exception_handler(ExceptionHandler handler);
  1836. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1837. Server &set_post_routing_handler(Handler handler);
  1838. Server &set_pre_request_handler(HandlerWithResponse handler);
  1839. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1840. Server &set_start_handler(StartHandler handler);
  1841. Server &set_logger(Logger logger);
  1842. Server &set_pre_compression_logger(Logger logger);
  1843. Server &set_error_logger(ErrorLogger error_logger);
  1844. Server &set_address_family(int family);
  1845. Server &set_tcp_nodelay(bool on);
  1846. Server &set_ipv6_v6only(bool on);
  1847. Server &set_socket_options(SocketOptions socket_options);
  1848. Server &set_default_headers(Headers headers);
  1849. Server &
  1850. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1851. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1852. Server &set_keep_alive_max_count(size_t count);
  1853. Server &set_keep_alive_timeout(time_t sec);
  1854. template <class Rep, class Period>
  1855. Server &
  1856. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1857. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1858. template <class Rep, class Period>
  1859. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1860. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1861. template <class Rep, class Period>
  1862. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1863. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1864. template <class Rep, class Period>
  1865. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1866. Server &set_payload_max_length(size_t length);
  1867. Server &set_static_file_compression(bool on);
  1868. Server &set_static_file_compression_min_length(size_t length);
  1869. Server &set_static_file_compression_max_length(size_t length);
  1870. Server &set_websocket_ping_interval(time_t sec);
  1871. template <class Rep, class Period>
  1872. Server &set_websocket_ping_interval(
  1873. const std::chrono::duration<Rep, Period> &duration);
  1874. Server &set_websocket_max_missed_pongs(int count);
  1875. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1876. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1877. bool listen_after_bind();
  1878. bool listen(const std::string &host, int port, int socket_flags = 0);
  1879. bool is_running() const;
  1880. void wait_until_ready() const;
  1881. void stop() noexcept;
  1882. void decommission();
  1883. std::function<TaskQueue *(void)> new_task_queue;
  1884. protected:
  1885. bool process_request(Stream &strm, const std::string &remote_addr,
  1886. int remote_port, const std::string &local_addr,
  1887. int local_port, bool close_connection,
  1888. bool &connection_closed,
  1889. const std::function<void(Request &)> &setup_request,
  1890. bool *websocket_upgraded = nullptr);
  1891. // Runs the per-connection serving loop and stops an exception thrown by a
  1892. // user callback from escaping the worker thread.
  1893. //
  1894. // process_request() wraps only routing() in a try/catch. Content providers,
  1895. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1896. // handlers all run outside it, and the task queue calls the job without a
  1897. // catch, so an exception from any of those would terminate the process.
  1898. //
  1899. // No 500 is possible here: by the time a content provider runs, the status
  1900. // line and headers are already on the wire. Report it through the error
  1901. // logger and drop the connection, which is what the peer observes either
  1902. // way. Other connections are unaffected.
  1903. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1904. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1905. return serve();
  1906. #else
  1907. try {
  1908. return serve();
  1909. } catch (...) {
  1910. // The error logger is a user callback too, so it must not be able to
  1911. // throw the guard back open.
  1912. try {
  1913. output_error_log(Error::UserCallbackException, nullptr);
  1914. } catch (...) {}
  1915. return false;
  1916. }
  1917. #endif
  1918. }
  1919. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1920. std::vector<std::string> trusted_proxies_;
  1921. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1922. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1923. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1924. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1925. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1926. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1927. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1928. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1929. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1930. bool static_file_compression_ = false;
  1931. size_t static_file_compression_min_length_ =
  1932. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1933. size_t static_file_compression_max_length_ =
  1934. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1935. time_t websocket_ping_interval_sec_ =
  1936. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1937. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1938. private:
  1939. using Handlers =
  1940. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1941. using HandlersForContentReader =
  1942. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1943. HandlerWithContentReader>>;
  1944. // Both handler tables for one custom method live in a single entry, so that
  1945. // routing() needs only one map lookup per request to reach either of them.
  1946. struct CustomHandlerEntry {
  1947. Handlers handlers;
  1948. HandlersForContentReader handlers_for_content_reader;
  1949. };
  1950. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1951. static std::unique_ptr<detail::MatcherBase>
  1952. make_matcher(const std::string &pattern);
  1953. static const std::set<std::string> &builtin_methods();
  1954. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  1955. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  1956. template <typename H>
  1957. Server &add_handler(
  1958. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  1959. const std::string &pattern, H handler) {
  1960. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  1961. return *this;
  1962. }
  1963. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  1964. Server &set_error_handler_core(Handler handler, std::false_type);
  1965. socket_t create_server_socket(const std::string &host, int port,
  1966. int socket_flags,
  1967. SocketOptions socket_options) const;
  1968. int bind_internal(const std::string &host, int port, int socket_flags);
  1969. bool listen_internal();
  1970. bool routing(Request &req, Response &res, Stream &strm);
  1971. bool handle_file_request(Request &req, Response &res);
  1972. bool check_if_not_modified(const Request &req, Response &res,
  1973. const std::string &etag, time_t mtime) const;
  1974. bool check_if_range(Request &req, const std::string &etag,
  1975. time_t mtime) const;
  1976. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  1977. Stream &strm);
  1978. bool dispatch_request_for_content_reader(
  1979. Request &req, Response &res, ContentReader content_reader,
  1980. const HandlersForContentReader &handlers) const;
  1981. bool parse_request_line(const char *s, Request &req) const;
  1982. detail::EncodingType static_file_encoding(const Request &req,
  1983. const Response &res,
  1984. const std::string &content_type,
  1985. size_t length) const;
  1986. bool apply_static_file_compression(const Request &req, Response &res) const;
  1987. void apply_ranges(const Request &req, Response &res,
  1988. std::string &content_type, std::string &boundary) const;
  1989. bool write_response(Stream &strm, bool close_connection, Request &req,
  1990. Response &res);
  1991. bool write_response_with_content(Stream &strm, bool close_connection,
  1992. const Request &req, Response &res);
  1993. bool write_response_core(Stream &strm, bool close_connection,
  1994. const Request &req, Response &res,
  1995. bool need_apply_ranges);
  1996. bool write_content_with_provider(Stream &strm, const Request &req,
  1997. Response &res, const std::string &boundary,
  1998. const std::string &content_type);
  1999. bool read_content(Stream &strm, Request &req, Response &res);
  2000. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2001. Response &res,
  2002. ContentReceiver receiver,
  2003. FormDataHeader multipart_header,
  2004. ContentReceiver multipart_receiver);
  2005. bool read_content_core(Stream &strm, Request &req, Response &res,
  2006. ContentReceiver receiver,
  2007. FormDataHeader multipart_header,
  2008. ContentReceiver multipart_receiver) const;
  2009. virtual bool process_and_close_socket(socket_t sock);
  2010. void output_log(const Request &req, const Response &res) const;
  2011. void output_pre_compression_log(const Request &req,
  2012. const Response &res) const;
  2013. void output_error_log(const Error &err, const Request *req) const;
  2014. std::atomic<bool> is_running_{false};
  2015. std::atomic<bool> is_decommissioned{false};
  2016. // Set when CustomRoute() refuses a registration. Written before listen(),
  2017. // read by is_valid() on the same thread, so it needs no synchronization.
  2018. bool has_invalid_registration_ = false;
  2019. struct MountPointEntry {
  2020. std::string mount_point;
  2021. std::string base_dir;
  2022. std::string resolved_base_dir;
  2023. Headers headers;
  2024. };
  2025. std::vector<MountPointEntry> base_dirs_;
  2026. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2027. std::string default_file_mimetype_ = "application/octet-stream";
  2028. Handler file_request_handler_;
  2029. Handlers get_handlers_;
  2030. Handlers post_handlers_;
  2031. HandlersForContentReader post_handlers_for_content_reader_;
  2032. Handlers put_handlers_;
  2033. HandlersForContentReader put_handlers_for_content_reader_;
  2034. Handlers patch_handlers_;
  2035. HandlersForContentReader patch_handlers_for_content_reader_;
  2036. Handlers delete_handlers_;
  2037. HandlersForContentReader delete_handlers_for_content_reader_;
  2038. Handlers options_handlers_;
  2039. CustomHandlers custom_handlers_;
  2040. struct WebSocketHandlerEntry {
  2041. std::unique_ptr<detail::MatcherBase> matcher;
  2042. WebSocketHandler handler;
  2043. SubProtocolSelector sub_protocol_selector;
  2044. };
  2045. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2046. WebSocketHandlers websocket_handlers_;
  2047. HandlerWithResponse error_handler_;
  2048. ExceptionHandler exception_handler_;
  2049. HandlerWithResponse pre_routing_handler_;
  2050. Handler post_routing_handler_;
  2051. HandlerWithResponse pre_request_handler_;
  2052. Expect100ContinueHandler expect_100_continue_handler_;
  2053. StartHandler start_handler_;
  2054. mutable std::mutex logger_mutex_;
  2055. Logger logger_;
  2056. Logger pre_compression_logger_;
  2057. ErrorLogger error_logger_;
  2058. int address_family_ = AF_UNSPEC;
  2059. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2060. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2061. SocketOptions socket_options_ = default_socket_options;
  2062. Headers default_headers_;
  2063. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2064. detail::write_headers;
  2065. };
  2066. class Result {
  2067. public:
  2068. Result() = default;
  2069. Result(std::unique_ptr<Response> &&res, Error err,
  2070. Headers &&request_headers = Headers{})
  2071. : res_(std::move(res)), err_(err),
  2072. request_headers_(std::move(request_headers)) {}
  2073. // Response
  2074. operator bool() const { return res_ != nullptr; }
  2075. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2076. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2077. const Response &value() const { return *res_; }
  2078. Response &value() { return *res_; }
  2079. const Response &operator*() const { return *res_; }
  2080. Response &operator*() { return *res_; }
  2081. const Response *operator->() const { return res_.get(); }
  2082. Response *operator->() { return res_.get(); }
  2083. // Error
  2084. Error error() const { return err_; }
  2085. // Request Headers
  2086. bool has_request_header(const std::string &key) const;
  2087. std::string get_request_header_value(const std::string &key,
  2088. const char *def = "",
  2089. size_t id = 0) const;
  2090. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2091. size_t id = 0) const;
  2092. size_t get_request_header_value_count(const std::string &key) const;
  2093. private:
  2094. std::unique_ptr<Response> res_;
  2095. Error err_ = Error::Unknown;
  2096. Headers request_headers_;
  2097. #ifdef CPPHTTPLIB_SSL_ENABLED
  2098. public:
  2099. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2100. int ssl_error)
  2101. : res_(std::move(res)), err_(err),
  2102. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2103. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2104. int ssl_error, uint64_t ssl_backend_error)
  2105. : res_(std::move(res)), err_(err),
  2106. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2107. ssl_backend_error_(ssl_backend_error) {}
  2108. int ssl_error() const { return ssl_error_; }
  2109. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2110. private:
  2111. int ssl_error_ = 0;
  2112. uint64_t ssl_backend_error_ = 0;
  2113. #endif
  2114. };
  2115. struct ClientConnection {
  2116. socket_t sock = INVALID_SOCKET;
  2117. bool is_open() const { return sock != INVALID_SOCKET; }
  2118. ClientConnection() = default;
  2119. ~ClientConnection();
  2120. ClientConnection(const ClientConnection &) = delete;
  2121. ClientConnection &operator=(const ClientConnection &) = delete;
  2122. ClientConnection(ClientConnection &&other) noexcept
  2123. : sock(other.sock)
  2124. #ifdef CPPHTTPLIB_SSL_ENABLED
  2125. ,
  2126. session(other.session)
  2127. #endif
  2128. {
  2129. other.sock = INVALID_SOCKET;
  2130. #ifdef CPPHTTPLIB_SSL_ENABLED
  2131. other.session = nullptr;
  2132. #endif
  2133. }
  2134. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2135. if (this != &other) {
  2136. sock = other.sock;
  2137. other.sock = INVALID_SOCKET;
  2138. #ifdef CPPHTTPLIB_SSL_ENABLED
  2139. session = other.session;
  2140. other.session = nullptr;
  2141. #endif
  2142. }
  2143. return *this;
  2144. }
  2145. #ifdef CPPHTTPLIB_SSL_ENABLED
  2146. tls::session_t session = nullptr;
  2147. #endif
  2148. };
  2149. namespace detail {
  2150. struct ChunkedDecoder;
  2151. struct BodyReader {
  2152. Stream *stream = nullptr;
  2153. bool has_content_length = false;
  2154. size_t content_length = 0;
  2155. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2156. size_t bytes_read = 0;
  2157. bool chunked = false;
  2158. bool eof = false;
  2159. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2160. Error last_error = Error::Success;
  2161. ssize_t read(char *buf, size_t len);
  2162. bool has_error() const { return last_error != Error::Success; }
  2163. };
  2164. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2165. size_t len) {
  2166. (void)stream;
  2167. return br.read(buf, len);
  2168. }
  2169. class decompressor;
  2170. enum class NoProxyKind {
  2171. Wildcard, // "*"
  2172. HostnameSuffix, // "example.com" or ".example.com"
  2173. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2174. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2175. };
  2176. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2177. // Lets one CIDR matcher cover both families.
  2178. using IPBytes = std::array<uint8_t, 16>;
  2179. struct NoProxyEntry {
  2180. NoProxyKind kind = NoProxyKind::Wildcard;
  2181. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2182. IPBytes net{};
  2183. int prefix_bits = 0;
  2184. };
  2185. struct NormalizedTarget {
  2186. std::string hostname; // lowercase; brackets and trailing dot removed
  2187. bool is_ipv4 = false;
  2188. bool is_ipv6 = false;
  2189. IPBytes ip{};
  2190. };
  2191. } // namespace detail
  2192. class ClientImpl {
  2193. public:
  2194. explicit ClientImpl(const std::string &host);
  2195. explicit ClientImpl(const std::string &host, int port);
  2196. explicit ClientImpl(const std::string &host, int port,
  2197. const std::string &client_cert_path,
  2198. const std::string &client_key_path);
  2199. virtual ~ClientImpl();
  2200. virtual bool is_valid() const;
  2201. struct StreamHandle {
  2202. std::unique_ptr<Response> response;
  2203. Error error = Error::Success;
  2204. StreamHandle() = default;
  2205. StreamHandle(const StreamHandle &) = delete;
  2206. StreamHandle &operator=(const StreamHandle &) = delete;
  2207. StreamHandle(StreamHandle &&) = default;
  2208. StreamHandle &operator=(StreamHandle &&) = default;
  2209. ~StreamHandle() = default;
  2210. bool is_valid() const {
  2211. return response != nullptr && error == Error::Success;
  2212. }
  2213. ssize_t read(char *buf, size_t len);
  2214. void parse_trailers_if_needed();
  2215. Error get_read_error() const { return body_reader_.last_error; }
  2216. bool has_read_error() const { return body_reader_.has_error(); }
  2217. bool trailers_parsed_ = false;
  2218. private:
  2219. friend class ClientImpl;
  2220. ssize_t read_with_decompression(char *buf, size_t len);
  2221. std::unique_ptr<ClientConnection> connection_;
  2222. std::unique_ptr<Stream> socket_stream_;
  2223. Stream *stream_ = nullptr;
  2224. detail::BodyReader body_reader_;
  2225. std::unique_ptr<detail::decompressor> decompressor_;
  2226. std::string decompress_buffer_;
  2227. size_t decompress_offset_ = 0;
  2228. size_t decompressed_bytes_read_ = 0;
  2229. };
  2230. // clang-format off
  2231. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2232. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2233. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2234. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2235. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2236. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2237. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2238. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2239. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2240. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2241. Result Head(const std::string &path);
  2242. Result Head(const std::string &path, const Headers &headers);
  2243. Result Post(const std::string &path);
  2244. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2245. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2246. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2247. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2248. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2249. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2250. Result Post(const std::string &path, const Params &params);
  2251. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2252. Result Post(const std::string &path, const Headers &headers);
  2253. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2254. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2255. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2256. 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);
  2257. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2258. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2259. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2260. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2261. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2262. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2263. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2264. Result Put(const std::string &path);
  2265. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2266. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2267. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2268. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2269. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2270. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2271. Result Put(const std::string &path, const Params &params);
  2272. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2273. Result Put(const std::string &path, const Headers &headers);
  2274. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2275. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2276. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2277. 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);
  2278. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2279. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2280. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2281. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2282. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2283. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2284. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2285. Result Patch(const std::string &path);
  2286. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2287. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2288. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2289. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2290. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2291. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2292. Result Patch(const std::string &path, const Params &params);
  2293. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2294. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2295. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2296. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2297. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2298. 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);
  2299. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2300. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2301. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2302. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2303. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2304. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2305. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2306. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2307. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2308. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2309. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2310. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2311. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2312. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2313. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2314. Result Options(const std::string &path);
  2315. Result Options(const std::string &path, const Headers &headers);
  2316. // clang-format on
  2317. // Streaming API: Open a stream for reading response body incrementally
  2318. // Socket ownership is transferred to StreamHandle for true streaming
  2319. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2320. StreamHandle open_stream(const std::string &method, const std::string &path,
  2321. const Params &params = {},
  2322. const Headers &headers = {},
  2323. const std::string &body = {},
  2324. const std::string &content_type = {});
  2325. bool send(Request &req, Response &res, Error &error);
  2326. Result send(const Request &req);
  2327. void stop();
  2328. std::string host() const;
  2329. int port() const;
  2330. size_t is_socket_open() const;
  2331. socket_t socket() const;
  2332. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2333. void set_default_headers(Headers headers);
  2334. void
  2335. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2336. void set_address_family(int family);
  2337. void set_tcp_nodelay(bool on);
  2338. void set_ipv6_v6only(bool on);
  2339. void set_socket_options(SocketOptions socket_options);
  2340. void set_connection_timeout(time_t sec, time_t usec = 0);
  2341. template <class Rep, class Period>
  2342. void
  2343. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2344. void set_read_timeout(time_t sec, time_t usec = 0);
  2345. template <class Rep, class Period>
  2346. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2347. void set_write_timeout(time_t sec, time_t usec = 0);
  2348. template <class Rep, class Period>
  2349. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2350. void set_max_timeout(time_t msec);
  2351. template <class Rep, class Period>
  2352. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2353. void set_basic_auth(const std::string &username, const std::string &password);
  2354. void set_bearer_token_auth(const std::string &token);
  2355. void set_keep_alive(bool on);
  2356. void set_follow_location(bool on);
  2357. void set_path_encode(bool on);
  2358. void set_compress(bool on);
  2359. void set_decompress(bool on);
  2360. void set_payload_max_length(size_t length);
  2361. void set_interface(const std::string &intf);
  2362. void set_proxy(const std::string &host, int port);
  2363. void set_proxy_basic_auth(const std::string &username,
  2364. const std::string &password);
  2365. void set_proxy_bearer_token_auth(const std::string &token);
  2366. void set_no_proxy(const std::vector<std::string> &patterns);
  2367. void set_logger(Logger logger);
  2368. void set_error_logger(ErrorLogger error_logger);
  2369. protected:
  2370. struct Socket {
  2371. socket_t sock = INVALID_SOCKET;
  2372. // For Mbed TLS compatibility: start_time for request timeout tracking
  2373. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2374. bool is_open() const { return sock != INVALID_SOCKET; }
  2375. #ifdef CPPHTTPLIB_SSL_ENABLED
  2376. tls::session_t ssl = nullptr;
  2377. #endif
  2378. };
  2379. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2380. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2381. virtual bool setup_proxy_connection(
  2382. Socket &socket,
  2383. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2384. Response &res, bool &success, Error &error);
  2385. bool is_proxy_enabled_for_host(const std::string &host) const;
  2386. // All of:
  2387. // shutdown_ssl
  2388. // shutdown_socket
  2389. // close_socket
  2390. // disconnect
  2391. // should ONLY be called when socket_mutex_ is locked, and only when
  2392. // no other thread is using the socket.
  2393. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2394. void shutdown_socket(Socket &socket) const;
  2395. void close_socket(Socket &socket);
  2396. void disconnect(bool gracefully);
  2397. bool process_request(Stream &strm, Request &req, Response &res,
  2398. bool close_connection, Error &error);
  2399. bool write_content_with_provider(Stream &strm, const Request &req,
  2400. Error &error) const;
  2401. void copy_settings(const ClientImpl &rhs);
  2402. void output_log(const Request &req, const Response &res) const;
  2403. void output_error_log(const Error &err, const Request *req) const;
  2404. // Socket endpoint information
  2405. const std::string host_;
  2406. const int port_;
  2407. // Current open socket
  2408. Socket socket_;
  2409. mutable std::mutex socket_mutex_;
  2410. std::recursive_mutex request_mutex_;
  2411. // These are all protected under socket_mutex
  2412. size_t socket_requests_in_flight_ = 0;
  2413. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2414. bool socket_should_be_closed_when_request_is_done_ = false;
  2415. // Hostname to connection target map. The value is an IP literal or another
  2416. // hostname; only the connection target changes, never the identity.
  2417. std::map<std::string, std::string> addr_map_;
  2418. // Default headers
  2419. Headers default_headers_;
  2420. // Header writer
  2421. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2422. detail::write_headers;
  2423. // Settings
  2424. std::string client_cert_path_;
  2425. std::string client_key_path_;
  2426. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2427. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2428. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2429. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2430. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2431. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2432. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2433. std::string basic_auth_username_;
  2434. std::string basic_auth_password_;
  2435. std::string bearer_token_auth_token_;
  2436. bool keep_alive_ = false;
  2437. bool follow_location_ = false;
  2438. bool path_encode_ = true;
  2439. int address_family_ = AF_UNSPEC;
  2440. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2441. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2442. SocketOptions socket_options_ = nullptr;
  2443. bool compress_ = false;
  2444. bool decompress_ = true;
  2445. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2446. bool has_payload_max_length_ = false;
  2447. std::string interface_;
  2448. std::string proxy_host_;
  2449. int proxy_port_ = -1;
  2450. std::string proxy_basic_auth_username_;
  2451. std::string proxy_basic_auth_password_;
  2452. std::string proxy_bearer_token_auth_token_;
  2453. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2454. mutable detail::NormalizedTarget host_normalized_;
  2455. mutable bool host_normalized_valid_ = false;
  2456. mutable std::mutex logger_mutex_;
  2457. Logger logger_;
  2458. ErrorLogger error_logger_;
  2459. private:
  2460. bool send_(Request &req, Response &res, Error &error);
  2461. Result send_(Request &&req);
  2462. socket_t create_client_socket(Error &error) const;
  2463. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2464. bool skip_100_continue = true) const;
  2465. bool write_request(Stream &strm, Request &req, bool close_connection,
  2466. Error &error, bool skip_body = false);
  2467. bool write_request_body(Stream &strm, Request &req, Error &error);
  2468. void prepare_default_headers(Request &r, bool for_stream,
  2469. const std::string &ct);
  2470. bool redirect(Request &req, Response &res, Error &error);
  2471. bool create_redirect_client(const std::string &scheme,
  2472. const std::string &host, int port, Request &req,
  2473. Response &res, const std::string &path,
  2474. const std::string &location, Error &error);
  2475. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2476. bool handle_request(Stream &strm, Request &req, Response &res,
  2477. bool close_connection, Error &error);
  2478. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2479. Request &req, const char *body, size_t content_length,
  2480. ContentProvider content_provider,
  2481. ContentProviderWithoutLength content_provider_without_length,
  2482. const std::string &content_type, ContentReceiver content_receiver,
  2483. Error &error);
  2484. Result send_with_content_provider_and_receiver(
  2485. const std::string &method, const std::string &path,
  2486. const Headers &headers, const char *body, size_t content_length,
  2487. ContentProvider content_provider,
  2488. ContentProviderWithoutLength content_provider_without_length,
  2489. const std::string &content_type, ContentReceiver content_receiver,
  2490. UploadProgress progress);
  2491. ContentProviderWithoutLength get_multipart_content_provider(
  2492. const std::string &boundary, const UploadFormDataItems &items,
  2493. const FormDataProviderItems &provider_items) const;
  2494. virtual bool
  2495. process_socket(const Socket &socket,
  2496. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2497. std::function<bool(Stream &strm)> callback);
  2498. virtual bool is_ssl() const;
  2499. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2500. #ifdef CPPHTTPLIB_SSL_ENABLED
  2501. public:
  2502. void set_digest_auth(const std::string &username,
  2503. const std::string &password);
  2504. void set_proxy_digest_auth(const std::string &username,
  2505. const std::string &password);
  2506. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2507. const std::string &ca_cert_dir_path = std::string());
  2508. void enable_server_certificate_verification(bool enabled);
  2509. void enable_server_hostname_verification(bool enabled);
  2510. void enable_system_ca(bool enabled);
  2511. protected:
  2512. std::string digest_auth_username_;
  2513. std::string digest_auth_password_;
  2514. std::string proxy_digest_auth_username_;
  2515. std::string proxy_digest_auth_password_;
  2516. std::string ca_cert_file_path_;
  2517. std::string ca_cert_dir_path_;
  2518. bool server_certificate_verification_ = true;
  2519. bool server_hostname_verification_ = true;
  2520. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2521. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2522. int last_ssl_error_ = 0;
  2523. uint64_t last_backend_error_ = 0;
  2524. #endif
  2525. };
  2526. class Client {
  2527. public:
  2528. // Universal interface
  2529. explicit Client(const std::string &scheme_host_port);
  2530. explicit Client(const std::string &scheme_host_port,
  2531. const std::string &client_cert_path,
  2532. const std::string &client_key_path);
  2533. // HTTP only interface
  2534. explicit Client(const std::string &host, int port);
  2535. explicit Client(const std::string &host, int port,
  2536. const std::string &client_cert_path,
  2537. const std::string &client_key_path);
  2538. Client(Client &&) = default;
  2539. Client &operator=(Client &&) = default;
  2540. ~Client();
  2541. bool is_valid() const;
  2542. // clang-format off
  2543. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2544. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2545. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2546. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2547. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2548. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2549. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2550. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2551. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2552. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2553. Result Head(const std::string &path);
  2554. Result Head(const std::string &path, const Headers &headers);
  2555. Result Post(const std::string &path);
  2556. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2557. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2558. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2559. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2560. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2561. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2562. Result Post(const std::string &path, const Params &params);
  2563. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2564. Result Post(const std::string &path, const Headers &headers);
  2565. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2566. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2567. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2568. 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);
  2569. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2570. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2571. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2572. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2573. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2574. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2575. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2576. Result Put(const std::string &path);
  2577. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2578. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2579. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2580. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2581. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2582. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2583. Result Put(const std::string &path, const Params &params);
  2584. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2585. Result Put(const std::string &path, const Headers &headers);
  2586. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2587. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2588. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2589. 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);
  2590. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2591. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2592. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2593. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2594. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2595. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2596. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2597. Result Patch(const std::string &path);
  2598. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2599. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2600. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2601. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2602. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2603. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2604. Result Patch(const std::string &path, const Params &params);
  2605. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2606. Result Patch(const std::string &path, const Headers &headers);
  2607. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2608. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2609. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2610. 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);
  2611. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2612. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2613. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2614. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2615. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2616. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2617. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2618. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2619. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2620. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2621. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2622. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2623. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2624. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2625. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2626. Result Options(const std::string &path);
  2627. Result Options(const std::string &path, const Headers &headers);
  2628. // clang-format on
  2629. // Streaming API: Open a stream for reading response body incrementally
  2630. // Socket ownership is transferred to StreamHandle for true streaming
  2631. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2632. ClientImpl::StreamHandle open_stream(const std::string &method,
  2633. const std::string &path,
  2634. const Params &params = {},
  2635. const Headers &headers = {},
  2636. const std::string &body = {},
  2637. const std::string &content_type = {});
  2638. bool send(Request &req, Response &res, Error &error);
  2639. Result send(const Request &req);
  2640. void stop();
  2641. std::string host() const;
  2642. int port() const;
  2643. size_t is_socket_open() const;
  2644. socket_t socket() const;
  2645. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2646. void set_default_headers(Headers headers);
  2647. void
  2648. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2649. void set_address_family(int family);
  2650. void set_tcp_nodelay(bool on);
  2651. void set_socket_options(SocketOptions socket_options);
  2652. void set_connection_timeout(time_t sec, time_t usec = 0);
  2653. template <class Rep, class Period>
  2654. void
  2655. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2656. void set_read_timeout(time_t sec, time_t usec = 0);
  2657. template <class Rep, class Period>
  2658. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2659. void set_write_timeout(time_t sec, time_t usec = 0);
  2660. template <class Rep, class Period>
  2661. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2662. void set_max_timeout(time_t msec);
  2663. template <class Rep, class Period>
  2664. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2665. void set_basic_auth(const std::string &username, const std::string &password);
  2666. void set_bearer_token_auth(const std::string &token);
  2667. void set_keep_alive(bool on);
  2668. void set_follow_location(bool on);
  2669. void set_path_encode(bool on);
  2670. void set_compress(bool on);
  2671. void set_decompress(bool on);
  2672. void set_payload_max_length(size_t length);
  2673. void set_interface(const std::string &intf);
  2674. void set_proxy(const std::string &host, int port);
  2675. void set_proxy_basic_auth(const std::string &username,
  2676. const std::string &password);
  2677. void set_proxy_bearer_token_auth(const std::string &token);
  2678. void set_no_proxy(const std::vector<std::string> &patterns);
  2679. void set_logger(Logger logger);
  2680. void set_error_logger(ErrorLogger error_logger);
  2681. private:
  2682. std::unique_ptr<ClientImpl> cli_;
  2683. #ifdef CPPHTTPLIB_SSL_ENABLED
  2684. public:
  2685. void set_digest_auth(const std::string &username,
  2686. const std::string &password);
  2687. void set_proxy_digest_auth(const std::string &username,
  2688. const std::string &password);
  2689. void enable_server_certificate_verification(bool enabled);
  2690. void enable_server_hostname_verification(bool enabled);
  2691. void enable_system_ca(bool enabled);
  2692. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2693. const std::string &ca_cert_dir_path = std::string());
  2694. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2695. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2696. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2697. void set_session_verifier(
  2698. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2699. tls::ctx_t tls_context() const;
  2700. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2701. void enable_windows_certificate_verification(bool enabled);
  2702. #endif
  2703. private:
  2704. bool is_ssl_ = false;
  2705. #endif
  2706. };
  2707. #ifdef CPPHTTPLIB_SSL_ENABLED
  2708. class SSLServer : public Server {
  2709. public:
  2710. SSLServer(const char *cert_path, const char *private_key_path,
  2711. const char *client_ca_cert_file_path = nullptr,
  2712. const char *client_ca_cert_dir_path = nullptr,
  2713. const char *private_key_password = nullptr);
  2714. struct PemMemory {
  2715. const char *cert_pem;
  2716. size_t cert_pem_len;
  2717. const char *key_pem;
  2718. size_t key_pem_len;
  2719. const char *client_ca_pem;
  2720. size_t client_ca_pem_len;
  2721. const char *private_key_password;
  2722. };
  2723. explicit SSLServer(const PemMemory &pem);
  2724. // The callback receives the ctx_t handle which can be cast to the
  2725. // appropriate backend type (SSL_CTX* for OpenSSL,
  2726. // tls::impl::MbedTlsContext* for Mbed TLS)
  2727. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2728. ~SSLServer() override;
  2729. bool is_valid() const override;
  2730. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2731. const char *client_ca_pem = nullptr,
  2732. const char *password = nullptr);
  2733. tls::ctx_t tls_context() const { return ctx_; }
  2734. int ssl_last_error() const { return last_ssl_error_; }
  2735. private:
  2736. bool process_and_close_socket(socket_t sock) override;
  2737. tls::ctx_t ctx_ = nullptr;
  2738. std::mutex ctx_mutex_;
  2739. int last_ssl_error_ = 0;
  2740. };
  2741. class SSLClient final : public ClientImpl {
  2742. public:
  2743. explicit SSLClient(const std::string &host);
  2744. explicit SSLClient(const std::string &host, int port);
  2745. explicit SSLClient(const std::string &host, int port,
  2746. const std::string &client_cert_path,
  2747. const std::string &client_key_path,
  2748. const std::string &private_key_password = std::string());
  2749. struct PemMemory {
  2750. const char *cert_pem;
  2751. size_t cert_pem_len;
  2752. const char *key_pem;
  2753. size_t key_pem_len;
  2754. const char *private_key_password;
  2755. };
  2756. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2757. ~SSLClient() override;
  2758. bool is_valid() const override;
  2759. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2760. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2761. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2762. // Post-handshake session verifier (backend-independent)
  2763. void set_session_verifier(
  2764. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2765. tls::ctx_t tls_context() const { return ctx_; }
  2766. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2767. void enable_windows_certificate_verification(bool enabled);
  2768. #endif
  2769. private:
  2770. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2771. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2772. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2773. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2774. bool
  2775. process_socket(const Socket &socket,
  2776. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2777. std::function<bool(Stream &strm)> callback) override;
  2778. bool is_ssl() const override;
  2779. bool setup_proxy_connection(
  2780. Socket &socket,
  2781. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2782. Response &res, bool &success, Error &error) override;
  2783. bool connect_with_proxy(
  2784. Socket &sock,
  2785. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2786. Response &res, bool &success, Error &error);
  2787. bool initialize_ssl(Socket &socket, Error &error);
  2788. void init_ctx();
  2789. void reset_ctx_on_error();
  2790. bool load_certs();
  2791. tls::ctx_t ctx_ = nullptr;
  2792. std::mutex ctx_mutex_;
  2793. std::once_flag initialize_cert_;
  2794. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2795. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2796. // Used to keep custom CA configuration exclusive with system CA loading.
  2797. bool ca_cert_store_set_ = false;
  2798. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2799. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2800. bool enable_windows_cert_verification_ = true;
  2801. #endif
  2802. friend class ClientImpl;
  2803. };
  2804. #endif // CPPHTTPLIB_SSL_ENABLED
  2805. namespace detail {
  2806. template <typename T, typename U>
  2807. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2808. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2809. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2810. duration - std::chrono::seconds(sec))
  2811. .count();
  2812. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2813. }
  2814. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2815. return N - 1;
  2816. }
  2817. inline bool is_numeric(const std::string &str) {
  2818. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2819. }
  2820. inline size_t get_header_value_u64(const Headers &headers,
  2821. const std::string &key, size_t def,
  2822. size_t id, bool &is_invalid_value) {
  2823. is_invalid_value = false;
  2824. auto rng = headers.equal_range(key);
  2825. auto it = rng.first;
  2826. std::advance(it, static_cast<ssize_t>(id));
  2827. if (it != rng.second) {
  2828. if (is_numeric(it->second)) {
  2829. // Parse at size_t width so an out-of-range Content-Length is reported
  2830. // rather than silently saturated/truncated (a value above 2^32 would
  2831. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2832. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2833. size_t val = 0;
  2834. const auto &s = it->second;
  2835. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2836. if (r.ec == std::errc::result_out_of_range) {
  2837. is_invalid_value = true;
  2838. return (std::numeric_limits<size_t>::max)();
  2839. }
  2840. return val;
  2841. } else {
  2842. is_invalid_value = true;
  2843. }
  2844. }
  2845. return def;
  2846. }
  2847. inline size_t get_header_value_u64(const Headers &headers,
  2848. const std::string &key, size_t def,
  2849. size_t id) {
  2850. auto dummy = false;
  2851. return get_header_value_u64(headers, key, def, id, dummy);
  2852. }
  2853. } // namespace detail
  2854. template <class Rep, class Period>
  2855. inline Server &
  2856. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2857. detail::duration_to_sec_and_usec(
  2858. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2859. return *this;
  2860. }
  2861. template <class Rep, class Period>
  2862. inline Server &
  2863. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2864. detail::duration_to_sec_and_usec(
  2865. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2866. return *this;
  2867. }
  2868. template <class Rep, class Period>
  2869. inline Server &
  2870. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2871. detail::duration_to_sec_and_usec(
  2872. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2873. return *this;
  2874. }
  2875. template <class Rep, class Period>
  2876. inline void ClientImpl::set_connection_timeout(
  2877. const std::chrono::duration<Rep, Period> &duration) {
  2878. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2879. set_connection_timeout(sec, usec);
  2880. });
  2881. }
  2882. template <class Rep, class Period>
  2883. inline void ClientImpl::set_read_timeout(
  2884. const std::chrono::duration<Rep, Period> &duration) {
  2885. detail::duration_to_sec_and_usec(
  2886. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2887. }
  2888. template <class Rep, class Period>
  2889. inline void ClientImpl::set_write_timeout(
  2890. const std::chrono::duration<Rep, Period> &duration) {
  2891. detail::duration_to_sec_and_usec(
  2892. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2893. }
  2894. template <class Rep, class Period>
  2895. inline void ClientImpl::set_max_timeout(
  2896. const std::chrono::duration<Rep, Period> &duration) {
  2897. auto msec =
  2898. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2899. set_max_timeout(msec);
  2900. }
  2901. template <class Rep, class Period>
  2902. inline void Client::set_connection_timeout(
  2903. const std::chrono::duration<Rep, Period> &duration) {
  2904. cli_->set_connection_timeout(duration);
  2905. }
  2906. template <class Rep, class Period>
  2907. inline void
  2908. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2909. cli_->set_read_timeout(duration);
  2910. }
  2911. template <class Rep, class Period>
  2912. inline void
  2913. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2914. cli_->set_write_timeout(duration);
  2915. }
  2916. inline void Client::set_max_timeout(time_t msec) {
  2917. cli_->set_max_timeout(msec);
  2918. }
  2919. template <class Rep, class Period>
  2920. inline void
  2921. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2922. cli_->set_max_timeout(duration);
  2923. }
  2924. /*
  2925. * Forward declarations and types that will be part of the .h file if split into
  2926. * .h + .cc.
  2927. */
  2928. std::string hosted_at(const std::string &hostname);
  2929. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2930. // JavaScript-style URL encoding/decoding functions
  2931. std::string encode_uri_component(const std::string &value);
  2932. std::string encode_uri(const std::string &value);
  2933. std::string decode_uri_component(const std::string &value);
  2934. std::string decode_uri(const std::string &value);
  2935. // RFC 3986 compliant URL component encoding/decoding functions
  2936. std::string encode_path_component(const std::string &component);
  2937. std::string decode_path_component(const std::string &component);
  2938. std::string encode_query_component(const std::string &component,
  2939. bool space_as_plus = true);
  2940. std::string decode_query_component(const std::string &component,
  2941. bool plus_as_space = true);
  2942. std::string sanitize_filename(const std::string &filename);
  2943. std::string append_query_params(const std::string &path, const Params &params);
  2944. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2945. std::pair<std::string, std::string>
  2946. make_basic_authentication_header(const std::string &username,
  2947. const std::string &password,
  2948. bool is_proxy = false);
  2949. namespace detail {
  2950. #if defined(_WIN32)
  2951. inline std::wstring u8string_to_wstring(const char *s) {
  2952. if (!s) { return std::wstring(); }
  2953. auto len = static_cast<int>(strlen(s));
  2954. if (!len) { return std::wstring(); }
  2955. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  2956. if (!wlen) { return std::wstring(); }
  2957. std::wstring ws;
  2958. ws.resize(wlen);
  2959. wlen = ::MultiByteToWideChar(
  2960. CP_UTF8, 0, s, len,
  2961. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  2962. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  2963. return ws;
  2964. }
  2965. #endif
  2966. struct FileStat {
  2967. FileStat(const std::string &path);
  2968. bool is_file() const;
  2969. bool is_dir() const;
  2970. time_t mtime() const;
  2971. size_t size() const;
  2972. private:
  2973. #if defined(_WIN32)
  2974. struct _stat st_;
  2975. #else
  2976. struct stat st_;
  2977. #endif
  2978. int ret_ = -1;
  2979. };
  2980. std::string make_host_and_port_string(const std::string &host, int port,
  2981. bool is_ssl);
  2982. template <typename T>
  2983. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  2984. Error &error);
  2985. std::string trim_copy(const std::string &s);
  2986. void divide(
  2987. const char *data, std::size_t size, char d,
  2988. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2989. fn);
  2990. void divide(
  2991. const std::string &str, char d,
  2992. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2993. fn);
  2994. void split(const char *b, const char *e, char d,
  2995. std::function<void(const char *, const char *)> fn);
  2996. void split(const char *b, const char *e, char d, size_t m,
  2997. std::function<void(const char *, const char *)> fn);
  2998. bool split_find(const char *b, const char *e, char d,
  2999. std::function<bool(const char *, const char *)> fn);
  3000. bool has_header_token(const Headers &headers, const std::string &key,
  3001. const std::string &token);
  3002. std::string websocket_accept_key(const std::string &client_key);
  3003. bool is_websocket_upgrade(const Request &req);
  3004. bool process_client_socket(
  3005. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3006. time_t write_timeout_sec, time_t write_timeout_usec,
  3007. time_t max_timeout_msec,
  3008. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3009. std::function<bool(Stream &)> callback);
  3010. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3011. int port, int address_family, bool tcp_nodelay,
  3012. bool ipv6_v6only, SocketOptions socket_options,
  3013. time_t connection_timeout_sec,
  3014. time_t connection_timeout_usec,
  3015. time_t read_timeout_sec, time_t read_timeout_usec,
  3016. time_t write_timeout_sec,
  3017. time_t write_timeout_usec,
  3018. const std::string &intf, Error &error);
  3019. const char *get_header_value(const Headers &headers, const std::string &key,
  3020. const char *def, size_t id);
  3021. std::string get_combined_header_value(const Headers &headers,
  3022. const std::string &key);
  3023. std::string params_to_query_str(const Params &params);
  3024. void parse_query_text(const char *data, std::size_t size, Params &params);
  3025. void parse_query_text(const std::string &s, Params &params);
  3026. bool parse_multipart_boundary(const std::string &content_type,
  3027. std::string &boundary);
  3028. bool parse_range_header(const std::string &s, Ranges &ranges);
  3029. bool parse_accept_header(const std::string &s,
  3030. std::vector<std::string> &content_types);
  3031. void parse_disposition_params(const std::string &s, Params &params);
  3032. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3033. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3034. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3035. EncodingType encoding_type(const Request &req, const Response &res,
  3036. const std::string &content_type);
  3037. EncodingType encoding_type(const Request &req, const Response &res);
  3038. class BufferStream final : public Stream {
  3039. public:
  3040. BufferStream() = default;
  3041. ~BufferStream() override = default;
  3042. bool is_readable() const override;
  3043. bool wait_readable() const override;
  3044. bool wait_writable() const override;
  3045. ssize_t read(char *ptr, size_t size) override;
  3046. ssize_t write(const char *ptr, size_t size) override;
  3047. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3048. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3049. socket_t socket() const override;
  3050. time_t duration() const override;
  3051. const std::string &get_buffer() const;
  3052. private:
  3053. std::string buffer;
  3054. size_t position = 0;
  3055. };
  3056. class compressor {
  3057. public:
  3058. virtual ~compressor() = default;
  3059. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3060. virtual bool compress(const char *data, size_t data_length, bool last,
  3061. Callback callback) = 0;
  3062. };
  3063. class decompressor {
  3064. public:
  3065. virtual ~decompressor() = default;
  3066. virtual bool is_valid() const = 0;
  3067. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3068. virtual bool decompress(const char *data, size_t data_length,
  3069. Callback callback) = 0;
  3070. };
  3071. class nocompressor final : public compressor {
  3072. public:
  3073. ~nocompressor() override = default;
  3074. bool compress(const char *data, size_t data_length, bool /*last*/,
  3075. Callback callback) override;
  3076. };
  3077. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3078. class gzip_compressor final : public compressor {
  3079. public:
  3080. gzip_compressor();
  3081. ~gzip_compressor() override;
  3082. bool compress(const char *data, size_t data_length, bool last,
  3083. Callback callback) override;
  3084. private:
  3085. bool is_valid_ = false;
  3086. z_stream strm_;
  3087. };
  3088. class gzip_decompressor final : public decompressor {
  3089. public:
  3090. gzip_decompressor();
  3091. ~gzip_decompressor() override;
  3092. bool is_valid() const override;
  3093. bool decompress(const char *data, size_t data_length,
  3094. Callback callback) override;
  3095. private:
  3096. bool is_valid_ = false;
  3097. z_stream strm_;
  3098. };
  3099. #endif
  3100. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3101. class brotli_compressor final : public compressor {
  3102. public:
  3103. brotli_compressor();
  3104. ~brotli_compressor();
  3105. bool compress(const char *data, size_t data_length, bool last,
  3106. Callback callback) override;
  3107. private:
  3108. BrotliEncoderState *state_ = nullptr;
  3109. };
  3110. class brotli_decompressor final : public decompressor {
  3111. public:
  3112. brotli_decompressor();
  3113. ~brotli_decompressor();
  3114. bool is_valid() const override;
  3115. bool decompress(const char *data, size_t data_length,
  3116. Callback callback) override;
  3117. private:
  3118. BrotliDecoderResult decoder_r;
  3119. BrotliDecoderState *decoder_s = nullptr;
  3120. };
  3121. #endif
  3122. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3123. class zstd_compressor : public compressor {
  3124. public:
  3125. zstd_compressor();
  3126. ~zstd_compressor();
  3127. bool compress(const char *data, size_t data_length, bool last,
  3128. Callback callback) override;
  3129. private:
  3130. ZSTD_CCtx *ctx_ = nullptr;
  3131. };
  3132. class zstd_decompressor : public decompressor {
  3133. public:
  3134. zstd_decompressor();
  3135. ~zstd_decompressor();
  3136. bool is_valid() const override;
  3137. bool decompress(const char *data, size_t data_length,
  3138. Callback callback) override;
  3139. private:
  3140. ZSTD_DCtx *ctx_ = nullptr;
  3141. };
  3142. #endif
  3143. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3144. // to store data. The call can set memory on stack for performance.
  3145. class stream_line_reader {
  3146. public:
  3147. stream_line_reader(Stream &strm, char *fixed_buffer,
  3148. size_t fixed_buffer_size);
  3149. const char *ptr() const;
  3150. size_t size() const;
  3151. bool end_with_crlf() const;
  3152. bool getline();
  3153. private:
  3154. void append(char c);
  3155. void append(const char *data, size_t size);
  3156. Stream &strm_;
  3157. char *fixed_buffer_;
  3158. const size_t fixed_buffer_size_;
  3159. size_t fixed_buffer_used_size_ = 0;
  3160. std::string growable_buffer_;
  3161. };
  3162. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3163. const Headers &src_headers);
  3164. struct ChunkedDecoder {
  3165. Stream &strm;
  3166. size_t chunk_remaining = 0;
  3167. bool finished = false;
  3168. char line_buf[64];
  3169. size_t last_chunk_total = 0;
  3170. size_t last_chunk_offset = 0;
  3171. explicit ChunkedDecoder(Stream &s);
  3172. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3173. size_t &out_chunk_total);
  3174. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3175. };
  3176. class mmap {
  3177. public:
  3178. mmap(const char *path);
  3179. ~mmap();
  3180. bool open(const char *path);
  3181. void close();
  3182. bool is_open() const;
  3183. size_t size() const;
  3184. const char *data() const;
  3185. private:
  3186. #if defined(_WIN32)
  3187. HANDLE hFile_ = NULL;
  3188. HANDLE hMapping_ = NULL;
  3189. #else
  3190. int fd_ = -1;
  3191. #endif
  3192. size_t size_ = 0;
  3193. void *addr_ = nullptr;
  3194. bool is_open_empty_file = false;
  3195. };
  3196. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3197. namespace fields {
  3198. bool is_token_char(char c);
  3199. bool is_token(const std::string &s);
  3200. bool is_field_name(const std::string &s);
  3201. bool is_vchar(char c);
  3202. bool is_obs_text(char c);
  3203. bool is_field_vchar(char c);
  3204. bool is_field_content(const std::string &s);
  3205. bool is_field_value(const std::string &s);
  3206. bool is_field_valid(const std::string &name, const std::string &value);
  3207. } // namespace fields
  3208. } // namespace detail
  3209. /*
  3210. * TLS Abstraction Layer Declarations
  3211. */
  3212. #ifdef CPPHTTPLIB_SSL_ENABLED
  3213. // TLS abstraction layer - backend-specific type declarations
  3214. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3215. namespace tls {
  3216. namespace impl {
  3217. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3218. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3219. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3220. struct MbedTlsContext {
  3221. mbedtls_ssl_config conf;
  3222. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3223. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3224. mbedtls_entropy_context entropy;
  3225. mbedtls_ctr_drbg_context ctr_drbg;
  3226. #endif
  3227. mbedtls_x509_crt ca_chain;
  3228. mbedtls_x509_crt own_cert;
  3229. mbedtls_pk_context own_key;
  3230. bool is_server = false;
  3231. bool verify_client = false;
  3232. bool has_verify_callback = false;
  3233. MbedTlsContext();
  3234. ~MbedTlsContext();
  3235. MbedTlsContext(const MbedTlsContext &) = delete;
  3236. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3237. };
  3238. } // namespace impl
  3239. } // namespace tls
  3240. #endif
  3241. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3242. namespace tls {
  3243. namespace impl {
  3244. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3245. // This struct is accessible via tls::impl for use in SSL context
  3246. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3247. struct WolfSSLContext {
  3248. WOLFSSL_CTX *ctx = nullptr;
  3249. bool is_server = false;
  3250. bool verify_client = false;
  3251. bool has_verify_callback = false;
  3252. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3253. WolfSSLContext();
  3254. ~WolfSSLContext();
  3255. WolfSSLContext(const WolfSSLContext &) = delete;
  3256. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3257. };
  3258. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3259. struct WolfSSLCAStore {
  3260. std::string pem_data;
  3261. };
  3262. } // namespace impl
  3263. } // namespace tls
  3264. #endif
  3265. #endif // CPPHTTPLIB_SSL_ENABLED
  3266. namespace stream {
  3267. class Result {
  3268. public:
  3269. Result();
  3270. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3271. Result(Result &&other) noexcept;
  3272. Result &operator=(Result &&other) noexcept;
  3273. Result(const Result &) = delete;
  3274. Result &operator=(const Result &) = delete;
  3275. // Response info
  3276. bool is_valid() const;
  3277. explicit operator bool() const;
  3278. int status() const;
  3279. const Headers &headers() const;
  3280. std::string get_header_value(const std::string &key,
  3281. const char *def = "") const;
  3282. bool has_header(const std::string &key) const;
  3283. Error error() const;
  3284. Error read_error() const;
  3285. bool has_read_error() const;
  3286. // Stream reading
  3287. bool next();
  3288. const char *data() const;
  3289. size_t size() const;
  3290. std::string read_all();
  3291. private:
  3292. ClientImpl::StreamHandle handle_;
  3293. std::string buffer_;
  3294. size_t current_size_ = 0;
  3295. size_t chunk_size_;
  3296. bool finished_ = false;
  3297. };
  3298. // GET
  3299. template <typename ClientType>
  3300. inline Result Get(ClientType &cli, const std::string &path,
  3301. size_t chunk_size = 8192) {
  3302. return Result{cli.open_stream("GET", path), chunk_size};
  3303. }
  3304. template <typename ClientType>
  3305. inline Result Get(ClientType &cli, const std::string &path,
  3306. const Headers &headers, size_t chunk_size = 8192) {
  3307. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3308. }
  3309. template <typename ClientType>
  3310. inline Result Get(ClientType &cli, const std::string &path,
  3311. const Params &params, size_t chunk_size = 8192) {
  3312. return Result{cli.open_stream("GET", path, params), chunk_size};
  3313. }
  3314. template <typename ClientType>
  3315. inline Result Get(ClientType &cli, const std::string &path,
  3316. const Params &params, const Headers &headers,
  3317. size_t chunk_size = 8192) {
  3318. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3319. }
  3320. // POST
  3321. template <typename ClientType>
  3322. inline Result Post(ClientType &cli, const std::string &path,
  3323. const std::string &body, const std::string &content_type,
  3324. size_t chunk_size = 8192) {
  3325. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3326. chunk_size};
  3327. }
  3328. template <typename ClientType>
  3329. inline Result Post(ClientType &cli, const std::string &path,
  3330. const Headers &headers, const std::string &body,
  3331. const std::string &content_type, size_t chunk_size = 8192) {
  3332. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3333. chunk_size};
  3334. }
  3335. template <typename ClientType>
  3336. inline Result Post(ClientType &cli, const std::string &path,
  3337. const Params &params, const std::string &body,
  3338. const std::string &content_type, size_t chunk_size = 8192) {
  3339. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3340. chunk_size};
  3341. }
  3342. template <typename ClientType>
  3343. inline Result Post(ClientType &cli, const std::string &path,
  3344. const Params &params, const Headers &headers,
  3345. const std::string &body, const std::string &content_type,
  3346. size_t chunk_size = 8192) {
  3347. return Result{
  3348. cli.open_stream("POST", path, params, headers, body, content_type),
  3349. chunk_size};
  3350. }
  3351. // PUT
  3352. template <typename ClientType>
  3353. inline Result Put(ClientType &cli, const std::string &path,
  3354. const std::string &body, const std::string &content_type,
  3355. size_t chunk_size = 8192) {
  3356. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3357. chunk_size};
  3358. }
  3359. template <typename ClientType>
  3360. inline Result Put(ClientType &cli, const std::string &path,
  3361. const Headers &headers, const std::string &body,
  3362. const std::string &content_type, size_t chunk_size = 8192) {
  3363. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3364. chunk_size};
  3365. }
  3366. template <typename ClientType>
  3367. inline Result Put(ClientType &cli, const std::string &path,
  3368. const Params &params, const std::string &body,
  3369. const std::string &content_type, size_t chunk_size = 8192) {
  3370. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3371. chunk_size};
  3372. }
  3373. template <typename ClientType>
  3374. inline Result Put(ClientType &cli, const std::string &path,
  3375. const Params &params, const Headers &headers,
  3376. const std::string &body, const std::string &content_type,
  3377. size_t chunk_size = 8192) {
  3378. return Result{
  3379. cli.open_stream("PUT", path, params, headers, body, content_type),
  3380. chunk_size};
  3381. }
  3382. // PATCH
  3383. template <typename ClientType>
  3384. inline Result Patch(ClientType &cli, const std::string &path,
  3385. const std::string &body, const std::string &content_type,
  3386. size_t chunk_size = 8192) {
  3387. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3388. chunk_size};
  3389. }
  3390. template <typename ClientType>
  3391. inline Result Patch(ClientType &cli, const std::string &path,
  3392. const Headers &headers, const std::string &body,
  3393. const std::string &content_type, size_t chunk_size = 8192) {
  3394. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3395. chunk_size};
  3396. }
  3397. template <typename ClientType>
  3398. inline Result Patch(ClientType &cli, const std::string &path,
  3399. const Params &params, const std::string &body,
  3400. const std::string &content_type, size_t chunk_size = 8192) {
  3401. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3402. chunk_size};
  3403. }
  3404. template <typename ClientType>
  3405. inline Result Patch(ClientType &cli, const std::string &path,
  3406. const Params &params, const Headers &headers,
  3407. const std::string &body, const std::string &content_type,
  3408. size_t chunk_size = 8192) {
  3409. return Result{
  3410. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3411. chunk_size};
  3412. }
  3413. // DELETE
  3414. template <typename ClientType>
  3415. inline Result Delete(ClientType &cli, const std::string &path,
  3416. size_t chunk_size = 8192) {
  3417. return Result{cli.open_stream("DELETE", path), chunk_size};
  3418. }
  3419. template <typename ClientType>
  3420. inline Result Delete(ClientType &cli, const std::string &path,
  3421. const Headers &headers, size_t chunk_size = 8192) {
  3422. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3423. }
  3424. template <typename ClientType>
  3425. inline Result Delete(ClientType &cli, const std::string &path,
  3426. const std::string &body, const std::string &content_type,
  3427. size_t chunk_size = 8192) {
  3428. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3429. chunk_size};
  3430. }
  3431. template <typename ClientType>
  3432. inline Result Delete(ClientType &cli, const std::string &path,
  3433. const Headers &headers, const std::string &body,
  3434. const std::string &content_type,
  3435. size_t chunk_size = 8192) {
  3436. return Result{
  3437. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3438. chunk_size};
  3439. }
  3440. template <typename ClientType>
  3441. inline Result Delete(ClientType &cli, const std::string &path,
  3442. const Params &params, size_t chunk_size = 8192) {
  3443. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3444. }
  3445. template <typename ClientType>
  3446. inline Result Delete(ClientType &cli, const std::string &path,
  3447. const Params &params, const Headers &headers,
  3448. size_t chunk_size = 8192) {
  3449. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3450. }
  3451. template <typename ClientType>
  3452. inline Result Delete(ClientType &cli, const std::string &path,
  3453. const Params &params, const std::string &body,
  3454. const std::string &content_type,
  3455. size_t chunk_size = 8192) {
  3456. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3457. chunk_size};
  3458. }
  3459. template <typename ClientType>
  3460. inline Result Delete(ClientType &cli, const std::string &path,
  3461. const Params &params, const Headers &headers,
  3462. const std::string &body, const std::string &content_type,
  3463. size_t chunk_size = 8192) {
  3464. return Result{
  3465. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3466. chunk_size};
  3467. }
  3468. // HEAD
  3469. template <typename ClientType>
  3470. inline Result Head(ClientType &cli, const std::string &path,
  3471. size_t chunk_size = 8192) {
  3472. return Result{cli.open_stream("HEAD", path), chunk_size};
  3473. }
  3474. template <typename ClientType>
  3475. inline Result Head(ClientType &cli, const std::string &path,
  3476. const Headers &headers, size_t chunk_size = 8192) {
  3477. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3478. }
  3479. template <typename ClientType>
  3480. inline Result Head(ClientType &cli, const std::string &path,
  3481. const Params &params, size_t chunk_size = 8192) {
  3482. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3483. }
  3484. template <typename ClientType>
  3485. inline Result Head(ClientType &cli, const std::string &path,
  3486. const Params &params, const Headers &headers,
  3487. size_t chunk_size = 8192) {
  3488. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3489. }
  3490. // OPTIONS
  3491. template <typename ClientType>
  3492. inline Result Options(ClientType &cli, const std::string &path,
  3493. size_t chunk_size = 8192) {
  3494. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3495. }
  3496. template <typename ClientType>
  3497. inline Result Options(ClientType &cli, const std::string &path,
  3498. const Headers &headers, size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3500. }
  3501. template <typename ClientType>
  3502. inline Result Options(ClientType &cli, const std::string &path,
  3503. const Params &params, size_t chunk_size = 8192) {
  3504. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3505. }
  3506. template <typename ClientType>
  3507. inline Result Options(ClientType &cli, const std::string &path,
  3508. const Params &params, const Headers &headers,
  3509. size_t chunk_size = 8192) {
  3510. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3511. }
  3512. } // namespace stream
  3513. namespace sse {
  3514. struct SSEMessage {
  3515. std::string event; // Event type (default: "message")
  3516. std::string data; // Event payload
  3517. std::string id; // Event ID for Last-Event-ID header
  3518. SSEMessage();
  3519. void clear();
  3520. };
  3521. class SSEClient {
  3522. public:
  3523. using MessageHandler = std::function<void(const SSEMessage &)>;
  3524. using ErrorHandler = std::function<void(Error)>;
  3525. using OpenHandler = std::function<void()>;
  3526. SSEClient(Client &client, const std::string &path);
  3527. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3528. ~SSEClient();
  3529. SSEClient(const SSEClient &) = delete;
  3530. SSEClient &operator=(const SSEClient &) = delete;
  3531. // Event handlers
  3532. SSEClient &on_message(MessageHandler handler);
  3533. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3534. SSEClient &on_open(OpenHandler handler);
  3535. SSEClient &on_error(ErrorHandler handler);
  3536. SSEClient &set_reconnect_interval(int ms);
  3537. SSEClient &set_max_reconnect_attempts(int n);
  3538. // Update headers (thread-safe)
  3539. SSEClient &set_headers(const Headers &headers);
  3540. // State accessors
  3541. bool is_connected() const;
  3542. const std::string &last_event_id() const;
  3543. // Blocking start - runs event loop with auto-reconnect
  3544. void start();
  3545. // Non-blocking start - runs in background thread
  3546. void start_async();
  3547. // Stop the client (thread-safe)
  3548. void stop();
  3549. private:
  3550. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3551. void run_event_loop();
  3552. void dispatch_event(const SSEMessage &msg);
  3553. bool should_reconnect(int count) const;
  3554. void wait_for_reconnect();
  3555. // Client and path
  3556. Client &client_;
  3557. std::string path_;
  3558. Headers headers_;
  3559. mutable std::mutex headers_mutex_;
  3560. // Callbacks
  3561. MessageHandler on_message_;
  3562. std::map<std::string, MessageHandler> event_handlers_;
  3563. OpenHandler on_open_;
  3564. ErrorHandler on_error_;
  3565. // Configuration
  3566. int reconnect_interval_ms_ = 3000;
  3567. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3568. // State
  3569. std::atomic<bool> running_{false};
  3570. std::atomic<bool> connected_{false};
  3571. std::string last_event_id_;
  3572. // Async support
  3573. std::thread async_thread_;
  3574. };
  3575. } // namespace sse
  3576. namespace ws {
  3577. enum class Opcode : uint8_t {
  3578. Continuation = 0x0,
  3579. Text = 0x1,
  3580. Binary = 0x2,
  3581. Close = 0x8,
  3582. Ping = 0x9,
  3583. Pong = 0xA,
  3584. };
  3585. enum class CloseStatus : uint16_t {
  3586. Normal = 1000,
  3587. GoingAway = 1001,
  3588. ProtocolError = 1002,
  3589. UnsupportedData = 1003,
  3590. NoStatus = 1005,
  3591. Abnormal = 1006,
  3592. InvalidPayload = 1007,
  3593. PolicyViolation = 1008,
  3594. MessageTooBig = 1009,
  3595. MandatoryExtension = 1010,
  3596. InternalError = 1011,
  3597. };
  3598. // Timeout is returned only when a read timeout was set and it elapsed before
  3599. // any byte of a frame arrived: nothing was consumed and the connection is
  3600. // still open, so the caller can send on it and read again. `msg` is left
  3601. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3602. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3603. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3604. // upgrade handshake fully succeeded. On failure error() identifies the
  3605. // failing layer; status()/headers() expose the server's upgrade response
  3606. // when one was received (status() is -1 otherwise).
  3607. class Result {
  3608. public:
  3609. Result() = default;
  3610. Result(Error err, int status, Headers &&headers)
  3611. : err_(err), status_(status), headers_(std::move(headers)) {}
  3612. explicit operator bool() const { return err_ == Error::Success; }
  3613. Error error() const { return err_; }
  3614. // Upgrade response info
  3615. int status() const { return status_; }
  3616. const Headers &headers() const { return headers_; }
  3617. std::string get_header_value(const std::string &key,
  3618. const char *def = "") const {
  3619. return detail::get_header_value(headers_, key, def, 0);
  3620. }
  3621. bool has_header(const std::string &key) const {
  3622. return headers_.find(key) != headers_.end();
  3623. }
  3624. #ifdef CPPHTTPLIB_SSL_ENABLED
  3625. Result(Error err, int status, Headers &&headers, int ssl_error,
  3626. uint64_t ssl_backend_error)
  3627. : err_(err), status_(status), headers_(std::move(headers)),
  3628. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3629. int ssl_error() const { return ssl_error_; }
  3630. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3631. #endif
  3632. private:
  3633. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3634. int status_ = -1;
  3635. Headers headers_;
  3636. #ifdef CPPHTTPLIB_SSL_ENABLED
  3637. int ssl_error_ = 0;
  3638. uint64_t ssl_backend_error_ = 0;
  3639. #endif
  3640. };
  3641. class WebSocket {
  3642. public:
  3643. WebSocket(const WebSocket &) = delete;
  3644. WebSocket &operator=(const WebSocket &) = delete;
  3645. ~WebSocket();
  3646. ReadResult read(std::string &msg);
  3647. bool send(const std::string &data);
  3648. bool send(const char *data, size_t len);
  3649. void close(CloseStatus status = CloseStatus::Normal,
  3650. const std::string &reason = "");
  3651. const Request &request() const;
  3652. bool is_open() const;
  3653. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3654. // A server handler owns its connection's timeout this way; a client sets it
  3655. // through WebSocketClient. Safe to call while another thread is in read().
  3656. void set_read_timeout(time_t sec, time_t usec = 0);
  3657. template <class Rep, class Period>
  3658. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3659. private:
  3660. friend class httplib::Server;
  3661. friend class WebSocketClient;
  3662. WebSocket(
  3663. Stream &strm, const Request &req, bool is_server,
  3664. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3665. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3666. : strm_(strm), req_(req), is_server_(is_server),
  3667. ping_interval_sec_(ping_interval_sec),
  3668. max_missed_pongs_(max_missed_pongs) {
  3669. start_heartbeat();
  3670. }
  3671. WebSocket(
  3672. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3673. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3674. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3675. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3676. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3677. max_missed_pongs_(max_missed_pongs) {
  3678. start_heartbeat();
  3679. }
  3680. void start_heartbeat();
  3681. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3682. Stream &strm_;
  3683. std::unique_ptr<Stream> owned_strm_;
  3684. Request req_;
  3685. bool is_server_;
  3686. time_t ping_interval_sec_;
  3687. int max_missed_pongs_;
  3688. int unacked_pings_ = 0;
  3689. std::atomic<bool> closed_{false};
  3690. std::mutex write_mutex_;
  3691. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3692. // may do so: read_websocket_frame() reads a payload until it has the whole
  3693. // declared length, so a second parser stealing bytes silently corrupts the
  3694. // message the first one is assembling.
  3695. std::mutex read_mutex_;
  3696. std::thread ping_thread_;
  3697. std::mutex ping_mutex_;
  3698. std::condition_variable ping_cv_;
  3699. };
  3700. class WebSocketClient {
  3701. public:
  3702. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3703. const Headers &headers = {});
  3704. ~WebSocketClient();
  3705. WebSocketClient(const WebSocketClient &) = delete;
  3706. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3707. bool is_valid() const;
  3708. Result connect();
  3709. ReadResult read(std::string &msg);
  3710. bool send(const std::string &data);
  3711. bool send(const char *data, size_t len);
  3712. void close(CloseStatus status = CloseStatus::Normal,
  3713. const std::string &reason = "");
  3714. bool is_open() const;
  3715. const std::string &subprotocol() const;
  3716. void set_read_timeout(time_t sec, time_t usec = 0);
  3717. template <class Rep, class Period>
  3718. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3719. void set_write_timeout(time_t sec, time_t usec = 0);
  3720. template <class Rep, class Period>
  3721. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3722. void set_websocket_ping_interval(time_t sec);
  3723. void set_websocket_max_missed_pongs(int count);
  3724. void set_tcp_nodelay(bool on);
  3725. void set_address_family(int family);
  3726. void set_ipv6_v6only(bool on);
  3727. void set_socket_options(SocketOptions socket_options);
  3728. void set_connection_timeout(time_t sec, time_t usec = 0);
  3729. template <class Rep, class Period>
  3730. void
  3731. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3732. void set_interface(const std::string &intf);
  3733. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3734. #ifdef CPPHTTPLIB_SSL_ENABLED
  3735. struct PemMemory {
  3736. const char *cert_pem;
  3737. size_t cert_pem_len;
  3738. const char *key_pem;
  3739. size_t key_pem_len;
  3740. const char *private_key_password;
  3741. };
  3742. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3743. const PemMemory &pem, const Headers &headers = {});
  3744. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3745. const std::string &ca_cert_dir_path = std::string());
  3746. void set_ca_cert_store(tls::ca_store_t store);
  3747. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3748. void enable_server_certificate_verification(bool enabled);
  3749. void enable_server_hostname_verification(bool enabled);
  3750. void enable_system_ca(bool enabled);
  3751. #endif
  3752. private:
  3753. void shutdown_and_close();
  3754. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3755. int &ssl_error, uint64_t &ssl_backend_error);
  3756. void prepare_default_headers(Request &req);
  3757. std::string host_;
  3758. int port_;
  3759. std::string path_;
  3760. Headers headers_;
  3761. std::string subprotocol_;
  3762. bool is_valid_ = false;
  3763. socket_t sock_ = INVALID_SOCKET;
  3764. std::unique_ptr<WebSocket> ws_;
  3765. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3766. time_t read_timeout_usec_ = 0;
  3767. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3768. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3769. time_t websocket_ping_interval_sec_ =
  3770. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3771. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3772. int address_family_ = AF_UNSPEC;
  3773. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3774. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3775. SocketOptions socket_options_ = nullptr;
  3776. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3777. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3778. std::string interface_;
  3779. // Hostname to connection target map. The value is an IP literal or another
  3780. // hostname; only the connection target changes, never the identity.
  3781. std::map<std::string, std::string> addr_map_;
  3782. #ifdef CPPHTTPLIB_SSL_ENABLED
  3783. bool is_ssl_ = false;
  3784. tls::ctx_t tls_ctx_ = nullptr;
  3785. tls::session_t tls_session_ = nullptr;
  3786. std::string ca_cert_file_path_;
  3787. std::string ca_cert_dir_path_;
  3788. bool custom_ca_loaded_ = false;
  3789. bool certs_loaded_ = false;
  3790. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3791. bool server_certificate_verification_ = true;
  3792. bool server_hostname_verification_ = true;
  3793. #endif
  3794. };
  3795. template <class Rep, class Period>
  3796. inline void WebSocket::set_read_timeout(
  3797. const std::chrono::duration<Rep, Period> &duration) {
  3798. detail::duration_to_sec_and_usec(
  3799. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3800. }
  3801. template <class Rep, class Period>
  3802. inline void WebSocketClient::set_read_timeout(
  3803. const std::chrono::duration<Rep, Period> &duration) {
  3804. detail::duration_to_sec_and_usec(
  3805. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3806. }
  3807. template <class Rep, class Period>
  3808. inline void WebSocketClient::set_write_timeout(
  3809. const std::chrono::duration<Rep, Period> &duration) {
  3810. detail::duration_to_sec_and_usec(
  3811. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3812. }
  3813. template <class Rep, class Period>
  3814. inline void WebSocketClient::set_connection_timeout(
  3815. const std::chrono::duration<Rep, Period> &duration) {
  3816. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3817. set_connection_timeout(sec, usec);
  3818. });
  3819. }
  3820. namespace impl {
  3821. bool is_valid_utf8(const std::string &s);
  3822. // Three states, because a failure that consumed bytes and one that consumed
  3823. // none are not the same thing: the first has left the stream in the middle of
  3824. // a frame and the connection cannot be reused, the second can just be retried.
  3825. enum class FrameRead { Ok, Fail, Timeout };
  3826. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3827. std::string &payload, bool &fin,
  3828. bool expect_masked, size_t max_len);
  3829. } // namespace impl
  3830. } // namespace ws
  3831. // ----------------------------------------------------------------------------
  3832. /*
  3833. * Implementation that will be part of the .cc file if split into .h + .cc.
  3834. */
  3835. namespace stream {
  3836. // stream::Result implementations
  3837. inline Result::Result() : chunk_size_(8192) {}
  3838. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3839. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3840. inline Result::Result(Result &&other) noexcept
  3841. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3842. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3843. finished_(other.finished_) {
  3844. other.current_size_ = 0;
  3845. other.finished_ = true;
  3846. }
  3847. inline Result &Result::operator=(Result &&other) noexcept {
  3848. if (this != &other) {
  3849. handle_ = std::move(other.handle_);
  3850. buffer_ = std::move(other.buffer_);
  3851. current_size_ = other.current_size_;
  3852. chunk_size_ = other.chunk_size_;
  3853. finished_ = other.finished_;
  3854. other.current_size_ = 0;
  3855. other.finished_ = true;
  3856. }
  3857. return *this;
  3858. }
  3859. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3860. inline Result::operator bool() const { return is_valid(); }
  3861. inline int Result::status() const {
  3862. return handle_.response ? handle_.response->status : -1;
  3863. }
  3864. inline const Headers &Result::headers() const {
  3865. static const Headers empty_headers;
  3866. return handle_.response ? handle_.response->headers : empty_headers;
  3867. }
  3868. inline std::string Result::get_header_value(const std::string &key,
  3869. const char *def) const {
  3870. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3871. }
  3872. inline bool Result::has_header(const std::string &key) const {
  3873. return handle_.response ? handle_.response->has_header(key) : false;
  3874. }
  3875. inline Error Result::error() const { return handle_.error; }
  3876. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3877. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3878. inline bool Result::next() {
  3879. if (!handle_.is_valid() || finished_) { return false; }
  3880. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3881. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3882. if (n > 0) {
  3883. current_size_ = static_cast<size_t>(n);
  3884. return true;
  3885. }
  3886. current_size_ = 0;
  3887. finished_ = true;
  3888. return false;
  3889. }
  3890. inline const char *Result::data() const { return buffer_.data(); }
  3891. inline size_t Result::size() const { return current_size_; }
  3892. inline std::string Result::read_all() {
  3893. std::string result;
  3894. while (next()) {
  3895. result.append(data(), size());
  3896. }
  3897. return result;
  3898. }
  3899. } // namespace stream
  3900. namespace sse {
  3901. // SSEMessage implementations
  3902. inline SSEMessage::SSEMessage() : event("message") {}
  3903. inline void SSEMessage::clear() {
  3904. event = "message";
  3905. data.clear();
  3906. id.clear();
  3907. }
  3908. // SSEClient implementations
  3909. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3910. : client_(client), path_(path) {}
  3911. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3912. const Headers &headers)
  3913. : client_(client), path_(path), headers_(headers) {}
  3914. inline SSEClient::~SSEClient() { stop(); }
  3915. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3916. on_message_ = std::move(handler);
  3917. return *this;
  3918. }
  3919. inline SSEClient &SSEClient::on_event(const std::string &type,
  3920. MessageHandler handler) {
  3921. event_handlers_[type] = std::move(handler);
  3922. return *this;
  3923. }
  3924. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3925. on_open_ = std::move(handler);
  3926. return *this;
  3927. }
  3928. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3929. on_error_ = std::move(handler);
  3930. return *this;
  3931. }
  3932. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3933. reconnect_interval_ms_ = ms;
  3934. return *this;
  3935. }
  3936. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3937. max_reconnect_attempts_ = n;
  3938. return *this;
  3939. }
  3940. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  3941. std::lock_guard<std::mutex> lock(headers_mutex_);
  3942. headers_ = headers;
  3943. return *this;
  3944. }
  3945. inline bool SSEClient::is_connected() const { return connected_.load(); }
  3946. inline const std::string &SSEClient::last_event_id() const {
  3947. return last_event_id_;
  3948. }
  3949. inline void SSEClient::start() {
  3950. running_.store(true);
  3951. run_event_loop();
  3952. }
  3953. inline void SSEClient::start_async() {
  3954. running_.store(true);
  3955. async_thread_ = std::thread([this]() { run_event_loop(); });
  3956. }
  3957. inline void SSEClient::stop() {
  3958. running_.store(false);
  3959. client_.stop(); // Cancel any pending operations
  3960. if (async_thread_.joinable()) { async_thread_.join(); }
  3961. }
  3962. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  3963. int &retry_ms) {
  3964. // Blank line signals end of event
  3965. if (line.empty() || line == "\r") { return true; }
  3966. // Lines starting with ':' are comments (ignored)
  3967. if (!line.empty() && line[0] == ':') { return false; }
  3968. // Find the colon separator
  3969. auto colon_pos = line.find(':');
  3970. if (colon_pos == std::string::npos) {
  3971. // Line with no colon is treated as field name with empty value
  3972. return false;
  3973. }
  3974. auto field = line.substr(0, colon_pos);
  3975. std::string value;
  3976. // Value starts after colon, skip optional single space
  3977. if (colon_pos + 1 < line.size()) {
  3978. auto value_start = colon_pos + 1;
  3979. if (line[value_start] == ' ') { value_start++; }
  3980. value = line.substr(value_start);
  3981. // Remove trailing \r if present
  3982. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  3983. }
  3984. // Handle known fields
  3985. if (field == "event") {
  3986. msg.event = value;
  3987. } else if (field == "data") {
  3988. // Multiple data lines are concatenated with newlines
  3989. if (!msg.data.empty()) { msg.data += "\n"; }
  3990. msg.data += value;
  3991. } else if (field == "id") {
  3992. // Empty id is valid (clears the last event ID)
  3993. msg.id = value;
  3994. } else if (field == "retry") {
  3995. // Parse retry interval in milliseconds
  3996. {
  3997. int v = 0;
  3998. auto res =
  3999. detail::from_chars(value.data(), value.data() + value.size(), v);
  4000. if (res.ec == std::errc{}) { retry_ms = v; }
  4001. }
  4002. }
  4003. // Unknown fields are ignored per SSE spec
  4004. return false;
  4005. }
  4006. inline void SSEClient::run_event_loop() {
  4007. auto reconnect_count = 0;
  4008. while (running_.load()) {
  4009. // Build headers, including Last-Event-ID if we have one
  4010. Headers request_headers;
  4011. {
  4012. std::lock_guard<std::mutex> lock(headers_mutex_);
  4013. request_headers = headers_;
  4014. }
  4015. if (!last_event_id_.empty()) {
  4016. request_headers.emplace("Last-Event-ID", last_event_id_);
  4017. }
  4018. // Open streaming connection
  4019. auto result = stream::Get(client_, path_, request_headers);
  4020. // Connection error handling
  4021. if (!result) {
  4022. connected_.store(false);
  4023. if (on_error_) { on_error_(result.error()); }
  4024. if (!should_reconnect(reconnect_count)) { break; }
  4025. wait_for_reconnect();
  4026. reconnect_count++;
  4027. continue;
  4028. }
  4029. if (result.status() != StatusCode::OK_200) {
  4030. connected_.store(false);
  4031. if (on_error_) { on_error_(Error::Connection); }
  4032. // For certain errors, don't reconnect.
  4033. // Note: 401 is intentionally absent so that handlers can refresh
  4034. // credentials via set_headers() and let the client reconnect.
  4035. if (result.status() == StatusCode::NoContent_204 ||
  4036. result.status() == StatusCode::NotFound_404 ||
  4037. result.status() == StatusCode::Forbidden_403) {
  4038. break;
  4039. }
  4040. if (!should_reconnect(reconnect_count)) { break; }
  4041. wait_for_reconnect();
  4042. reconnect_count++;
  4043. continue;
  4044. }
  4045. // Connection successful
  4046. connected_.store(true);
  4047. reconnect_count = 0;
  4048. if (on_open_) { on_open_(); }
  4049. // Event receiving loop
  4050. std::string buffer;
  4051. SSEMessage current_msg;
  4052. while (running_.load() && result.next()) {
  4053. buffer.append(result.data(), result.size());
  4054. // Process complete lines in the buffer
  4055. size_t line_start = 0;
  4056. size_t newline_pos;
  4057. while ((newline_pos = buffer.find('\n', line_start)) !=
  4058. std::string::npos) {
  4059. auto line = buffer.substr(line_start, newline_pos - line_start);
  4060. line_start = newline_pos + 1;
  4061. // Parse the line and check if event is complete
  4062. auto event_complete =
  4063. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  4064. if (event_complete && !current_msg.data.empty()) {
  4065. // Update last_event_id for reconnection
  4066. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4067. // Dispatch event to appropriate handler
  4068. dispatch_event(current_msg);
  4069. current_msg.clear();
  4070. }
  4071. }
  4072. // Keep unprocessed data in buffer
  4073. buffer.erase(0, line_start);
  4074. }
  4075. // Connection ended
  4076. connected_.store(false);
  4077. if (!running_.load()) { break; }
  4078. // Check for read errors
  4079. if (result.has_read_error()) {
  4080. if (on_error_) { on_error_(result.read_error()); }
  4081. }
  4082. if (!should_reconnect(reconnect_count)) { break; }
  4083. wait_for_reconnect();
  4084. reconnect_count++;
  4085. }
  4086. connected_.store(false);
  4087. }
  4088. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4089. // Check for specific event type handler first
  4090. auto it = event_handlers_.find(msg.event);
  4091. if (it != event_handlers_.end()) {
  4092. it->second(msg);
  4093. return;
  4094. }
  4095. // Fall back to generic message handler
  4096. if (on_message_) { on_message_(msg); }
  4097. }
  4098. inline bool SSEClient::should_reconnect(int count) const {
  4099. if (!running_.load()) { return false; }
  4100. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4101. return count < max_reconnect_attempts_;
  4102. }
  4103. inline void SSEClient::wait_for_reconnect() {
  4104. // Use small increments to check running_ flag frequently
  4105. auto waited = 0;
  4106. while (running_.load() && waited < reconnect_interval_ms_) {
  4107. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  4108. waited += 100;
  4109. }
  4110. }
  4111. } // namespace sse
  4112. #ifdef CPPHTTPLIB_SSL_ENABLED
  4113. /*
  4114. * TLS abstraction layer - internal function declarations
  4115. * These are implementation details and not part of the public API.
  4116. */
  4117. namespace tls {
  4118. // Client context
  4119. ctx_t create_client_context();
  4120. void free_context(ctx_t ctx);
  4121. bool set_min_version(ctx_t ctx, Version version);
  4122. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4123. bool load_ca_file(ctx_t ctx, const char *file_path);
  4124. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4125. bool load_system_certs(ctx_t ctx);
  4126. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4127. const char *password);
  4128. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4129. const char *key_path, const char *password);
  4130. // Server context
  4131. ctx_t create_server_context();
  4132. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4133. const char *password);
  4134. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4135. const char *key_path, const char *password);
  4136. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4137. void set_verify_client(ctx_t ctx, bool require);
  4138. // Session management
  4139. session_t create_session(ctx_t ctx, socket_t sock);
  4140. void free_session(session_t session);
  4141. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4142. // Handshake (non-blocking capable)
  4143. TlsError connect(session_t session);
  4144. TlsError accept(session_t session);
  4145. // Handshake with timeout (blocking until timeout)
  4146. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4147. time_t timeout_usec, TlsError *err);
  4148. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4149. time_t timeout_usec, TlsError *err);
  4150. // I/O (non-blocking capable)
  4151. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4152. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4153. int pending(const_session_t session);
  4154. void shutdown(session_t session, bool graceful);
  4155. // Connection state
  4156. bool is_peer_closed(session_t session, socket_t sock);
  4157. // Certificate verification
  4158. cert_t get_peer_cert(const_session_t session);
  4159. void free_cert(cert_t cert);
  4160. bool verify_hostname(cert_t cert, const char *hostname);
  4161. uint64_t hostname_mismatch_code();
  4162. long get_verify_result(const_session_t session);
  4163. // Certificate introspection
  4164. std::string get_cert_subject_cn(cert_t cert);
  4165. std::string get_cert_issuer_name(cert_t cert);
  4166. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4167. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4168. std::string get_cert_serial(cert_t cert);
  4169. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4170. const char *get_sni(const_session_t session);
  4171. // CA store management
  4172. ca_store_t create_ca_store(const char *pem, size_t len);
  4173. void free_ca_store(ca_store_t store);
  4174. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4175. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4176. std::vector<std::string> get_ca_names(ctx_t ctx);
  4177. // Dynamic certificate update (for servers)
  4178. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4179. const char *password);
  4180. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4181. // Certificate verification callback
  4182. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4183. long get_verify_error(const_session_t session);
  4184. std::string verify_error_string(long error_code);
  4185. // TlsError information
  4186. uint64_t peek_error();
  4187. uint64_t get_error();
  4188. std::string error_string(uint64_t code);
  4189. } // namespace tls
  4190. #endif // CPPHTTPLIB_SSL_ENABLED
  4191. /*
  4192. * Group 1: detail namespace - Non-SSL utilities
  4193. */
  4194. namespace detail {
  4195. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4196. const void *optval, socklen_t optlen) {
  4197. return setsockopt(sock, level, optname,
  4198. #ifdef _WIN32
  4199. reinterpret_cast<const char *>(optval),
  4200. #else
  4201. optval,
  4202. #endif
  4203. optlen) == 0;
  4204. }
  4205. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4206. time_t sec, time_t usec) {
  4207. #ifdef _WIN32
  4208. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4209. #else
  4210. timeval timeout;
  4211. timeout.tv_sec = static_cast<long>(sec);
  4212. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4213. #endif
  4214. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4215. }
  4216. inline bool is_hex(char c, int &v) {
  4217. if (is_ascii_digit(c)) {
  4218. v = c - '0';
  4219. return true;
  4220. } else if ('A' <= c && c <= 'F') {
  4221. v = c - 'A' + 10;
  4222. return true;
  4223. } else if ('a' <= c && c <= 'f') {
  4224. v = c - 'a' + 10;
  4225. return true;
  4226. }
  4227. return false;
  4228. }
  4229. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4230. int &val) {
  4231. if (i >= s.size()) { return false; }
  4232. val = 0;
  4233. for (; cnt; i++, cnt--) {
  4234. if (!s[i]) { return false; }
  4235. auto v = 0;
  4236. if (is_hex(s[i], v)) {
  4237. val = val * 16 + v;
  4238. } else {
  4239. return false;
  4240. }
  4241. }
  4242. return true;
  4243. }
  4244. inline std::string from_i_to_hex(size_t n) {
  4245. static const auto charset = "0123456789abcdef";
  4246. std::string ret;
  4247. do {
  4248. ret = charset[n & 15] + ret;
  4249. n >>= 4;
  4250. } while (n > 0);
  4251. return ret;
  4252. }
  4253. inline std::string compute_etag(const FileStat &fs,
  4254. const std::string &suffix = std::string()) {
  4255. if (!fs.is_file()) { return std::string(); }
  4256. // If mtime cannot be determined (negative value indicates an error
  4257. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4258. // value like 0 could collide with a real file that legitimately has
  4259. // mtime == 0 (epoch) and lead to misleading validators.
  4260. auto mtime_raw = fs.mtime();
  4261. if (mtime_raw < 0) { return std::string(); }
  4262. auto mtime = static_cast<size_t>(mtime_raw);
  4263. auto size = fs.size();
  4264. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4265. from_i_to_hex(size) + suffix + "\"";
  4266. }
  4267. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4268. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4269. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4270. inline std::string file_mtime_to_http_date(time_t mtime) {
  4271. if (mtime < 0) { return std::string(); }
  4272. struct tm tm_buf;
  4273. #ifdef _WIN32
  4274. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4275. #else
  4276. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4277. #endif
  4278. char buf[64];
  4279. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4280. return std::string();
  4281. }
  4282. return std::string(buf);
  4283. }
  4284. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4285. inline time_t parse_http_date(const std::string &date_str) {
  4286. struct tm tm_buf;
  4287. // Create a classic locale object once for all parsing attempts
  4288. const std::locale classic_locale = std::locale::classic();
  4289. // Try to parse using std::get_time (C++11, cross-platform)
  4290. auto try_parse = [&](const char *fmt) -> bool {
  4291. std::istringstream ss(date_str);
  4292. ss.imbue(classic_locale);
  4293. memset(&tm_buf, 0, sizeof(tm_buf));
  4294. ss >> std::get_time(&tm_buf, fmt);
  4295. return !ss.fail();
  4296. };
  4297. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4298. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4299. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4300. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4301. // asctime format: "Sun Nov 6 08:49:37 1994"
  4302. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4303. return static_cast<time_t>(-1);
  4304. }
  4305. }
  4306. }
  4307. #ifdef _WIN32
  4308. return _mkgmtime(&tm_buf);
  4309. #elif defined _AIX
  4310. return mktime(&tm_buf);
  4311. #else
  4312. return timegm(&tm_buf);
  4313. #endif
  4314. }
  4315. inline bool is_weak_etag(const std::string &s) {
  4316. // Check if the string is a weak ETag (starts with 'W/"')
  4317. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4318. }
  4319. inline bool is_strong_etag(const std::string &s) {
  4320. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4321. // chars)
  4322. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4323. }
  4324. inline size_t to_utf8(int code, char *buff) {
  4325. if (code < 0x0080) {
  4326. buff[0] = static_cast<char>(code & 0x7F);
  4327. return 1;
  4328. } else if (code < 0x0800) {
  4329. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4330. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4331. return 2;
  4332. } else if (code < 0xD800) {
  4333. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4334. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4335. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4336. return 3;
  4337. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4338. return 0;
  4339. } else if (code < 0x10000) {
  4340. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4341. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4342. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4343. return 3;
  4344. } else if (code < 0x110000) {
  4345. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4346. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4347. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4348. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4349. return 4;
  4350. }
  4351. // NOTREACHED
  4352. return 0;
  4353. }
  4354. } // namespace detail
  4355. namespace ws {
  4356. namespace impl {
  4357. inline bool is_valid_utf8(const std::string &s) {
  4358. size_t i = 0;
  4359. auto n = s.size();
  4360. while (i < n) {
  4361. auto c = static_cast<unsigned char>(s[i]);
  4362. size_t len;
  4363. uint32_t cp;
  4364. if (c < 0x80) {
  4365. i++;
  4366. continue;
  4367. } else if ((c & 0xE0) == 0xC0) {
  4368. len = 2;
  4369. cp = c & 0x1F;
  4370. } else if ((c & 0xF0) == 0xE0) {
  4371. len = 3;
  4372. cp = c & 0x0F;
  4373. } else if ((c & 0xF8) == 0xF0) {
  4374. len = 4;
  4375. cp = c & 0x07;
  4376. } else {
  4377. return false;
  4378. }
  4379. if (i + len > n) { return false; }
  4380. for (size_t j = 1; j < len; j++) {
  4381. auto b = static_cast<unsigned char>(s[i + j]);
  4382. if ((b & 0xC0) != 0x80) { return false; }
  4383. cp = (cp << 6) | (b & 0x3F);
  4384. }
  4385. // Overlong encoding check
  4386. if (len == 2 && cp < 0x80) { return false; }
  4387. if (len == 3 && cp < 0x800) { return false; }
  4388. if (len == 4 && cp < 0x10000) { return false; }
  4389. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4390. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4391. if (cp > 0x10FFFF) { return false; }
  4392. i += len;
  4393. }
  4394. return true;
  4395. }
  4396. } // namespace impl
  4397. } // namespace ws
  4398. namespace detail {
  4399. // NOTE: This code came up with the following stackoverflow post:
  4400. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4401. inline std::string base64_encode(const std::string &in) {
  4402. static const auto lookup =
  4403. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4404. std::string out;
  4405. out.reserve(in.size());
  4406. // Unsigned: the accumulator is never masked, so with a signed int the
  4407. // `val << 8` below overflows once enough bytes are folded in (undefined
  4408. // behaviour before C++20). Only the low bits are ever emitted, so the
  4409. // wrap-around of an unsigned accumulator does not affect the output.
  4410. uint32_t val = 0;
  4411. auto valb = -6;
  4412. for (auto c : in) {
  4413. val = (val << 8) + static_cast<uint8_t>(c);
  4414. valb += 8;
  4415. while (valb >= 0) {
  4416. out.push_back(lookup[(val >> valb) & 0x3F]);
  4417. valb -= 6;
  4418. }
  4419. }
  4420. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4421. while (out.size() % 4) {
  4422. out.push_back('=');
  4423. }
  4424. return out;
  4425. }
  4426. inline std::string sha1(const std::string &input) {
  4427. // RFC 3174 SHA-1 implementation
  4428. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4429. return (x << n) | (x >> (32 - n));
  4430. };
  4431. uint32_t h0 = 0x67452301;
  4432. uint32_t h1 = 0xEFCDAB89;
  4433. uint32_t h2 = 0x98BADCFE;
  4434. uint32_t h3 = 0x10325476;
  4435. uint32_t h4 = 0xC3D2E1F0;
  4436. // Pre-processing: adding padding bits
  4437. std::string msg = input;
  4438. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4439. msg.push_back(static_cast<char>(0x80u));
  4440. while (msg.size() % 64 != 56) {
  4441. msg.push_back(0);
  4442. }
  4443. // Append original length in bits as 64-bit big-endian
  4444. for (int i = 56; i >= 0; i -= 8) {
  4445. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4446. }
  4447. // Process each 512-bit chunk
  4448. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4449. uint32_t w[80];
  4450. for (size_t i = 0; i < 16; i++) {
  4451. w[i] =
  4452. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4453. << 24) |
  4454. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4455. << 16) |
  4456. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4457. << 8) |
  4458. (static_cast<uint32_t>(
  4459. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4460. }
  4461. for (int i = 16; i < 80; i++) {
  4462. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4463. }
  4464. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4465. for (int i = 0; i < 80; i++) {
  4466. uint32_t f, k;
  4467. if (i < 20) {
  4468. f = (b & c) | ((~b) & d);
  4469. k = 0x5A827999;
  4470. } else if (i < 40) {
  4471. f = b ^ c ^ d;
  4472. k = 0x6ED9EBA1;
  4473. } else if (i < 60) {
  4474. f = (b & c) | (b & d) | (c & d);
  4475. k = 0x8F1BBCDC;
  4476. } else {
  4477. f = b ^ c ^ d;
  4478. k = 0xCA62C1D6;
  4479. }
  4480. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4481. e = d;
  4482. d = c;
  4483. c = left_rotate(b, 30);
  4484. b = a;
  4485. a = temp;
  4486. }
  4487. h0 += a;
  4488. h1 += b;
  4489. h2 += c;
  4490. h3 += d;
  4491. h4 += e;
  4492. }
  4493. // Produce the final hash as a 20-byte binary string
  4494. std::string hash(20, '\0');
  4495. for (size_t i = 0; i < 4; i++) {
  4496. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4497. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4498. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4499. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4500. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4501. }
  4502. return hash;
  4503. }
  4504. inline std::string websocket_accept_key(const std::string &client_key) {
  4505. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4506. return base64_encode(sha1(client_key + magic));
  4507. }
  4508. inline bool is_websocket_upgrade(const Request &req) {
  4509. if (req.method != "GET") { return false; }
  4510. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4511. // list of protocols and asks recipients to match each name
  4512. // case-insensitively, so look for the token rather than compare the whole
  4513. // field value.
  4514. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4515. // Check Connection: Upgrade
  4516. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4517. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4518. // RFC 6455 Section 4.2.1
  4519. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4520. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4521. return false;
  4522. }
  4523. static const std::string b64chars =
  4524. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4525. for (size_t i = 0; i < 22; i++) {
  4526. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4527. }
  4528. // Check Sec-WebSocket-Version: 13
  4529. auto version = req.get_header_value("Sec-WebSocket-Version");
  4530. if (version != "13") { return false; }
  4531. return true;
  4532. }
  4533. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4534. const char *data, size_t len, bool fin,
  4535. bool mask) {
  4536. // First byte: FIN + opcode
  4537. uint8_t header[2];
  4538. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4539. (static_cast<uint8_t>(opcode) & 0x0F));
  4540. // Second byte: MASK + payload length
  4541. if (len < 126) {
  4542. header[1] = static_cast<uint8_t>(len);
  4543. if (mask) { header[1] |= 0x80; }
  4544. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4545. } else if (len <= 0xFFFF) {
  4546. header[1] = 126;
  4547. if (mask) { header[1] |= 0x80; }
  4548. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4549. uint8_t ext[2];
  4550. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4551. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4552. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4553. } else {
  4554. header[1] = 127;
  4555. if (mask) { header[1] |= 0x80; }
  4556. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4557. uint8_t ext[8];
  4558. for (int i = 7; i >= 0; i--) {
  4559. ext[7 - i] =
  4560. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4561. }
  4562. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4563. }
  4564. if (mask) {
  4565. // Generate random mask key
  4566. thread_local std::mt19937 rng(std::random_device{}());
  4567. uint8_t mask_key[4];
  4568. auto r = rng();
  4569. std::memcpy(mask_key, &r, 4);
  4570. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4571. // Write masked payload in chunks
  4572. const size_t chunk_size = 4096;
  4573. std::vector<char> buf((std::min)(len, chunk_size));
  4574. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4575. size_t n = (std::min)(chunk_size, len - offset);
  4576. for (size_t i = 0; i < n; i++) {
  4577. buf[i] =
  4578. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4579. }
  4580. if (strm.write(buf.data(), n) < 0) { return false; }
  4581. }
  4582. } else {
  4583. if (len > 0) {
  4584. if (strm.write(data, len) < 0) { return false; }
  4585. }
  4586. }
  4587. return true;
  4588. }
  4589. } // namespace detail
  4590. namespace ws {
  4591. namespace impl {
  4592. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4593. // hands back whatever its buffer already holds -- so every multi-byte field has
  4594. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4595. // header straddles the read buffer's boundary.
  4596. //
  4597. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4598. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4599. // there is a failure like any other. (When read() fails it always records why,
  4600. // so the error belongs to this call and not to an earlier one.)
  4601. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4602. auto p = static_cast<char *>(buf);
  4603. size_t total = 0;
  4604. while (total < size) {
  4605. auto n = strm.read(p + total, size - total);
  4606. if (n <= 0) {
  4607. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4608. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4609. }
  4610. total += static_cast<size_t>(n);
  4611. }
  4612. return FrameRead::Ok;
  4613. }
  4614. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4615. std::string &payload, bool &fin,
  4616. bool expect_masked, size_t max_len) {
  4617. // Read first 2 bytes. This is the only read that may report a timeout: it
  4618. // sits on a frame boundary, where nothing has been consumed yet.
  4619. uint8_t header[2];
  4620. FrameRead first = read_exact(strm, header, 2);
  4621. if (first != FrameRead::Ok) { return first; }
  4622. fin = (header[0] & 0x80) != 0;
  4623. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4624. if (header[0] & 0x70) { return FrameRead::Fail; }
  4625. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4626. bool masked = (header[1] & 0x80) != 0;
  4627. uint64_t payload_len = header[1] & 0x7F;
  4628. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4629. // MUST have a payload length of 125 bytes or less
  4630. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4631. if (is_control) {
  4632. if (!fin) { return FrameRead::Fail; }
  4633. if (payload_len > 125) { return FrameRead::Fail; }
  4634. }
  4635. if (masked != expect_masked) { return FrameRead::Fail; }
  4636. // Extended payload length
  4637. if (payload_len == 126) {
  4638. uint8_t ext[2];
  4639. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4640. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4641. } else if (payload_len == 127) {
  4642. uint8_t ext[8];
  4643. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4644. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4645. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4646. payload_len = 0;
  4647. for (int i = 0; i < 8; i++) {
  4648. payload_len = (payload_len << 8) | ext[i];
  4649. }
  4650. }
  4651. if (payload_len > max_len) { return FrameRead::Fail; }
  4652. // Read mask key if present
  4653. uint8_t mask_key[4] = {0};
  4654. if (masked) {
  4655. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4656. return FrameRead::Fail;
  4657. }
  4658. }
  4659. // Read payload
  4660. payload.resize(static_cast<size_t>(payload_len));
  4661. if (payload_len > 0 &&
  4662. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4663. FrameRead::Ok) {
  4664. return FrameRead::Fail;
  4665. }
  4666. // Unmask if needed
  4667. if (masked) {
  4668. for (size_t i = 0; i < payload.size(); i++) {
  4669. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4670. }
  4671. }
  4672. return FrameRead::Ok;
  4673. }
  4674. } // namespace impl
  4675. } // namespace ws
  4676. namespace detail {
  4677. inline bool is_valid_path(const std::string &path) {
  4678. size_t level = 0;
  4679. size_t i = 0;
  4680. // Skip slash
  4681. while (i < path.size() && path[i] == '/') {
  4682. i++;
  4683. }
  4684. while (i < path.size()) {
  4685. // Read component
  4686. auto beg = i;
  4687. while (i < path.size() && path[i] != '/') {
  4688. if (path[i] == '\0') {
  4689. return false;
  4690. } else if (path[i] == '\\') {
  4691. return false;
  4692. }
  4693. i++;
  4694. }
  4695. auto len = i - beg;
  4696. assert(len > 0);
  4697. if (!path.compare(beg, len, ".")) {
  4698. ;
  4699. } else if (!path.compare(beg, len, "..")) {
  4700. if (level == 0) { return false; }
  4701. level--;
  4702. } else {
  4703. level++;
  4704. }
  4705. // Skip slash
  4706. while (i < path.size() && path[i] == '/') {
  4707. i++;
  4708. }
  4709. }
  4710. return true;
  4711. }
  4712. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4713. #if defined(_WIN32)
  4714. char buf[_MAX_PATH];
  4715. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4716. resolved = buf;
  4717. #elif defined(PATH_MAX)
  4718. char buf[PATH_MAX];
  4719. if (realpath(path, buf) == nullptr) { return false; }
  4720. resolved = buf;
  4721. #else
  4722. auto buf = realpath(path, nullptr);
  4723. auto guard = scope_exit([&]() { std::free(buf); });
  4724. if (buf == nullptr) { return false; }
  4725. resolved = buf;
  4726. #endif
  4727. return true;
  4728. }
  4729. inline bool is_path_within_base(const std::string &resolved_path,
  4730. const std::string &resolved_base) {
  4731. #if defined(_WIN32)
  4732. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4733. resolved_base.size()) == 0;
  4734. #else
  4735. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4736. resolved_base.size()) == 0;
  4737. #endif
  4738. }
  4739. inline FileStat::FileStat(const std::string &path) {
  4740. #if defined(_WIN32)
  4741. auto wpath = u8string_to_wstring(path.c_str());
  4742. ret_ = _wstat(wpath.c_str(), &st_);
  4743. #else
  4744. ret_ = stat(path.c_str(), &st_);
  4745. #endif
  4746. }
  4747. inline bool FileStat::is_file() const {
  4748. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4749. }
  4750. inline bool FileStat::is_dir() const {
  4751. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4752. }
  4753. inline time_t FileStat::mtime() const {
  4754. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4755. : static_cast<time_t>(-1);
  4756. }
  4757. inline size_t FileStat::size() const {
  4758. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4759. }
  4760. inline std::string encode_path(const std::string &s) {
  4761. std::string result;
  4762. result.reserve(s.size());
  4763. for (size_t i = 0; s[i]; i++) {
  4764. switch (s[i]) {
  4765. case ' ': result += "%20"; break;
  4766. case '+': result += "%2B"; break;
  4767. case '\r': result += "%0D"; break;
  4768. case '\n': result += "%0A"; break;
  4769. case '\'': result += "%27"; break;
  4770. case ',': result += "%2C"; break;
  4771. // case ':': result += "%3A"; break; // ok? probably...
  4772. case ';': result += "%3B"; break;
  4773. default:
  4774. auto c = static_cast<uint8_t>(s[i]);
  4775. if (c >= 0x80) {
  4776. result += '%';
  4777. char hex[4];
  4778. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4779. assert(len == 2);
  4780. result.append(hex, static_cast<size_t>(len));
  4781. } else {
  4782. result += s[i];
  4783. }
  4784. break;
  4785. }
  4786. }
  4787. return result;
  4788. }
  4789. inline std::string file_extension(const std::string &path) {
  4790. std::smatch m;
  4791. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4792. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4793. return std::string();
  4794. }
  4795. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4796. template <typename T>
  4797. inline bool parse_header(const char *beg, const char *end, T fn);
  4798. template <typename T>
  4799. inline bool parse_header(const char *beg, const char *end, T fn) {
  4800. // Skip trailing spaces and tabs.
  4801. while (beg < end && is_space_or_tab(end[-1])) {
  4802. end--;
  4803. }
  4804. auto p = beg;
  4805. while (p < end && *p != ':') {
  4806. p++;
  4807. }
  4808. auto name = std::string(beg, p);
  4809. if (!detail::fields::is_field_name(name)) { return false; }
  4810. if (p == end) { return false; }
  4811. auto key_end = p;
  4812. if (*p++ != ':') { return false; }
  4813. while (p < end && is_space_or_tab(*p)) {
  4814. p++;
  4815. }
  4816. if (p <= end) {
  4817. auto key_len = key_end - beg;
  4818. if (!key_len) { return false; }
  4819. auto key = std::string(beg, key_end);
  4820. auto val = std::string(p, end);
  4821. if (!detail::fields::is_field_value(val)) { return false; }
  4822. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4823. // percent-decoded by the recipient. Applications that need to interpret a
  4824. // value as a URI component should call httplib::decode_uri_component()
  4825. // (or decode_path_component()) explicitly.
  4826. fn(key, val);
  4827. return true;
  4828. }
  4829. return false;
  4830. }
  4831. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4832. const Headers &src_headers) {
  4833. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4834. // transfer coding is complete when a chunk with a chunk-size of zero is
  4835. // received, possibly followed by a trailer section, and finally terminated by
  4836. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4837. //
  4838. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4839. // doesn't care for the existence of the final CRLF. In other words, it seems
  4840. // to be ok whether the final CRLF exists or not in the chunked data.
  4841. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4842. //
  4843. // According to the reference code in RFC 9112, cpp-httplib now allows
  4844. // chunked transfer coding data without the final CRLF.
  4845. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4846. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4847. "transfer-encoding",
  4848. "content-length",
  4849. "host",
  4850. "authorization",
  4851. "www-authenticate",
  4852. "proxy-authenticate",
  4853. "proxy-authorization",
  4854. "cookie",
  4855. "set-cookie",
  4856. "cache-control",
  4857. "expect",
  4858. "max-forwards",
  4859. "pragma",
  4860. "range",
  4861. "te",
  4862. "age",
  4863. "expires",
  4864. "date",
  4865. "location",
  4866. "retry-after",
  4867. "vary",
  4868. "warning",
  4869. "content-encoding",
  4870. "content-type",
  4871. "content-range",
  4872. "trailer"};
  4873. case_ignore::unordered_set<std::string> declared_trailers;
  4874. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4875. if (!trailer_header.empty()) {
  4876. // split() trims each token and skips empty ones, so the name arrives ready
  4877. // to look up.
  4878. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4879. ',', [&](const char *b, const char *e) {
  4880. std::string key(b, e);
  4881. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4882. declared_trailers.insert(key);
  4883. }
  4884. });
  4885. }
  4886. size_t trailer_header_count = 0;
  4887. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4888. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4889. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4890. constexpr auto line_terminator_len = 2;
  4891. auto line_beg = line_reader.ptr();
  4892. auto line_end =
  4893. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4894. if (!parse_header(line_beg, line_end,
  4895. [&](const std::string &key, const std::string &val) {
  4896. if (declared_trailers.find(key) !=
  4897. declared_trailers.end()) {
  4898. dest.emplace(key, val);
  4899. trailer_header_count++;
  4900. }
  4901. })) {
  4902. return false;
  4903. }
  4904. if (!line_reader.getline()) { return false; }
  4905. }
  4906. return true;
  4907. }
  4908. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4909. size_t right) {
  4910. while (b + left < e && is_space_or_tab(b[left])) {
  4911. left++;
  4912. }
  4913. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4914. right--;
  4915. }
  4916. return std::make_pair(left, right);
  4917. }
  4918. inline std::string trim_copy(const std::string &s) {
  4919. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4920. return s.substr(r.first, r.second - r.first);
  4921. }
  4922. inline std::string trim_double_quotes_copy(const std::string &s) {
  4923. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4924. return s.substr(1, s.size() - 2);
  4925. }
  4926. return s;
  4927. }
  4928. inline void
  4929. divide(const char *data, std::size_t size, char d,
  4930. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4931. fn) {
  4932. const auto it = std::find(data, data + size, d);
  4933. const auto found = static_cast<std::size_t>(it != data + size);
  4934. const auto lhs_data = data;
  4935. const auto lhs_size = static_cast<std::size_t>(it - data);
  4936. const auto rhs_data = it + found;
  4937. const auto rhs_size = size - lhs_size - found;
  4938. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  4939. }
  4940. inline void
  4941. divide(const std::string &str, char d,
  4942. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4943. fn) {
  4944. divide(str.data(), str.size(), d, std::move(fn));
  4945. }
  4946. inline void split(const char *b, const char *e, char d,
  4947. std::function<void(const char *, const char *)> fn) {
  4948. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  4949. }
  4950. inline void split(const char *b, const char *e, char d, size_t m,
  4951. std::function<void(const char *, const char *)> fn) {
  4952. size_t i = 0;
  4953. size_t beg = 0;
  4954. size_t count = 1;
  4955. while (e ? (b + i < e) : (b[i] != '\0')) {
  4956. if (b[i] == d && count < m) {
  4957. auto r = trim(b, e, beg, i);
  4958. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4959. beg = i + 1;
  4960. count++;
  4961. }
  4962. i++;
  4963. }
  4964. if (i) {
  4965. auto r = trim(b, e, beg, i);
  4966. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4967. }
  4968. }
  4969. // Same contract as split(), except that a delimiter inside a quoted-string is
  4970. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  4971. // quoted-string, and ';' and '=' are legal characters inside one.
  4972. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  4973. std::function<void(const char *, const char *)> fn) {
  4974. size_t i = 0;
  4975. size_t beg = 0;
  4976. size_t count = 1;
  4977. auto in_quotes = false;
  4978. while (e ? (b + i < e) : (b[i] != '\0')) {
  4979. if (b[i] == '"') {
  4980. in_quotes = !in_quotes;
  4981. } else if (b[i] == d && !in_quotes && count < m) {
  4982. auto r = trim(b, e, beg, i);
  4983. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4984. beg = i + 1;
  4985. count++;
  4986. }
  4987. i++;
  4988. }
  4989. if (i) {
  4990. auto r = trim(b, e, beg, i);
  4991. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4992. }
  4993. }
  4994. inline void split_unquoted(const char *b, const char *e, char d,
  4995. std::function<void(const char *, const char *)> fn) {
  4996. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  4997. std::move(fn));
  4998. }
  4999. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5000. // key a token, so the first '=' is the separator even when the value is a
  5001. // quoted-string carrying more of them.
  5002. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5003. std::string &val) {
  5004. divide(
  5005. b, static_cast<std::size_t>(e - b), '=',
  5006. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5007. const auto kr = trim(kb, kb + klen, 0, klen);
  5008. key.assign(kb + kr.first, kb + kr.second);
  5009. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5010. val.assign(vb + vr.first, vb + vr.second);
  5011. });
  5012. }
  5013. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5014. std::function<bool(const char *, const char *)> fn) {
  5015. size_t i = 0;
  5016. size_t beg = 0;
  5017. size_t count = 1;
  5018. while (e ? (b + i < e) : (b[i] != '\0')) {
  5019. if (b[i] == d && count < m) {
  5020. auto r = trim(b, e, beg, i);
  5021. if (r.first < r.second) {
  5022. auto found = fn(&b[r.first], &b[r.second]);
  5023. if (found) { return true; }
  5024. }
  5025. beg = i + 1;
  5026. count++;
  5027. }
  5028. i++;
  5029. }
  5030. if (i) {
  5031. auto r = trim(b, e, beg, i);
  5032. if (r.first < r.second) {
  5033. auto found = fn(&b[r.first], &b[r.second]);
  5034. if (found) { return true; }
  5035. }
  5036. }
  5037. return false;
  5038. }
  5039. inline bool split_find(const char *b, const char *e, char d,
  5040. std::function<bool(const char *, const char *)> fn) {
  5041. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5042. std::move(fn));
  5043. }
  5044. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5045. size_t fixed_buffer_size)
  5046. : strm_(strm), fixed_buffer_(fixed_buffer),
  5047. fixed_buffer_size_(fixed_buffer_size) {}
  5048. inline const char *stream_line_reader::ptr() const {
  5049. if (growable_buffer_.empty()) {
  5050. return fixed_buffer_;
  5051. } else {
  5052. return growable_buffer_.data();
  5053. }
  5054. }
  5055. inline size_t stream_line_reader::size() const {
  5056. if (growable_buffer_.empty()) {
  5057. return fixed_buffer_used_size_;
  5058. } else {
  5059. return growable_buffer_.size();
  5060. }
  5061. }
  5062. inline bool stream_line_reader::end_with_crlf() const {
  5063. auto end = ptr() + size();
  5064. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5065. }
  5066. inline bool stream_line_reader::getline() {
  5067. fixed_buffer_used_size_ = 0;
  5068. growable_buffer_.clear();
  5069. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5070. char prev_byte = 0;
  5071. #endif
  5072. for (size_t i = 0;; i++) {
  5073. // Fast path: whatever the stream has already buffered can be scanned for
  5074. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5075. // call, a bounds check and a one-byte copy per character of the request.
  5076. size_t buffered_size = 0;
  5077. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5078. auto take = buffered_size;
  5079. auto terminated = false;
  5080. for (size_t at = 0; at < buffered_size;) {
  5081. auto nl = static_cast<const char *>(
  5082. memchr(buffered + at, '\n', buffered_size - at));
  5083. if (!nl) { break; }
  5084. auto pos = static_cast<size_t>(nl - buffered);
  5085. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5086. take = pos + 1;
  5087. terminated = true;
  5088. break;
  5089. #else
  5090. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5091. // be the last byte of an earlier chunk, hence prev_byte.
  5092. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5093. take = pos + 1;
  5094. terminated = true;
  5095. break;
  5096. }
  5097. at = pos + 1;
  5098. #endif
  5099. }
  5100. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5101. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5102. prev_byte = buffered[take - 1];
  5103. #endif
  5104. append(buffered, take);
  5105. strm_.consume_buffered(take);
  5106. i += take;
  5107. if (terminated) { return true; }
  5108. continue;
  5109. }
  5110. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5111. // Treat exceptionally long lines as an error to
  5112. // prevent infinite loops/memory exhaustion
  5113. return false;
  5114. }
  5115. char byte;
  5116. auto n = strm_.read(&byte, 1);
  5117. if (n < 0) {
  5118. return false;
  5119. } else if (n == 0) {
  5120. if (i == 0) {
  5121. return false;
  5122. } else {
  5123. break;
  5124. }
  5125. }
  5126. append(byte);
  5127. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5128. if (byte == '\n') { break; }
  5129. #else
  5130. if (prev_byte == '\r' && byte == '\n') { break; }
  5131. prev_byte = byte;
  5132. #endif
  5133. }
  5134. return true;
  5135. }
  5136. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5137. inline void stream_line_reader::append(const char *data, size_t size) {
  5138. // Once the line has outgrown the fixed buffer everything must keep going to
  5139. // the growable one, even if a later chunk would have fit. Without the
  5140. // emptiness check a short append after a long one would land in the fixed
  5141. // buffer, which ptr() and size() no longer look at, and be lost.
  5142. if (growable_buffer_.empty() &&
  5143. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5144. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5145. fixed_buffer_used_size_ += size;
  5146. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5147. } else {
  5148. // Unlike the per-character overload, this can be the very first append of
  5149. // the line, so the fixed buffer may hold nothing and carry no terminator
  5150. // yet. assign() takes an explicit length and does not need one.
  5151. if (growable_buffer_.empty()) {
  5152. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5153. }
  5154. growable_buffer_.append(data, size);
  5155. }
  5156. }
  5157. inline mmap::mmap(const char *path) { open(path); }
  5158. inline mmap::~mmap() { close(); }
  5159. inline bool mmap::open(const char *path) {
  5160. close();
  5161. #if defined(_WIN32)
  5162. auto wpath = u8string_to_wstring(path);
  5163. if (wpath.empty()) { return false; }
  5164. hFile_ =
  5165. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5166. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5167. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5168. LARGE_INTEGER size{};
  5169. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5170. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5171. // See:
  5172. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5173. if (static_cast<ULONGLONG>(size.QuadPart) >
  5174. (std::numeric_limits<decltype(size_)>::max)()) {
  5175. // `size_t` might be 32-bits, on 32-bits Windows.
  5176. return false;
  5177. }
  5178. size_ = static_cast<size_t>(size.QuadPart);
  5179. hMapping_ =
  5180. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5181. // Special treatment for an empty file...
  5182. if (hMapping_ == NULL && size_ == 0) {
  5183. close();
  5184. is_open_empty_file = true;
  5185. return true;
  5186. }
  5187. if (hMapping_ == NULL) {
  5188. close();
  5189. return false;
  5190. }
  5191. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5192. if (addr_ == nullptr) {
  5193. close();
  5194. return false;
  5195. }
  5196. #else
  5197. fd_ = ::open(path, O_RDONLY);
  5198. if (fd_ == -1) { return false; }
  5199. struct stat sb;
  5200. if (fstat(fd_, &sb) == -1) {
  5201. close();
  5202. return false;
  5203. }
  5204. size_ = static_cast<size_t>(sb.st_size);
  5205. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5206. // Special treatment for an empty file...
  5207. if (addr_ == MAP_FAILED && size_ == 0) {
  5208. close();
  5209. is_open_empty_file = true;
  5210. return false;
  5211. }
  5212. if (addr_ == MAP_FAILED) {
  5213. // Clear the sentinel before `close()`, since `is_open()` only checks
  5214. // `addr_` against nullptr and `munmap()` must not be called with it.
  5215. addr_ = nullptr;
  5216. close();
  5217. return false;
  5218. }
  5219. #endif
  5220. return true;
  5221. }
  5222. inline bool mmap::is_open() const {
  5223. return is_open_empty_file ? true : addr_ != nullptr;
  5224. }
  5225. inline size_t mmap::size() const { return size_; }
  5226. inline const char *mmap::data() const {
  5227. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5228. }
  5229. inline void mmap::close() {
  5230. #if defined(_WIN32)
  5231. if (addr_) {
  5232. ::UnmapViewOfFile(addr_);
  5233. addr_ = nullptr;
  5234. }
  5235. if (hMapping_) {
  5236. ::CloseHandle(hMapping_);
  5237. hMapping_ = NULL;
  5238. }
  5239. if (hFile_ != INVALID_HANDLE_VALUE) {
  5240. ::CloseHandle(hFile_);
  5241. hFile_ = INVALID_HANDLE_VALUE;
  5242. }
  5243. is_open_empty_file = false;
  5244. #else
  5245. if (addr_ != nullptr) {
  5246. munmap(addr_, size_);
  5247. addr_ = nullptr;
  5248. }
  5249. if (fd_ != -1) {
  5250. ::close(fd_);
  5251. fd_ = -1;
  5252. }
  5253. #endif
  5254. size_ = 0;
  5255. }
  5256. inline int close_socket(socket_t sock) noexcept {
  5257. #ifdef _WIN32
  5258. return closesocket(sock);
  5259. #else
  5260. return close(sock);
  5261. #endif
  5262. }
  5263. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5264. ssize_t res = 0;
  5265. while (true) {
  5266. res = fn();
  5267. if (res < 0 && errno == EINTR) {
  5268. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5269. continue;
  5270. }
  5271. break;
  5272. }
  5273. return res;
  5274. }
  5275. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5276. return handle_EINTR([&]() {
  5277. return recv(sock,
  5278. #ifdef _WIN32
  5279. static_cast<char *>(ptr), static_cast<int>(size),
  5280. #else
  5281. ptr, size,
  5282. #endif
  5283. flags);
  5284. });
  5285. }
  5286. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5287. int flags) {
  5288. return handle_EINTR([&]() {
  5289. return send(sock,
  5290. #ifdef _WIN32
  5291. static_cast<const char *>(ptr), static_cast<int>(size),
  5292. #else
  5293. ptr, size,
  5294. #endif
  5295. flags);
  5296. });
  5297. }
  5298. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5299. #ifdef _WIN32
  5300. return ::WSAPoll(fds, nfds, timeout);
  5301. #else
  5302. return ::poll(fds, nfds, timeout);
  5303. #endif
  5304. }
  5305. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5306. time_t usec) {
  5307. struct pollfd pfd;
  5308. pfd.fd = sock;
  5309. pfd.events = events;
  5310. pfd.revents = 0;
  5311. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5312. // "return immediately", which callers here rely on to probe a socket.
  5313. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5314. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5315. }
  5316. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5317. return select_impl(sock, POLLIN, sec, usec);
  5318. }
  5319. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5320. return select_impl(sock, POLLOUT, sec, usec);
  5321. }
  5322. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5323. time_t usec) {
  5324. struct pollfd pfd_read;
  5325. pfd_read.fd = sock;
  5326. pfd_read.events = POLLIN | POLLOUT;
  5327. pfd_read.revents = 0;
  5328. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5329. auto poll_res =
  5330. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5331. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5332. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5333. auto error = 0;
  5334. socklen_t len = sizeof(error);
  5335. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5336. reinterpret_cast<char *>(&error), &len);
  5337. auto successful = res >= 0 && !error;
  5338. return successful ? Error::Success : Error::Connection;
  5339. }
  5340. return Error::Connection;
  5341. }
  5342. inline bool is_socket_alive(socket_t sock) {
  5343. const auto val = detail::select_read(sock, 0, 0);
  5344. if (val == 0) {
  5345. return true;
  5346. } else if (val < 0 && errno == EBADF) {
  5347. return false;
  5348. }
  5349. char buf[1];
  5350. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5351. }
  5352. class SocketStream final : public Stream {
  5353. public:
  5354. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5355. time_t write_timeout_sec, time_t write_timeout_usec,
  5356. time_t max_timeout_msec = 0,
  5357. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5358. (std::chrono::steady_clock::time_point::min)());
  5359. ~SocketStream() override;
  5360. bool is_readable() const override;
  5361. bool wait_readable() const override;
  5362. bool wait_writable() const override;
  5363. bool is_peer_alive() const override;
  5364. ssize_t read(char *ptr, size_t size) override;
  5365. ssize_t write(const char *ptr, size_t size) override;
  5366. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5367. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5368. socket_t socket() const override;
  5369. time_t duration() const override;
  5370. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5371. const char *buffered_data(size_t &size) const override;
  5372. void consume_buffered(size_t size) override;
  5373. // The caller has just seen this socket become readable. Lets the next read
  5374. // skip its own readiness wait, which would otherwise ask the kernel a
  5375. // question that was answered a moment ago. Consumed by that read.
  5376. void set_readable_hint() { readable_hint_ = true; }
  5377. private:
  5378. bool ensure_readable();
  5379. socket_t sock_;
  5380. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5381. // thread while a read is in flight -- that is the point of it, for a caller
  5382. // holding one connection and wanting control back to send on it.
  5383. std::atomic<time_t> read_timeout_sec_;
  5384. std::atomic<time_t> read_timeout_usec_;
  5385. time_t write_timeout_sec_;
  5386. time_t write_timeout_usec_;
  5387. time_t max_timeout_msec_;
  5388. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5389. std::vector<char> read_buff_;
  5390. size_t read_buff_off_ = 0;
  5391. size_t read_buff_content_size_ = 0;
  5392. bool readable_hint_ = false;
  5393. static const size_t read_buff_size_ = 1024l * 4;
  5394. };
  5395. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5396. time_t keep_alive_timeout_sec) {
  5397. using namespace std::chrono;
  5398. const auto interval_usec =
  5399. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5400. // Avoid expensive `steady_clock::now()` call for the first time
  5401. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5402. const auto start = steady_clock::now() - microseconds{interval_usec};
  5403. const auto timeout = seconds{keep_alive_timeout_sec};
  5404. while (true) {
  5405. if (svr_sock == INVALID_SOCKET) {
  5406. break; // Server socket is closed
  5407. }
  5408. auto val = select_read(sock, 0, interval_usec);
  5409. if (val < 0) {
  5410. break; // Ssocket error
  5411. } else if (val == 0) {
  5412. if (steady_clock::now() - start > timeout) {
  5413. break; // Timeout
  5414. }
  5415. } else {
  5416. return true; // Ready for read
  5417. }
  5418. }
  5419. return false;
  5420. }
  5421. template <typename T>
  5422. inline bool
  5423. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5424. size_t keep_alive_max_count,
  5425. time_t keep_alive_timeout_sec, T callback) {
  5426. assert(keep_alive_max_count > 0);
  5427. auto ret = false;
  5428. auto count = keep_alive_max_count;
  5429. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5430. auto close_connection = count == 1;
  5431. auto connection_closed = false;
  5432. ret = callback(close_connection, connection_closed);
  5433. if (!ret || connection_closed) { break; }
  5434. count--;
  5435. }
  5436. return ret;
  5437. }
  5438. template <typename T>
  5439. inline bool
  5440. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5441. size_t keep_alive_max_count,
  5442. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5443. time_t read_timeout_usec, time_t write_timeout_sec,
  5444. time_t write_timeout_usec, T callback) {
  5445. return process_server_socket_core(
  5446. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5447. [&](bool close_connection, bool &connection_closed) {
  5448. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5449. write_timeout_sec, write_timeout_usec);
  5450. // process_server_socket_core() only gets here once keep_alive() has
  5451. // seen the socket go readable.
  5452. strm.set_readable_hint();
  5453. return callback(strm, close_connection, connection_closed);
  5454. });
  5455. }
  5456. inline bool process_client_socket(
  5457. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5458. time_t write_timeout_sec, time_t write_timeout_usec,
  5459. time_t max_timeout_msec,
  5460. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5461. std::function<bool(Stream &)> callback) {
  5462. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5463. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5464. start_time);
  5465. return callback(strm);
  5466. }
  5467. inline int shutdown_socket(socket_t sock) noexcept {
  5468. #ifdef _WIN32
  5469. return shutdown(sock, SD_BOTH);
  5470. #else
  5471. return shutdown(sock, SHUT_RDWR);
  5472. #endif
  5473. }
  5474. // Half-closes the write side and drains any in-flight/queued bytes before
  5475. // the final shutdown+close. Closing with unread data in the receive queue
  5476. // (or bytes arriving after the receive side is closed) makes the stack send
  5477. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5478. // response as a failed read even though it was fully written.
  5479. inline void drain_and_close_socket(socket_t sock) noexcept {
  5480. #ifdef _WIN32
  5481. shutdown(sock, SD_SEND);
  5482. #else
  5483. shutdown(sock, SHUT_WR);
  5484. #endif
  5485. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5486. size_t total = 0;
  5487. const auto deadline = std::chrono::steady_clock::now() +
  5488. std::chrono::milliseconds(100); // bound #1
  5489. while (total < size_t(1024u * 1024u)) { // bound #2
  5490. const auto remaining =
  5491. std::chrono::duration_cast<std::chrono::microseconds>(
  5492. deadline - std::chrono::steady_clock::now())
  5493. .count();
  5494. if (remaining <= 0) { break; }
  5495. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5496. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5497. if (n <= 0) { break; }
  5498. total += static_cast<size_t>(n);
  5499. }
  5500. shutdown_socket(sock);
  5501. close_socket(sock);
  5502. }
  5503. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5504. if (s.size() > 1 && s[0] == '\0') {
  5505. auto ret = s;
  5506. ret[0] = '@';
  5507. return ret;
  5508. }
  5509. return s;
  5510. }
  5511. inline std::string
  5512. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5513. if (s.size() > 1 && s[0] == '@') {
  5514. auto ret = s;
  5515. ret[0] = '\0';
  5516. return ret;
  5517. }
  5518. return s;
  5519. }
  5520. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5521. const struct addrinfo *hints,
  5522. struct addrinfo **res, time_t timeout_sec) {
  5523. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5524. if (timeout_sec <= 0) {
  5525. // No timeout specified, use standard getaddrinfo
  5526. return getaddrinfo(node, service, hints, res);
  5527. }
  5528. #ifdef _WIN32
  5529. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5530. OVERLAPPED overlapped = {};
  5531. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5532. if (!event) { return EAI_FAIL; }
  5533. overlapped.hEvent = event;
  5534. PADDRINFOEXW result_addrinfo = nullptr;
  5535. HANDLE cancel_handle = nullptr;
  5536. ADDRINFOEXW hints_ex = {};
  5537. if (hints) {
  5538. hints_ex.ai_flags = hints->ai_flags;
  5539. hints_ex.ai_family = hints->ai_family;
  5540. hints_ex.ai_socktype = hints->ai_socktype;
  5541. hints_ex.ai_protocol = hints->ai_protocol;
  5542. }
  5543. auto wnode = u8string_to_wstring(node);
  5544. auto wservice = u8string_to_wstring(service);
  5545. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5546. hints ? &hints_ex : nullptr, &result_addrinfo,
  5547. nullptr, &overlapped, nullptr, &cancel_handle);
  5548. if (ret == WSA_IO_PENDING) {
  5549. auto wait_result =
  5550. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5551. if (wait_result == WAIT_TIMEOUT) {
  5552. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5553. ::CloseHandle(event);
  5554. return EAI_AGAIN;
  5555. }
  5556. DWORD bytes_returned;
  5557. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5558. &bytes_returned, FALSE)) {
  5559. ::CloseHandle(event);
  5560. return ::WSAGetLastError();
  5561. }
  5562. }
  5563. ::CloseHandle(event);
  5564. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5565. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5566. return 0;
  5567. }
  5568. return ret;
  5569. #elif TARGET_OS_MAC && defined(__clang__)
  5570. if (!node) { return EAI_NONAME; }
  5571. // macOS implementation using CFHost API for asynchronous DNS resolution
  5572. CFStringRef hostname_ref = CFStringCreateWithCString(
  5573. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5574. if (!hostname_ref) { return EAI_MEMORY; }
  5575. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5576. CFRelease(hostname_ref);
  5577. if (!host_ref) { return EAI_MEMORY; }
  5578. // Set up context for callback
  5579. struct CFHostContext {
  5580. bool completed = false;
  5581. bool success = false;
  5582. CFArrayRef addresses = nullptr;
  5583. std::mutex mutex;
  5584. std::condition_variable cv;
  5585. } context;
  5586. CFHostClientContext client_context;
  5587. memset(&client_context, 0, sizeof(client_context));
  5588. client_context.info = &context;
  5589. // Set callback
  5590. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5591. const CFStreamError *error, void *info) {
  5592. auto ctx = static_cast<CFHostContext *>(info);
  5593. std::lock_guard<std::mutex> lock(ctx->mutex);
  5594. if (error && error->error != 0) {
  5595. ctx->success = false;
  5596. } else {
  5597. Boolean hasBeenResolved;
  5598. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5599. if (ctx->addresses && hasBeenResolved) {
  5600. CFRetain(ctx->addresses);
  5601. ctx->success = true;
  5602. } else {
  5603. ctx->success = false;
  5604. }
  5605. }
  5606. ctx->completed = true;
  5607. ctx->cv.notify_one();
  5608. };
  5609. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5610. CFRelease(host_ref);
  5611. return EAI_SYSTEM;
  5612. }
  5613. // Schedule on run loop
  5614. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5615. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5616. // Start resolution
  5617. CFStreamError stream_error;
  5618. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5619. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5620. CFRelease(host_ref);
  5621. return EAI_FAIL;
  5622. }
  5623. // Wait for completion with timeout
  5624. auto timeout_time =
  5625. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5626. bool timed_out = false;
  5627. {
  5628. std::unique_lock<std::mutex> lock(context.mutex);
  5629. while (!context.completed) {
  5630. auto now = std::chrono::steady_clock::now();
  5631. if (now >= timeout_time) {
  5632. timed_out = true;
  5633. break;
  5634. }
  5635. // Run the runloop for a short time
  5636. lock.unlock();
  5637. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5638. lock.lock();
  5639. }
  5640. }
  5641. // Clean up
  5642. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5643. CFHostSetClient(host_ref, nullptr, nullptr);
  5644. if (timed_out || !context.completed) {
  5645. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5646. CFRelease(host_ref);
  5647. return EAI_AGAIN;
  5648. }
  5649. if (!context.success || !context.addresses) {
  5650. CFRelease(host_ref);
  5651. return EAI_NODATA;
  5652. }
  5653. // Convert CFArray to addrinfo
  5654. CFIndex count = CFArrayGetCount(context.addresses);
  5655. if (count == 0) {
  5656. CFRelease(context.addresses);
  5657. CFRelease(host_ref);
  5658. return EAI_NODATA;
  5659. }
  5660. struct addrinfo *result_addrinfo = nullptr;
  5661. struct addrinfo **current = &result_addrinfo;
  5662. for (CFIndex i = 0; i < count; i++) {
  5663. CFDataRef addr_data =
  5664. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5665. if (!addr_data) continue;
  5666. const struct sockaddr *sockaddr_ptr =
  5667. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5668. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5669. // Allocate addrinfo structure
  5670. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5671. if (!*current) {
  5672. freeaddrinfo(result_addrinfo);
  5673. CFRelease(context.addresses);
  5674. CFRelease(host_ref);
  5675. return EAI_MEMORY;
  5676. }
  5677. memset(*current, 0, sizeof(struct addrinfo));
  5678. // Set up addrinfo fields
  5679. (*current)->ai_family = sockaddr_ptr->sa_family;
  5680. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5681. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5682. (*current)->ai_addrlen = sockaddr_len;
  5683. // Copy sockaddr
  5684. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5685. if (!(*current)->ai_addr) {
  5686. freeaddrinfo(result_addrinfo);
  5687. CFRelease(context.addresses);
  5688. CFRelease(host_ref);
  5689. return EAI_MEMORY;
  5690. }
  5691. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5692. // Set port if service is specified
  5693. if (service && *service) {
  5694. int port = 0;
  5695. if (parse_port(service, strlen(service), port)) {
  5696. if (sockaddr_ptr->sa_family == AF_INET) {
  5697. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5698. ->sin_port = htons(static_cast<uint16_t>(port));
  5699. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5700. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5701. ->sin6_port = htons(static_cast<uint16_t>(port));
  5702. }
  5703. }
  5704. }
  5705. current = &((*current)->ai_next);
  5706. }
  5707. CFRelease(context.addresses);
  5708. CFRelease(host_ref);
  5709. *res = result_addrinfo;
  5710. return 0;
  5711. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5712. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5713. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5714. // the resolver worker still references the stack-local gaicb. The cancel
  5715. // path therefore waits (gai_suspend with no timeout) for the worker to
  5716. // actually finish before letting the stack frame go. The trade-off is that
  5717. // a wedged DNS server can hold this thread for the system resolver timeout
  5718. // (~30s by default) past the caller's connection timeout.
  5719. struct gaicb request{};
  5720. struct gaicb *requests[1] = {&request};
  5721. struct sigevent sevp{};
  5722. struct timespec timeout{timeout_sec, 0};
  5723. request.ar_name = node;
  5724. request.ar_service = service;
  5725. request.ar_request = hints;
  5726. sevp.sigev_notify = SIGEV_NONE;
  5727. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5728. if (rc != 0) { return rc; }
  5729. auto cleanup = scope_exit([&] {
  5730. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5731. });
  5732. int wait_result = gai_suspend(requests, 1, &timeout);
  5733. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5734. int gai_result = gai_error(&request);
  5735. if (gai_result == 0) {
  5736. *res = request.ar_result;
  5737. request.ar_result = nullptr;
  5738. return 0;
  5739. }
  5740. return gai_result;
  5741. }
  5742. gai_cancel(&request);
  5743. while (gai_error(&request) == EAI_INPROGRESS) {
  5744. gai_suspend(requests, 1, nullptr);
  5745. }
  5746. return wait_result;
  5747. #else
  5748. // Fallback implementation using thread-based timeout for other Unix systems.
  5749. struct GetAddrInfoState {
  5750. ~GetAddrInfoState() {
  5751. if (info) { freeaddrinfo(info); }
  5752. }
  5753. std::mutex mutex;
  5754. std::condition_variable result_cv;
  5755. bool completed = false;
  5756. int result = EAI_SYSTEM;
  5757. std::string node;
  5758. std::string service;
  5759. struct addrinfo hints;
  5760. struct addrinfo *info = nullptr;
  5761. };
  5762. // Allocate on the heap, so the resolver thread can keep using the data.
  5763. auto state = std::make_shared<GetAddrInfoState>();
  5764. if (node) { state->node = node; }
  5765. state->service = service;
  5766. state->hints = *hints;
  5767. std::thread resolve_thread([state]() {
  5768. auto thread_result =
  5769. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5770. &state->info);
  5771. std::lock_guard<std::mutex> lock(state->mutex);
  5772. state->result = thread_result;
  5773. state->completed = true;
  5774. state->result_cv.notify_one();
  5775. });
  5776. // Wait for completion or timeout
  5777. std::unique_lock<std::mutex> lock(state->mutex);
  5778. auto finished =
  5779. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5780. [&] { return state->completed; });
  5781. if (finished) {
  5782. // Operation completed within timeout
  5783. resolve_thread.join();
  5784. *res = state->info;
  5785. state->info = nullptr; // Pass ownership to caller
  5786. return state->result;
  5787. } else {
  5788. // Timeout occurred
  5789. resolve_thread.detach(); // Let the thread finish in background
  5790. return EAI_AGAIN; // Return timeout error
  5791. }
  5792. #endif
  5793. #else
  5794. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5795. return getaddrinfo(node, service, hints, res);
  5796. #endif
  5797. }
  5798. template <typename BindOrConnect>
  5799. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5800. int address_family, int socket_flags, bool tcp_nodelay,
  5801. bool ipv6_v6only, SocketOptions socket_options,
  5802. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5803. // Get address info
  5804. const char *node = nullptr;
  5805. struct addrinfo hints;
  5806. struct addrinfo *result;
  5807. memset(&hints, 0, sizeof(struct addrinfo));
  5808. hints.ai_socktype = SOCK_STREAM;
  5809. hints.ai_protocol = IPPROTO_IP;
  5810. if (!ip.empty()) {
  5811. node = ip.c_str();
  5812. // Ask getaddrinfo to convert IP in c-string to address
  5813. hints.ai_family = AF_UNSPEC;
  5814. hints.ai_flags = AI_NUMERICHOST;
  5815. } else {
  5816. if (!host.empty()) { node = host.c_str(); }
  5817. hints.ai_family = address_family;
  5818. hints.ai_flags = socket_flags;
  5819. }
  5820. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5821. if (hints.ai_family == AF_UNIX) {
  5822. const auto addrlen = host.length();
  5823. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5824. #ifdef SOCK_CLOEXEC
  5825. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5826. hints.ai_protocol);
  5827. #else
  5828. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5829. #endif
  5830. if (sock != INVALID_SOCKET) {
  5831. sockaddr_un addr{};
  5832. addr.sun_family = AF_UNIX;
  5833. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5834. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5835. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5836. hints.ai_addrlen = static_cast<socklen_t>(
  5837. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5838. #ifndef SOCK_CLOEXEC
  5839. #ifndef _WIN32
  5840. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5841. #endif
  5842. #endif
  5843. if (socket_options) { socket_options(sock); }
  5844. #ifdef _WIN32
  5845. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5846. // remove the option.
  5847. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5848. #endif
  5849. bool dummy;
  5850. if (!bind_or_connect(sock, hints, dummy)) {
  5851. close_socket(sock);
  5852. sock = INVALID_SOCKET;
  5853. }
  5854. }
  5855. return sock;
  5856. }
  5857. #endif
  5858. auto service = std::to_string(port);
  5859. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5860. timeout_sec)) {
  5861. #if defined __linux__ && !defined __ANDROID__
  5862. res_init();
  5863. #endif
  5864. return INVALID_SOCKET;
  5865. }
  5866. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5867. for (auto rp = result; rp; rp = rp->ai_next) {
  5868. // Create a socket
  5869. #ifdef _WIN32
  5870. auto sock =
  5871. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5872. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5873. /**
  5874. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5875. * and above the socket creation fails on older Windows Systems.
  5876. *
  5877. * Let's try to create a socket the old way in this case.
  5878. *
  5879. * Reference:
  5880. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5881. *
  5882. * WSA_FLAG_NO_HANDLE_INHERIT:
  5883. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5884. * SP1, and later
  5885. *
  5886. */
  5887. if (sock == INVALID_SOCKET) {
  5888. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5889. }
  5890. #else
  5891. #ifdef SOCK_CLOEXEC
  5892. auto sock =
  5893. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5894. #else
  5895. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5896. #endif
  5897. #endif
  5898. if (sock == INVALID_SOCKET) { continue; }
  5899. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5900. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5901. close_socket(sock);
  5902. continue;
  5903. }
  5904. #endif
  5905. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5906. if (rp->ai_family == AF_INET6) {
  5907. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5908. }
  5909. if (socket_options) { socket_options(sock); }
  5910. // bind or connect
  5911. auto quit = false;
  5912. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5913. close_socket(sock);
  5914. if (quit) { break; }
  5915. }
  5916. return INVALID_SOCKET;
  5917. }
  5918. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5919. #ifdef _WIN32
  5920. auto flags = nonblocking ? 1UL : 0UL;
  5921. ioctlsocket(sock, FIONBIO, &flags);
  5922. #else
  5923. auto flags = fcntl(sock, F_GETFL, 0);
  5924. fcntl(sock, F_SETFL,
  5925. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5926. #endif
  5927. }
  5928. inline bool is_connection_error() {
  5929. #ifdef _WIN32
  5930. return WSAGetLastError() != WSAEWOULDBLOCK;
  5931. #else
  5932. return errno != EINPROGRESS;
  5933. #endif
  5934. }
  5935. // accept() failed because the process or the network stack is temporarily out
  5936. // of resources. The listening socket is still usable, so back off briefly and
  5937. // try again.
  5938. inline bool is_accept_resource_error() {
  5939. #ifdef _WIN32
  5940. auto err = WSAGetLastError();
  5941. return err == WSAEMFILE || err == WSAENOBUFS;
  5942. #else
  5943. auto err = errno;
  5944. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  5945. #endif
  5946. }
  5947. // accept() failed for a reason that says nothing about the listening socket:
  5948. // the pending connection went away before it could be accepted, or the call
  5949. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  5950. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  5951. // connection that way.
  5952. inline bool is_accept_transient_error() {
  5953. #ifdef _WIN32
  5954. auto err = WSAGetLastError();
  5955. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  5956. err == WSAECONNABORTED;
  5957. #else
  5958. auto err = errno;
  5959. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  5960. err == ECONNABORTED;
  5961. #endif
  5962. }
  5963. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  5964. struct addrinfo hints;
  5965. struct addrinfo *result;
  5966. memset(&hints, 0, sizeof(struct addrinfo));
  5967. hints.ai_family = AF_UNSPEC;
  5968. hints.ai_socktype = SOCK_STREAM;
  5969. hints.ai_protocol = 0;
  5970. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  5971. return false;
  5972. }
  5973. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5974. auto ret = false;
  5975. for (auto rp = result; rp; rp = rp->ai_next) {
  5976. const auto &ai = *rp;
  5977. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  5978. ret = true;
  5979. break;
  5980. }
  5981. }
  5982. return ret;
  5983. }
  5984. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  5985. #define USE_IF2IP
  5986. #endif
  5987. #ifdef USE_IF2IP
  5988. inline std::string if2ip(int address_family, const std::string &ifn) {
  5989. struct ifaddrs *ifap;
  5990. getifaddrs(&ifap);
  5991. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  5992. std::string addr_candidate;
  5993. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  5994. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  5995. (AF_UNSPEC == address_family ||
  5996. ifa->ifa_addr->sa_family == address_family)) {
  5997. if (ifa->ifa_addr->sa_family == AF_INET) {
  5998. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  5999. char buf[INET_ADDRSTRLEN];
  6000. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6001. return std::string(buf, INET_ADDRSTRLEN);
  6002. }
  6003. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6004. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6005. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6006. char buf[INET6_ADDRSTRLEN] = {};
  6007. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6008. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6009. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6010. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6011. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6012. } else {
  6013. return std::string(buf, INET6_ADDRSTRLEN);
  6014. }
  6015. }
  6016. }
  6017. }
  6018. }
  6019. }
  6020. return addr_candidate;
  6021. }
  6022. #endif
  6023. inline socket_t create_client_socket(
  6024. const std::string &host, const std::string &ip, int port,
  6025. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6026. SocketOptions socket_options, time_t connection_timeout_sec,
  6027. time_t connection_timeout_usec, time_t read_timeout_sec,
  6028. time_t read_timeout_usec, time_t write_timeout_sec,
  6029. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6030. auto sock = create_socket(
  6031. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6032. std::move(socket_options),
  6033. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6034. if (!intf.empty()) {
  6035. #ifdef USE_IF2IP
  6036. auto ip_from_if = if2ip(address_family, intf);
  6037. if (ip_from_if.empty()) { ip_from_if = intf; }
  6038. if (!bind_ip_address(sock2, ip_from_if)) {
  6039. error = Error::BindIPAddress;
  6040. return false;
  6041. }
  6042. #endif
  6043. }
  6044. set_nonblocking(sock2, true);
  6045. auto ret =
  6046. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6047. if (ret < 0) {
  6048. if (is_connection_error()) {
  6049. error = Error::Connection;
  6050. return false;
  6051. }
  6052. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6053. connection_timeout_usec);
  6054. if (error != Error::Success) {
  6055. if (error == Error::ConnectionTimeout) { quit = true; }
  6056. return false;
  6057. }
  6058. }
  6059. set_nonblocking(sock2, false);
  6060. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6061. read_timeout_usec);
  6062. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6063. write_timeout_usec);
  6064. error = Error::Success;
  6065. return true;
  6066. },
  6067. connection_timeout_sec); // Pass DNS timeout
  6068. if (sock != INVALID_SOCKET) {
  6069. error = Error::Success;
  6070. } else {
  6071. if (error == Error::Success) { error = Error::Connection; }
  6072. }
  6073. return sock;
  6074. }
  6075. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6076. socklen_t addr_len, std::string &ip, int &port) {
  6077. if (addr.ss_family == AF_INET) {
  6078. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6079. } else if (addr.ss_family == AF_INET6) {
  6080. port =
  6081. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6082. } else {
  6083. return false;
  6084. }
  6085. std::array<char, NI_MAXHOST> ipstr{};
  6086. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6087. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6088. 0, NI_NUMERICHOST)) {
  6089. return false;
  6090. }
  6091. ip = ipstr.data();
  6092. return true;
  6093. }
  6094. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6095. struct sockaddr_storage addr;
  6096. socklen_t addr_len = sizeof(addr);
  6097. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6098. &addr_len)) {
  6099. get_ip_and_port(addr, addr_len, ip, port);
  6100. }
  6101. }
  6102. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6103. struct sockaddr_storage addr;
  6104. socklen_t addr_len = sizeof(addr);
  6105. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6106. &addr_len)) {
  6107. #ifndef _WIN32
  6108. if (addr.ss_family == AF_UNIX) {
  6109. #if defined(__linux__)
  6110. struct ucred ucred;
  6111. socklen_t len = sizeof(ucred);
  6112. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6113. port = ucred.pid;
  6114. }
  6115. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6116. pid_t pid;
  6117. socklen_t len = sizeof(pid);
  6118. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6119. port = pid;
  6120. }
  6121. #endif
  6122. return;
  6123. }
  6124. #endif
  6125. get_ip_and_port(addr, addr_len, ip, port);
  6126. }
  6127. }
  6128. // Recursive form retained so operator""_t below can compute hashes for
  6129. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6130. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6131. // instead, which is iterative and stack-safe.
  6132. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6133. unsigned int h) {
  6134. return (l == 0)
  6135. ? h
  6136. : str2tag_core(
  6137. s + 1, l - 1,
  6138. // Unsets the 6 high bits of h, therefore no overflow happens
  6139. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6140. h * 33) ^
  6141. static_cast<unsigned char>(*s));
  6142. }
  6143. inline unsigned int str2tag(const std::string &s) {
  6144. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6145. // for compile-time UDL evaluation of short string literals, but at runtime
  6146. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6147. // would blow the stack with one frame per character.
  6148. unsigned int h = 0;
  6149. for (auto c : s) {
  6150. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6151. static_cast<unsigned char>(c);
  6152. }
  6153. return h;
  6154. }
  6155. namespace udl {
  6156. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6157. return str2tag_core(s, l, 0);
  6158. }
  6159. } // namespace udl
  6160. inline std::string
  6161. find_content_type(const std::string &path,
  6162. const std::map<std::string, std::string> &user_data,
  6163. const std::string &default_content_type) {
  6164. auto ext = file_extension(path);
  6165. auto it = user_data.find(ext);
  6166. if (it != user_data.end()) { return it->second; }
  6167. using udl::operator""_t;
  6168. switch (str2tag(ext)) {
  6169. default: return default_content_type;
  6170. case "css"_t: return "text/css";
  6171. case "csv"_t: return "text/csv";
  6172. case "htm"_t:
  6173. case "html"_t: return "text/html";
  6174. case "js"_t:
  6175. case "mjs"_t: return "text/javascript";
  6176. case "txt"_t: return "text/plain";
  6177. case "vtt"_t: return "text/vtt";
  6178. case "apng"_t: return "image/apng";
  6179. case "avif"_t: return "image/avif";
  6180. case "bmp"_t: return "image/bmp";
  6181. case "gif"_t: return "image/gif";
  6182. case "png"_t: return "image/png";
  6183. case "svg"_t: return "image/svg+xml";
  6184. case "webp"_t: return "image/webp";
  6185. case "ico"_t: return "image/x-icon";
  6186. case "tif"_t: return "image/tiff";
  6187. case "tiff"_t: return "image/tiff";
  6188. case "jpg"_t:
  6189. case "jpeg"_t: return "image/jpeg";
  6190. case "mp4"_t: return "video/mp4";
  6191. case "mpeg"_t: return "video/mpeg";
  6192. case "webm"_t: return "video/webm";
  6193. case "mp3"_t: return "audio/mp3";
  6194. case "mpga"_t: return "audio/mpeg";
  6195. case "weba"_t: return "audio/webm";
  6196. case "wav"_t: return "audio/wave";
  6197. case "otf"_t: return "font/otf";
  6198. case "ttf"_t: return "font/ttf";
  6199. case "woff"_t: return "font/woff";
  6200. case "woff2"_t: return "font/woff2";
  6201. case "7z"_t: return "application/x-7z-compressed";
  6202. case "atom"_t: return "application/atom+xml";
  6203. case "pdf"_t: return "application/pdf";
  6204. case "json"_t: return "application/json";
  6205. case "rss"_t: return "application/rss+xml";
  6206. case "tar"_t: return "application/x-tar";
  6207. case "xht"_t:
  6208. case "xhtml"_t: return "application/xhtml+xml";
  6209. case "xslt"_t: return "application/xslt+xml";
  6210. case "xml"_t: return "application/xml";
  6211. case "gz"_t: return "application/gzip";
  6212. case "zip"_t: return "application/zip";
  6213. case "wasm"_t: return "application/wasm";
  6214. }
  6215. }
  6216. inline std::string
  6217. extract_media_type(const std::string &content_type,
  6218. std::map<std::string, std::string> *params = nullptr) {
  6219. // Extract type/subtype from Content-Type value (RFC 2045)
  6220. // e.g. "application/json; charset=utf-8" -> "application/json"
  6221. auto media_type = content_type;
  6222. auto semicolon_pos = media_type.find(';');
  6223. if (semicolon_pos != std::string::npos) {
  6224. auto param_str = media_type.substr(semicolon_pos + 1);
  6225. media_type = media_type.substr(0, semicolon_pos);
  6226. if (params) {
  6227. // Parse parameters: key=value pairs separated by ';'
  6228. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6229. [&](const char *b, const char *e) {
  6230. std::string key;
  6231. std::string val;
  6232. divide_param_pair(b, e, key, val);
  6233. if (!key.empty()) {
  6234. params->emplace(trim_copy(key),
  6235. trim_double_quotes_copy(val));
  6236. }
  6237. });
  6238. }
  6239. }
  6240. // Trim whitespace from media type
  6241. return trim_copy(media_type);
  6242. }
  6243. inline bool can_compress_content_type(const std::string &content_type) {
  6244. using udl::operator""_t;
  6245. auto mime_type = extract_media_type(content_type);
  6246. auto tag = str2tag(mime_type);
  6247. switch (tag) {
  6248. case "image/svg+xml"_t:
  6249. case "application/javascript"_t:
  6250. case "application/x-javascript"_t:
  6251. case "application/json"_t:
  6252. case "application/ld+json"_t:
  6253. case "application/xml"_t:
  6254. case "application/xhtml+xml"_t:
  6255. case "application/rss+xml"_t:
  6256. case "application/atom+xml"_t:
  6257. case "application/xslt+xml"_t:
  6258. case "application/protobuf"_t: return true;
  6259. case "text/event-stream"_t: return false;
  6260. default: return !mime_type.rfind("text/", 0);
  6261. }
  6262. }
  6263. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6264. double &quality) {
  6265. quality = 1.0;
  6266. token.clear();
  6267. // Split on first ';': left = token name, right = parameters
  6268. const char *params_b = nullptr;
  6269. std::size_t params_len = 0;
  6270. divide(
  6271. b, static_cast<std::size_t>(e - b), ';',
  6272. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6273. auto r = trim(lb, lb + llen, 0, llen);
  6274. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6275. params_b = rb;
  6276. params_len = rlen;
  6277. });
  6278. if (token.empty()) { return false; }
  6279. if (params_len == 0) { return true; }
  6280. // Scan parameters for q= (stops on first match)
  6281. bool invalid = false;
  6282. split_find(params_b, params_b + params_len, ';',
  6283. (std::numeric_limits<size_t>::max)(),
  6284. [&](const char *pb, const char *pe) -> bool {
  6285. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6286. auto len = static_cast<size_t>(pe - pb);
  6287. if (len < 2) { return false; }
  6288. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6289. return false;
  6290. }
  6291. // Trim the value portion
  6292. auto r = trim(pb, pe, 2, len);
  6293. if (r.first >= r.second) {
  6294. invalid = true;
  6295. return true;
  6296. }
  6297. double v = 0.0;
  6298. auto res = from_chars(pb + r.first, pb + r.second, v);
  6299. if (res.ec != std::errc{} || v < 0.0 || v > 1.0) {
  6300. invalid = true;
  6301. return true;
  6302. }
  6303. quality = v;
  6304. return true;
  6305. });
  6306. return !invalid;
  6307. }
  6308. inline EncodingType encoding_type(const Request &req,
  6309. const std::string &content_type) {
  6310. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6311. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6312. if (s.empty()) { return EncodingType::None; }
  6313. // Single-pass: iterate tokens and track the best supported encoding.
  6314. // Server preference breaks ties (br > gzip > zstd).
  6315. EncodingType best = EncodingType::None;
  6316. double best_q = 0.0; // q=0 means "not acceptable"
  6317. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6318. auto priority = [](EncodingType t) -> int {
  6319. switch (t) {
  6320. case EncodingType::Brotli: return 0;
  6321. case EncodingType::Gzip: return 1;
  6322. case EncodingType::Zstd: return 2;
  6323. default: return 3;
  6324. }
  6325. };
  6326. std::string name;
  6327. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6328. double quality = 1.0;
  6329. if (!parse_quality(b, e, name, quality)) { return; }
  6330. if (quality <= 0.0) { return; }
  6331. EncodingType type = EncodingType::None;
  6332. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6333. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6334. #endif
  6335. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6336. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6337. type = EncodingType::Gzip;
  6338. }
  6339. #endif
  6340. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6341. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6342. type = EncodingType::Zstd;
  6343. }
  6344. #endif
  6345. if (type == EncodingType::None) { return; }
  6346. // Higher q-value wins; for equal q, server preference breaks ties
  6347. if (quality > best_q ||
  6348. (quality == best_q && priority(type) < priority(best))) {
  6349. best_q = quality;
  6350. best = type;
  6351. }
  6352. });
  6353. return best;
  6354. }
  6355. // `content_type` is taken separately because a file-backed response has not
  6356. // been given one yet when its coding has to be decided.
  6357. inline EncodingType encoding_type(const Request &req, const Response &res,
  6358. const std::string &content_type) {
  6359. // The response already names a content coding of its own: a handler serving
  6360. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6361. // point whose headers name the coding its files are stored in. Applying one
  6362. // on top of that would double-encode the body and append a second
  6363. // `Content-Encoding` field line.
  6364. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6365. return encoding_type(req, content_type);
  6366. }
  6367. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6368. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6369. }
  6370. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6371. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6372. if (type == EncodingType::Gzip) {
  6373. return detail::make_unique<gzip_compressor>();
  6374. }
  6375. #endif
  6376. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6377. if (type == EncodingType::Brotli) {
  6378. return detail::make_unique<brotli_compressor>();
  6379. }
  6380. #endif
  6381. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6382. if (type == EncodingType::Zstd) {
  6383. return detail::make_unique<zstd_compressor>();
  6384. }
  6385. #endif
  6386. (void)type;
  6387. return nullptr;
  6388. }
  6389. inline const char *encoding_name(EncodingType type) {
  6390. switch (type) {
  6391. case EncodingType::Gzip: return "gzip";
  6392. case EncodingType::Brotli: return "br";
  6393. case EncodingType::Zstd: return "zstd";
  6394. default: return "";
  6395. }
  6396. }
  6397. inline bool nocompressor::compress(const char *data, size_t data_length,
  6398. bool /*last*/, Callback callback) {
  6399. if (!data_length) { return true; }
  6400. return callback(data, data_length);
  6401. }
  6402. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6403. inline gzip_compressor::gzip_compressor() {
  6404. std::memset(&strm_, 0, sizeof(strm_));
  6405. strm_.zalloc = Z_NULL;
  6406. strm_.zfree = Z_NULL;
  6407. strm_.opaque = Z_NULL;
  6408. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6409. Z_DEFAULT_STRATEGY) == Z_OK;
  6410. }
  6411. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6412. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6413. bool last, Callback callback) {
  6414. assert(is_valid_);
  6415. do {
  6416. constexpr size_t max_avail_in =
  6417. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6418. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6419. (std::min)(data_length, max_avail_in));
  6420. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6421. data_length -= strm_.avail_in;
  6422. data += strm_.avail_in;
  6423. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6424. auto ret = Z_OK;
  6425. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6426. do {
  6427. strm_.avail_out = static_cast<uInt>(buff.size());
  6428. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6429. ret = deflate(&strm_, flush);
  6430. if (ret == Z_STREAM_ERROR) { return false; }
  6431. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6432. return false;
  6433. }
  6434. } while (strm_.avail_out == 0);
  6435. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6436. (flush == Z_NO_FLUSH && ret == Z_OK));
  6437. assert(strm_.avail_in == 0);
  6438. } while (data_length > 0);
  6439. return true;
  6440. }
  6441. inline gzip_decompressor::gzip_decompressor() {
  6442. std::memset(&strm_, 0, sizeof(strm_));
  6443. strm_.zalloc = Z_NULL;
  6444. strm_.zfree = Z_NULL;
  6445. strm_.opaque = Z_NULL;
  6446. // 15 is the value of wbits, which should be at the maximum possible value
  6447. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6448. // that the stream type should be automatically detected either gzip or
  6449. // deflate.
  6450. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6451. }
  6452. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6453. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6454. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6455. Callback callback) {
  6456. assert(is_valid_);
  6457. auto ret = Z_OK;
  6458. do {
  6459. constexpr size_t max_avail_in =
  6460. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6461. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6462. (std::min)(data_length, max_avail_in));
  6463. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6464. data_length -= strm_.avail_in;
  6465. data += strm_.avail_in;
  6466. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6467. while (strm_.avail_in > 0 && ret == Z_OK) {
  6468. strm_.avail_out = static_cast<uInt>(buff.size());
  6469. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6470. ret = inflate(&strm_, Z_NO_FLUSH);
  6471. assert(ret != Z_STREAM_ERROR);
  6472. switch (ret) {
  6473. case Z_NEED_DICT:
  6474. case Z_DATA_ERROR:
  6475. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6476. }
  6477. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6478. return false;
  6479. }
  6480. }
  6481. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6482. } while (data_length > 0);
  6483. return true;
  6484. }
  6485. #endif
  6486. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6487. inline brotli_compressor::brotli_compressor() {
  6488. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6489. }
  6490. inline brotli_compressor::~brotli_compressor() {
  6491. BrotliEncoderDestroyInstance(state_);
  6492. }
  6493. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6494. bool last, Callback callback) {
  6495. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6496. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6497. auto available_in = data_length;
  6498. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6499. for (;;) {
  6500. if (last) {
  6501. if (BrotliEncoderIsFinished(state_)) { break; }
  6502. } else {
  6503. if (!available_in) { break; }
  6504. }
  6505. auto available_out = buff.size();
  6506. auto next_out = buff.data();
  6507. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6508. &available_out, &next_out, nullptr)) {
  6509. return false;
  6510. }
  6511. auto output_bytes = buff.size() - available_out;
  6512. if (output_bytes) {
  6513. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6514. }
  6515. }
  6516. return true;
  6517. }
  6518. inline brotli_decompressor::brotli_decompressor() {
  6519. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6520. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6521. : BROTLI_DECODER_RESULT_ERROR;
  6522. }
  6523. inline brotli_decompressor::~brotli_decompressor() {
  6524. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6525. }
  6526. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6527. inline bool brotli_decompressor::decompress(const char *data,
  6528. size_t data_length,
  6529. Callback callback) {
  6530. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6531. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6532. return 0;
  6533. }
  6534. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6535. size_t avail_in = data_length;
  6536. size_t total_out;
  6537. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6538. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6539. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6540. char *next_out = buff.data();
  6541. size_t avail_out = buff.size();
  6542. decoder_r = BrotliDecoderDecompressStream(
  6543. decoder_s, &avail_in, &next_in, &avail_out,
  6544. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6545. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6546. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6547. }
  6548. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6549. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6550. }
  6551. #endif
  6552. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6553. inline zstd_compressor::zstd_compressor() {
  6554. ctx_ = ZSTD_createCCtx();
  6555. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6556. }
  6557. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6558. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6559. bool last, Callback callback) {
  6560. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6561. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6562. ZSTD_inBuffer input = {data, data_length, 0};
  6563. bool finished;
  6564. do {
  6565. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6566. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6567. if (ZSTD_isError(remaining)) { return false; }
  6568. if (!callback(buff.data(), output.pos)) { return false; }
  6569. finished = last ? (remaining == 0) : (input.pos == input.size);
  6570. } while (!finished);
  6571. return true;
  6572. }
  6573. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6574. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6575. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6576. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6577. Callback callback) {
  6578. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6579. ZSTD_inBuffer input = {data, data_length, 0};
  6580. while (input.pos < input.size) {
  6581. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6582. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6583. if (ZSTD_isError(remaining)) { return false; }
  6584. if (!callback(buff.data(), output.pos)) { return false; }
  6585. }
  6586. return true;
  6587. }
  6588. #endif
  6589. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6590. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6591. // unknown coding, and its payload would be handed back still compressed.
  6592. inline bool is_zlib_encoding(const std::string &encoding) {
  6593. return case_ignore::equal(encoding, "gzip") ||
  6594. case_ignore::equal(encoding, "deflate");
  6595. }
  6596. inline bool is_brotli_encoding(const std::string &encoding) {
  6597. return case_ignore::equal(encoding, "br");
  6598. }
  6599. inline bool is_zstd_encoding(const std::string &encoding) {
  6600. return case_ignore::equal(encoding, "zstd");
  6601. }
  6602. // Returns true if the content coding is one cpp-httplib is able to decompress
  6603. // when the corresponding support is compiled in.
  6604. inline bool is_known_content_encoding(const std::string &encoding) {
  6605. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6606. is_zstd_encoding(encoding);
  6607. }
  6608. inline std::unique_ptr<decompressor>
  6609. create_decompressor(const std::string &encoding) {
  6610. std::unique_ptr<decompressor> decompressor;
  6611. if (is_zlib_encoding(encoding)) {
  6612. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6613. decompressor = detail::make_unique<gzip_decompressor>();
  6614. #endif
  6615. } else if (is_brotli_encoding(encoding)) {
  6616. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6617. decompressor = detail::make_unique<brotli_decompressor>();
  6618. #endif
  6619. } else if (is_zstd_encoding(encoding)) {
  6620. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6621. decompressor = detail::make_unique<zstd_decompressor>();
  6622. #endif
  6623. }
  6624. return decompressor;
  6625. }
  6626. // Returns the best available compressor and its Content-Encoding name.
  6627. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6628. inline std::pair<std::unique_ptr<compressor>, const char *>
  6629. create_compressor() {
  6630. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6631. return {detail::make_unique<brotli_compressor>(), "br"};
  6632. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6633. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6634. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6635. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6636. #else
  6637. return {nullptr, nullptr};
  6638. #endif
  6639. }
  6640. inline bool is_prohibited_header_name(const std::string &name) {
  6641. using udl::operator""_t;
  6642. switch (str2tag(name)) {
  6643. case "REMOTE_ADDR"_t:
  6644. case "REMOTE_PORT"_t:
  6645. case "LOCAL_ADDR"_t:
  6646. case "LOCAL_PORT"_t: return true;
  6647. default: return false;
  6648. }
  6649. }
  6650. inline bool has_header(const Headers &headers, const std::string &key) {
  6651. if (is_prohibited_header_name(key)) { return false; }
  6652. return headers.find(key) != headers.end();
  6653. }
  6654. inline const char *get_header_value(const Headers &headers,
  6655. const std::string &key, const char *def,
  6656. size_t id) {
  6657. if (is_prohibited_header_name(key)) {
  6658. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6659. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6660. throw std::invalid_argument(msg);
  6661. #else
  6662. return "";
  6663. #endif
  6664. }
  6665. auto rng = headers.equal_range(key);
  6666. auto it = rng.first;
  6667. std::advance(it, static_cast<ssize_t>(id));
  6668. if (it != rng.second) { return it->second.c_str(); }
  6669. return def;
  6670. }
  6671. inline size_t get_header_value_count(const Headers &headers,
  6672. const std::string &key) {
  6673. return headers.count(key);
  6674. }
  6675. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6676. // list may be sent as several field lines, and the combined field value is
  6677. // those values joined by commas in the order they were received. Callers that
  6678. // parse such a list must work on the combined value; reading only the first
  6679. // occurrence silently drops whatever the later field lines carry.
  6680. inline std::string get_combined_header_value(const Headers &headers,
  6681. const std::string &key) {
  6682. std::string combined;
  6683. auto rng = headers.equal_range(key);
  6684. for (auto it = rng.first; it != rng.second; ++it) {
  6685. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6686. // elements, so an empty field line must not contribute a bare comma to the
  6687. // combined value.
  6688. if (it->second.empty()) { continue; }
  6689. if (!combined.empty()) { combined += ", "; }
  6690. combined += it->second;
  6691. }
  6692. return combined;
  6693. }
  6694. inline bool has_header_token(const Headers &headers, const std::string &key,
  6695. const std::string &token) {
  6696. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6697. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6698. // several lines. Match complete tokens rather than searching the raw value,
  6699. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6700. auto rng = headers.equal_range(key);
  6701. for (auto it = rng.first; it != rng.second; ++it) {
  6702. const auto &value = it->second;
  6703. if (split_find(value.data(), value.data() + value.size(), ',',
  6704. [&](const char *b, const char *e) {
  6705. return case_ignore::equal(std::string(b, e), token);
  6706. })) {
  6707. return true;
  6708. }
  6709. }
  6710. return false;
  6711. }
  6712. template <typename Map>
  6713. inline typename Map::mapped_type
  6714. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6715. auto rng = m.equal_range(key);
  6716. auto it = rng.first;
  6717. std::advance(it, static_cast<ssize_t>(id));
  6718. if (it != rng.second) { return it->second; }
  6719. return typename Map::mapped_type();
  6720. }
  6721. inline void set_header(Headers &headers, const std::string &key,
  6722. const std::string &val) {
  6723. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6724. }
  6725. inline bool read_headers(Stream &strm, Headers &headers) {
  6726. const auto bufsiz = 2048;
  6727. char buf[bufsiz];
  6728. stream_line_reader line_reader(strm, buf, bufsiz);
  6729. size_t header_count = 0;
  6730. for (;;) {
  6731. if (!line_reader.getline()) { return false; }
  6732. // Check if the line ends with CRLF.
  6733. auto line_terminator_len = 2;
  6734. if (line_reader.end_with_crlf()) {
  6735. // Blank line indicates end of headers.
  6736. if (line_reader.size() == 2) { break; }
  6737. } else {
  6738. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6739. // Blank line indicates end of headers.
  6740. if (line_reader.size() == 1) { break; }
  6741. line_terminator_len = 1;
  6742. #else
  6743. continue; // Skip invalid line.
  6744. #endif
  6745. }
  6746. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6747. // Check header count limit
  6748. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6749. // Exclude line terminator
  6750. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6751. if (!parse_header(line_reader.ptr(), end,
  6752. [&](const std::string &key, const std::string &val) {
  6753. headers.emplace(key, val);
  6754. })) {
  6755. return false;
  6756. }
  6757. header_count++;
  6758. }
  6759. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6760. // headers that have different values to prevent request smuggling.
  6761. auto cl_range = headers.equal_range("Content-Length");
  6762. if (cl_range.first != cl_range.second) {
  6763. const auto &first_val = cl_range.first->second;
  6764. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6765. if (it->second != first_val) { return false; }
  6766. }
  6767. }
  6768. return true;
  6769. }
  6770. inline bool parse_status_line(const char *line, std::string &version,
  6771. int &status, std::string &reason) {
  6772. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6773. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6774. #else
  6775. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6776. #endif
  6777. std::cmatch m;
  6778. if (!std::regex_match(line, m, re)) { return false; }
  6779. version = std::string(m[1]);
  6780. status = std::stoi(std::string(m[2]));
  6781. reason = std::string(m[3]);
  6782. return true;
  6783. }
  6784. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6785. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6786. struct WebSocketUpgradeResponse {
  6787. Error error = Error::Success;
  6788. int status = -1;
  6789. Headers headers;
  6790. std::string selected_subprotocol;
  6791. };
  6792. inline bool read_websocket_upgrade_response(Stream &strm,
  6793. const std::string &expected_accept,
  6794. WebSocketUpgradeResponse &upgrade) {
  6795. // Read status line
  6796. const auto bufsiz = 2048;
  6797. char buf[bufsiz];
  6798. stream_line_reader line_reader(strm, buf, bufsiz);
  6799. if (!line_reader.getline()) {
  6800. upgrade.error = Error::Read;
  6801. return false;
  6802. }
  6803. std::string version;
  6804. std::string reason;
  6805. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6806. upgrade.error = Error::WebSocketHandshake;
  6807. return false;
  6808. }
  6809. // Read the headers even for a rejection so the caller can see why the
  6810. // server refused the upgrade. A non-101 response may carry a body; it is
  6811. // deliberately left unread since the caller closes the socket right away.
  6812. if (!read_headers(strm, upgrade.headers)) {
  6813. upgrade.error = Error::Read;
  6814. return false;
  6815. }
  6816. const auto &headers = upgrade.headers;
  6817. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6818. upgrade.error = Error::WebSocketHandshake;
  6819. return false;
  6820. }
  6821. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6822. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6823. upgrade.error = Error::WebSocketHandshake;
  6824. return false;
  6825. }
  6826. // Verify Connection: Upgrade
  6827. if (!has_header_token(headers, "Connection", "upgrade")) {
  6828. upgrade.error = Error::WebSocketHandshake;
  6829. return false;
  6830. }
  6831. // Verify Sec-WebSocket-Accept header value
  6832. auto it = headers.find("Sec-WebSocket-Accept");
  6833. if (it == headers.end() || it->second != expected_accept) {
  6834. upgrade.error = Error::WebSocketHandshake;
  6835. return false;
  6836. }
  6837. // Extract negotiated subprotocol
  6838. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6839. if (proto_it != headers.end()) {
  6840. upgrade.selected_subprotocol = proto_it->second;
  6841. }
  6842. return true;
  6843. }
  6844. enum class ReadContentResult {
  6845. Success, // Successfully read the content
  6846. PayloadTooLarge, // The content exceeds the specified payload limit
  6847. Error // An error occurred while reading the content
  6848. };
  6849. inline ReadContentResult read_content_with_length(
  6850. Stream &strm, size_t len, DownloadProgress progress,
  6851. ContentReceiverWithProgress out,
  6852. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6853. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6854. detail::BodyReader br;
  6855. br.stream = &strm;
  6856. br.has_content_length = true;
  6857. br.content_length = len;
  6858. br.payload_max_length = payload_max_length;
  6859. br.chunked = false;
  6860. br.bytes_read = 0;
  6861. br.last_error = Error::Success;
  6862. size_t r = 0;
  6863. while (r < len) {
  6864. auto read_len = static_cast<size_t>(len - r);
  6865. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6866. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6867. if (n <= 0) {
  6868. // Check if it was a payload size error
  6869. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6870. return ReadContentResult::PayloadTooLarge;
  6871. }
  6872. return ReadContentResult::Error;
  6873. }
  6874. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6875. return ReadContentResult::Error;
  6876. }
  6877. r += static_cast<size_t>(n);
  6878. if (progress) {
  6879. if (!progress(r, len)) { return ReadContentResult::Error; }
  6880. }
  6881. }
  6882. return ReadContentResult::Success;
  6883. }
  6884. inline ReadContentResult
  6885. read_content_without_length(Stream &strm, size_t payload_max_length,
  6886. ContentReceiverWithProgress out) {
  6887. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6888. size_t r = 0;
  6889. for (;;) {
  6890. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6891. if (n == 0) { return ReadContentResult::Success; }
  6892. if (n < 0) { return ReadContentResult::Error; }
  6893. // Check if adding this data would exceed the payload limit
  6894. if (r > payload_max_length ||
  6895. payload_max_length - r < static_cast<size_t>(n)) {
  6896. return ReadContentResult::PayloadTooLarge;
  6897. }
  6898. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6899. return ReadContentResult::Error;
  6900. }
  6901. r += static_cast<size_t>(n);
  6902. }
  6903. return ReadContentResult::Success;
  6904. }
  6905. template <typename T>
  6906. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6907. size_t payload_max_length,
  6908. ContentReceiverWithProgress out) {
  6909. detail::ChunkedDecoder dec(strm);
  6910. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6911. size_t total_len = 0;
  6912. for (;;) {
  6913. size_t chunk_offset = 0;
  6914. size_t chunk_total = 0;
  6915. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6916. if (n < 0) { return ReadContentResult::Error; }
  6917. if (n == 0) {
  6918. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6919. return ReadContentResult::Error;
  6920. }
  6921. return ReadContentResult::Success;
  6922. }
  6923. if (total_len > payload_max_length ||
  6924. payload_max_length - total_len < static_cast<size_t>(n)) {
  6925. return ReadContentResult::PayloadTooLarge;
  6926. }
  6927. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6928. return ReadContentResult::Error;
  6929. }
  6930. total_len += static_cast<size_t>(n);
  6931. }
  6932. }
  6933. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  6934. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  6935. // is the final transfer coding. A single field value may list several
  6936. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  6937. // several Transfer-Encoding lines, which combine into one comma-separated
  6938. // list in the order the lines were received. Headers preserves that order,
  6939. // so the final coding is the last token of the last line. Match it
  6940. // case-insensitively rather than comparing the whole value against
  6941. // "chunked".
  6942. //
  6943. // Security: reading a chunked message as unframed leaves its body in the
  6944. // socket, where a keep-alive connection parses it as a smuggled request.
  6945. // Server::process_request() answers 400 and closes when the final coding is
  6946. // not chunked, so a request whose framing cannot be determined never
  6947. // reaches the "no body" path.
  6948. auto rng = headers.equal_range("Transfer-Encoding");
  6949. if (rng.first == rng.second) { return false; }
  6950. // Cleared per line, so a trailing line carrying no coding at all leaves the
  6951. // combined list ending in nothing rather than inheriting the line before it.
  6952. std::string last_coding;
  6953. for (auto it = rng.first; it != rng.second; ++it) {
  6954. const auto &value = it->second;
  6955. last_coding.clear();
  6956. split(value.data(), value.data() + value.size(), ',',
  6957. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  6958. }
  6959. return case_ignore::equal(last_coding, "chunked");
  6960. }
  6961. template <typename T, typename U>
  6962. bool prepare_content_receiver(T &x, int &status,
  6963. ContentReceiverWithProgress receiver,
  6964. bool decompress, size_t payload_max_length,
  6965. bool &exceed_payload_max_length, U callback) {
  6966. if (decompress) {
  6967. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  6968. std::unique_ptr<decompressor> decompressor;
  6969. if (!encoding.empty()) {
  6970. // A coding we know about but were not built with is an error. An
  6971. // unrecognized coding (including "identity") is left alone and the
  6972. // payload is passed through as-is, since some servers misuse the header,
  6973. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  6974. decompressor = detail::create_decompressor(encoding);
  6975. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  6976. status = StatusCode::UnsupportedMediaType_415;
  6977. return false;
  6978. }
  6979. }
  6980. if (decompressor) {
  6981. if (decompressor->is_valid()) {
  6982. size_t decompressed_size = 0;
  6983. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  6984. size_t off, size_t len) {
  6985. return decompressor->decompress(
  6986. buf, n, [&](const char *buf2, size_t n2) {
  6987. // Guard against zip-bomb: check
  6988. // decompressed size against limit.
  6989. if (payload_max_length > 0 &&
  6990. (decompressed_size >= payload_max_length ||
  6991. n2 > payload_max_length - decompressed_size)) {
  6992. exceed_payload_max_length = true;
  6993. return false;
  6994. }
  6995. decompressed_size += n2;
  6996. return receiver(buf2, n2, off, len);
  6997. });
  6998. };
  6999. return callback(std::move(out));
  7000. } else {
  7001. status = StatusCode::InternalServerError_500;
  7002. return false;
  7003. }
  7004. }
  7005. }
  7006. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7007. size_t len) {
  7008. return receiver(buf, n, off, len);
  7009. };
  7010. return callback(std::move(out));
  7011. }
  7012. template <typename T>
  7013. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7014. DownloadProgress progress,
  7015. ContentReceiverWithProgress receiver, bool decompress) {
  7016. bool exceed_payload_max_length = false;
  7017. return prepare_content_receiver(
  7018. x, status, std::move(receiver), decompress, payload_max_length,
  7019. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7020. auto ret = true;
  7021. // Note: exceed_payload_max_length may also be set by the decompressor
  7022. // wrapper in prepare_content_receiver when the decompressed payload
  7023. // size exceeds the limit.
  7024. if (is_chunked_transfer_encoding(x.headers)) {
  7025. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7026. if (result == ReadContentResult::Success) {
  7027. ret = true;
  7028. } else if (result == ReadContentResult::PayloadTooLarge) {
  7029. exceed_payload_max_length = true;
  7030. ret = false;
  7031. } else {
  7032. ret = false;
  7033. }
  7034. } else if (!has_header(x.headers, "Content-Length")) {
  7035. auto result =
  7036. read_content_without_length(strm, payload_max_length, out);
  7037. if (result == ReadContentResult::Success) {
  7038. ret = true;
  7039. } else if (result == ReadContentResult::PayloadTooLarge) {
  7040. exceed_payload_max_length = true;
  7041. ret = false;
  7042. } else {
  7043. ret = false;
  7044. }
  7045. } else {
  7046. auto is_invalid_value = false;
  7047. auto len = get_header_value_u64(x.headers, "Content-Length",
  7048. (std::numeric_limits<size_t>::max)(),
  7049. 0, is_invalid_value);
  7050. if (is_invalid_value) {
  7051. ret = false;
  7052. } else if (len > 0) {
  7053. auto result = read_content_with_length(
  7054. strm, len, std::move(progress), out, payload_max_length);
  7055. ret = (result == ReadContentResult::Success);
  7056. if (result == ReadContentResult::PayloadTooLarge) {
  7057. exceed_payload_max_length = true;
  7058. }
  7059. }
  7060. }
  7061. if (!ret) {
  7062. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7063. : StatusCode::BadRequest_400;
  7064. }
  7065. return ret;
  7066. });
  7067. }
  7068. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7069. const std::string &path) {
  7070. // A request target must not carry CR/LF (or other control octets); otherwise
  7071. // a value smuggled into it splits the request line and injects headers or a
  7072. // whole request. The same field-value check already guards header values in
  7073. // check_and_write_headers and the request target in
  7074. // perform_websocket_handshake; apply it here too.
  7075. if (!fields::is_field_value(path)) { return -1; }
  7076. std::string s = method;
  7077. s += ' ';
  7078. s += path;
  7079. s += " HTTP/1.1\r\n";
  7080. return strm.write(s.data(), s.size());
  7081. }
  7082. inline ssize_t write_response_line(Stream &strm, int status) {
  7083. std::string s = "HTTP/1.1 ";
  7084. s += std::to_string(status);
  7085. s += ' ';
  7086. s += httplib::status_message(status);
  7087. s += "\r\n";
  7088. return strm.write(s.data(), s.size());
  7089. }
  7090. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7091. ssize_t write_len = 0;
  7092. for (const auto &x : headers) {
  7093. // Skip fields with invalid names or values to prevent response splitting
  7094. // via CR/LF injection, matching set_header(). The client validates request
  7095. // headers up front in check_and_write_headers, but the server passes
  7096. // res.headers straight to this writer, and res.headers is a public field
  7097. // an application can populate directly with request-derived values.
  7098. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7099. std::string s;
  7100. s = x.first;
  7101. s += ": ";
  7102. s += x.second;
  7103. s += "\r\n";
  7104. auto len = strm.write(s.data(), s.size());
  7105. if (len < 0) { return len; }
  7106. write_len += len;
  7107. }
  7108. auto len = strm.write("\r\n");
  7109. if (len < 0) { return len; }
  7110. write_len += len;
  7111. return write_len;
  7112. }
  7113. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7114. size_t offset = 0;
  7115. while (offset < l) {
  7116. auto length = strm.write(d + offset, l - offset);
  7117. if (length < 0) { return false; }
  7118. offset += static_cast<size_t>(length);
  7119. }
  7120. return true;
  7121. }
  7122. template <typename T>
  7123. inline bool write_content_with_progress(Stream &strm,
  7124. const ContentProvider &content_provider,
  7125. size_t offset, size_t length,
  7126. T is_shutting_down,
  7127. const UploadProgress &upload_progress,
  7128. Error &error) {
  7129. size_t end_offset = offset + length;
  7130. size_t start_offset = offset;
  7131. auto ok = true;
  7132. auto finished = false;
  7133. DataSink data_sink;
  7134. data_sink.write = [&](const char *d, size_t l) -> bool {
  7135. if (ok) {
  7136. if (write_data(strm, d, l)) {
  7137. offset += l;
  7138. if (upload_progress && length > 0) {
  7139. size_t current_written = offset - start_offset;
  7140. if (!upload_progress(current_written, length)) {
  7141. ok = false;
  7142. return false;
  7143. }
  7144. }
  7145. } else {
  7146. ok = false;
  7147. }
  7148. }
  7149. return ok;
  7150. };
  7151. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7152. // The body is framed by `length`, so a provider that reports itself done
  7153. // early has truncated it. Record that and let the short-body check below
  7154. // fail the write, rather than calling the provider again forever.
  7155. data_sink.done = [&]() { finished = true; };
  7156. while (offset < end_offset && !finished && !is_shutting_down()) {
  7157. auto last_offset = offset;
  7158. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7159. error = Error::Write;
  7160. return false;
  7161. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7162. error = Error::Canceled;
  7163. return false;
  7164. } else if (!ok) {
  7165. error = Error::Write;
  7166. return false;
  7167. }
  7168. // A provider that reports success without writing anything and without
  7169. // reporting itself done gets handed the same offset and length again on
  7170. // the next pass, so it would spin here for as long as the peer stays
  7171. // connected. Treat making no progress as a short body, like done() early.
  7172. if (!finished && offset == last_offset) {
  7173. error = Error::Write;
  7174. return false;
  7175. }
  7176. }
  7177. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7178. error = Error::Write;
  7179. return false;
  7180. }
  7181. error = Error::Success;
  7182. return true;
  7183. }
  7184. template <typename T>
  7185. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7186. size_t offset, size_t length, T is_shutting_down,
  7187. Error &error) {
  7188. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7189. is_shutting_down, nullptr, error);
  7190. }
  7191. template <typename T>
  7192. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7193. size_t offset, size_t length,
  7194. const T &is_shutting_down) {
  7195. auto error = Error::Success;
  7196. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7197. error);
  7198. }
  7199. template <typename T>
  7200. inline bool
  7201. write_content_without_length(Stream &strm,
  7202. const ContentProvider &content_provider,
  7203. const T &is_shutting_down) {
  7204. size_t offset = 0;
  7205. auto data_available = true;
  7206. auto ok = true;
  7207. DataSink data_sink;
  7208. data_sink.write = [&](const char *d, size_t l) -> bool {
  7209. if (ok) {
  7210. offset += l;
  7211. if (!write_data(strm, d, l)) { ok = false; }
  7212. }
  7213. return ok;
  7214. };
  7215. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7216. data_sink.done = [&](void) { data_available = false; };
  7217. while (data_available && !is_shutting_down()) {
  7218. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7219. return false;
  7220. } else if (!content_provider(offset, 0, data_sink)) {
  7221. return false;
  7222. } else if (!ok) {
  7223. return false;
  7224. }
  7225. }
  7226. return !data_available; // true only if done() was called, false if shutting
  7227. // down
  7228. }
  7229. // Runs a known-length content provider to completion and compresses what it
  7230. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7231. // by an mmap hands the compressor a pointer straight into the mapping.
  7232. inline bool compress_content_provider(const ContentProvider &content_provider,
  7233. size_t length, compressor &cmp,
  7234. std::string &out) {
  7235. size_t offset = 0;
  7236. auto ok = true;
  7237. auto finished = false;
  7238. DataSink data_sink;
  7239. auto append = [&](const char *data, size_t data_len) {
  7240. out.append(data, data_len);
  7241. return true;
  7242. };
  7243. data_sink.write = [&](const char *d, size_t l) -> bool {
  7244. if (!ok) { return false; }
  7245. offset += l;
  7246. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7247. return ok;
  7248. };
  7249. // The body is framed by `length`, so a provider that reports itself done
  7250. // early has truncated it; the short-body check below turns that into a
  7251. // failure rather than calling the provider again forever.
  7252. data_sink.done = [&]() { finished = true; };
  7253. while (offset < length && !finished) {
  7254. auto prev_offset = offset;
  7255. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7256. return false;
  7257. }
  7258. // No Stream to block on here, so a provider that keeps returning true
  7259. // without writing would spin. Treat a pass that made no progress as a
  7260. // failure.
  7261. if (offset == prev_offset) { return false; }
  7262. }
  7263. if (offset != length) { return false; }
  7264. return cmp.compress(nullptr, 0, true, append);
  7265. }
  7266. // Serves `m` as the response body. `set_content_provider()` clears the coding,
  7267. // so recording it has to come after; keeping both here means a third
  7268. // file-serving path cannot get that order wrong.
  7269. inline void set_file_content_provider(Response &res,
  7270. const std::shared_ptr<mmap> &m,
  7271. const std::string &content_type,
  7272. EncodingType encoding) {
  7273. res.set_content_provider(
  7274. m->size(), content_type,
  7275. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7276. sink.write(m->data() + offset, length);
  7277. return true;
  7278. });
  7279. res.content_coding_ = encoding;
  7280. }
  7281. template <typename T, typename U>
  7282. inline bool
  7283. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7284. const T &is_shutting_down, U &compressor, Error &error) {
  7285. size_t offset = 0;
  7286. auto data_available = true;
  7287. auto ok = true;
  7288. DataSink data_sink;
  7289. data_sink.write = [&](const char *d, size_t l) -> bool {
  7290. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7291. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7292. // zero-length chunk is the terminator, so it must not be emitted here.
  7293. if (ok && l > 0) {
  7294. offset += l;
  7295. std::string payload;
  7296. if (compressor.compress(d, l, false,
  7297. [&](const char *data, size_t data_len) {
  7298. payload.append(data, data_len);
  7299. return true;
  7300. })) {
  7301. if (!payload.empty()) {
  7302. // Emit chunked response header and footer for each chunk
  7303. auto chunk =
  7304. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7305. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7306. }
  7307. } else {
  7308. ok = false;
  7309. }
  7310. }
  7311. return ok;
  7312. };
  7313. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7314. auto done_with_trailer = [&](const Headers *trailer) {
  7315. if (!ok) { return; }
  7316. data_available = false;
  7317. std::string payload;
  7318. if (!compressor.compress(nullptr, 0, true,
  7319. [&](const char *data, size_t data_len) {
  7320. payload.append(data, data_len);
  7321. return true;
  7322. })) {
  7323. ok = false;
  7324. return;
  7325. }
  7326. if (!payload.empty()) {
  7327. // Emit chunked response header and footer for each chunk
  7328. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7329. if (!write_data(strm, chunk.data(), chunk.size())) {
  7330. ok = false;
  7331. return;
  7332. }
  7333. }
  7334. constexpr const char done_marker[] = "0\r\n";
  7335. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7336. // Trailer
  7337. if (trailer) {
  7338. for (const auto &kv : *trailer) {
  7339. // Skip fields with invalid names or values to prevent response
  7340. // splitting via CR/LF injection, matching set_header().
  7341. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7342. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7343. if (!write_data(strm, field_line.data(), field_line.size())) {
  7344. ok = false;
  7345. }
  7346. }
  7347. }
  7348. constexpr const char crlf[] = "\r\n";
  7349. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7350. };
  7351. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7352. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7353. done_with_trailer(&trailer);
  7354. };
  7355. while (data_available && !is_shutting_down()) {
  7356. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7357. error = Error::Write;
  7358. return false;
  7359. } else if (!content_provider(offset, 0, data_sink)) {
  7360. error = Error::Canceled;
  7361. return false;
  7362. } else if (!ok) {
  7363. error = Error::Write;
  7364. return false;
  7365. }
  7366. }
  7367. if (data_available) { // exited due to is_shutting_down(), not done()
  7368. error = Error::Write;
  7369. return false;
  7370. }
  7371. error = Error::Success;
  7372. return true;
  7373. }
  7374. template <typename T, typename U>
  7375. inline bool write_content_chunked(Stream &strm,
  7376. const ContentProvider &content_provider,
  7377. const T &is_shutting_down, U &compressor) {
  7378. auto error = Error::Success;
  7379. return write_content_chunked(strm, content_provider, is_shutting_down,
  7380. compressor, error);
  7381. }
  7382. template <typename T>
  7383. inline bool redirect(T &cli, Request &req, Response &res,
  7384. const std::string &path, const std::string &location,
  7385. Error &error) {
  7386. Request new_req = req;
  7387. new_req.path = path;
  7388. new_req.redirect_count_ -= 1;
  7389. if (res.status == StatusCode::SeeOther_303 &&
  7390. (req.method != "GET" && req.method != "HEAD")) {
  7391. new_req.method = "GET";
  7392. new_req.body.clear();
  7393. new_req.headers.clear();
  7394. }
  7395. Response new_res;
  7396. auto ret = cli.send(new_req, new_res, error);
  7397. if (ret) {
  7398. req = std::move(new_req);
  7399. res = std::move(new_res);
  7400. if (res.location.empty()) { res.location = location; }
  7401. }
  7402. return ret;
  7403. }
  7404. inline std::string params_to_query_str(const Params &params) {
  7405. std::string query;
  7406. for (auto it = params.begin(); it != params.end(); ++it) {
  7407. if (it != params.begin()) { query += '&'; }
  7408. query += encode_query_component(it->first);
  7409. query += '=';
  7410. query += encode_query_component(it->second);
  7411. }
  7412. return query;
  7413. }
  7414. // Splits one "key=value" span of a query string at its first '='. A span with
  7415. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7416. // "?flag" keeps its name.
  7417. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7418. std::string &val) {
  7419. divide(b, static_cast<std::size_t>(e - b), '=',
  7420. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7421. std::size_t rhs_size) {
  7422. key.assign(lhs_data, lhs_size);
  7423. val.assign(rhs_data, rhs_size);
  7424. });
  7425. }
  7426. inline void parse_query_text(const char *data, std::size_t size,
  7427. Params &params) {
  7428. std::set<std::string> cache;
  7429. split(data, data + size, '&', [&](const char *b, const char *e) {
  7430. std::string kv(b, e);
  7431. if (cache.find(kv) != cache.end()) { return; }
  7432. cache.insert(std::move(kv));
  7433. std::string key;
  7434. std::string val;
  7435. divide_query_pair(b, e, key, val);
  7436. if (!key.empty()) {
  7437. params.emplace(decode_query_component(key), decode_query_component(val));
  7438. }
  7439. });
  7440. }
  7441. inline void parse_query_text(const std::string &s, Params &params) {
  7442. parse_query_text(s.data(), s.size(), params);
  7443. }
  7444. // Normalize a query string by decoding and re-encoding each key/value pair
  7445. // while preserving the original parameter order. This avoids double-encoding
  7446. // and ensures consistent encoding. It works on the raw string rather than
  7447. // parsing into Params and re-serializing, because that round trip cannot
  7448. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7449. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7450. // duplicated pairs.
  7451. inline std::string normalize_query_string(const std::string &query) {
  7452. std::string result;
  7453. split(query.data(), query.data() + query.size(), '&',
  7454. [&](const char *b, const char *e) {
  7455. std::string key;
  7456. std::string val;
  7457. divide_query_pair(b, e, key, val);
  7458. if (!key.empty()) {
  7459. auto dec_key = decode_query_component(key);
  7460. auto dec_val = decode_query_component(val);
  7461. if (!result.empty()) { result += '&'; }
  7462. result += encode_query_component(dec_key);
  7463. if (!val.empty() || std::find(b, e, '=') != e) {
  7464. result += '=';
  7465. result += encode_query_component(dec_val);
  7466. }
  7467. }
  7468. });
  7469. return result;
  7470. }
  7471. // Build the request target that goes on the wire from a caller-supplied path.
  7472. // Shared by the buffered send path and the streaming API so that both put the
  7473. // same bytes in the request line for the same input.
  7474. inline std::string encode_request_target(const std::string &target,
  7475. bool path_encode) {
  7476. // `substr(0, npos)` yields the whole string, which is what the no-query
  7477. // case needs.
  7478. auto query_pos = target.find('?');
  7479. auto path_part = target.substr(0, query_pos);
  7480. std::string query_part;
  7481. if (query_pos != std::string::npos) {
  7482. query_part = target.substr(query_pos + 1);
  7483. }
  7484. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7485. if (!query_part.empty()) {
  7486. // When path encoding is disabled the caller has supplied an already-encoded
  7487. // target and expects the exact bytes to be sent on the wire, so skip
  7488. // normalization for the query too. Normalizing would decode-then-re-encode
  7489. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7490. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7491. if (path_encode) {
  7492. auto normalized = normalize_query_string(query_part);
  7493. if (!normalized.empty()) {
  7494. result += '?';
  7495. result += normalized;
  7496. }
  7497. } else {
  7498. result += '?';
  7499. result += query_part;
  7500. }
  7501. }
  7502. return result;
  7503. }
  7504. inline bool parse_multipart_boundary(const std::string &content_type,
  7505. std::string &boundary) {
  7506. std::map<std::string, std::string> params;
  7507. extract_media_type(content_type, &params);
  7508. auto it = params.find("boundary");
  7509. if (it == params.end()) { return false; }
  7510. boundary = it->second;
  7511. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7512. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7513. // bytes costs a nearly full comparison at nearly every position: the
  7514. // boundary's length multiplies the worst-case cost of scanning a body.
  7515. return !boundary.empty() && boundary.size() <= 70;
  7516. }
  7517. inline void parse_disposition_params(const std::string &s, Params &params) {
  7518. std::set<std::string> cache;
  7519. split_unquoted(s.data(), s.data() + s.size(), ';',
  7520. [&](const char *b, const char *e) {
  7521. std::string kv(b, e);
  7522. if (cache.find(kv) != cache.end()) { return; }
  7523. cache.insert(kv);
  7524. std::string key;
  7525. std::string val;
  7526. divide_param_pair(b, e, key, val);
  7527. if (!key.empty()) {
  7528. params.emplace(trim_double_quotes_copy(key),
  7529. trim_double_quotes_copy(val));
  7530. }
  7531. });
  7532. }
  7533. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7534. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7535. #else
  7536. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7537. #endif
  7538. auto is_valid = [](const std::string &str) {
  7539. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7540. };
  7541. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7542. const auto pos = static_cast<size_t>(6);
  7543. const auto len = static_cast<size_t>(s.size() - 6);
  7544. auto all_valid_ranges = true;
  7545. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7546. if (!all_valid_ranges) { return; }
  7547. const auto it = std::find(b, e, '-');
  7548. if (it == e) {
  7549. all_valid_ranges = false;
  7550. return;
  7551. }
  7552. const auto lhs = std::string(b, it);
  7553. const auto rhs = std::string(it + 1, e);
  7554. if (!is_valid(lhs) || !is_valid(rhs)) {
  7555. all_valid_ranges = false;
  7556. return;
  7557. }
  7558. ssize_t first = -1;
  7559. if (!lhs.empty()) {
  7560. ssize_t v;
  7561. auto res = detail::from_chars(lhs.data(), lhs.data() + lhs.size(), v);
  7562. if (res.ec == std::errc{}) { first = v; }
  7563. }
  7564. ssize_t last = -1;
  7565. if (!rhs.empty()) {
  7566. ssize_t v;
  7567. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7568. if (res.ec == std::errc{}) { last = v; }
  7569. }
  7570. if ((first == -1 && last == -1) ||
  7571. (first != -1 && last != -1 && first > last)) {
  7572. all_valid_ranges = false;
  7573. return;
  7574. }
  7575. ranges.emplace_back(first, last);
  7576. });
  7577. return all_valid_ranges && !ranges.empty();
  7578. }
  7579. return false;
  7580. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7581. }
  7582. #else
  7583. } catch (...) { return false; }
  7584. #endif
  7585. inline bool parse_accept_header(const std::string &s,
  7586. std::vector<std::string> &content_types) {
  7587. content_types.clear();
  7588. // Empty string is considered valid (no preference)
  7589. if (s.empty()) { return true; }
  7590. struct AcceptEntry {
  7591. std::string media_type;
  7592. double quality;
  7593. int order;
  7594. };
  7595. std::vector<AcceptEntry> entries;
  7596. int order = 0;
  7597. bool has_invalid_entry = false;
  7598. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7599. // has to parse and ignore empty list elements, so a leading, trailing or
  7600. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7601. // split() skips them, and the header length limit bounds how many a sender
  7602. // can send, so ignoring all of them cannot be used as a denial-of-service
  7603. // vector.
  7604. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7605. std::string entry(b, e);
  7606. entry = trim_copy(entry);
  7607. AcceptEntry accept_entry;
  7608. accept_entry.order = order++;
  7609. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7610. accept_entry.media_type, accept_entry.quality)) {
  7611. has_invalid_entry = true;
  7612. return;
  7613. }
  7614. // Remove additional parameters from media type
  7615. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7616. // Basic validation of media type format
  7617. if (accept_entry.media_type.empty()) {
  7618. has_invalid_entry = true;
  7619. return;
  7620. }
  7621. // Check for basic media type format (should contain '/' or be '*')
  7622. if (accept_entry.media_type != "*" &&
  7623. accept_entry.media_type.find('/') == std::string::npos) {
  7624. has_invalid_entry = true;
  7625. return;
  7626. }
  7627. entries.push_back(std::move(accept_entry));
  7628. });
  7629. // Return false if any invalid entry was found
  7630. if (has_invalid_entry) { return false; }
  7631. // Sort by quality (descending), then by original order (ascending)
  7632. std::sort(entries.begin(), entries.end(),
  7633. [](const AcceptEntry &a, const AcceptEntry &b) {
  7634. if (a.quality != b.quality) {
  7635. return a.quality > b.quality; // Higher quality first
  7636. }
  7637. return a.order < b.order; // Earlier order first for same quality
  7638. });
  7639. // Extract sorted media types
  7640. content_types.reserve(entries.size());
  7641. for (auto &entry : entries) {
  7642. content_types.push_back(std::move(entry.media_type));
  7643. }
  7644. return true;
  7645. }
  7646. class FormDataParser {
  7647. public:
  7648. FormDataParser() = default;
  7649. void set_boundary(std::string &&boundary) {
  7650. boundary_ = std::move(boundary);
  7651. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7652. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7653. }
  7654. bool is_valid() const { return is_valid_; }
  7655. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7656. const ContentReceiver &content_callback) {
  7657. // Once the close delimiter has been seen the rest of the body is epilogue
  7658. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7659. // spread across reads is not copied in only to be erased right away.
  7660. if (state_ == 5) { return true; }
  7661. buf_append(buf, n);
  7662. while (buf_size() > 0) {
  7663. switch (state_) {
  7664. case 0: { // Initial boundary
  7665. auto pos = buf_find(dash_boundary_crlf_);
  7666. if (pos == buf_size()) {
  7667. // Not found yet: keep only a possible partial boundary at the tail so
  7668. // that a body which never contains the boundary cannot grow the
  7669. // buffer (and get rescanned from the start) without bound.
  7670. auto keep = dash_boundary_crlf_.size() - 1;
  7671. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7672. return true;
  7673. }
  7674. buf_erase(pos + dash_boundary_crlf_.size());
  7675. state_ = 1;
  7676. break;
  7677. }
  7678. case 1: { // New entry
  7679. clear_file_info();
  7680. state_ = 2;
  7681. break;
  7682. }
  7683. case 2: { // Headers
  7684. auto pos = buf_find(crlf_);
  7685. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7686. while (pos < buf_size()) {
  7687. // Empty line
  7688. if (pos == 0) {
  7689. if (!header_callback(file_)) {
  7690. is_valid_ = false;
  7691. return false;
  7692. }
  7693. buf_erase(crlf_.size());
  7694. state_ = 3;
  7695. break;
  7696. }
  7697. // Check header count limit
  7698. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7699. is_valid_ = false;
  7700. return false;
  7701. }
  7702. header_count_++;
  7703. const auto header = buf_head(pos);
  7704. if (!parse_header(header.data(), header.data() + header.size(),
  7705. [&](const std::string &, const std::string &) {})) {
  7706. is_valid_ = false;
  7707. return false;
  7708. }
  7709. // Parse and emplace space trimmed headers into a map
  7710. if (!parse_header(
  7711. header.data(), header.data() + header.size(),
  7712. [&](const std::string &key, const std::string &val) {
  7713. file_.headers.emplace(key, val);
  7714. })) {
  7715. is_valid_ = false;
  7716. return false;
  7717. }
  7718. constexpr const char header_content_type[] = "Content-Type:";
  7719. if (start_with_case_ignore(header, header_content_type)) {
  7720. file_.content_type =
  7721. trim_copy(header.substr(str_len(header_content_type)));
  7722. } else {
  7723. std::string disposition_params;
  7724. if (parse_content_disposition(header, disposition_params)) {
  7725. Params params;
  7726. parse_disposition_params(disposition_params, params);
  7727. auto it = params.find("name");
  7728. if (it != params.end()) {
  7729. file_.name = it->second;
  7730. } else {
  7731. is_valid_ = false;
  7732. return false;
  7733. }
  7734. it = params.find("filename");
  7735. if (it != params.end()) { file_.filename = it->second; }
  7736. it = params.find("filename*");
  7737. if (it != params.end()) {
  7738. // RFC 5987: only UTF-8 encoding is allowed
  7739. const auto &val = it->second;
  7740. constexpr const char utf8_prefix[] = "UTF-8''";
  7741. constexpr size_t prefix_len = str_len(utf8_prefix);
  7742. if (val.size() > prefix_len &&
  7743. start_with_case_ignore(val, utf8_prefix)) {
  7744. file_.filename = decode_path_component(
  7745. val.substr(prefix_len)); // override...
  7746. } else {
  7747. is_valid_ = false;
  7748. return false;
  7749. }
  7750. }
  7751. }
  7752. }
  7753. buf_erase(pos + crlf_.size());
  7754. pos = buf_find(crlf_);
  7755. }
  7756. if (state_ != 3) { return true; }
  7757. break;
  7758. }
  7759. case 3: { // Body
  7760. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7761. auto pos = buf_find(crlf_dash_boundary_);
  7762. if (pos < buf_size()) {
  7763. if (!content_callback(buf_data(), pos)) {
  7764. is_valid_ = false;
  7765. return false;
  7766. }
  7767. buf_erase(pos + crlf_dash_boundary_.size());
  7768. state_ = 4;
  7769. } else {
  7770. auto len = buf_size() - crlf_dash_boundary_.size();
  7771. if (len > 0) {
  7772. if (!content_callback(buf_data(), len)) {
  7773. is_valid_ = false;
  7774. return false;
  7775. }
  7776. buf_erase(len);
  7777. }
  7778. return true;
  7779. }
  7780. break;
  7781. }
  7782. case 4: { // Boundary
  7783. if (crlf_.size() > buf_size()) { return true; }
  7784. if (buf_start_with(crlf_)) {
  7785. buf_erase(crlf_.size());
  7786. state_ = 1;
  7787. } else if (buf_start_with(dash_)) {
  7788. buf_erase(dash_.size());
  7789. is_valid_ = true;
  7790. state_ = 5;
  7791. } else {
  7792. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7793. // accepted after a boundary; RFC 2046 allows transport-padding in
  7794. // between, but this parser has never supported it. Either way the
  7795. // body is already destined to be rejected, so fail now instead of
  7796. // buffering the rest of it. Both are two bytes, so the check above
  7797. // already guarantees enough buffered data to decide.
  7798. is_valid_ = false;
  7799. return false;
  7800. }
  7801. break;
  7802. }
  7803. case 5: { // Epilogue
  7804. buf_erase(buf_size());
  7805. break;
  7806. }
  7807. }
  7808. }
  7809. return true;
  7810. }
  7811. private:
  7812. void clear_file_info() {
  7813. file_.name.clear();
  7814. file_.filename.clear();
  7815. file_.content_type.clear();
  7816. file_.headers.clear();
  7817. header_count_ = 0;
  7818. }
  7819. bool start_with_case_ignore(const std::string &a, const char *b,
  7820. size_t offset = 0) const {
  7821. const auto b_len = strlen(b);
  7822. if (a.size() < offset + b_len) { return false; }
  7823. for (size_t i = 0; i < b_len; i++) {
  7824. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7825. return false;
  7826. }
  7827. }
  7828. return true;
  7829. }
  7830. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7831. // Returns true if header matches, with the params portion in `params_out`.
  7832. bool parse_content_disposition(const std::string &header,
  7833. std::string &params_out) const {
  7834. constexpr const char prefix[] = "Content-Disposition:";
  7835. constexpr size_t prefix_len = str_len(prefix);
  7836. if (!start_with_case_ignore(header, prefix)) { return false; }
  7837. // Skip whitespace after "Content-Disposition:"
  7838. auto pos = prefix_len;
  7839. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7840. pos++;
  7841. }
  7842. // Match "form-data;" (case-insensitive)
  7843. constexpr const char form_data[] = "form-data;";
  7844. constexpr size_t form_data_len = str_len(form_data);
  7845. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7846. pos += form_data_len;
  7847. // Skip whitespace after "form-data;"
  7848. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7849. pos++;
  7850. }
  7851. params_out = header.substr(pos);
  7852. return true;
  7853. }
  7854. const std::string dash_ = "--";
  7855. const std::string crlf_ = "\r\n";
  7856. std::string boundary_;
  7857. std::string dash_boundary_crlf_;
  7858. std::string crlf_dash_boundary_;
  7859. size_t state_ = 0;
  7860. bool is_valid_ = false;
  7861. FormData file_;
  7862. size_t header_count_ = 0;
  7863. // Buffer
  7864. bool start_with(const std::string &a, size_t spos, size_t epos,
  7865. const std::string &b) const {
  7866. if (epos - spos < b.size()) { return false; }
  7867. for (size_t i = 0; i < b.size(); i++) {
  7868. if (a[i + spos] != b[i]) { return false; }
  7869. }
  7870. return true;
  7871. }
  7872. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7873. const char *buf_data() const { return &buf_[buf_spos_]; }
  7874. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7875. bool buf_start_with(const std::string &s) const {
  7876. return start_with(buf_, buf_spos_, buf_epos_, s);
  7877. }
  7878. size_t buf_find(const std::string &s) const {
  7879. auto c = s.front();
  7880. size_t off = buf_spos_;
  7881. while (off < buf_epos_) {
  7882. auto pos = off;
  7883. while (true) {
  7884. if (pos == buf_epos_) { return buf_size(); }
  7885. if (buf_[pos] == c) { break; }
  7886. pos++;
  7887. }
  7888. auto remaining_size = buf_epos_ - pos;
  7889. if (s.size() > remaining_size) { return buf_size(); }
  7890. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7891. off = pos + 1;
  7892. }
  7893. return buf_size();
  7894. }
  7895. void buf_append(const char *data, size_t n) {
  7896. auto remaining_size = buf_size();
  7897. if (remaining_size > 0 && buf_spos_ > 0) {
  7898. for (size_t i = 0; i < remaining_size; i++) {
  7899. buf_[i] = buf_[buf_spos_ + i];
  7900. }
  7901. }
  7902. buf_spos_ = 0;
  7903. buf_epos_ = remaining_size;
  7904. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7905. for (size_t i = 0; i < n; i++) {
  7906. buf_[buf_epos_ + i] = data[i];
  7907. }
  7908. buf_epos_ += n;
  7909. }
  7910. void buf_erase(size_t size) { buf_spos_ += size; }
  7911. std::string buf_;
  7912. size_t buf_spos_ = 0;
  7913. size_t buf_epos_ = 0;
  7914. };
  7915. inline std::string random_string(size_t length) {
  7916. constexpr const char data[] =
  7917. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  7918. thread_local auto engine([]() {
  7919. // std::random_device might actually be deterministic on some
  7920. // platforms, but due to lack of support in the c++ standard library,
  7921. // doing better requires either some ugly hacks or breaking portability.
  7922. std::random_device seed_gen;
  7923. // Request 128 bits of entropy for initialization
  7924. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  7925. return std::mt19937(seed_sequence);
  7926. }());
  7927. std::string result;
  7928. for (size_t i = 0; i < length; i++) {
  7929. result += data[engine() % (sizeof(data) - 1)];
  7930. }
  7931. return result;
  7932. }
  7933. inline std::string make_multipart_data_boundary() {
  7934. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  7935. }
  7936. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  7937. auto valid = true;
  7938. for (size_t i = 0; i < boundary.size(); i++) {
  7939. auto c = boundary[i];
  7940. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  7941. valid = false;
  7942. break;
  7943. }
  7944. }
  7945. return valid;
  7946. }
  7947. // Escape a multipart field name/filename following the WHATWG HTML standard
  7948. // ("escape a multipart form-data name"), which is what browsers send:
  7949. // '"' -> %22, CR -> %0D, LF -> %0A
  7950. // With escape_quote = false, only CR and LF are escaped; this is for header
  7951. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  7952. inline std::string escape_multipart_field(const std::string &s,
  7953. bool escape_quote = true) {
  7954. std::string result;
  7955. result.reserve(s.size());
  7956. for (auto c : s) {
  7957. switch (c) {
  7958. case '"':
  7959. if (escape_quote) {
  7960. result += "%22";
  7961. } else {
  7962. result += c;
  7963. }
  7964. break;
  7965. case '\r': result += "%0D"; break;
  7966. case '\n': result += "%0A"; break;
  7967. default: result += c; break;
  7968. }
  7969. }
  7970. return result;
  7971. }
  7972. template <typename T>
  7973. inline std::string
  7974. serialize_multipart_formdata_item_begin(const T &item,
  7975. const std::string &boundary) {
  7976. std::string body = "--" + boundary + "\r\n";
  7977. body += "Content-Disposition: form-data; name=\"" +
  7978. escape_multipart_field(item.name) + "\"";
  7979. if (!item.filename.empty()) {
  7980. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  7981. }
  7982. body += "\r\n";
  7983. if (!item.content_type.empty()) {
  7984. body +=
  7985. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  7986. "\r\n";
  7987. }
  7988. body += "\r\n";
  7989. return body;
  7990. }
  7991. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  7992. inline std::string
  7993. serialize_multipart_formdata_finish(const std::string &boundary) {
  7994. return "--" + boundary + "--\r\n";
  7995. }
  7996. inline std::string
  7997. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  7998. return "multipart/form-data; boundary=" + boundary;
  7999. }
  8000. inline std::string
  8001. serialize_multipart_formdata(const UploadFormDataItems &items,
  8002. const std::string &boundary, bool finish = true) {
  8003. std::string body;
  8004. for (const auto &item : items) {
  8005. body += serialize_multipart_formdata_item_begin(item, boundary);
  8006. body += item.content + serialize_multipart_formdata_item_end();
  8007. }
  8008. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8009. return body;
  8010. }
  8011. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8012. const std::string &boundary) {
  8013. size_t total = 0;
  8014. for (const auto &item : items) {
  8015. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8016. total += item.content.size();
  8017. total += serialize_multipart_formdata_item_end().size();
  8018. }
  8019. total += serialize_multipart_formdata_finish(boundary).size();
  8020. return total;
  8021. }
  8022. struct MultipartSegment {
  8023. const char *data;
  8024. size_t size;
  8025. };
  8026. // NOTE: items must outlive the returned ContentProvider
  8027. // (safe for synchronous use inside Post/Put/Patch)
  8028. inline ContentProvider
  8029. make_multipart_content_provider(const UploadFormDataItems &items,
  8030. const std::string &boundary) {
  8031. // Own the per-item header strings and the finish string
  8032. std::vector<std::string> owned;
  8033. owned.reserve(items.size() + 1);
  8034. for (const auto &item : items)
  8035. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8036. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8037. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8038. std::vector<MultipartSegment> segs;
  8039. segs.reserve(items.size() * 3 + 1);
  8040. static const char crlf[] = "\r\n";
  8041. for (size_t i = 0; i < items.size(); i++) {
  8042. segs.push_back({owned[i].data(), owned[i].size()});
  8043. segs.push_back({items[i].content.data(), items[i].content.size()});
  8044. segs.push_back({crlf, 2});
  8045. }
  8046. segs.push_back({owned.back().data(), owned.back().size()});
  8047. struct MultipartState {
  8048. std::vector<std::string> owned;
  8049. std::vector<MultipartSegment> segs;
  8050. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8051. };
  8052. auto state = std::make_shared<MultipartState>();
  8053. state->owned = std::move(owned);
  8054. // `segs` holds raw pointers into owned strings; std::string move preserves
  8055. // the data pointer, so these pointers remain valid after the move above.
  8056. state->segs = std::move(segs);
  8057. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8058. // Buffer multiple small segments into fewer, larger writes to avoid
  8059. // excessive TCP packets when there are many form data items (#2410)
  8060. auto &buf = state->buf;
  8061. auto buf_size = buf.size();
  8062. size_t buf_len = 0;
  8063. size_t remaining = length;
  8064. // Find the first segment containing 'offset'
  8065. size_t pos = 0;
  8066. size_t seg_idx = 0;
  8067. for (; seg_idx < state->segs.size(); seg_idx++) {
  8068. const auto &seg = state->segs[seg_idx];
  8069. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8070. pos += seg.size;
  8071. }
  8072. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8073. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8074. const auto &seg = state->segs[seg_idx];
  8075. size_t available = seg.size - seg_offset;
  8076. size_t to_copy = (std::min)(available, remaining);
  8077. const char *src = seg.data + seg_offset;
  8078. seg_offset = 0; // only the first segment has a non-zero offset
  8079. while (to_copy > 0) {
  8080. size_t space = buf_size - buf_len;
  8081. size_t chunk = (std::min)(to_copy, space);
  8082. std::memcpy(buf.data() + buf_len, src, chunk);
  8083. buf_len += chunk;
  8084. src += chunk;
  8085. to_copy -= chunk;
  8086. remaining -= chunk;
  8087. if (buf_len == buf_size) {
  8088. if (!sink.write(buf.data(), buf_len)) { return false; }
  8089. buf_len = 0;
  8090. }
  8091. }
  8092. }
  8093. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8094. return true;
  8095. };
  8096. }
  8097. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8098. if (ranges.size() <= 1) return;
  8099. // Sort ranges by start position
  8100. std::sort(ranges.begin(), ranges.end(),
  8101. [](const Range &a, const Range &b) { return a.first < b.first; });
  8102. Ranges coalesced;
  8103. coalesced.reserve(ranges.size());
  8104. for (auto &r : ranges) {
  8105. auto first_pos = r.first;
  8106. auto last_pos = r.second;
  8107. // Handle special cases like in range_error
  8108. if (first_pos == -1 && last_pos == -1) {
  8109. first_pos = 0;
  8110. last_pos = static_cast<ssize_t>(content_length);
  8111. }
  8112. if (first_pos == -1) {
  8113. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8114. last_pos = static_cast<ssize_t>(content_length) - 1;
  8115. }
  8116. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8117. last_pos = static_cast<ssize_t>(content_length) - 1;
  8118. }
  8119. // Skip invalid ranges
  8120. if (!(0 <= first_pos && first_pos <= last_pos &&
  8121. last_pos < static_cast<ssize_t>(content_length))) {
  8122. continue;
  8123. }
  8124. // Coalesce with previous range if overlapping or adjacent (but not
  8125. // identical)
  8126. if (!coalesced.empty()) {
  8127. auto &prev = coalesced.back();
  8128. // Check if current range overlaps or is adjacent to previous range
  8129. // but don't coalesce identical ranges (allow duplicates)
  8130. if (first_pos <= prev.second + 1 &&
  8131. !(first_pos == prev.first && last_pos == prev.second)) {
  8132. // Extend the previous range
  8133. prev.second = (std::max)(prev.second, last_pos);
  8134. continue;
  8135. }
  8136. }
  8137. // Add new range
  8138. coalesced.emplace_back(first_pos, last_pos);
  8139. }
  8140. ranges = std::move(coalesced);
  8141. }
  8142. inline bool range_error(Request &req, Response &res) {
  8143. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8144. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8145. req.ranges.clear();
  8146. if (res.status == StatusCode::PartialContent_206) {
  8147. res.status = StatusCode::OK_200;
  8148. }
  8149. return false;
  8150. }
  8151. ssize_t content_len = static_cast<ssize_t>(
  8152. res.content_length_ ? res.content_length_ : res.body.size());
  8153. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8154. size_t overwrapping_count = 0;
  8155. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8156. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8157. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8158. // Too many ranges
  8159. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8160. for (auto &r : req.ranges) {
  8161. auto &first_pos = r.first;
  8162. auto &last_pos = r.second;
  8163. if (first_pos == -1 && last_pos == -1) {
  8164. first_pos = 0;
  8165. last_pos = content_len;
  8166. }
  8167. if (first_pos == -1) {
  8168. first_pos = content_len - last_pos;
  8169. last_pos = content_len - 1;
  8170. }
  8171. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8172. // A client can limit the number of bytes requested without knowing the
  8173. // size of the selected representation. If the last-pos value is absent,
  8174. // or if the value is greater than or equal to the current length of the
  8175. // representation data, the byte range is interpreted as the remainder of
  8176. // the representation (i.e., the server replaces the value of last-pos
  8177. // with a value that is one less than the current length of the selected
  8178. // representation).
  8179. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8180. if (last_pos == -1 || last_pos >= content_len) {
  8181. last_pos = content_len - 1;
  8182. }
  8183. // Range must be within content length
  8184. if (!(0 <= first_pos && first_pos <= last_pos &&
  8185. last_pos <= content_len - 1)) {
  8186. return true;
  8187. }
  8188. // Request must not have more than two overlapping ranges
  8189. for (const auto &processed_range : processed_ranges) {
  8190. if (!(last_pos < processed_range.first ||
  8191. first_pos > processed_range.second)) {
  8192. overwrapping_count++;
  8193. if (overwrapping_count > 2) { return true; }
  8194. break; // Only count once per range
  8195. }
  8196. }
  8197. processed_ranges.emplace_back(first_pos, last_pos);
  8198. }
  8199. // After validation, coalesce overlapping ranges as per RFC 9110
  8200. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8201. }
  8202. return false;
  8203. }
  8204. inline std::pair<size_t, size_t>
  8205. get_range_offset_and_length(Range r, size_t content_length) {
  8206. assert(r.first != -1 && r.second != -1);
  8207. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8208. assert(r.first <= r.second &&
  8209. r.second < static_cast<ssize_t>(content_length));
  8210. (void)(content_length);
  8211. return std::make_pair(static_cast<size_t>(r.first),
  8212. static_cast<size_t>(r.second - r.first) + 1);
  8213. }
  8214. inline std::string make_content_range_header_field(
  8215. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8216. auto st = offset_and_length.first;
  8217. auto ed = st + offset_and_length.second - 1;
  8218. std::string field = "bytes ";
  8219. field += std::to_string(st);
  8220. field += '-';
  8221. field += std::to_string(ed);
  8222. field += '/';
  8223. field += std::to_string(content_length);
  8224. return field;
  8225. }
  8226. template <typename SToken, typename CToken, typename Content>
  8227. bool process_multipart_ranges_data(const Request &req,
  8228. const std::string &boundary,
  8229. const std::string &content_type,
  8230. size_t content_length, SToken stoken,
  8231. CToken ctoken, Content content) {
  8232. for (size_t i = 0; i < req.ranges.size(); i++) {
  8233. ctoken("--");
  8234. stoken(boundary);
  8235. ctoken("\r\n");
  8236. if (!content_type.empty()) {
  8237. ctoken("Content-Type: ");
  8238. stoken(content_type);
  8239. ctoken("\r\n");
  8240. }
  8241. auto offset_and_length =
  8242. get_range_offset_and_length(req.ranges[i], content_length);
  8243. ctoken("Content-Range: ");
  8244. stoken(make_content_range_header_field(offset_and_length, content_length));
  8245. ctoken("\r\n");
  8246. ctoken("\r\n");
  8247. if (!content(offset_and_length.first, offset_and_length.second)) {
  8248. return false;
  8249. }
  8250. ctoken("\r\n");
  8251. }
  8252. ctoken("--");
  8253. stoken(boundary);
  8254. ctoken("--");
  8255. return true;
  8256. }
  8257. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8258. const std::string &boundary,
  8259. const std::string &content_type,
  8260. size_t content_length,
  8261. std::string &data) {
  8262. process_multipart_ranges_data(
  8263. req, boundary, content_type, content_length,
  8264. [&](const std::string &token) { data += token; },
  8265. [&](const std::string &token) { data += token; },
  8266. [&](size_t offset, size_t length) {
  8267. assert(offset + length <= content_length);
  8268. data += res.body.substr(offset, length);
  8269. return true;
  8270. });
  8271. }
  8272. inline size_t get_multipart_ranges_data_length(const Request &req,
  8273. const std::string &boundary,
  8274. const std::string &content_type,
  8275. size_t content_length) {
  8276. size_t data_length = 0;
  8277. process_multipart_ranges_data(
  8278. req, boundary, content_type, content_length,
  8279. [&](const std::string &token) { data_length += token.size(); },
  8280. [&](const std::string &token) { data_length += token.size(); },
  8281. [&](size_t /*offset*/, size_t length) {
  8282. data_length += length;
  8283. return true;
  8284. });
  8285. return data_length;
  8286. }
  8287. template <typename T>
  8288. inline bool
  8289. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8290. const std::string &boundary,
  8291. const std::string &content_type,
  8292. size_t content_length, const T &is_shutting_down) {
  8293. return process_multipart_ranges_data(
  8294. req, boundary, content_type, content_length,
  8295. [&](const std::string &token) { strm.write(token); },
  8296. [&](const std::string &token) { strm.write(token); },
  8297. [&](size_t offset, size_t length) {
  8298. return write_content(strm, res.content_provider_, offset, length,
  8299. is_shutting_down);
  8300. });
  8301. }
  8302. inline bool has_framed_body(const Request &req) {
  8303. return is_chunked_transfer_encoding(req.headers) ||
  8304. req.get_header_value_u64("Content-Length") > 0;
  8305. }
  8306. inline bool is_connection_persistent(const Request &req) {
  8307. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8308. if (req.version == "HTTP/1.0" &&
  8309. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8310. return false;
  8311. }
  8312. return true;
  8313. }
  8314. inline bool expect_content(const Request &req) {
  8315. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8316. req.method == "DELETE") {
  8317. return true;
  8318. }
  8319. return has_framed_body(req);
  8320. }
  8321. #ifdef _WIN32
  8322. class WSInit {
  8323. public:
  8324. WSInit() {
  8325. WSADATA wsaData;
  8326. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8327. }
  8328. ~WSInit() {
  8329. if (is_valid_) WSACleanup();
  8330. }
  8331. bool is_valid_ = false;
  8332. };
  8333. static WSInit wsinit_;
  8334. #endif
  8335. // RFC 9110 Section 11.6.1 defines a challenge list as
  8336. // WWW-Authenticate = #challenge
  8337. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8338. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8339. // so a server may offer several schemes, each with its own comma-separated
  8340. // auth-param list, in either order and either as separate field lines or
  8341. // packed into one. Splitting on every comma would break apart a challenge's
  8342. // own param list; splitting only on the first space would miss a Digest
  8343. // challenge that isn't first. Split on commas that aren't inside a
  8344. // quoted-string instead, then track which scheme each resulting segment
  8345. // belongs to: a segment whose text before "=" contains whitespace (or that
  8346. // has no "=" at all) starts a new challenge named by its leading token.
  8347. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8348. std::vector<std::string> segments;
  8349. size_t start = 0;
  8350. auto in_quotes = false;
  8351. for (size_t i = 0; i < s.size(); i++) {
  8352. auto c = s[i];
  8353. if (in_quotes) {
  8354. if (c == '\\' && i + 1 < s.size()) {
  8355. i++;
  8356. } else if (c == '"') {
  8357. in_quotes = false;
  8358. }
  8359. } else if (c == '"') {
  8360. in_quotes = true;
  8361. } else if (c == ',') {
  8362. segments.push_back(s.substr(start, i - start));
  8363. start = i + 1;
  8364. }
  8365. }
  8366. segments.push_back(s.substr(start));
  8367. return segments;
  8368. }
  8369. inline std::string unescape_quoted_pairs(const std::string &s) {
  8370. std::string out;
  8371. out.reserve(s.size());
  8372. for (size_t i = 0; i < s.size(); i++) {
  8373. if (s[i] == '\\' && i + 1 < s.size()) {
  8374. out += s[++i];
  8375. } else {
  8376. out += s[i];
  8377. }
  8378. }
  8379. return out;
  8380. }
  8381. inline bool parse_www_authenticate(const Response &res,
  8382. std::map<std::string, std::string> &auth,
  8383. bool is_proxy) {
  8384. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8385. auto combined = get_combined_header_value(res.headers, auth_key);
  8386. if (combined.empty()) { return false; }
  8387. auto found_digest = false;
  8388. auto in_digest_challenge = false;
  8389. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8390. auto segment = trim_copy(raw_segment);
  8391. if (segment.empty()) { continue; }
  8392. auto eq_pos = segment.find('=');
  8393. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8394. // for the first segment of a challenge, "<scheme> <key>") must be
  8395. // trimmed before its boundaries are inspected.
  8396. auto key_part = trim_copy(
  8397. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8398. auto space_pos = key_part.find_last_of(" \t");
  8399. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8400. // "<scheme>[ <key>]" starts a new challenge.
  8401. auto scheme_end =
  8402. space_pos == std::string::npos ? key_part.size() : space_pos;
  8403. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8404. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8405. // from one challenge is never paired with another's algorithm.
  8406. in_digest_challenge =
  8407. !found_digest &&
  8408. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8409. if (in_digest_challenge) { found_digest = true; }
  8410. if (space_pos == std::string::npos) {
  8411. // Bare scheme (or a token68), no auth-param on this segment.
  8412. continue;
  8413. }
  8414. key_part = key_part.substr(space_pos + 1);
  8415. }
  8416. if (!in_digest_challenge) { continue; }
  8417. auto val = trim_copy(segment.substr(eq_pos + 1));
  8418. auto unquoted = trim_double_quotes_copy(val);
  8419. if (unquoted.size() != val.size()) {
  8420. unquoted = unescape_quoted_pairs(unquoted);
  8421. }
  8422. auth[std::move(key_part)] = std::move(unquoted);
  8423. }
  8424. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8425. // make_digest_authentication_header() dereferences both unconditionally, so
  8426. // a challenge missing either can't produce a usable Authorization header.
  8427. // Treat it the same as no Digest challenge at all.
  8428. return found_digest && auth.find("realm") != auth.end() &&
  8429. auth.find("nonce") != auth.end();
  8430. }
  8431. class ContentProviderAdapter {
  8432. public:
  8433. explicit ContentProviderAdapter(
  8434. ContentProviderWithoutLength &&content_provider)
  8435. : content_provider_(std::move(content_provider)) {}
  8436. bool operator()(size_t offset, size_t, DataSink &sink) {
  8437. return content_provider_(offset, sink);
  8438. }
  8439. private:
  8440. ContentProviderWithoutLength content_provider_;
  8441. };
  8442. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8443. namespace fields {
  8444. inline bool is_token_char(char c) {
  8445. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8446. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8447. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8448. }
  8449. inline bool is_token(const std::string &s) {
  8450. if (s.empty()) { return false; }
  8451. for (auto c : s) {
  8452. if (!is_token_char(c)) { return false; }
  8453. }
  8454. return true;
  8455. }
  8456. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8457. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8458. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8459. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8460. inline bool is_field_content(const std::string &s) {
  8461. if (s.empty()) { return true; }
  8462. if (s.size() == 1) {
  8463. return is_field_vchar(s[0]);
  8464. } else if (s.size() == 2) {
  8465. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8466. } else {
  8467. size_t i = 0;
  8468. if (!is_field_vchar(s[i])) { return false; }
  8469. i++;
  8470. while (i < s.size() - 1) {
  8471. auto c = s[i++];
  8472. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8473. } else {
  8474. return false;
  8475. }
  8476. }
  8477. return is_field_vchar(s[i]);
  8478. }
  8479. }
  8480. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8481. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8482. return is_field_name(name) && is_field_value(value);
  8483. }
  8484. } // namespace fields
  8485. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8486. WebSocketUpgradeResponse &upgrade) {
  8487. // Generate random Sec-WebSocket-Key
  8488. thread_local std::mt19937 rng(std::random_device{}());
  8489. std::string key_bytes(16, '\0');
  8490. for (size_t i = 0; i < 16; i += 4) {
  8491. auto r = rng();
  8492. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8493. }
  8494. auto client_key = base64_encode(key_bytes);
  8495. req.headers.erase("Upgrade");
  8496. req.headers.erase("Connection");
  8497. req.headers.erase("Sec-WebSocket-Key");
  8498. req.headers.erase("Sec-WebSocket-Version");
  8499. req.headers.emplace("Upgrade", "websocket");
  8500. req.headers.emplace("Connection", "Upgrade");
  8501. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8502. req.headers.emplace("Sec-WebSocket-Version", "13");
  8503. // Build the request in memory first, like ClientImpl::write_request does.
  8504. // Writing straight to the socket would leak a request line onto the wire
  8505. // before check_and_write_headers gets a chance to reject an invalid header,
  8506. // and would emit one small write per header.
  8507. BufferStream bstrm;
  8508. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8509. upgrade.error = Error::Write;
  8510. return false;
  8511. }
  8512. auto error = Error::Success;
  8513. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8514. upgrade.error = error;
  8515. return false;
  8516. }
  8517. const auto &data = bstrm.get_buffer();
  8518. if (!write_data(strm, data.data(), data.size())) {
  8519. upgrade.error = Error::Write;
  8520. return false;
  8521. }
  8522. // Verify 101 response and Sec-WebSocket-Accept header
  8523. auto expected_accept = websocket_accept_key(client_key);
  8524. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8525. }
  8526. inline bool is_ip_address(const std::string &host) {
  8527. struct in_addr addr4;
  8528. struct in6_addr addr6;
  8529. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8530. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8531. }
  8532. // Resolve where a client should connect for `host`, honoring a user-supplied
  8533. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8534. // supplying the Host header and SNI; only the connection target changes.
  8535. //
  8536. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8537. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8538. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8539. // absent or empty mapping leaves `host` as the connection target; without the
  8540. // empty check the value would reach getaddrinfo as a null node and silently
  8541. // resolve to loopback.
  8542. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8543. const std::string &host, std::string &connect_host,
  8544. std::string &ip) {
  8545. connect_host = host;
  8546. ip.clear();
  8547. auto it = addr_map.find(host);
  8548. if (it == addr_map.end() || it->second.empty()) { return; }
  8549. if (is_ip_address(it->second)) {
  8550. ip = it->second;
  8551. } else {
  8552. connect_host = it->second;
  8553. }
  8554. }
  8555. } // namespace detail
  8556. /*
  8557. * Group 2: detail namespace - SSL common utilities
  8558. */
  8559. #ifdef CPPHTTPLIB_SSL_ENABLED
  8560. namespace detail {
  8561. class SSLSocketStream final : public Stream {
  8562. public:
  8563. SSLSocketStream(
  8564. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8565. time_t read_timeout_usec, time_t write_timeout_sec,
  8566. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8567. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8568. (std::chrono::steady_clock::time_point::min)());
  8569. ~SSLSocketStream() override;
  8570. bool is_readable() const override;
  8571. bool wait_readable() const override;
  8572. bool wait_writable() const override;
  8573. bool is_peer_alive() const override;
  8574. ssize_t read(char *ptr, size_t size) override;
  8575. ssize_t write(const char *ptr, size_t size) override;
  8576. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8577. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8578. socket_t socket() const override;
  8579. time_t duration() const override;
  8580. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8581. // See SocketStream::set_readable_hint().
  8582. void set_readable_hint() { readable_hint_ = true; }
  8583. private:
  8584. bool ensure_readable();
  8585. socket_t sock_;
  8586. tls::session_t session_;
  8587. time_t read_timeout_sec_;
  8588. time_t read_timeout_usec_;
  8589. time_t write_timeout_sec_;
  8590. time_t write_timeout_usec_;
  8591. time_t max_timeout_msec_;
  8592. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8593. bool readable_hint_ = false;
  8594. };
  8595. // A TLS stream for WebSocket connections, where the receive path and the
  8596. // send path (application send() plus the heartbeat ping thread) run on
  8597. // different threads. A single TLS session must never be entered
  8598. // concurrently, so every call into the session is serialized by one mutex.
  8599. //
  8600. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8601. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8602. // call under the lock, then waits for readiness with select() outside the
  8603. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8604. // blocked waiting for data never stalls a concurrent sender.
  8605. //
  8606. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8607. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8608. class WebSocketSSLStream final : public Stream {
  8609. public:
  8610. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8611. time_t read_timeout_sec, time_t read_timeout_usec,
  8612. time_t write_timeout_sec, time_t write_timeout_usec);
  8613. ~WebSocketSSLStream() override;
  8614. bool is_readable() const override;
  8615. bool wait_readable() const override;
  8616. bool wait_writable() const override;
  8617. ssize_t read(char *ptr, size_t size) override;
  8618. ssize_t write(const char *ptr, size_t size) override;
  8619. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8620. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8621. socket_t socket() const override;
  8622. time_t duration() const override;
  8623. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8624. private:
  8625. mutable std::mutex session_mutex_;
  8626. socket_t sock_;
  8627. tls::session_t session_;
  8628. // WebSocket::close() shortens the read timeout from the closing thread
  8629. // while the receive thread is inside wait_readable(), so these two are read
  8630. // and written concurrently. The write timeouts are never mutated.
  8631. std::atomic<time_t> read_timeout_sec_;
  8632. std::atomic<time_t> read_timeout_usec_;
  8633. time_t write_timeout_sec_;
  8634. time_t write_timeout_usec_;
  8635. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8636. };
  8637. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8638. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8639. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8640. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8641. unsigned int hash_length = 0;
  8642. unsigned char hash[EVP_MAX_MD_SIZE];
  8643. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8644. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8645. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8646. std::stringstream ss;
  8647. for (auto i = 0u; i < hash_length; ++i) {
  8648. ss << std::hex << std::setw(2) << std::setfill('0')
  8649. << static_cast<unsigned int>(hash[i]);
  8650. }
  8651. return ss.str();
  8652. }
  8653. inline std::string MD5(const std::string &s) {
  8654. return message_digest(s, EVP_md5());
  8655. }
  8656. inline std::string SHA_256(const std::string &s) {
  8657. return message_digest(s, EVP_sha256());
  8658. }
  8659. inline std::string SHA_512(const std::string &s) {
  8660. return message_digest(s, EVP_sha512());
  8661. }
  8662. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8663. namespace {
  8664. template <size_t N>
  8665. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8666. std::stringstream ss;
  8667. for (size_t i = 0; i < N; ++i) {
  8668. ss << std::hex << std::setw(2) << std::setfill('0')
  8669. << static_cast<unsigned int>(hash[i]);
  8670. }
  8671. return ss.str();
  8672. }
  8673. } // namespace
  8674. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8675. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8676. // initialized once. PSA state is process-global; do not free it.
  8677. inline bool ensure_mbedtls_psa_crypto() {
  8678. static std::once_flag once;
  8679. static bool ok = false;
  8680. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8681. return ok;
  8682. }
  8683. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8684. unsigned char *out, size_t out_size) {
  8685. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8686. size_t olen = 0;
  8687. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8688. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8689. olen == out_size;
  8690. }
  8691. #endif
  8692. inline std::string MD5(const std::string &s) {
  8693. unsigned char hash[16];
  8694. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8695. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8696. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8697. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8698. hash);
  8699. #else
  8700. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8701. hash);
  8702. #endif
  8703. return hash_to_hex(hash);
  8704. }
  8705. inline std::string SHA_256(const std::string &s) {
  8706. unsigned char hash[32];
  8707. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8708. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8709. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8710. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8711. hash, 0);
  8712. #else
  8713. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8714. s.size(), hash, 0);
  8715. #endif
  8716. return hash_to_hex(hash);
  8717. }
  8718. inline std::string SHA_512(const std::string &s) {
  8719. unsigned char hash[64];
  8720. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8721. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8722. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8723. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8724. hash, 0);
  8725. #else
  8726. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8727. s.size(), hash, 0);
  8728. #endif
  8729. return hash_to_hex(hash);
  8730. }
  8731. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8732. namespace {
  8733. template <size_t N>
  8734. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8735. std::stringstream ss;
  8736. for (size_t i = 0; i < N; ++i) {
  8737. ss << std::hex << std::setw(2) << std::setfill('0')
  8738. << static_cast<unsigned int>(hash[i]);
  8739. }
  8740. return ss.str();
  8741. }
  8742. } // namespace
  8743. inline std::string MD5(const std::string &s) {
  8744. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8745. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8746. static_cast<word32>(s.size()), hash);
  8747. return hash_to_hex(hash);
  8748. }
  8749. inline std::string SHA_256(const std::string &s) {
  8750. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8751. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8752. static_cast<word32>(s.size()), hash);
  8753. return hash_to_hex(hash);
  8754. }
  8755. inline std::string SHA_512(const std::string &s) {
  8756. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8757. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8758. static_cast<word32>(s.size()), hash);
  8759. return hash_to_hex(hash);
  8760. }
  8761. #endif
  8762. template <typename T>
  8763. inline bool process_server_socket_ssl(
  8764. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8765. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8766. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8767. time_t write_timeout_usec, T callback) {
  8768. return process_server_socket_core(
  8769. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8770. [&](bool close_connection, bool &connection_closed) {
  8771. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8772. write_timeout_sec, write_timeout_usec);
  8773. // See the non-TLS path in process_server_socket().
  8774. strm.set_readable_hint();
  8775. return callback(strm, close_connection, connection_closed);
  8776. });
  8777. }
  8778. template <typename T>
  8779. inline bool process_client_socket_ssl(
  8780. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8781. time_t read_timeout_usec, time_t write_timeout_sec,
  8782. time_t write_timeout_usec, time_t max_timeout_msec,
  8783. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8784. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8785. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8786. start_time);
  8787. return callback(strm);
  8788. }
  8789. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8790. const Request &req, const std::map<std::string, std::string> &auth,
  8791. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8792. const std::string &password, bool is_proxy = false) {
  8793. std::string nc;
  8794. {
  8795. std::stringstream ss;
  8796. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8797. nc = ss.str();
  8798. }
  8799. std::string qop;
  8800. if (auth.find("qop") != auth.end()) {
  8801. qop = auth.at("qop");
  8802. if (qop.find("auth-int") != std::string::npos) {
  8803. qop = "auth-int";
  8804. } else if (qop.find("auth") != std::string::npos) {
  8805. qop = "auth";
  8806. } else {
  8807. qop.clear();
  8808. }
  8809. }
  8810. std::string algo = "MD5";
  8811. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8812. std::string response;
  8813. {
  8814. auto H = algo == "SHA-256" ? detail::SHA_256
  8815. : algo == "SHA-512" ? detail::SHA_512
  8816. : detail::MD5;
  8817. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8818. auto A2 = req.method + ":" + req.path;
  8819. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8820. if (qop.empty()) {
  8821. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8822. } else {
  8823. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8824. ":" + qop + ":" + H(A2));
  8825. }
  8826. }
  8827. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8828. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8829. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8830. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8831. (qop.empty() ? ", response=\""
  8832. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8833. cnonce + "\", response=\"") +
  8834. response + "\"" +
  8835. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8836. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8837. return std::make_pair(key, field);
  8838. }
  8839. inline bool match_hostname(const std::string &pattern,
  8840. const std::string &hostname) {
  8841. // Exact match (case-insensitive)
  8842. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8843. // Split both pattern and hostname into components by '.'
  8844. std::vector<std::string> pattern_components;
  8845. if (!pattern.empty()) {
  8846. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8847. [&](const char *b, const char *e) {
  8848. pattern_components.emplace_back(b, e);
  8849. });
  8850. }
  8851. std::vector<std::string> host_components;
  8852. if (!hostname.empty()) {
  8853. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8854. [&](const char *b, const char *e) {
  8855. host_components.emplace_back(b, e);
  8856. });
  8857. }
  8858. // Component count must match
  8859. if (host_components.size() != pattern_components.size()) { return false; }
  8860. // Compare each component with wildcard support
  8861. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8862. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8863. auto itr = pattern_components.begin();
  8864. for (const auto &h : host_components) {
  8865. auto &p = *itr;
  8866. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8867. bool partial_match = false;
  8868. if (!p.empty() && p[p.size() - 1] == '*') {
  8869. const auto prefix_length = p.size() - 1;
  8870. if (prefix_length == 0) {
  8871. partial_match = true;
  8872. } else if (h.size() >= prefix_length) {
  8873. partial_match =
  8874. std::equal(p.begin(),
  8875. p.begin() + static_cast<std::string::difference_type>(
  8876. prefix_length),
  8877. h.begin(), [](const char ca, const char cb) {
  8878. return detail::case_ignore::to_lower(ca) ==
  8879. detail::case_ignore::to_lower(cb);
  8880. });
  8881. }
  8882. }
  8883. if (!partial_match) { return false; }
  8884. }
  8885. ++itr;
  8886. }
  8887. return true;
  8888. }
  8889. #ifdef _WIN32
  8890. // Verify certificate using Windows CertGetCertificateChain API.
  8891. // This provides real-time certificate validation with Windows Update
  8892. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8893. inline bool
  8894. verify_cert_with_windows_schannel(const std::vector<unsigned char> &der_cert,
  8895. const std::string &hostname,
  8896. bool verify_hostname, uint64_t &out_error) {
  8897. if (der_cert.empty()) { return false; }
  8898. out_error = 0;
  8899. // Create Windows certificate context from DER data
  8900. auto cert_context = CertCreateCertificateContext(
  8901. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8902. static_cast<DWORD>(der_cert.size()));
  8903. if (!cert_context) {
  8904. out_error = GetLastError();
  8905. return false;
  8906. }
  8907. auto cert_guard =
  8908. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8909. // Setup chain parameters
  8910. CERT_CHAIN_PARA chain_para = {};
  8911. chain_para.cbSize = sizeof(chain_para);
  8912. // Build certificate chain with revocation checking
  8913. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  8914. auto chain_result = CertGetCertificateChain(
  8915. nullptr, cert_context, nullptr, cert_context->hCertStore, &chain_para,
  8916. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  8917. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  8918. nullptr, &chain_context);
  8919. if (!chain_result || !chain_context) {
  8920. out_error = GetLastError();
  8921. return false;
  8922. }
  8923. auto chain_guard =
  8924. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  8925. // Check if chain has errors
  8926. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  8927. out_error = chain_context->TrustStatus.dwErrorStatus;
  8928. return false;
  8929. }
  8930. // Verify SSL policy
  8931. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  8932. extra_policy_para.cbSize = sizeof(extra_policy_para);
  8933. #ifdef AUTHTYPE_SERVER
  8934. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  8935. #endif
  8936. std::wstring whost;
  8937. if (verify_hostname) {
  8938. whost = u8string_to_wstring(hostname.c_str());
  8939. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  8940. }
  8941. CERT_CHAIN_POLICY_PARA policy_para = {};
  8942. policy_para.cbSize = sizeof(policy_para);
  8943. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  8944. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  8945. #else
  8946. policy_para.dwFlags = 0;
  8947. #endif
  8948. policy_para.pvExtraPolicyPara = &extra_policy_para;
  8949. CERT_CHAIN_POLICY_STATUS policy_status = {};
  8950. policy_status.cbSize = sizeof(policy_status);
  8951. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  8952. &policy_para, &policy_status)) {
  8953. out_error = GetLastError();
  8954. return false;
  8955. }
  8956. if (policy_status.dwError != 0) {
  8957. out_error = policy_status.dwError;
  8958. return false;
  8959. }
  8960. return true;
  8961. }
  8962. #endif // _WIN32
  8963. // Loads CA file/dir configuration and applies the system CA policy to a
  8964. // client TLS context. PEM data and native stores are applied to the context
  8965. // directly at set time; has_custom_store reflects them for the Auto policy
  8966. // decision.
  8967. inline bool load_client_ca_config(tls::ctx_t ctx,
  8968. const std::string &ca_cert_file_path,
  8969. const std::string &ca_cert_dir_path,
  8970. bool has_custom_store, SystemCAMode mode,
  8971. uint64_t &backend_error) {
  8972. auto ret = true;
  8973. if (!ca_cert_file_path.empty()) {
  8974. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  8975. backend_error = tls::get_error();
  8976. ret = false;
  8977. }
  8978. } else if (!ca_cert_dir_path.empty()) {
  8979. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  8980. backend_error = tls::get_error();
  8981. ret = false;
  8982. }
  8983. }
  8984. auto has_custom_ca = !ca_cert_file_path.empty() ||
  8985. !ca_cert_dir_path.empty() || has_custom_store;
  8986. if (mode == SystemCAMode::Enabled ||
  8987. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  8988. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  8989. }
  8990. return ret;
  8991. }
  8992. // The parts of session setup that only SSLClient needs, plus the handful
  8993. // WebSocketClient also exposes; everything else takes the defaults, which is
  8994. // what keeps the two clients on one implementation.
  8995. struct ClientTlsSessionOptions {
  8996. // Both SSLClient and WebSocketClient expose this independently of
  8997. // certificate verification.
  8998. bool server_hostname_verification = true;
  8999. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9000. // When non-null, guards session creation against concurrent use of the
  9001. // context. A WebSocketClient is not safe to use from several threads to
  9002. // begin with, so it passes nothing.
  9003. std::mutex *ctx_mutex = nullptr;
  9004. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9005. // The caller decides whether Schannel has anything to say about this
  9006. // connection; see SSLClient::initialize_ssl().
  9007. bool windows_cert_verification = false;
  9008. #endif
  9009. };
  9010. // Filled in on failure for callers that report error details.
  9011. struct ClientTlsSessionError {
  9012. Error error = Error::Success;
  9013. int ssl_error = 0;
  9014. uint64_t backend_error = 0;
  9015. };
  9016. // Establishes a client TLS session on an already connected socket. On failure
  9017. // the session is left for the caller to free: SSLClient frees it right away,
  9018. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9019. inline bool setup_client_tls_session(
  9020. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9021. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9022. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9023. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9024. using namespace tls;
  9025. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9026. if (out_error) {
  9027. out_error->error = error;
  9028. out_error->ssl_error = ssl_error;
  9029. out_error->backend_error = backend_error;
  9030. }
  9031. return false;
  9032. };
  9033. if (!ctx) {
  9034. session = nullptr;
  9035. return fail(Error::SSLConnection, 0, 0);
  9036. }
  9037. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9038. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9039. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  9040. // verification happens during the handshake even for IP hosts; the
  9041. // certificate identity is verified post-handshake via verify_hostname().
  9042. set_verify_client(ctx, server_certificate_verification);
  9043. #endif
  9044. {
  9045. std::unique_lock<std::mutex> guard;
  9046. if (options.ctx_mutex) {
  9047. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9048. }
  9049. session = create_session(ctx, sock);
  9050. }
  9051. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9052. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9053. // their identity is checked post-handshake below instead. On Mbed TLS and
  9054. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9055. // options.server_hostname_verification is threaded through here.
  9056. if (!is_ip_address(host)) {
  9057. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9058. return fail(Error::SSLConnection, 0, get_error());
  9059. }
  9060. }
  9061. TlsError tls_err;
  9062. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9063. &tls_err)) {
  9064. auto error = Error::SSLConnection;
  9065. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9066. error = Error::SSLServerVerification;
  9067. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9068. error = Error::SSLServerHostnameVerification;
  9069. }
  9070. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9071. }
  9072. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9073. if (options.session_verifier) {
  9074. verification_status = options.session_verifier(session);
  9075. }
  9076. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9077. return fail(Error::SSLServerVerification, 0, get_error());
  9078. }
  9079. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9080. server_certificate_verification) {
  9081. auto verify_result = get_verify_result(session);
  9082. if (verify_result != 0) {
  9083. return fail(Error::SSLServerVerification, 0,
  9084. static_cast<uint64_t>(verify_result));
  9085. }
  9086. auto server_cert = get_peer_cert(session);
  9087. if (!server_cert) {
  9088. return fail(Error::SSLServerVerification, 0, get_error());
  9089. }
  9090. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9091. // Identity check against the peer certificate, post-handshake for all
  9092. // backends. For IP hosts this is the only identity verification, since no
  9093. // hostname is bound during the handshake.
  9094. if (options.server_hostname_verification) {
  9095. if (!verify_hostname(server_cert, host.c_str())) {
  9096. return fail(Error::SSLServerHostnameVerification, 0,
  9097. hostname_mismatch_code());
  9098. }
  9099. }
  9100. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9101. // Additional Windows Schannel verification.
  9102. // This provides real-time certificate validation with Windows Update
  9103. // integration, working with both OpenSSL and MbedTLS backends.
  9104. if (options.windows_cert_verification) {
  9105. std::vector<unsigned char> der;
  9106. if (get_cert_der(server_cert, der)) {
  9107. uint64_t wincrypt_error = 0;
  9108. if (!verify_cert_with_windows_schannel(
  9109. der, host, options.server_hostname_verification,
  9110. wincrypt_error)) {
  9111. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9112. }
  9113. }
  9114. }
  9115. #endif
  9116. }
  9117. return true;
  9118. }
  9119. } // namespace detail
  9120. #endif // CPPHTTPLIB_SSL_ENABLED
  9121. /*
  9122. * Group 3: httplib namespace - Non-SSL public API implementations
  9123. */
  9124. inline void default_socket_options(socket_t sock) {
  9125. set_socket_opt(sock, SOL_SOCKET,
  9126. #ifdef SO_REUSEPORT
  9127. SO_REUSEPORT,
  9128. #else
  9129. SO_REUSEADDR,
  9130. #endif
  9131. 1);
  9132. }
  9133. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9134. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9135. sizeof(optval));
  9136. }
  9137. inline std::string get_bearer_token_auth(const Request &req) {
  9138. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9139. // than the prefix carries no token.
  9140. constexpr const char bearer_prefix[] = "Bearer ";
  9141. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9142. auto value = req.get_header_value("Authorization");
  9143. if (value.size() >= bearer_prefix_len &&
  9144. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9145. bearer_prefix)) {
  9146. return value.substr(bearer_prefix_len);
  9147. }
  9148. return "";
  9149. }
  9150. inline const char *status_message(int status) {
  9151. switch (status) {
  9152. case StatusCode::Continue_100: return "Continue";
  9153. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9154. case StatusCode::Processing_102: return "Processing";
  9155. case StatusCode::EarlyHints_103: return "Early Hints";
  9156. case StatusCode::OK_200: return "OK";
  9157. case StatusCode::Created_201: return "Created";
  9158. case StatusCode::Accepted_202: return "Accepted";
  9159. case StatusCode::NonAuthoritativeInformation_203:
  9160. return "Non-Authoritative Information";
  9161. case StatusCode::NoContent_204: return "No Content";
  9162. case StatusCode::ResetContent_205: return "Reset Content";
  9163. case StatusCode::PartialContent_206: return "Partial Content";
  9164. case StatusCode::MultiStatus_207: return "Multi-Status";
  9165. case StatusCode::AlreadyReported_208: return "Already Reported";
  9166. case StatusCode::IMUsed_226: return "IM Used";
  9167. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9168. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9169. case StatusCode::Found_302: return "Found";
  9170. case StatusCode::SeeOther_303: return "See Other";
  9171. case StatusCode::NotModified_304: return "Not Modified";
  9172. case StatusCode::UseProxy_305: return "Use Proxy";
  9173. case StatusCode::unused_306: return "unused";
  9174. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9175. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9176. case StatusCode::BadRequest_400: return "Bad Request";
  9177. case StatusCode::Unauthorized_401: return "Unauthorized";
  9178. case StatusCode::PaymentRequired_402: return "Payment Required";
  9179. case StatusCode::Forbidden_403: return "Forbidden";
  9180. case StatusCode::NotFound_404: return "Not Found";
  9181. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9182. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9183. case StatusCode::ProxyAuthenticationRequired_407:
  9184. return "Proxy Authentication Required";
  9185. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9186. case StatusCode::Conflict_409: return "Conflict";
  9187. case StatusCode::Gone_410: return "Gone";
  9188. case StatusCode::LengthRequired_411: return "Length Required";
  9189. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9190. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9191. case StatusCode::UriTooLong_414: return "URI Too Long";
  9192. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9193. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9194. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9195. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9196. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9197. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9198. case StatusCode::Locked_423: return "Locked";
  9199. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9200. case StatusCode::TooEarly_425: return "Too Early";
  9201. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9202. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9203. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9204. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9205. return "Request Header Fields Too Large";
  9206. case StatusCode::UnavailableForLegalReasons_451:
  9207. return "Unavailable For Legal Reasons";
  9208. case StatusCode::NotImplemented_501: return "Not Implemented";
  9209. case StatusCode::BadGateway_502: return "Bad Gateway";
  9210. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9211. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9212. case StatusCode::HttpVersionNotSupported_505:
  9213. return "HTTP Version Not Supported";
  9214. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9215. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9216. case StatusCode::LoopDetected_508: return "Loop Detected";
  9217. case StatusCode::NotExtended_510: return "Not Extended";
  9218. case StatusCode::NetworkAuthenticationRequired_511:
  9219. return "Network Authentication Required";
  9220. default:
  9221. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9222. }
  9223. }
  9224. inline std::string to_string(const Error error) {
  9225. switch (error) {
  9226. case Error::Success: return "Success (no error)";
  9227. case Error::Unknown: return "Unknown";
  9228. case Error::Connection: return "Could not establish connection";
  9229. case Error::BindIPAddress: return "Failed to bind IP address";
  9230. case Error::Read: return "Failed to read connection";
  9231. case Error::Write: return "Failed to write connection";
  9232. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9233. case Error::Canceled: return "Connection handling canceled";
  9234. case Error::SSLConnection: return "SSL connection failed";
  9235. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9236. case Error::SSLServerVerification: return "SSL server verification failed";
  9237. case Error::SSLServerHostnameVerification:
  9238. return "SSL server hostname verification failed";
  9239. case Error::UnsupportedMultipartBoundaryChars:
  9240. return "Unsupported HTTP multipart boundary characters";
  9241. case Error::Compression: return "Compression failed";
  9242. case Error::ConnectionTimeout: return "Connection timed out";
  9243. case Error::ProxyConnection: return "Proxy connection failed";
  9244. case Error::ConnectionClosed: return "Connection closed by server";
  9245. case Error::Timeout: return "Read timeout";
  9246. case Error::ResourceExhaustion: return "Resource exhaustion";
  9247. case Error::TooManyFormDataFiles: return "Too many form data files";
  9248. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9249. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9250. case Error::ExceedMaxSocketDescriptorCount:
  9251. return "Exceeded maximum socket descriptor count";
  9252. case Error::InvalidRequestLine: return "Invalid request line";
  9253. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9254. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9255. case Error::InvalidHeaders: return "Invalid headers";
  9256. case Error::MultipartParsing: return "Multipart parsing failed";
  9257. case Error::OpenFile: return "Failed to open file";
  9258. case Error::Listen: return "Failed to listen on socket";
  9259. case Error::GetSockName: return "Failed to get socket name";
  9260. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9261. case Error::HTTPParsing: return "HTTP parsing failed";
  9262. case Error::InvalidRangeHeader: return "Invalid Range header";
  9263. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9264. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9265. case Error::UserCallbackException: return "User callback threw an exception";
  9266. default: break;
  9267. }
  9268. return "Invalid";
  9269. }
  9270. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9271. os << to_string(obj);
  9272. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9273. return os;
  9274. }
  9275. inline std::string hosted_at(const std::string &hostname) {
  9276. std::vector<std::string> addrs;
  9277. hosted_at(hostname, addrs);
  9278. if (addrs.empty()) { return std::string(); }
  9279. return addrs[0];
  9280. }
  9281. inline void hosted_at(const std::string &hostname,
  9282. std::vector<std::string> &addrs) {
  9283. struct addrinfo hints;
  9284. struct addrinfo *result;
  9285. memset(&hints, 0, sizeof(struct addrinfo));
  9286. hints.ai_family = AF_UNSPEC;
  9287. hints.ai_socktype = SOCK_STREAM;
  9288. hints.ai_protocol = 0;
  9289. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9290. &result, 0)) {
  9291. #if defined __linux__ && !defined __ANDROID__
  9292. res_init();
  9293. #endif
  9294. return;
  9295. }
  9296. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9297. for (auto rp = result; rp; rp = rp->ai_next) {
  9298. const auto &addr =
  9299. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9300. std::string ip;
  9301. auto dummy = -1;
  9302. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9303. dummy)) {
  9304. addrs.emplace_back(std::move(ip));
  9305. }
  9306. }
  9307. }
  9308. inline std::string encode_uri_component(const std::string &value) {
  9309. std::ostringstream escaped;
  9310. escaped.fill('0');
  9311. escaped << std::hex;
  9312. for (auto c : value) {
  9313. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9314. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9315. escaped << c;
  9316. } else {
  9317. escaped << std::uppercase;
  9318. escaped << '%' << std::setw(2)
  9319. << static_cast<int>(static_cast<unsigned char>(c));
  9320. escaped << std::nouppercase;
  9321. }
  9322. }
  9323. return escaped.str();
  9324. }
  9325. inline std::string encode_uri(const std::string &value) {
  9326. std::ostringstream escaped;
  9327. escaped.fill('0');
  9328. escaped << std::hex;
  9329. for (auto c : value) {
  9330. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9331. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9332. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9333. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9334. escaped << c;
  9335. } else {
  9336. escaped << std::uppercase;
  9337. escaped << '%' << std::setw(2)
  9338. << static_cast<int>(static_cast<unsigned char>(c));
  9339. escaped << std::nouppercase;
  9340. }
  9341. }
  9342. return escaped.str();
  9343. }
  9344. inline std::string decode_uri_component(const std::string &value) {
  9345. std::string result;
  9346. for (size_t i = 0; i < value.size(); i++) {
  9347. if (value[i] == '%' && i + 2 < value.size()) {
  9348. auto val = 0;
  9349. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9350. result += static_cast<char>(val);
  9351. i += 2;
  9352. } else {
  9353. result += value[i];
  9354. }
  9355. } else {
  9356. result += value[i];
  9357. }
  9358. }
  9359. return result;
  9360. }
  9361. inline std::string decode_uri(const std::string &value) {
  9362. std::string result;
  9363. for (size_t i = 0; i < value.size(); i++) {
  9364. if (value[i] == '%' && i + 2 < value.size()) {
  9365. auto val = 0;
  9366. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9367. auto c = static_cast<char>(val);
  9368. // Keep escapes of the reserved characters that encode_uri leaves
  9369. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9370. // delimiter is not promoted into a real one (as with JS decodeURI).
  9371. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9372. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9373. c == '#') {
  9374. result += value[i];
  9375. result += value[i + 1];
  9376. result += value[i + 2];
  9377. } else {
  9378. result += c;
  9379. }
  9380. i += 2;
  9381. } else {
  9382. result += value[i];
  9383. }
  9384. } else {
  9385. result += value[i];
  9386. }
  9387. }
  9388. return result;
  9389. }
  9390. inline std::string encode_path_component(const std::string &component) {
  9391. std::string result;
  9392. result.reserve(component.size() * 3);
  9393. for (size_t i = 0; i < component.size(); i++) {
  9394. auto c = static_cast<unsigned char>(component[i]);
  9395. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9396. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9397. c == '_' || c == '~') {
  9398. result += static_cast<char>(c);
  9399. }
  9400. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9401. // "," / ";" / "="
  9402. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9403. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9404. c == '=') {
  9405. result += static_cast<char>(c);
  9406. }
  9407. // Colon is allowed in path segments except first segment
  9408. else if (c == ':') {
  9409. result += static_cast<char>(c);
  9410. }
  9411. // @ is allowed in path
  9412. else if (c == '@') {
  9413. result += static_cast<char>(c);
  9414. } else {
  9415. result += '%';
  9416. char hex[3];
  9417. snprintf(hex, sizeof(hex), "%02X", c);
  9418. result.append(hex, 2);
  9419. }
  9420. }
  9421. return result;
  9422. }
  9423. inline std::string decode_path_component(const std::string &component) {
  9424. std::string result;
  9425. result.reserve(component.size());
  9426. for (size_t i = 0; i < component.size(); i++) {
  9427. if (component[i] == '%' && i + 1 < component.size()) {
  9428. if (component[i + 1] == 'u') {
  9429. // Unicode %uXXXX encoding
  9430. auto val = 0;
  9431. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9432. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9433. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9434. char buff[4];
  9435. size_t len = detail::to_utf8(val, buff);
  9436. if (len > 0) { result.append(buff, len); }
  9437. i += 5; // 'u0000'
  9438. } else {
  9439. result += component[i];
  9440. }
  9441. } else {
  9442. // Standard %XX encoding
  9443. auto val = 0;
  9444. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9445. // 2 digits hex codes
  9446. result += static_cast<char>(val);
  9447. i += 2; // 'XX'
  9448. } else {
  9449. result += component[i];
  9450. }
  9451. }
  9452. } else {
  9453. result += component[i];
  9454. }
  9455. }
  9456. return result;
  9457. }
  9458. inline std::string encode_query_component(const std::string &component,
  9459. bool space_as_plus) {
  9460. std::string result;
  9461. result.reserve(component.size() * 3);
  9462. for (size_t i = 0; i < component.size(); i++) {
  9463. auto c = static_cast<unsigned char>(component[i]);
  9464. // Unreserved characters per RFC 3986
  9465. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9466. c == '_' || c == '~') {
  9467. result += static_cast<char>(c);
  9468. }
  9469. // Space handling
  9470. else if (c == ' ') {
  9471. if (space_as_plus) {
  9472. result += '+';
  9473. } else {
  9474. result += "%20";
  9475. }
  9476. }
  9477. // Plus sign handling
  9478. else if (c == '+') {
  9479. if (space_as_plus) {
  9480. result += "%2B";
  9481. } else {
  9482. result += static_cast<char>(c);
  9483. }
  9484. }
  9485. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9486. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9487. c == '*' || c == ',' || c == ';') {
  9488. result += static_cast<char>(c);
  9489. }
  9490. // Colon and @ are allowed in query
  9491. else if (c == ':' || c == '@') {
  9492. result += static_cast<char>(c);
  9493. }
  9494. // Forward slash is allowed in query values
  9495. else if (c == '/') {
  9496. result += static_cast<char>(c);
  9497. }
  9498. // Question mark is allowed in query values (after first ?)
  9499. else if (c == '?') {
  9500. result += static_cast<char>(c);
  9501. } else {
  9502. result += '%';
  9503. char hex[3];
  9504. snprintf(hex, sizeof(hex), "%02X", c);
  9505. result.append(hex, 2);
  9506. }
  9507. }
  9508. return result;
  9509. }
  9510. inline std::string decode_query_component(const std::string &component,
  9511. bool plus_as_space) {
  9512. std::string result;
  9513. result.reserve(component.size());
  9514. for (size_t i = 0; i < component.size(); i++) {
  9515. if (component[i] == '%' && i + 2 < component.size()) {
  9516. auto val = 0;
  9517. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9518. result += static_cast<char>(val);
  9519. i += 2;
  9520. } else {
  9521. result += component[i];
  9522. }
  9523. } else if (component[i] == '+' && plus_as_space) {
  9524. result += ' '; // + becomes space in form-urlencoded
  9525. } else {
  9526. result += component[i];
  9527. }
  9528. }
  9529. return result;
  9530. }
  9531. inline std::string sanitize_filename(const std::string &filename) {
  9532. // Extract basename: find the last path separator (/ or \)
  9533. auto pos = filename.find_last_of("/\\");
  9534. auto result =
  9535. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9536. // Strip null bytes
  9537. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9538. // Trim whitespace
  9539. {
  9540. auto start = result.find_first_not_of(" \t");
  9541. auto end = result.find_last_not_of(" \t");
  9542. result = (start == std::string::npos)
  9543. ? ""
  9544. : result.substr(start, end - start + 1);
  9545. }
  9546. // Reject . and ..
  9547. if (result == "." || result == "..") { return ""; }
  9548. return result;
  9549. }
  9550. inline std::string append_query_params(const std::string &path,
  9551. const Params &params) {
  9552. std::string path_with_query = path;
  9553. thread_local const std::regex re("[^?]+\\?.*");
  9554. auto delm = std::regex_match(path, re) ? '&' : '?';
  9555. path_with_query += delm + detail::params_to_query_str(params);
  9556. return path_with_query;
  9557. }
  9558. // Header utilities
  9559. inline std::pair<std::string, std::string>
  9560. make_range_header(const Ranges &ranges) {
  9561. std::string field = "bytes=";
  9562. auto i = 0;
  9563. for (const auto &r : ranges) {
  9564. if (i != 0) { field += ", "; }
  9565. if (r.first != -1) { field += std::to_string(r.first); }
  9566. field += '-';
  9567. if (r.second != -1) { field += std::to_string(r.second); }
  9568. i++;
  9569. }
  9570. return std::make_pair("Range", std::move(field));
  9571. }
  9572. inline std::pair<std::string, std::string>
  9573. make_basic_authentication_header(const std::string &username,
  9574. const std::string &password, bool is_proxy) {
  9575. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9576. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9577. return std::make_pair(key, std::move(field));
  9578. }
  9579. inline std::pair<std::string, std::string>
  9580. make_bearer_token_authentication_header(const std::string &token,
  9581. bool is_proxy = false) {
  9582. auto field = "Bearer " + token;
  9583. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9584. return std::make_pair(key, std::move(field));
  9585. }
  9586. // Request implementation
  9587. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9588. size_t id) const {
  9589. return detail::get_header_value_u64(headers, key, def, id);
  9590. }
  9591. inline bool Request::has_header(const std::string &key) const {
  9592. return detail::has_header(headers, key);
  9593. }
  9594. inline std::string Request::get_header_value(const std::string &key,
  9595. const char *def, size_t id) const {
  9596. return detail::get_header_value(headers, key, def, id);
  9597. }
  9598. inline size_t Request::get_header_value_count(const std::string &key) const {
  9599. return detail::get_header_value_count(headers, key);
  9600. }
  9601. inline void Request::set_header(const std::string &key,
  9602. const std::string &val) {
  9603. detail::set_header(headers, key, val);
  9604. }
  9605. inline bool Request::has_trailer(const std::string &key) const {
  9606. return trailers.find(key) != trailers.end();
  9607. }
  9608. inline std::string Request::get_trailer_value(const std::string &key,
  9609. size_t id) const {
  9610. return detail::get_multimap_value(trailers, key, id);
  9611. }
  9612. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9613. return trailers.count(key);
  9614. }
  9615. inline bool Request::has_param(const std::string &key) const {
  9616. return params.find(key) != params.end();
  9617. }
  9618. inline std::string Request::get_param_value(const std::string &key,
  9619. size_t id) const {
  9620. return detail::get_multimap_value(params, key, id);
  9621. }
  9622. inline std::vector<std::string>
  9623. Request::get_param_values(const std::string &key) const {
  9624. auto rng = params.equal_range(key);
  9625. std::vector<std::string> values;
  9626. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9627. for (auto it = rng.first; it != rng.second; ++it) {
  9628. values.push_back(it->second);
  9629. }
  9630. return values;
  9631. }
  9632. inline size_t Request::get_param_value_count(const std::string &key) const {
  9633. return params.count(key);
  9634. }
  9635. inline bool Request::is_multipart_form_data() const {
  9636. const auto &content_type = get_header_value("Content-Type");
  9637. return detail::extract_media_type(content_type) == "multipart/form-data";
  9638. }
  9639. // Multipart FormData implementation
  9640. inline std::string MultipartFormData::get_field(const std::string &key,
  9641. size_t id) const {
  9642. auto rng = fields.equal_range(key);
  9643. auto it = rng.first;
  9644. std::advance(it, static_cast<ssize_t>(id));
  9645. if (it != rng.second) { return it->second.content; }
  9646. return std::string();
  9647. }
  9648. inline std::vector<std::string>
  9649. MultipartFormData::get_fields(const std::string &key) const {
  9650. std::vector<std::string> values;
  9651. auto rng = fields.equal_range(key);
  9652. for (auto it = rng.first; it != rng.second; it++) {
  9653. values.push_back(it->second.content);
  9654. }
  9655. return values;
  9656. }
  9657. inline bool MultipartFormData::has_field(const std::string &key) const {
  9658. return fields.find(key) != fields.end();
  9659. }
  9660. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9661. return fields.count(key);
  9662. }
  9663. inline FormData MultipartFormData::get_file(const std::string &key,
  9664. size_t id) const {
  9665. return detail::get_multimap_value(files, key, id);
  9666. }
  9667. inline std::vector<FormData>
  9668. MultipartFormData::get_files(const std::string &key) const {
  9669. std::vector<FormData> values;
  9670. auto rng = files.equal_range(key);
  9671. for (auto it = rng.first; it != rng.second; it++) {
  9672. values.push_back(it->second);
  9673. }
  9674. return values;
  9675. }
  9676. inline bool MultipartFormData::has_file(const std::string &key) const {
  9677. return files.find(key) != files.end();
  9678. }
  9679. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9680. return files.count(key);
  9681. }
  9682. // Multipart FormData writer implementation
  9683. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9684. return detail::is_multipart_boundary_chars_valid(boundary);
  9685. }
  9686. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9687. : boundary_(detail::make_multipart_data_boundary()) {}
  9688. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9689. : boundary_(std::move(boundary)) {}
  9690. inline const std::string &MultipartFormDataWriter::boundary() const {
  9691. return boundary_;
  9692. }
  9693. inline std::string MultipartFormDataWriter::content_type() const {
  9694. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9695. }
  9696. inline std::string
  9697. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9698. return detail::serialize_multipart_formdata(items, boundary_);
  9699. }
  9700. inline size_t MultipartFormDataWriter::content_length(
  9701. const UploadFormDataItems &items) const {
  9702. return detail::get_multipart_content_length(items, boundary_);
  9703. }
  9704. inline std::string
  9705. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9706. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9707. }
  9708. inline std::string MultipartFormDataWriter::item_end() {
  9709. return detail::serialize_multipart_formdata_item_end();
  9710. }
  9711. inline std::string MultipartFormDataWriter::finish() const {
  9712. return detail::serialize_multipart_formdata_finish(boundary_);
  9713. }
  9714. // Response implementation
  9715. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9716. size_t id) const {
  9717. return detail::get_header_value_u64(headers, key, def, id);
  9718. }
  9719. inline bool Response::has_header(const std::string &key) const {
  9720. return headers.find(key) != headers.end();
  9721. }
  9722. inline std::string Response::get_header_value(const std::string &key,
  9723. const char *def,
  9724. size_t id) const {
  9725. return detail::get_header_value(headers, key, def, id);
  9726. }
  9727. inline size_t Response::get_header_value_count(const std::string &key) const {
  9728. return detail::get_header_value_count(headers, key);
  9729. }
  9730. inline void Response::set_header(const std::string &key,
  9731. const std::string &val) {
  9732. detail::set_header(headers, key, val);
  9733. }
  9734. inline bool Response::has_trailer(const std::string &key) const {
  9735. return trailers.find(key) != trailers.end();
  9736. }
  9737. inline std::string Response::get_trailer_value(const std::string &key,
  9738. size_t id) const {
  9739. return detail::get_multimap_value(trailers, key, id);
  9740. }
  9741. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9742. return trailers.count(key);
  9743. }
  9744. inline void Response::set_redirect(const std::string &url, int stat) {
  9745. if (detail::fields::is_field_value(url)) {
  9746. set_header("Location", url);
  9747. if (300 <= stat && stat < 400) {
  9748. this->status = stat;
  9749. } else {
  9750. this->status = StatusCode::Found_302;
  9751. }
  9752. }
  9753. }
  9754. inline void Response::set_content(const char *s, size_t n,
  9755. const std::string &content_type) {
  9756. body.assign(s, n);
  9757. auto rng = headers.equal_range("Content-Type");
  9758. headers.erase(rng.first, rng.second);
  9759. set_header("Content-Type", content_type);
  9760. content_coding_ = detail::EncodingType::None;
  9761. }
  9762. inline void Response::set_content(const std::string &s,
  9763. const std::string &content_type) {
  9764. set_content(s.data(), s.size(), content_type);
  9765. }
  9766. inline void Response::set_content(std::string &&s,
  9767. const std::string &content_type) {
  9768. body = std::move(s);
  9769. auto rng = headers.equal_range("Content-Type");
  9770. headers.erase(rng.first, rng.second);
  9771. set_header("Content-Type", content_type);
  9772. content_coding_ = detail::EncodingType::None;
  9773. }
  9774. inline void Response::set_content_provider(
  9775. size_t in_length, const std::string &content_type, ContentProvider provider,
  9776. ContentProviderResourceReleaser resource_releaser) {
  9777. set_header("Content-Type", content_type);
  9778. content_length_ = in_length;
  9779. if (in_length > 0) { content_provider_ = std::move(provider); }
  9780. content_provider_resource_releaser_ = std::move(resource_releaser);
  9781. is_chunked_content_provider_ = false;
  9782. content_coding_ = detail::EncodingType::None;
  9783. }
  9784. inline void Response::set_content_provider(
  9785. const std::string &content_type, ContentProviderWithoutLength provider,
  9786. ContentProviderResourceReleaser resource_releaser) {
  9787. set_header("Content-Type", content_type);
  9788. content_length_ = 0;
  9789. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9790. content_provider_resource_releaser_ = std::move(resource_releaser);
  9791. is_chunked_content_provider_ = false;
  9792. content_coding_ = detail::EncodingType::None;
  9793. }
  9794. inline void Response::set_chunked_content_provider(
  9795. const std::string &content_type, ContentProviderWithoutLength provider,
  9796. ContentProviderResourceReleaser resource_releaser) {
  9797. set_header("Content-Type", content_type);
  9798. content_length_ = 0;
  9799. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9800. content_provider_resource_releaser_ = std::move(resource_releaser);
  9801. is_chunked_content_provider_ = true;
  9802. content_coding_ = detail::EncodingType::None;
  9803. }
  9804. inline void Response::set_file_content(const std::string &path,
  9805. const std::string &content_type) {
  9806. file_content_path_ = path;
  9807. file_content_content_type_ = content_type;
  9808. }
  9809. inline void Response::set_file_content(const std::string &path) {
  9810. file_content_path_ = path;
  9811. }
  9812. // Result implementation
  9813. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9814. size_t def,
  9815. size_t id) const {
  9816. return detail::get_header_value_u64(request_headers_, key, def, id);
  9817. }
  9818. inline bool Result::has_request_header(const std::string &key) const {
  9819. return request_headers_.find(key) != request_headers_.end();
  9820. }
  9821. inline std::string Result::get_request_header_value(const std::string &key,
  9822. const char *def,
  9823. size_t id) const {
  9824. return detail::get_header_value(request_headers_, key, def, id);
  9825. }
  9826. inline size_t
  9827. Result::get_request_header_value_count(const std::string &key) const {
  9828. return request_headers_.count(key);
  9829. }
  9830. // Stream implementation
  9831. inline ssize_t Stream::write(const char *ptr) {
  9832. return write(ptr, strlen(ptr));
  9833. }
  9834. inline ssize_t Stream::write(const std::string &s) {
  9835. return write(s.data(), s.size());
  9836. }
  9837. // BodyReader implementation
  9838. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9839. if (!stream) {
  9840. last_error = Error::Connection;
  9841. return -1;
  9842. }
  9843. if (eof) { return 0; }
  9844. if (!chunked) {
  9845. // Content-Length based reading
  9846. if (has_content_length && bytes_read >= content_length) {
  9847. eof = true;
  9848. return 0;
  9849. }
  9850. auto to_read = len;
  9851. if (has_content_length) {
  9852. auto remaining = content_length - bytes_read;
  9853. to_read = (std::min)(len, remaining);
  9854. }
  9855. auto n = stream->read(buf, to_read);
  9856. if (n < 0) {
  9857. last_error = stream->get_error();
  9858. if (last_error == Error::Success) { last_error = Error::Read; }
  9859. eof = true;
  9860. return n;
  9861. }
  9862. if (n == 0) {
  9863. // Unexpected EOF before content_length
  9864. last_error = stream->get_error();
  9865. if (last_error == Error::Success) { last_error = Error::Read; }
  9866. eof = true;
  9867. return 0;
  9868. }
  9869. bytes_read += static_cast<size_t>(n);
  9870. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9871. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9872. last_error = Error::ExceedMaxPayloadSize;
  9873. eof = true;
  9874. return -1;
  9875. }
  9876. return n;
  9877. }
  9878. // Chunked transfer encoding: delegate to shared decoder instance.
  9879. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9880. size_t chunk_offset = 0;
  9881. size_t chunk_total = 0;
  9882. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9883. if (n < 0) {
  9884. last_error = stream->get_error();
  9885. if (last_error == Error::Success) { last_error = Error::Read; }
  9886. eof = true;
  9887. return n;
  9888. }
  9889. if (n == 0) {
  9890. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  9891. eof = true;
  9892. return 0;
  9893. }
  9894. bytes_read += static_cast<size_t>(n);
  9895. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9896. last_error = Error::ExceedMaxPayloadSize;
  9897. eof = true;
  9898. return -1;
  9899. }
  9900. return n;
  9901. }
  9902. // ThreadPool implementation
  9903. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  9904. time_t idle_timeout_sec)
  9905. : base_thread_count_(n), max_queued_requests_(mqr),
  9906. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  9907. shutdown_(false) {
  9908. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9909. if (max_n != 0 && max_n < n) {
  9910. std::string msg = "max_threads must be >= base_threads";
  9911. throw std::invalid_argument(msg);
  9912. }
  9913. #endif
  9914. max_thread_count_ = max_n == 0 ? n : max_n;
  9915. threads_.reserve(base_thread_count_);
  9916. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9917. try {
  9918. #endif
  9919. for (size_t i = 0; i < base_thread_count_; i++) {
  9920. threads_.emplace_back(std::thread([this]() { worker(false); }));
  9921. }
  9922. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9923. } catch (...) {
  9924. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  9925. // signal the workers we already spawned to exit and join them so the
  9926. // vector destructor does not see joinable threads (which would call
  9927. // std::terminate). Then rethrow so the caller learns of the failure.
  9928. {
  9929. std::unique_lock<std::mutex> lock(mutex_);
  9930. shutdown_ = true;
  9931. }
  9932. cond_.notify_all();
  9933. for (auto &t : threads_) {
  9934. if (t.joinable()) { t.join(); }
  9935. }
  9936. throw;
  9937. }
  9938. #endif
  9939. }
  9940. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  9941. {
  9942. std::unique_lock<std::mutex> lock(mutex_);
  9943. if (shutdown_) { return false; }
  9944. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  9945. return false;
  9946. }
  9947. jobs_.push_back(std::move(fn));
  9948. // Spawn a dynamic thread if no idle threads and under max
  9949. if (idle_thread_count_ == 0 &&
  9950. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  9951. cleanup_finished_threads();
  9952. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  9953. }
  9954. }
  9955. cond_.notify_one();
  9956. return true;
  9957. }
  9958. inline void ThreadPool::shutdown() {
  9959. {
  9960. std::unique_lock<std::mutex> lock(mutex_);
  9961. shutdown_ = true;
  9962. }
  9963. cond_.notify_all();
  9964. for (auto &t : threads_) {
  9965. if (t.joinable()) { t.join(); }
  9966. }
  9967. // Move dynamic_threads_ to a local list under the lock to avoid racing
  9968. // with worker threads that call move_to_finished() concurrently.
  9969. std::list<std::thread> remaining_dynamic;
  9970. {
  9971. std::unique_lock<std::mutex> lock(mutex_);
  9972. remaining_dynamic = std::move(dynamic_threads_);
  9973. }
  9974. for (auto &t : remaining_dynamic) {
  9975. if (t.joinable()) { t.join(); }
  9976. }
  9977. std::unique_lock<std::mutex> lock(mutex_);
  9978. cleanup_finished_threads();
  9979. }
  9980. inline void ThreadPool::move_to_finished(std::thread::id id) {
  9981. // Must be called with mutex_ held
  9982. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  9983. if (it->get_id() == id) {
  9984. finished_threads_.push_back(std::move(*it));
  9985. dynamic_threads_.erase(it);
  9986. return;
  9987. }
  9988. }
  9989. }
  9990. inline void ThreadPool::cleanup_finished_threads() {
  9991. // Must be called with mutex_ held
  9992. for (auto &t : finished_threads_) {
  9993. if (t.joinable()) { t.join(); }
  9994. }
  9995. finished_threads_.clear();
  9996. }
  9997. inline void ThreadPool::worker(bool is_dynamic) {
  9998. for (;;) {
  9999. std::function<void()> fn;
  10000. {
  10001. std::unique_lock<std::mutex> lock(mutex_);
  10002. idle_thread_count_++;
  10003. if (is_dynamic) {
  10004. auto has_work =
  10005. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10006. [&] { return !jobs_.empty() || shutdown_; });
  10007. if (!has_work) {
  10008. // Timed out with no work - exit this dynamic thread
  10009. idle_thread_count_--;
  10010. move_to_finished(std::this_thread::get_id());
  10011. break;
  10012. }
  10013. } else {
  10014. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10015. }
  10016. idle_thread_count_--;
  10017. if (shutdown_ && jobs_.empty()) { break; }
  10018. fn = std::move(jobs_.front());
  10019. jobs_.pop_front();
  10020. }
  10021. assert(true == static_cast<bool>(fn));
  10022. fn();
  10023. }
  10024. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10025. !defined(LIBRESSL_VERSION_NUMBER)
  10026. OPENSSL_thread_stop();
  10027. #endif
  10028. }
  10029. /*
  10030. * Group 1 (continued): detail namespace - Stream implementations
  10031. */
  10032. namespace detail {
  10033. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10034. time_t timeout_sec, time_t timeout_usec,
  10035. time_t &actual_timeout_sec,
  10036. time_t &actual_timeout_usec) {
  10037. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10038. auto actual_timeout_msec =
  10039. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10040. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10041. actual_timeout_sec = actual_timeout_msec / 1000;
  10042. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10043. }
  10044. // Socket stream implementation
  10045. inline SocketStream::SocketStream(
  10046. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10047. time_t write_timeout_sec, time_t write_timeout_usec,
  10048. time_t max_timeout_msec,
  10049. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10050. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10051. read_timeout_usec_(read_timeout_usec),
  10052. write_timeout_sec_(write_timeout_sec),
  10053. write_timeout_usec_(write_timeout_usec),
  10054. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10055. read_buff_(read_buff_size_, 0) {}
  10056. inline SocketStream::~SocketStream() = default;
  10057. inline bool SocketStream::is_readable() const {
  10058. return read_buff_off_ < read_buff_content_size_;
  10059. }
  10060. inline bool SocketStream::wait_readable() const {
  10061. if (max_timeout_msec_ <= 0) {
  10062. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10063. }
  10064. time_t read_timeout_sec;
  10065. time_t read_timeout_usec;
  10066. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10067. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10068. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10069. }
  10070. inline bool SocketStream::wait_writable() const {
  10071. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10072. }
  10073. inline bool SocketStream::ensure_readable() {
  10074. if (readable_hint_) {
  10075. readable_hint_ = false;
  10076. return true;
  10077. }
  10078. return wait_readable();
  10079. }
  10080. inline const char *SocketStream::buffered_data(size_t &size) const {
  10081. size = read_buff_content_size_ - read_buff_off_;
  10082. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10083. }
  10084. inline void SocketStream::consume_buffered(size_t size) {
  10085. assert(size <= read_buff_content_size_ - read_buff_off_);
  10086. read_buff_off_ += size;
  10087. }
  10088. inline bool SocketStream::is_peer_alive() const {
  10089. return detail::is_socket_alive(sock_);
  10090. }
  10091. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10092. #ifdef _WIN32
  10093. size =
  10094. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10095. #else
  10096. size = (std::min)(size,
  10097. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10098. #endif
  10099. if (read_buff_off_ < read_buff_content_size_) {
  10100. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10101. if (size <= remaining_size) {
  10102. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10103. read_buff_off_ += size;
  10104. return static_cast<ssize_t>(size);
  10105. } else {
  10106. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10107. read_buff_off_ += remaining_size;
  10108. return static_cast<ssize_t>(remaining_size);
  10109. }
  10110. }
  10111. if (!ensure_readable()) {
  10112. error_ = Error::Timeout;
  10113. return -1;
  10114. }
  10115. read_buff_off_ = 0;
  10116. read_buff_content_size_ = 0;
  10117. if (size < read_buff_size_) {
  10118. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10119. CPPHTTPLIB_RECV_FLAGS);
  10120. if (n <= 0) {
  10121. if (n == 0) {
  10122. error_ = Error::ConnectionClosed;
  10123. } else {
  10124. error_ = Error::Read;
  10125. }
  10126. return n;
  10127. } else if (n <= static_cast<ssize_t>(size)) {
  10128. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10129. return n;
  10130. } else {
  10131. memcpy(ptr, read_buff_.data(), size);
  10132. read_buff_off_ = size;
  10133. read_buff_content_size_ = static_cast<size_t>(n);
  10134. return static_cast<ssize_t>(size);
  10135. }
  10136. } else {
  10137. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10138. if (n <= 0) {
  10139. if (n == 0) {
  10140. error_ = Error::ConnectionClosed;
  10141. } else {
  10142. error_ = Error::Read;
  10143. }
  10144. }
  10145. return n;
  10146. }
  10147. }
  10148. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10149. if (!wait_writable()) { return -1; }
  10150. #if defined(_WIN32) && !defined(_WIN64)
  10151. size =
  10152. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10153. #endif
  10154. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10155. }
  10156. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10157. int &port) const {
  10158. return detail::get_remote_ip_and_port(sock_, ip, port);
  10159. }
  10160. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10161. int &port) const {
  10162. return detail::get_local_ip_and_port(sock_, ip, port);
  10163. }
  10164. inline socket_t SocketStream::socket() const { return sock_; }
  10165. inline time_t SocketStream::duration() const {
  10166. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10167. std::chrono::steady_clock::now() - start_time_)
  10168. .count();
  10169. }
  10170. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10171. read_timeout_sec_ = sec;
  10172. read_timeout_usec_ = usec;
  10173. }
  10174. // Buffer stream implementation
  10175. inline bool BufferStream::is_readable() const { return true; }
  10176. inline bool BufferStream::wait_readable() const { return true; }
  10177. inline bool BufferStream::wait_writable() const { return true; }
  10178. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10179. #if defined(_MSC_VER) && _MSC_VER < 1910
  10180. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10181. #else
  10182. auto len_read = buffer.copy(ptr, size, position);
  10183. #endif
  10184. position += static_cast<size_t>(len_read);
  10185. return static_cast<ssize_t>(len_read);
  10186. }
  10187. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10188. buffer.append(ptr, size);
  10189. return static_cast<ssize_t>(size);
  10190. }
  10191. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10192. int & /*port*/) const {}
  10193. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10194. int & /*port*/) const {}
  10195. inline socket_t BufferStream::socket() const { return 0; }
  10196. inline time_t BufferStream::duration() const { return 0; }
  10197. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10198. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10199. : MatcherBase(pattern) {
  10200. constexpr const char marker[] = "/:";
  10201. // One past the last ending position of a path param substring
  10202. std::size_t last_param_end = 0;
  10203. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10204. // Needed to ensure that parameter names are unique during matcher
  10205. // construction
  10206. // If exceptions are disabled, only last duplicate path
  10207. // parameter will be set
  10208. std::unordered_set<std::string> param_name_set;
  10209. #endif
  10210. while (true) {
  10211. const auto marker_pos = pattern.find(
  10212. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10213. if (marker_pos == std::string::npos) { break; }
  10214. static_fragments_.push_back(
  10215. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10216. const auto param_name_start = marker_pos + str_len(marker);
  10217. auto sep_pos = pattern.find(separator, param_name_start);
  10218. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10219. auto param_name =
  10220. pattern.substr(param_name_start, sep_pos - param_name_start);
  10221. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10222. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10223. std::string msg = "Encountered path parameter '" + param_name +
  10224. "' multiple times in route pattern '" + pattern + "'.";
  10225. throw std::invalid_argument(msg);
  10226. }
  10227. #endif
  10228. param_names_.push_back(std::move(param_name));
  10229. last_param_end = sep_pos + 1;
  10230. }
  10231. if (last_param_end < pattern.length()) {
  10232. static_fragments_.push_back(pattern.substr(last_param_end));
  10233. }
  10234. }
  10235. inline bool PathParamsMatcher::match(Request &request) const {
  10236. request.matches = std::smatch();
  10237. request.path_params.clear();
  10238. // A pattern without parameters is just a literal path to compare against
  10239. if (param_names_.empty()) { return request.path == pattern(); }
  10240. request.path_params.reserve(param_names_.size());
  10241. // One past the position at which the path matched the pattern last time
  10242. std::size_t starting_pos = 0;
  10243. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10244. const auto &fragment = static_fragments_[i];
  10245. if (starting_pos + fragment.length() > request.path.length()) {
  10246. return false;
  10247. }
  10248. // Avoid unnecessary allocation by using strncmp instead of substr +
  10249. // comparison
  10250. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10251. fragment.length()) != 0) {
  10252. return false;
  10253. }
  10254. starting_pos += fragment.length();
  10255. // Should only happen when we have a static fragment after a param
  10256. // Example: '/users/:id/subscriptions'
  10257. // The 'subscriptions' fragment here does not have a corresponding param
  10258. if (i >= param_names_.size()) { continue; }
  10259. auto sep_pos = request.path.find(separator, starting_pos);
  10260. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10261. const auto &param_name = param_names_[i];
  10262. request.path_params.emplace(
  10263. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10264. // Mark everything up to '/' as matched
  10265. starting_pos = sep_pos + 1;
  10266. }
  10267. // Returns false if the path is longer than the pattern
  10268. return starting_pos >= request.path.length();
  10269. }
  10270. inline bool RegexMatcher::match(Request &request) const {
  10271. request.path_params.clear();
  10272. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10273. // a non-match rather than risking a stack overflow in std::regex_match.
  10274. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10275. return false;
  10276. }
  10277. return std::regex_match(request.path, request.matches, regex_);
  10278. }
  10279. // Enclose IPv6 address in brackets if needed
  10280. inline std::string prepare_host_string(const std::string &host) {
  10281. // Enclose IPv6 address in brackets (but not if already enclosed)
  10282. if (host.find(':') == std::string::npos ||
  10283. (!host.empty() && host[0] == '[')) {
  10284. // IPv4, hostname, or already bracketed IPv6
  10285. return host;
  10286. } else {
  10287. // IPv6 address without brackets
  10288. return "[" + host + "]";
  10289. }
  10290. }
  10291. inline std::string make_host_and_port_string(const std::string &host, int port,
  10292. bool is_ssl) {
  10293. auto result = prepare_host_string(host);
  10294. // Append port if not default
  10295. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10296. ; // do nothing
  10297. } else {
  10298. result += ":" + std::to_string(port);
  10299. }
  10300. return result;
  10301. }
  10302. // Create "host:port" string always including port number (for CONNECT method)
  10303. inline std::string
  10304. make_host_and_port_string_always_port(const std::string &host, int port) {
  10305. return prepare_host_string(host) + ":" + std::to_string(port);
  10306. }
  10307. // Value for the Host header a client sends when the caller supplied none.
  10308. // Only the value: callers decide where in their header list it goes.
  10309. inline std::string make_default_host_header_value(const std::string &host,
  10310. int port, bool is_ssl,
  10311. int address_family) {
  10312. if (address_family == AF_UNIX) { return "localhost"; }
  10313. return make_host_and_port_string(host, port, is_ssl);
  10314. }
  10315. inline void add_default_user_agent_header(Request &req) {
  10316. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10317. if (!req.has_header("User-Agent")) {
  10318. req.set_header("User-Agent",
  10319. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10320. }
  10321. #else
  10322. (void)req;
  10323. #endif
  10324. }
  10325. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10326. NormalizedTarget normalize_target(const std::string &host);
  10327. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10328. bool host_matches_no_proxy(const NormalizedTarget &target,
  10329. const std::vector<NoProxyEntry> &entries);
  10330. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10331. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10332. if (prefix_bits == 0) { return true; }
  10333. int full_bytes = prefix_bits / 8;
  10334. int rem_bits = prefix_bits % 8;
  10335. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10336. static_cast<size_t>(full_bytes)) != 0) {
  10337. return false;
  10338. }
  10339. if (rem_bits == 0) { return true; }
  10340. auto i = static_cast<size_t>(full_bytes);
  10341. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10342. return (ip[i] & mask) == (net[i] & mask);
  10343. }
  10344. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10345. if (token.empty()) { return false; }
  10346. if (token == "*") {
  10347. out.kind = NoProxyKind::Wildcard;
  10348. return true;
  10349. }
  10350. auto slash = token.find('/');
  10351. std::string addr_part =
  10352. (slash == std::string::npos) ? token : token.substr(0, slash);
  10353. std::string prefix_part =
  10354. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10355. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10356. // don't silently treat it as a /32 (or /128).
  10357. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10358. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10359. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10360. // when brackets are present.
  10361. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10362. addr_part.back() == ']';
  10363. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10364. if (!bracketed) {
  10365. struct in_addr v4;
  10366. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10367. int prefix = 32;
  10368. if (!prefix_part.empty()) {
  10369. auto r = from_chars(prefix_part.data(),
  10370. prefix_part.data() + prefix_part.size(), prefix);
  10371. if (r.ec != std::errc{} ||
  10372. r.ptr != prefix_part.data() + prefix_part.size()) {
  10373. return false;
  10374. }
  10375. if (prefix < 0 || prefix > 32) { return false; }
  10376. }
  10377. out.kind = NoProxyKind::IPv4Cidr;
  10378. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10379. out.prefix_bits = prefix;
  10380. return true;
  10381. }
  10382. }
  10383. struct in6_addr v6;
  10384. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10385. int prefix = 128;
  10386. if (!prefix_part.empty()) {
  10387. auto r = from_chars(prefix_part.data(),
  10388. prefix_part.data() + prefix_part.size(), prefix);
  10389. if (r.ec != std::errc{} ||
  10390. r.ptr != prefix_part.data() + prefix_part.size()) {
  10391. return false;
  10392. }
  10393. if (prefix < 0 || prefix > 128) { return false; }
  10394. }
  10395. out.kind = NoProxyKind::IPv6Cidr;
  10396. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10397. out.prefix_bits = prefix;
  10398. return true;
  10399. }
  10400. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10401. // the entry is malformed — don't fall through to the hostname branch.
  10402. if (bracketed) { return false; }
  10403. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10404. if (slash != std::string::npos) { return false; }
  10405. // Port-specific entries (host:port) are not supported.
  10406. if (token.find(':') != std::string::npos) { return false; }
  10407. std::string hostname = case_ignore::to_lower(token);
  10408. while (!hostname.empty() && hostname.front() == '.') {
  10409. hostname.erase(hostname.begin());
  10410. }
  10411. while (!hostname.empty() && hostname.back() == '.') {
  10412. hostname.pop_back();
  10413. }
  10414. if (hostname.empty()) { return false; }
  10415. out.kind = NoProxyKind::HostnameSuffix;
  10416. out.hostname_pattern = std::move(hostname);
  10417. return true;
  10418. }
  10419. inline NormalizedTarget normalize_target(const std::string &host) {
  10420. NormalizedTarget t;
  10421. std::string h = host;
  10422. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10423. h = h.substr(1, h.size() - 2);
  10424. }
  10425. // Strip a single trailing dot so "example.com." canonicalizes to
  10426. // "example.com".
  10427. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10428. t.hostname = case_ignore::to_lower(h);
  10429. if (!t.hostname.empty()) {
  10430. struct in_addr v4;
  10431. struct in6_addr v6;
  10432. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10433. t.is_ipv4 = true;
  10434. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10435. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10436. t.is_ipv6 = true;
  10437. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10438. }
  10439. }
  10440. return t;
  10441. }
  10442. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10443. const std::vector<NoProxyEntry> &entries) {
  10444. if (target.hostname.empty()) { return false; }
  10445. for (const auto &e : entries) {
  10446. switch (e.kind) {
  10447. case NoProxyKind::Wildcard: return true;
  10448. case NoProxyKind::IPv4Cidr:
  10449. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10450. return true;
  10451. }
  10452. break;
  10453. case NoProxyKind::IPv6Cidr:
  10454. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10455. return true;
  10456. }
  10457. break;
  10458. case NoProxyKind::HostnameSuffix:
  10459. if (target.is_ipv4 || target.is_ipv6) { break; }
  10460. if (target.hostname == e.hostname_pattern) { return true; }
  10461. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10462. // an entry of "example.com".
  10463. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10464. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10465. if (target.hostname[offset - 1] == '.' &&
  10466. target.hostname.compare(offset, e.hostname_pattern.size(),
  10467. e.hostname_pattern) == 0) {
  10468. return true;
  10469. }
  10470. }
  10471. break;
  10472. }
  10473. }
  10474. return false;
  10475. }
  10476. template <typename T>
  10477. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10478. T header_writer, Error &error) {
  10479. for (const auto &h : headers) {
  10480. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10481. error = Error::InvalidHeaders;
  10482. return false;
  10483. }
  10484. }
  10485. if (header_writer(strm, headers) <= 0) {
  10486. error = Error::Write;
  10487. return false;
  10488. }
  10489. return true;
  10490. }
  10491. } // namespace detail
  10492. /*
  10493. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10494. */
  10495. #ifdef CPPHTTPLIB_SSL_ENABLED
  10496. namespace detail {
  10497. // SSL socket stream implementation
  10498. inline SSLSocketStream::SSLSocketStream(
  10499. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10500. time_t read_timeout_usec, time_t write_timeout_sec,
  10501. time_t write_timeout_usec, time_t max_timeout_msec,
  10502. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10503. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10504. read_timeout_usec_(read_timeout_usec),
  10505. write_timeout_sec_(write_timeout_sec),
  10506. write_timeout_usec_(write_timeout_usec),
  10507. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10508. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10509. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10510. // Note: create_session() also clears this, but SSLClient currently
  10511. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10512. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10513. // SSL session was created.
  10514. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10515. #endif
  10516. }
  10517. inline SSLSocketStream::~SSLSocketStream() = default;
  10518. inline bool SSLSocketStream::is_readable() const {
  10519. return tls::pending(session_) > 0;
  10520. }
  10521. inline bool SSLSocketStream::wait_readable() const {
  10522. if (max_timeout_msec_ <= 0) {
  10523. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10524. }
  10525. time_t read_timeout_sec;
  10526. time_t read_timeout_usec;
  10527. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10528. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10529. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10530. }
  10531. inline bool SSLSocketStream::wait_writable() const {
  10532. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10533. !tls::is_peer_closed(session_, sock_);
  10534. }
  10535. inline bool SSLSocketStream::ensure_readable() {
  10536. if (readable_hint_) {
  10537. readable_hint_ = false;
  10538. return true;
  10539. }
  10540. return wait_readable();
  10541. }
  10542. inline bool SSLSocketStream::is_peer_alive() const {
  10543. return !tls::is_peer_closed(session_, sock_);
  10544. }
  10545. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10546. if (tls::pending(session_) > 0) {
  10547. tls::TlsError err;
  10548. auto ret = tls::read(session_, ptr, size, err);
  10549. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10550. error_ = Error::ConnectionClosed;
  10551. }
  10552. return ret;
  10553. } else if (ensure_readable()) {
  10554. tls::TlsError err;
  10555. auto ret = tls::read(session_, ptr, size, err);
  10556. if (ret < 0) {
  10557. auto n = 1000;
  10558. #ifdef _WIN32
  10559. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10560. (err.code == tls::ErrorCode::SyscallError &&
  10561. WSAGetLastError() == WSAETIMEDOUT))) {
  10562. #else
  10563. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10564. #endif
  10565. if (tls::pending(session_) > 0) {
  10566. return tls::read(session_, ptr, size, err);
  10567. } else if (wait_readable()) {
  10568. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10569. ret = tls::read(session_, ptr, size, err);
  10570. if (ret >= 0) { return ret; }
  10571. } else {
  10572. break;
  10573. }
  10574. }
  10575. assert(ret < 0);
  10576. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10577. error_ = Error::ConnectionClosed;
  10578. }
  10579. return ret;
  10580. } else {
  10581. error_ = Error::Timeout;
  10582. return -1;
  10583. }
  10584. }
  10585. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10586. if (wait_writable()) {
  10587. auto handle_size =
  10588. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10589. tls::TlsError err;
  10590. auto ret = tls::write(session_, ptr, handle_size, err);
  10591. if (ret < 0) {
  10592. auto n = 1000;
  10593. #ifdef _WIN32
  10594. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10595. (err.code == tls::ErrorCode::SyscallError &&
  10596. WSAGetLastError() == WSAETIMEDOUT))) {
  10597. #else
  10598. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10599. #endif
  10600. if (wait_writable()) {
  10601. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10602. ret = tls::write(session_, ptr, handle_size, err);
  10603. if (ret >= 0) { return ret; }
  10604. } else {
  10605. break;
  10606. }
  10607. }
  10608. assert(ret < 0);
  10609. }
  10610. return ret;
  10611. }
  10612. return -1;
  10613. }
  10614. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10615. int &port) const {
  10616. detail::get_remote_ip_and_port(sock_, ip, port);
  10617. }
  10618. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10619. int &port) const {
  10620. detail::get_local_ip_and_port(sock_, ip, port);
  10621. }
  10622. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10623. inline time_t SSLSocketStream::duration() const {
  10624. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10625. std::chrono::steady_clock::now() - start_time_)
  10626. .count();
  10627. }
  10628. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10629. read_timeout_sec_ = sec;
  10630. read_timeout_usec_ = usec;
  10631. }
  10632. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10633. tls::session_t session,
  10634. time_t read_timeout_sec,
  10635. time_t read_timeout_usec,
  10636. time_t write_timeout_sec,
  10637. time_t write_timeout_usec)
  10638. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10639. read_timeout_usec_(read_timeout_usec),
  10640. write_timeout_sec_(write_timeout_sec),
  10641. write_timeout_usec_(write_timeout_usec),
  10642. start_time_(std::chrono::steady_clock::now()) {
  10643. // The receive and send paths run on different threads, so each TLS call is
  10644. // driven in non-blocking mode and readiness is awaited with select()
  10645. // outside the session lock. Set the socket non-blocking once here; it is
  10646. // never flipped back, so no thread races on the flag.
  10647. detail::set_nonblocking(sock_, true);
  10648. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10649. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10650. #endif
  10651. }
  10652. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10653. inline bool WebSocketSSLStream::is_readable() const {
  10654. std::lock_guard<std::mutex> guard(session_mutex_);
  10655. return tls::pending(session_) > 0;
  10656. }
  10657. inline bool WebSocketSSLStream::wait_readable() const {
  10658. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10659. }
  10660. inline bool WebSocketSSLStream::wait_writable() const {
  10661. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10662. // that probe toggles the socket's blocking flag, which would race with the
  10663. // concurrent reader on a permanently non-blocking socket.
  10664. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10665. }
  10666. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10667. tls::TlsError err;
  10668. auto n = 1000;
  10669. while (--n >= 0) {
  10670. {
  10671. std::lock_guard<std::mutex> guard(session_mutex_);
  10672. auto ret = tls::read(session_, ptr, size, err);
  10673. if (ret > 0) { return ret; }
  10674. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10675. error_ = Error::ConnectionClosed;
  10676. return ret;
  10677. }
  10678. }
  10679. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10680. // direction: the send path shares this session, so output it left pending
  10681. // has to be flushed before more input can be decrypted. Anything else is
  10682. // a hard error.
  10683. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10684. #ifdef _WIN32
  10685. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10686. needs_readable =
  10687. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10688. WSAGetLastError() == WSAETIMEDOUT);
  10689. #endif
  10690. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10691. error_ = Error::Read;
  10692. return -1;
  10693. }
  10694. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10695. error_ = Error::Timeout;
  10696. return -1;
  10697. }
  10698. }
  10699. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10700. // to tell a timeout from a close would otherwise see whatever the previous
  10701. // failure left behind (error_ is never cleared on success).
  10702. error_ = Error::Read;
  10703. return -1;
  10704. }
  10705. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10706. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10707. tls::TlsError err;
  10708. auto n = 1000;
  10709. while (--n >= 0) {
  10710. {
  10711. std::lock_guard<std::mutex> guard(session_mutex_);
  10712. auto ret = tls::write(session_, ptr, handle_size, err);
  10713. if (ret >= 0) { return ret; }
  10714. }
  10715. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10716. // or a post-handshake message must be consumed before the record goes
  10717. // out. Anything else is a hard error.
  10718. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10719. #ifdef _WIN32
  10720. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10721. needs_writable =
  10722. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10723. WSAGetLastError() == WSAETIMEDOUT);
  10724. #endif
  10725. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10726. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10727. }
  10728. return -1;
  10729. }
  10730. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10731. int &port) const {
  10732. detail::get_remote_ip_and_port(sock_, ip, port);
  10733. }
  10734. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10735. int &port) const {
  10736. detail::get_local_ip_and_port(sock_, ip, port);
  10737. }
  10738. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10739. inline time_t WebSocketSSLStream::duration() const {
  10740. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10741. std::chrono::steady_clock::now() - start_time_)
  10742. .count();
  10743. }
  10744. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10745. read_timeout_sec_ = sec;
  10746. read_timeout_usec_ = usec;
  10747. }
  10748. } // namespace detail
  10749. #endif // CPPHTTPLIB_SSL_ENABLED
  10750. /*
  10751. * Group 4: Server implementation
  10752. */
  10753. // HTTP server implementation
  10754. inline Server::Server()
  10755. : new_task_queue([] {
  10756. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10757. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10758. }) {
  10759. #ifndef _WIN32
  10760. signal(SIGPIPE, SIG_IGN);
  10761. #endif
  10762. }
  10763. inline Server::~Server() = default;
  10764. inline std::unique_ptr<detail::MatcherBase>
  10765. Server::make_matcher(const std::string &pattern) {
  10766. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10767. // a path params pattern
  10768. if (pattern.find("/:") != std::string::npos) {
  10769. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10770. }
  10771. // A pattern with no regex metacharacter only has to be compared literally,
  10772. // which is what PathParamsMatcher already does when it captures no
  10773. // parameter, so std::regex is only worth building for the patterns that
  10774. // actually need it
  10775. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10776. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10777. }
  10778. return detail::make_unique<detail::RegexMatcher>(pattern);
  10779. }
  10780. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10781. return add_handler(get_handlers_, pattern, std::move(handler));
  10782. }
  10783. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10784. return add_handler(post_handlers_, pattern, std::move(handler));
  10785. }
  10786. inline Server &Server::Post(const std::string &pattern,
  10787. HandlerWithContentReader handler) {
  10788. return add_handler(post_handlers_for_content_reader_, pattern,
  10789. std::move(handler));
  10790. }
  10791. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10792. return add_handler(put_handlers_, pattern, std::move(handler));
  10793. }
  10794. inline Server &Server::Put(const std::string &pattern,
  10795. HandlerWithContentReader handler) {
  10796. return add_handler(put_handlers_for_content_reader_, pattern,
  10797. std::move(handler));
  10798. }
  10799. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10800. return add_handler(patch_handlers_, pattern, std::move(handler));
  10801. }
  10802. inline Server &Server::Patch(const std::string &pattern,
  10803. HandlerWithContentReader handler) {
  10804. return add_handler(patch_handlers_for_content_reader_, pattern,
  10805. std::move(handler));
  10806. }
  10807. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10808. return add_handler(delete_handlers_, pattern, std::move(handler));
  10809. }
  10810. inline Server &Server::Delete(const std::string &pattern,
  10811. HandlerWithContentReader handler) {
  10812. return add_handler(delete_handlers_for_content_reader_, pattern,
  10813. std::move(handler));
  10814. }
  10815. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10816. return add_handler(options_handlers_, pattern, std::move(handler));
  10817. }
  10818. inline const std::set<std::string> &Server::builtin_methods() {
  10819. thread_local const std::set<std::string> methods{
  10820. "GET", "HEAD", "POST", "PUT", "DELETE",
  10821. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10822. return methods;
  10823. }
  10824. inline Server::CustomHandlerEntry *
  10825. Server::custom_entry_for_registration(const std::string &method) {
  10826. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10827. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10828. // routing() before the custom tables are consulted, so a route registered
  10829. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10830. // there and would be reachable, but they carry protocol-level meaning
  10831. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10832. // library does not route.
  10833. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10834. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10835. has_invalid_registration_ = true;
  10836. return nullptr;
  10837. }
  10838. return &custom_handlers_[method];
  10839. }
  10840. inline Server &Server::CustomRoute(const std::string &method,
  10841. const std::string &pattern,
  10842. Handler handler) {
  10843. auto *entry = custom_entry_for_registration(method);
  10844. if (!entry) { return *this; }
  10845. return add_handler(entry->handlers, pattern, std::move(handler));
  10846. }
  10847. inline Server &Server::CustomRoute(const std::string &method,
  10848. const std::string &pattern,
  10849. HandlerWithContentReader handler) {
  10850. auto *entry = custom_entry_for_registration(method);
  10851. if (!entry) { return *this; }
  10852. return add_handler(entry->handlers_for_content_reader, pattern,
  10853. std::move(handler));
  10854. }
  10855. inline const Server::CustomHandlerEntry *
  10856. Server::find_custom_entry(const std::string &method) const {
  10857. // find() alone would be correct here. The empty() check is what keeps the
  10858. // per-request cost off servers that never call CustomRoute(), which is the
  10859. // overwhelmingly common case; keep it rather than walking into the tree.
  10860. if (custom_handlers_.empty()) { return nullptr; }
  10861. auto it = custom_handlers_.find(method);
  10862. return it == custom_handlers_.end() ? nullptr : &it->second;
  10863. }
  10864. inline Server &Server::WebSocket(const std::string &pattern,
  10865. WebSocketHandler handler) {
  10866. websocket_handlers_.push_back(
  10867. {make_matcher(pattern), std::move(handler), nullptr});
  10868. return *this;
  10869. }
  10870. inline Server &Server::WebSocket(const std::string &pattern,
  10871. WebSocketHandler handler,
  10872. SubProtocolSelector sub_protocol_selector) {
  10873. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10874. std::move(sub_protocol_selector)});
  10875. return *this;
  10876. }
  10877. inline bool Server::set_base_dir(const std::string &dir,
  10878. const std::string &mount_point) {
  10879. return set_mount_point(mount_point, dir);
  10880. }
  10881. inline bool Server::set_mount_point(const std::string &mount_point,
  10882. const std::string &dir, Headers headers) {
  10883. detail::FileStat stat(dir);
  10884. if (stat.is_dir()) {
  10885. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10886. if (!mnt.empty() && mnt[0] == '/') {
  10887. std::string resolved_base;
  10888. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  10889. #if defined(_WIN32)
  10890. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  10891. resolved_base += '\\';
  10892. }
  10893. #else
  10894. if (resolved_base.back() != '/') { resolved_base += '/'; }
  10895. #endif
  10896. }
  10897. base_dirs_.push_back(
  10898. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  10899. return true;
  10900. }
  10901. }
  10902. return false;
  10903. }
  10904. inline bool Server::remove_mount_point(const std::string &mount_point) {
  10905. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  10906. if (it->mount_point == mount_point) {
  10907. base_dirs_.erase(it);
  10908. return true;
  10909. }
  10910. }
  10911. return false;
  10912. }
  10913. inline Server &
  10914. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  10915. const std::string &mime) {
  10916. file_extension_and_mimetype_map_[ext] = mime;
  10917. return *this;
  10918. }
  10919. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  10920. default_file_mimetype_ = mime;
  10921. return *this;
  10922. }
  10923. inline Server &Server::set_file_request_handler(Handler handler) {
  10924. file_request_handler_ = std::move(handler);
  10925. return *this;
  10926. }
  10927. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  10928. std::true_type) {
  10929. error_handler_ = std::move(handler);
  10930. return *this;
  10931. }
  10932. inline Server &Server::set_error_handler_core(Handler handler,
  10933. std::false_type) {
  10934. error_handler_ = [handler](const Request &req, Response &res) {
  10935. handler(req, res);
  10936. return HandlerResponse::Handled;
  10937. };
  10938. return *this;
  10939. }
  10940. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  10941. exception_handler_ = std::move(handler);
  10942. return *this;
  10943. }
  10944. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  10945. pre_routing_handler_ = std::move(handler);
  10946. return *this;
  10947. }
  10948. inline Server &Server::set_post_routing_handler(Handler handler) {
  10949. post_routing_handler_ = std::move(handler);
  10950. return *this;
  10951. }
  10952. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  10953. pre_request_handler_ = std::move(handler);
  10954. return *this;
  10955. }
  10956. inline Server &Server::set_logger(Logger logger) {
  10957. logger_ = std::move(logger);
  10958. return *this;
  10959. }
  10960. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  10961. error_logger_ = std::move(error_logger);
  10962. return *this;
  10963. }
  10964. inline Server &Server::set_pre_compression_logger(Logger logger) {
  10965. pre_compression_logger_ = std::move(logger);
  10966. return *this;
  10967. }
  10968. inline Server &
  10969. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  10970. expect_100_continue_handler_ = std::move(handler);
  10971. return *this;
  10972. }
  10973. inline Server &Server::set_start_handler(StartHandler handler) {
  10974. start_handler_ = std::move(handler);
  10975. return *this;
  10976. }
  10977. inline Server &Server::set_address_family(int family) {
  10978. address_family_ = family;
  10979. return *this;
  10980. }
  10981. inline Server &Server::set_tcp_nodelay(bool on) {
  10982. tcp_nodelay_ = on;
  10983. return *this;
  10984. }
  10985. inline Server &Server::set_ipv6_v6only(bool on) {
  10986. ipv6_v6only_ = on;
  10987. return *this;
  10988. }
  10989. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  10990. socket_options_ = std::move(socket_options);
  10991. return *this;
  10992. }
  10993. inline Server &Server::set_default_headers(Headers headers) {
  10994. default_headers_ = std::move(headers);
  10995. return *this;
  10996. }
  10997. inline Server &Server::set_header_writer(
  10998. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  10999. header_writer_ = writer;
  11000. return *this;
  11001. }
  11002. inline Server &
  11003. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11004. trusted_proxies_ = proxies;
  11005. return *this;
  11006. }
  11007. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11008. keep_alive_max_count_ = count;
  11009. return *this;
  11010. }
  11011. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11012. keep_alive_timeout_sec_ = sec;
  11013. return *this;
  11014. }
  11015. template <class Rep, class Period>
  11016. inline Server &Server::set_keep_alive_timeout(
  11017. const std::chrono::duration<Rep, Period> &duration) {
  11018. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11019. set_keep_alive_timeout(sec);
  11020. });
  11021. return *this;
  11022. }
  11023. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11024. read_timeout_sec_ = sec;
  11025. read_timeout_usec_ = usec;
  11026. return *this;
  11027. }
  11028. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11029. write_timeout_sec_ = sec;
  11030. write_timeout_usec_ = usec;
  11031. return *this;
  11032. }
  11033. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11034. idle_interval_sec_ = sec;
  11035. idle_interval_usec_ = usec;
  11036. return *this;
  11037. }
  11038. inline Server &Server::set_payload_max_length(size_t length) {
  11039. payload_max_length_ = length;
  11040. return *this;
  11041. }
  11042. inline Server &Server::set_static_file_compression(bool on) {
  11043. static_file_compression_ = on;
  11044. return *this;
  11045. }
  11046. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11047. static_file_compression_min_length_ = length;
  11048. return *this;
  11049. }
  11050. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11051. static_file_compression_max_length_ = length;
  11052. return *this;
  11053. }
  11054. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11055. websocket_max_missed_pongs_ = count;
  11056. return *this;
  11057. }
  11058. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11059. websocket_ping_interval_sec_ = sec;
  11060. return *this;
  11061. }
  11062. template <class Rep, class Period>
  11063. inline Server &Server::set_websocket_ping_interval(
  11064. const std::chrono::duration<Rep, Period> &duration) {
  11065. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11066. set_websocket_ping_interval(sec);
  11067. });
  11068. return *this;
  11069. }
  11070. inline bool Server::bind_to_port(const std::string &host, int port,
  11071. int socket_flags) {
  11072. auto ret = bind_internal(host, port, socket_flags);
  11073. if (ret == -1) { is_decommissioned = true; }
  11074. return ret >= 0;
  11075. }
  11076. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11077. auto ret = bind_internal(host, 0, socket_flags);
  11078. if (ret == -1) { is_decommissioned = true; }
  11079. return ret;
  11080. }
  11081. inline bool Server::listen_after_bind() { return listen_internal(); }
  11082. inline bool Server::listen(const std::string &host, int port,
  11083. int socket_flags) {
  11084. return bind_to_port(host, port, socket_flags) && listen_internal();
  11085. }
  11086. inline bool Server::is_running() const { return is_running_; }
  11087. inline void Server::wait_until_ready() const {
  11088. while (!is_running_ && !is_decommissioned) {
  11089. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11090. }
  11091. }
  11092. inline void Server::stop() noexcept {
  11093. // Release the listening socket whether or not the accept loop is running:
  11094. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11095. // exchange is what makes this safe to call concurrently with the accept loop.
  11096. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11097. if (sock != INVALID_SOCKET) {
  11098. detail::shutdown_socket(sock);
  11099. detail::close_socket(sock);
  11100. }
  11101. is_decommissioned = false;
  11102. }
  11103. inline void Server::decommission() { is_decommissioned = true; }
  11104. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11105. auto len = strlen(s);
  11106. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11107. len -= 2;
  11108. {
  11109. size_t count = 0;
  11110. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11111. switch (count) {
  11112. case 0: req.method = std::string(b, e); break;
  11113. case 1: req.target = std::string(b, e); break;
  11114. case 2: req.version = std::string(b, e); break;
  11115. default: break;
  11116. }
  11117. count++;
  11118. });
  11119. if (count != 3) { return false; }
  11120. }
  11121. // A method outside the built-in set is accepted only when a handler has been
  11122. // registered for it with CustomRoute().
  11123. const auto &methods = builtin_methods();
  11124. if (methods.find(req.method) == methods.end() &&
  11125. !find_custom_entry(req.method)) {
  11126. output_error_log(Error::InvalidHTTPMethod, &req);
  11127. return false;
  11128. }
  11129. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11130. output_error_log(Error::InvalidHTTPVersion, &req);
  11131. return false;
  11132. }
  11133. {
  11134. // Skip URL fragment
  11135. for (size_t i = 0; i < req.target.size(); i++) {
  11136. if (req.target[i] == '#') {
  11137. req.target.erase(i);
  11138. break;
  11139. }
  11140. }
  11141. detail::divide(req.target, '?',
  11142. [&](const char *lhs_data, std::size_t lhs_size,
  11143. const char *rhs_data, std::size_t rhs_size) {
  11144. req.path =
  11145. decode_path_component(std::string(lhs_data, lhs_size));
  11146. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11147. });
  11148. }
  11149. return true;
  11150. }
  11151. inline bool Server::write_response(Stream &strm, bool close_connection,
  11152. Request &req, Response &res) {
  11153. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11154. // incorrectly to the error content.
  11155. req.ranges.clear();
  11156. return write_response_core(strm, close_connection, req, res, false);
  11157. }
  11158. inline bool Server::write_response_with_content(Stream &strm,
  11159. bool close_connection,
  11160. const Request &req,
  11161. Response &res) {
  11162. return write_response_core(strm, close_connection, req, res, true);
  11163. }
  11164. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11165. const Request &req, Response &res,
  11166. bool need_apply_ranges) {
  11167. assert(res.status != -1);
  11168. if (400 <= res.status && error_handler_ &&
  11169. error_handler_(req, res) == HandlerResponse::Handled) {
  11170. need_apply_ranges = true;
  11171. }
  11172. std::string content_type;
  11173. std::string boundary;
  11174. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11175. // Prepare additional headers
  11176. if (close_connection ||
  11177. detail::has_header_token(req.headers, "Connection", "close") ||
  11178. 400 <= res.status) { // Don't leave connections open after errors
  11179. res.set_header("Connection", "close");
  11180. } else {
  11181. std::string s = "timeout=";
  11182. s += std::to_string(keep_alive_timeout_sec_);
  11183. s += ", max=";
  11184. s += std::to_string(keep_alive_max_count_);
  11185. res.set_header("Keep-Alive", s);
  11186. }
  11187. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11188. !res.has_header("Content-Type")) {
  11189. res.set_header("Content-Type", "text/plain");
  11190. }
  11191. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11192. !res.has_header("Content-Length")) {
  11193. res.set_header("Content-Length", "0");
  11194. }
  11195. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11196. res.set_header("Accept-Ranges", "bytes");
  11197. }
  11198. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11199. // Response line and headers
  11200. detail::BufferStream bstrm;
  11201. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11202. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11203. // Combine small body with headers to reduce write syscalls
  11204. if (req.method != "HEAD" && !res.body.empty() && !res.content_provider_) {
  11205. bstrm.write(res.body.data(), res.body.size());
  11206. }
  11207. // Log before writing to avoid race condition with client-side code that
  11208. // accesses logger-captured data immediately after receiving the response.
  11209. output_log(req, res);
  11210. // Flush buffer
  11211. auto &data = bstrm.get_buffer();
  11212. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11213. // Streaming body
  11214. auto ret = true;
  11215. if (req.method != "HEAD" && res.content_provider_) {
  11216. if (write_content_with_provider(strm, req, res, boundary, content_type)) {
  11217. res.content_provider_success_ = true;
  11218. } else {
  11219. ret = false;
  11220. }
  11221. }
  11222. return ret;
  11223. }
  11224. inline bool
  11225. Server::write_content_with_provider(Stream &strm, const Request &req,
  11226. Response &res, const std::string &boundary,
  11227. const std::string &content_type) {
  11228. auto is_shutting_down = [this]() {
  11229. return this->svr_sock_ == INVALID_SOCKET;
  11230. };
  11231. if (res.content_length_ > 0) {
  11232. // Only a 206 response is served as a partial representation, matching the
  11233. // condition `apply_ranges()` used to decide the Content-Length and the
  11234. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11235. // only for a 2xx status, slicing under any other status would write a body
  11236. // that disagrees with the header already sent, from an unchecked offset.
  11237. auto is_partial =
  11238. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11239. if (!is_partial) {
  11240. return detail::write_content(strm, res.content_provider_, 0,
  11241. res.content_length_, is_shutting_down);
  11242. } else if (req.ranges.size() == 1) {
  11243. auto offset_and_length = detail::get_range_offset_and_length(
  11244. req.ranges[0], res.content_length_);
  11245. return detail::write_content(strm, res.content_provider_,
  11246. offset_and_length.first,
  11247. offset_and_length.second, is_shutting_down);
  11248. } else {
  11249. return detail::write_multipart_ranges_data(
  11250. strm, req, res, boundary, content_type, res.content_length_,
  11251. is_shutting_down);
  11252. }
  11253. } else {
  11254. if (res.is_chunked_content_provider_) {
  11255. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11256. // re-negotiating here would disagree with them, e.g. once a handler's
  11257. // own Content-Encoding header suppresses the negotiation.
  11258. auto compressor = detail::make_compressor(res.content_coding_);
  11259. if (!compressor) {
  11260. compressor = detail::make_unique<detail::nocompressor>();
  11261. }
  11262. return detail::write_content_chunked(strm, res.content_provider_,
  11263. is_shutting_down, *compressor);
  11264. } else {
  11265. return detail::write_content_without_length(strm, res.content_provider_,
  11266. is_shutting_down);
  11267. }
  11268. }
  11269. }
  11270. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11271. FormFields::iterator cur_field;
  11272. FormFiles::iterator cur_file;
  11273. auto is_text_field = false;
  11274. size_t count = 0;
  11275. if (read_content_core(
  11276. strm, req, res,
  11277. // Regular
  11278. [&](const char *buf, size_t n) {
  11279. // Prevent arithmetic overflow when checking sizes.
  11280. // Avoid computing (req.body.size() + n) directly because
  11281. // adding two unsigned `size_t` values can wrap around and
  11282. // produce a small result instead of indicating overflow.
  11283. // Instead, check using subtraction: ensure `n` does not
  11284. // exceed the remaining capacity `max_size() - size()`.
  11285. if (req.body.size() >= req.body.max_size() ||
  11286. n > req.body.max_size() - req.body.size()) {
  11287. return false;
  11288. }
  11289. // Limit decompressed body size to payload_max_length_ to protect
  11290. // against "zip bomb" attacks where a small compressed payload
  11291. // decompresses to a massive size.
  11292. if (payload_max_length_ > 0 &&
  11293. (req.body.size() >= payload_max_length_ ||
  11294. n > payload_max_length_ - req.body.size())) {
  11295. return false;
  11296. }
  11297. req.body.append(buf, n);
  11298. return true;
  11299. },
  11300. // Multipart FormData
  11301. [&](const FormData &file) {
  11302. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11303. output_error_log(Error::TooManyFormDataFiles, &req);
  11304. return false;
  11305. }
  11306. if (file.filename.empty()) {
  11307. cur_field = req.form.fields.emplace(
  11308. file.name, FormField{file.name, file.content, file.headers});
  11309. is_text_field = true;
  11310. } else {
  11311. cur_file = req.form.files.emplace(file.name, file);
  11312. is_text_field = false;
  11313. }
  11314. return true;
  11315. },
  11316. [&](const char *buf, size_t n) {
  11317. if (is_text_field) {
  11318. auto &content = cur_field->second.content;
  11319. if (content.size() + n > content.max_size()) { return false; }
  11320. content.append(buf, n);
  11321. } else {
  11322. auto &content = cur_file->second.content;
  11323. if (content.size() + n > content.max_size()) { return false; }
  11324. content.append(buf, n);
  11325. }
  11326. return true;
  11327. })) {
  11328. const auto &content_type = req.get_header_value("Content-Type");
  11329. if (detail::extract_media_type(content_type) ==
  11330. "application/x-www-form-urlencoded") {
  11331. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11332. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11333. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11334. return false;
  11335. }
  11336. detail::parse_query_text(req.body, req.params);
  11337. }
  11338. return true;
  11339. }
  11340. return false;
  11341. }
  11342. inline bool Server::read_content_with_content_receiver(
  11343. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11344. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11345. return read_content_core(strm, req, res, std::move(receiver),
  11346. std::move(multipart_header),
  11347. std::move(multipart_receiver));
  11348. }
  11349. inline bool Server::read_content_core(
  11350. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11351. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11352. detail::FormDataParser multipart_form_data_parser;
  11353. ContentReceiverWithProgress out;
  11354. if (req.is_multipart_form_data()) {
  11355. const auto &content_type = req.get_header_value("Content-Type");
  11356. std::string boundary;
  11357. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11358. res.status = StatusCode::BadRequest_400;
  11359. output_error_log(Error::MultipartParsing, &req);
  11360. return false;
  11361. }
  11362. multipart_form_data_parser.set_boundary(std::move(boundary));
  11363. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11364. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11365. multipart_receiver);
  11366. };
  11367. } else {
  11368. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11369. size_t /*len*/) { return receiver(buf, n); };
  11370. }
  11371. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11372. // For non-SSL builds we still scan non-persistent connections for stray
  11373. // body bytes so the payload limit is enforced (413). On keep-alive,
  11374. // pending bytes may be the next request (issue #2450), so skip.
  11375. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11376. if (!req.has_header("Content-Length") &&
  11377. !detail::is_chunked_transfer_encoding(req.headers)) {
  11378. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11379. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11380. auto has_data = strm.is_readable();
  11381. if (!has_data) {
  11382. auto s = strm.socket();
  11383. if (s != INVALID_SOCKET) {
  11384. has_data = detail::select_read(s, 0, 0) > 0;
  11385. }
  11386. }
  11387. if (has_data) {
  11388. // Route through the same decompressing reader used by the
  11389. // length-framed and chunked paths below, so payload_max_length_ is
  11390. // enforced on the decompressed size here too instead of only on the
  11391. // compressed wire bytes.
  11392. return detail::read_content(strm, req, payload_max_length_, res.status,
  11393. nullptr, out, true);
  11394. }
  11395. }
  11396. return true;
  11397. }
  11398. #else
  11399. if (!req.has_header("Content-Length") &&
  11400. !detail::is_chunked_transfer_encoding(req.headers)) {
  11401. return true;
  11402. }
  11403. #endif
  11404. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11405. out, true)) {
  11406. return false;
  11407. }
  11408. req.body_consumed_ = true;
  11409. if (req.is_multipart_form_data()) {
  11410. if (!multipart_form_data_parser.is_valid()) {
  11411. res.status = StatusCode::BadRequest_400;
  11412. output_error_log(Error::MultipartParsing, &req);
  11413. return false;
  11414. }
  11415. }
  11416. return true;
  11417. }
  11418. inline bool Server::handle_file_request(Request &req, Response &res) {
  11419. for (const auto &entry : base_dirs_) {
  11420. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11421. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11422. // One that already ends in '/' (the root mount among them) carries its own
  11423. // boundary; set_mount_point() guarantees the mount point is not empty.
  11424. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11425. (entry.mount_point.back() == '/' ||
  11426. req.path.size() == entry.mount_point.size() ||
  11427. req.path[entry.mount_point.size()] == '/')) {
  11428. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11429. if (detail::is_valid_path(sub_path)) {
  11430. auto path = entry.base_dir + sub_path;
  11431. if (path.back() == '/') { path += "index.html"; }
  11432. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11433. // but symlinks/junctions can still escape the base directory.
  11434. if (!entry.resolved_base_dir.empty()) {
  11435. std::string resolved_path;
  11436. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11437. !detail::is_path_within_base(resolved_path,
  11438. entry.resolved_base_dir)) {
  11439. res.status = StatusCode::Forbidden_403;
  11440. return true;
  11441. }
  11442. }
  11443. detail::FileStat stat(path);
  11444. if (stat.is_dir()) {
  11445. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11446. return true;
  11447. }
  11448. if (stat.is_file()) {
  11449. for (const auto &kv : entry.headers) {
  11450. res.set_header(kv.first, kv.second);
  11451. }
  11452. auto content_type_of = [&]() {
  11453. return detail::find_content_type(
  11454. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11455. };
  11456. // Only the ETag needs the content type this early, and only to name
  11457. // the coding. Deciding it here would otherwise put a regex in front
  11458. // of the 304 below, which serving a file never used to pay for.
  11459. std::string content_type;
  11460. auto encoding = detail::EncodingType::None;
  11461. if (static_file_compression_) {
  11462. content_type = content_type_of();
  11463. encoding =
  11464. static_file_encoding(req, res, content_type, stat.size());
  11465. }
  11466. // The ETag names the representation actually sent, so a client that
  11467. // cached the compressed form revalidates against the compressed ETag
  11468. // and still gets a 304, while one that took identity keeps the plain
  11469. // ETag.
  11470. auto etag = detail::compute_etag(
  11471. stat, encoding == detail::EncodingType::None
  11472. ? std::string()
  11473. : std::string("-") + detail::encoding_name(encoding));
  11474. if (!etag.empty()) { res.set_header("ETag", etag); }
  11475. auto mtime = stat.mtime();
  11476. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11477. if (!last_modified.empty()) {
  11478. res.set_header("Last-Modified", last_modified);
  11479. }
  11480. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11481. check_if_range(req, etag, mtime);
  11482. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11483. if (!mm->is_open()) {
  11484. output_error_log(Error::OpenFile, &req);
  11485. return false;
  11486. }
  11487. if (!static_file_compression_) { content_type = content_type_of(); }
  11488. detail::set_file_content_provider(res, mm, content_type, encoding);
  11489. if (req.method != "HEAD" && file_request_handler_) {
  11490. file_request_handler_(req, res);
  11491. }
  11492. return true;
  11493. } else {
  11494. output_error_log(Error::OpenFile, &req);
  11495. }
  11496. }
  11497. }
  11498. }
  11499. return false;
  11500. }
  11501. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11502. const std::string &etag,
  11503. time_t mtime) const {
  11504. // Handle conditional GET:
  11505. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11506. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11507. if (req.has_header("If-None-Match")) {
  11508. if (!etag.empty()) {
  11509. auto val =
  11510. detail::get_combined_header_value(req.headers, "If-None-Match");
  11511. // NOTE: We use exact string matching here. This works correctly
  11512. // because our server always generates weak ETags (W/"..."), and
  11513. // clients typically send back the same ETag they received.
  11514. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11515. // If-None-Match, where W/"x" and "x" would match, but this
  11516. // simplified implementation requires exact matches.
  11517. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11518. [&](const char *b, const char *e) {
  11519. auto seg_len = static_cast<size_t>(e - b);
  11520. return (seg_len == 1 && *b == '*') ||
  11521. (seg_len == etag.size() &&
  11522. std::equal(b, e, etag.begin()));
  11523. });
  11524. if (ret) {
  11525. res.status = StatusCode::NotModified_304;
  11526. return true;
  11527. }
  11528. }
  11529. } else if (req.has_header("If-Modified-Since")) {
  11530. auto val = req.get_header_value("If-Modified-Since");
  11531. auto t = detail::parse_http_date(val);
  11532. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11533. res.status = StatusCode::NotModified_304;
  11534. return true;
  11535. }
  11536. }
  11537. return false;
  11538. }
  11539. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11540. time_t mtime) const {
  11541. // Handle If-Range for partial content requests (RFC 9110
  11542. // Section 13.1.5). If-Range is only evaluated when Range header is
  11543. // present. If the validator matches, serve partial content; otherwise
  11544. // serve full content.
  11545. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11546. auto val = req.get_header_value("If-Range");
  11547. auto is_valid_range = [&]() {
  11548. if (detail::is_strong_etag(val)) {
  11549. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11550. // comparison.
  11551. return (!etag.empty() && val == etag);
  11552. } else if (detail::is_weak_etag(val)) {
  11553. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11554. return false;
  11555. } else {
  11556. // HTTP-date comparison
  11557. auto t = detail::parse_http_date(val);
  11558. return (t != static_cast<time_t>(-1) && mtime <= t);
  11559. }
  11560. };
  11561. if (!is_valid_range()) {
  11562. // Validator doesn't match: ignore Range and serve full content
  11563. req.ranges.clear();
  11564. return false;
  11565. }
  11566. }
  11567. return true;
  11568. }
  11569. inline socket_t
  11570. Server::create_server_socket(const std::string &host, int port,
  11571. int socket_flags,
  11572. SocketOptions socket_options) const {
  11573. return detail::create_socket(
  11574. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11575. ipv6_v6only_, std::move(socket_options),
  11576. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11577. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11578. output_error_log(Error::BindIPAddress, nullptr);
  11579. return false;
  11580. }
  11581. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11582. output_error_log(Error::Listen, nullptr);
  11583. return false;
  11584. }
  11585. return true;
  11586. });
  11587. }
  11588. inline int Server::bind_internal(const std::string &host, int port,
  11589. int socket_flags) {
  11590. if (is_decommissioned) { return -1; }
  11591. if (!is_valid()) { return -1; }
  11592. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11593. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11594. if (port == 0) {
  11595. struct sockaddr_storage addr;
  11596. socklen_t addr_len = sizeof(addr);
  11597. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11598. &addr_len) == -1) {
  11599. output_error_log(Error::GetSockName, nullptr);
  11600. return -1;
  11601. }
  11602. if (addr.ss_family == AF_INET) {
  11603. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11604. } else if (addr.ss_family == AF_INET6) {
  11605. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11606. } else {
  11607. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11608. return -1;
  11609. }
  11610. } else {
  11611. return port;
  11612. }
  11613. }
  11614. inline bool Server::listen_internal() {
  11615. // A stop() between bind and listen leaves nothing to accept on. Report
  11616. // failure instead of returning success without ever serving, and mark the
  11617. // server decommissioned the way any failed listen does so that a concurrent
  11618. // wait_until_ready() wakes up instead of spinning forever.
  11619. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11620. is_decommissioned = true;
  11621. return false;
  11622. }
  11623. auto ret = true;
  11624. is_running_ = true;
  11625. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11626. if (start_handler_) { start_handler_(); }
  11627. {
  11628. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11629. while (svr_sock_ != INVALID_SOCKET) {
  11630. #ifndef _WIN32
  11631. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11632. #endif
  11633. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11634. idle_interval_usec_);
  11635. if (val == 0) { // Timeout
  11636. task_queue->on_idle();
  11637. continue;
  11638. }
  11639. #ifndef _WIN32
  11640. }
  11641. #endif
  11642. #if defined _WIN32
  11643. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11644. // OVERLAPPED
  11645. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11646. #elif defined SOCK_CLOEXEC
  11647. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11648. #else
  11649. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11650. #endif
  11651. if (sock == INVALID_SOCKET) {
  11652. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11653. // touches the CRT errno, so the two have to be asked platform by
  11654. // platform rather than by testing errno here.
  11655. if (detail::is_accept_resource_error()) {
  11656. // The per-process descriptor limit or the network stack's buffer
  11657. // space has been reached. Try to accept new connections after a
  11658. // short sleep.
  11659. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11660. continue;
  11661. } else if (detail::is_accept_transient_error()) {
  11662. continue;
  11663. }
  11664. // Take the descriptor out of svr_sock_ before closing it: a later
  11665. // stop() would otherwise shutdown()/close() a value the OS may have
  11666. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11667. // gone. The exchange also settles the race with a concurrent stop(),
  11668. // since whichever side takes the descriptor closes it exactly once.
  11669. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11670. if (listen_sock != INVALID_SOCKET) {
  11671. detail::close_socket(listen_sock);
  11672. ret = false;
  11673. output_error_log(Error::Connection, nullptr);
  11674. } else {
  11675. ; // The server socket was closed by user.
  11676. }
  11677. break;
  11678. }
  11679. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11680. read_timeout_sec_, read_timeout_usec_);
  11681. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11682. write_timeout_sec_, write_timeout_usec_);
  11683. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11684. if (!task_queue->enqueue(
  11685. [this, sock]() { process_and_close_socket(sock); })) {
  11686. output_error_log(Error::ResourceExhaustion, nullptr);
  11687. detail::shutdown_socket(sock);
  11688. detail::close_socket(sock);
  11689. }
  11690. }
  11691. task_queue->shutdown();
  11692. }
  11693. is_decommissioned = !ret;
  11694. return ret;
  11695. }
  11696. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11697. if (pre_routing_handler_ &&
  11698. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11699. return true;
  11700. }
  11701. // File handler
  11702. if ((req.method == "GET" || req.method == "HEAD") &&
  11703. handle_file_request(req, res)) {
  11704. return true;
  11705. }
  11706. const auto *custom = find_custom_entry(req.method);
  11707. // The second clause mirrors what expect_content() does unconditionally for
  11708. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11709. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11710. // `allprop`) would skip its handler and fall through to 404.
  11711. if (detail::expect_content(req) ||
  11712. (custom && !custom->handlers_for_content_reader.empty())) {
  11713. // Content reader handler
  11714. {
  11715. // Track whether the ContentReader was aborted due to the decompressed
  11716. // payload exceeding `payload_max_length_`.
  11717. // The user handler runs after the lambda returns, so we must restore the
  11718. // 413 status if the handler overwrites it.
  11719. bool content_reader_payload_too_large = false;
  11720. ContentReader reader(
  11721. [&](ContentReceiver receiver) {
  11722. auto result = read_content_with_content_receiver(
  11723. strm, req, res, std::move(receiver), nullptr, nullptr);
  11724. if (!result) {
  11725. output_error_log(Error::Read, &req);
  11726. if (res.status == StatusCode::PayloadTooLarge_413) {
  11727. content_reader_payload_too_large = true;
  11728. }
  11729. }
  11730. return result;
  11731. },
  11732. [&](FormDataHeader header, ContentReceiver receiver) {
  11733. auto result = read_content_with_content_receiver(
  11734. strm, req, res, nullptr, std::move(header),
  11735. std::move(receiver));
  11736. if (!result) {
  11737. output_error_log(Error::Read, &req);
  11738. if (res.status == StatusCode::PayloadTooLarge_413) {
  11739. content_reader_payload_too_large = true;
  11740. }
  11741. }
  11742. return result;
  11743. });
  11744. bool dispatched = false;
  11745. if (req.method == "POST") {
  11746. dispatched = dispatch_request_for_content_reader(
  11747. req, res, std::move(reader), post_handlers_for_content_reader_);
  11748. } else if (req.method == "PUT") {
  11749. dispatched = dispatch_request_for_content_reader(
  11750. req, res, std::move(reader), put_handlers_for_content_reader_);
  11751. } else if (req.method == "PATCH") {
  11752. dispatched = dispatch_request_for_content_reader(
  11753. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11754. } else if (req.method == "DELETE") {
  11755. dispatched = dispatch_request_for_content_reader(
  11756. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11757. } else if (custom) {
  11758. dispatched = dispatch_request_for_content_reader(
  11759. req, res, std::move(reader), custom->handlers_for_content_reader);
  11760. }
  11761. if (dispatched) {
  11762. if (content_reader_payload_too_large) {
  11763. // Enforce the limit: override any status the handler may have set
  11764. // and return false so the error path sends a plain 413 response.
  11765. res.status = StatusCode::PayloadTooLarge_413;
  11766. res.body.clear();
  11767. res.content_length_ = 0;
  11768. res.content_provider_ = nullptr;
  11769. return false;
  11770. }
  11771. return true;
  11772. }
  11773. }
  11774. // NOTE: `req.body` is not read here. For a regular handler the body is
  11775. // read inside dispatch_request(), after the route has matched and the
  11776. // pre-request handler has approved the request, so that a rejected
  11777. // request (e.g. failed authentication) never forces us to buffer a
  11778. // potentially large body.
  11779. }
  11780. // Regular handler
  11781. if (req.method == "GET" || req.method == "HEAD") {
  11782. return dispatch_request(req, res, get_handlers_, strm);
  11783. } else if (req.method == "POST") {
  11784. return dispatch_request(req, res, post_handlers_, strm);
  11785. } else if (req.method == "PUT") {
  11786. return dispatch_request(req, res, put_handlers_, strm);
  11787. } else if (req.method == "DELETE") {
  11788. return dispatch_request(req, res, delete_handlers_, strm);
  11789. } else if (req.method == "OPTIONS") {
  11790. return dispatch_request(req, res, options_handlers_, strm);
  11791. } else if (req.method == "PATCH") {
  11792. return dispatch_request(req, res, patch_handlers_, strm);
  11793. } else if (custom) {
  11794. return dispatch_request(req, res, custom->handlers, strm);
  11795. }
  11796. res.status = StatusCode::BadRequest_400;
  11797. return false;
  11798. }
  11799. inline bool Server::dispatch_request(Request &req, Response &res,
  11800. const Handlers &handlers, Stream &strm) {
  11801. for (const auto &x : handlers) {
  11802. const auto &matcher = x.first;
  11803. const auto &handler = x.second;
  11804. if (matcher->match(req)) {
  11805. req.matched_route = matcher->pattern();
  11806. // Run the pre-request handler before reading the body so a rejected
  11807. // request (e.g. failed authentication) never forces us to buffer a
  11808. // potentially large body. `req.matched_route` is available here.
  11809. if (pre_request_handler_ &&
  11810. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11811. return true;
  11812. }
  11813. // The route matched and the request was approved; read the body now.
  11814. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11815. output_error_log(Error::Read, &req);
  11816. return false;
  11817. }
  11818. handler(req, res);
  11819. return true;
  11820. }
  11821. }
  11822. return false;
  11823. }
  11824. // Decides the content coding for a response served straight from a file. Both
  11825. // the ETag, which has to name the representation actually sent, and
  11826. // `apply_static_file_compression()` go through this, so the two cannot drift
  11827. // apart.
  11828. inline detail::EncodingType
  11829. Server::static_file_encoding(const Request &req, const Response &res,
  11830. const std::string &content_type,
  11831. size_t length) const {
  11832. if (!static_file_compression_) { return detail::EncodingType::None; }
  11833. // Nothing to compress, and an empty file already answers with
  11834. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11835. // turn an empty body into a 20-byte gzip stream.
  11836. if (length == 0) { return detail::EncodingType::None; }
  11837. // A file that already fits in a single packet gains nothing from being made
  11838. // smaller, since it still travels in that one segment, and a file of a few
  11839. // bytes comes out larger than it went in.
  11840. if (length < static_file_compression_min_length_) {
  11841. return detail::EncodingType::None;
  11842. }
  11843. // RFC 9110 applies Range to the representation after content coding, so a
  11844. // compressed 206 would mean compressing the whole file and then slicing it.
  11845. // Serve ranges from the identity representation instead.
  11846. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  11847. if (static_file_compression_max_length_ > 0 &&
  11848. length > static_file_compression_max_length_) {
  11849. return detail::EncodingType::None;
  11850. }
  11851. return detail::encoding_type(req, res, content_type);
  11852. }
  11853. // Compresses a file-backed content provider into `res.body` and takes over the
  11854. // framing headers. Returns false when the response is left untouched.
  11855. inline bool Server::apply_static_file_compression(const Request &req,
  11856. Response &res) const {
  11857. auto type = res.content_coding_;
  11858. if (type == detail::EncodingType::None || !res.content_provider_) {
  11859. return false;
  11860. }
  11861. auto compressor = detail::make_compressor(type);
  11862. if (!compressor) { return false; }
  11863. output_pre_compression_log(req, res);
  11864. std::string compressed;
  11865. if (!detail::compress_content_provider(res.content_provider_,
  11866. res.content_length_, *compressor,
  11867. compressed)) {
  11868. return false;
  11869. }
  11870. res.body.swap(compressed);
  11871. // The provider was consumed in full, so a resource releaser registered with
  11872. // it should hear about a success when the response goes away.
  11873. res.content_provider_success_ = true;
  11874. res.content_provider_ = nullptr;
  11875. res.content_length_ = 0;
  11876. res.content_coding_ = detail::EncodingType::None;
  11877. res.set_header("Content-Encoding", detail::encoding_name(type));
  11878. res.set_header("Vary", "Accept-Encoding");
  11879. res.set_header("Content-Length", std::to_string(res.body.size()));
  11880. return true;
  11881. }
  11882. inline void Server::apply_ranges(const Request &req, Response &res,
  11883. std::string &content_type,
  11884. std::string &boundary) const {
  11885. // A known-length content provider leaves `res.body` empty, so the compressor
  11886. // at the end of this function never runs for one (issue #2545). A file-backed
  11887. // provider is fully readable right here, so compress it and answer with an
  11888. // ordinary body: `Content-Length` and HEAD keep working, and the response
  11889. // takes the same path as `set_content()` from here on. Range requests never
  11890. // get a content coding, so `Content-Range` still names identity bytes and
  11891. // none of the framing below applies.
  11892. if (apply_static_file_compression(req, res)) { return; }
  11893. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  11894. auto it = res.headers.find("Content-Type");
  11895. if (it != res.headers.end()) {
  11896. content_type = it->second;
  11897. res.headers.erase(it);
  11898. }
  11899. boundary = detail::make_multipart_data_boundary();
  11900. res.set_header("Content-Type",
  11901. "multipart/byteranges; boundary=" + boundary);
  11902. }
  11903. auto type = detail::encoding_type(req, res);
  11904. if (res.body.empty()) {
  11905. if (res.content_length_ > 0) {
  11906. size_t length = 0;
  11907. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11908. length = res.content_length_;
  11909. } else if (req.ranges.size() == 1) {
  11910. auto offset_and_length = detail::get_range_offset_and_length(
  11911. req.ranges[0], res.content_length_);
  11912. length = offset_and_length.second;
  11913. auto content_range = detail::make_content_range_header_field(
  11914. offset_and_length, res.content_length_);
  11915. res.set_header("Content-Range", content_range);
  11916. } else {
  11917. length = detail::get_multipart_ranges_data_length(
  11918. req, boundary, content_type, res.content_length_);
  11919. }
  11920. res.set_header("Content-Length", std::to_string(length));
  11921. } else {
  11922. if (res.content_provider_) {
  11923. if (res.is_chunked_content_provider_) {
  11924. res.set_header("Transfer-Encoding", "chunked");
  11925. res.content_coding_ = type;
  11926. if (type != detail::EncodingType::None) {
  11927. res.set_header("Content-Encoding", detail::encoding_name(type));
  11928. res.set_header("Vary", "Accept-Encoding");
  11929. }
  11930. }
  11931. }
  11932. }
  11933. } else {
  11934. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11935. ;
  11936. } else if (req.ranges.size() == 1) {
  11937. auto offset_and_length =
  11938. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  11939. auto offset = offset_and_length.first;
  11940. auto length = offset_and_length.second;
  11941. auto content_range = detail::make_content_range_header_field(
  11942. offset_and_length, res.body.size());
  11943. res.set_header("Content-Range", content_range);
  11944. assert(offset + length <= res.body.size());
  11945. res.body = res.body.substr(offset, length);
  11946. } else {
  11947. std::string data;
  11948. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  11949. res.body.size(), data);
  11950. res.body.swap(data);
  11951. }
  11952. if (type != detail::EncodingType::None) {
  11953. output_pre_compression_log(req, res);
  11954. if (auto compressor = detail::make_compressor(type)) {
  11955. std::string compressed;
  11956. if (compressor->compress(res.body.data(), res.body.size(), true,
  11957. [&](const char *data, size_t data_len) {
  11958. compressed.append(data, data_len);
  11959. return true;
  11960. })) {
  11961. res.body.swap(compressed);
  11962. res.set_header("Content-Encoding", detail::encoding_name(type));
  11963. res.set_header("Vary", "Accept-Encoding");
  11964. }
  11965. }
  11966. }
  11967. res.content_length_ = res.body.size();
  11968. res.set_header("Content-Length", std::to_string(res.content_length_));
  11969. }
  11970. }
  11971. inline bool Server::dispatch_request_for_content_reader(
  11972. Request &req, Response &res, ContentReader content_reader,
  11973. const HandlersForContentReader &handlers) const {
  11974. for (const auto &x : handlers) {
  11975. const auto &matcher = x.first;
  11976. const auto &handler = x.second;
  11977. if (matcher->match(req)) {
  11978. req.matched_route = matcher->pattern();
  11979. if (!pre_request_handler_ ||
  11980. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  11981. handler(req, res, content_reader);
  11982. }
  11983. return true;
  11984. }
  11985. }
  11986. return false;
  11987. }
  11988. inline std::string
  11989. get_client_ip(const std::string &x_forwarded_for,
  11990. const std::vector<std::string> &trusted_proxies) {
  11991. // X-Forwarded-For is a comma-separated list per RFC 7239
  11992. std::vector<std::string> ip_list;
  11993. detail::split(x_forwarded_for.data(),
  11994. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  11995. [&](const char *b, const char *e) {
  11996. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  11997. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  11998. });
  11999. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12000. // no segments. Signal "no client IP derived" with an empty string so the
  12001. // caller can fall back to the connection-level remote address.
  12002. if (ip_list.empty()) { return std::string(); }
  12003. // Each hop appends the address it received the request from, so the rightmost
  12004. // entries are the ones written by our own infrastructure while the leftmost
  12005. // are whatever the original client chose to send. Walk from the right and
  12006. // skip trusted proxies; the first address that is not a trusted proxy is the
  12007. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12008. // from the left instead lets a client forge an arbitrary address by following
  12009. // it with a trusted proxy's address, which the left-to-right scan then
  12010. // returned as the client.
  12011. for (size_t i = ip_list.size(); i-- > 0;) {
  12012. const auto &ip = ip_list[i];
  12013. auto is_trusted_proxy =
  12014. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12015. [&](const std::string &proxy) { return ip == proxy; });
  12016. if (!is_trusted_proxy) { return ip; }
  12017. }
  12018. // Every hop was a trusted proxy; fall back to the first entry.
  12019. return ip_list.front();
  12020. }
  12021. inline bool
  12022. Server::process_request(Stream &strm, const std::string &remote_addr,
  12023. int remote_port, const std::string &local_addr,
  12024. int local_port, bool close_connection,
  12025. bool &connection_closed,
  12026. const std::function<void(Request &)> &setup_request,
  12027. bool *websocket_upgraded) {
  12028. std::array<char, 2048> buf{};
  12029. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12030. // Connection has been closed on client
  12031. if (!line_reader.getline()) { return false; }
  12032. Request req;
  12033. req.start_time_ = std::chrono::steady_clock::now();
  12034. req.remote_addr = remote_addr;
  12035. req.remote_port = remote_port;
  12036. req.local_addr = local_addr;
  12037. req.local_port = local_port;
  12038. Response res;
  12039. res.version = "HTTP/1.1";
  12040. res.headers = default_headers_;
  12041. // Request line and headers
  12042. if (!parse_request_line(line_reader.ptr(), req)) {
  12043. res.status = StatusCode::BadRequest_400;
  12044. output_error_log(Error::InvalidRequestLine, &req);
  12045. return write_response(strm, close_connection, req, res);
  12046. }
  12047. // Request headers
  12048. if (!detail::read_headers(strm, req.headers)) {
  12049. res.status = StatusCode::BadRequest_400;
  12050. output_error_log(Error::InvalidHeaders, &req);
  12051. return write_response(strm, close_connection, req, res);
  12052. }
  12053. // RFC 9112 §6.3: Reject requests whose framing is ambiguous, which would
  12054. // otherwise let an intermediary and this parser disagree on where the body
  12055. // ends and enable request smuggling. Two cases: a non-zero Content-Length
  12056. // alongside any Transfer-Encoding (Content-Length: 0 is tolerated for
  12057. // compatibility with existing clients), and a Transfer-Encoding whose final
  12058. // coding is not chunked, which leaves the body length undeterminable. The
  12059. // latter must not fall through to the "no body" path, or the body bytes are
  12060. // parsed as the next request on a persistent connection.
  12061. if (req.has_header("Transfer-Encoding") &&
  12062. (req.get_header_value_u64("Content-Length") > 0 ||
  12063. !detail::is_chunked_transfer_encoding(req.headers))) {
  12064. connection_closed = true;
  12065. res.status = StatusCode::BadRequest_400;
  12066. return write_response(strm, close_connection, req, res);
  12067. }
  12068. // Check if the request URI doesn't exceed the limit
  12069. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12070. connection_closed = true;
  12071. res.status = StatusCode::UriTooLong_414;
  12072. output_error_log(Error::ExceedUriMaxLength, &req);
  12073. return write_response(strm, close_connection, req, res);
  12074. }
  12075. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12076. connection_closed = true;
  12077. }
  12078. if (req.version == "HTTP/1.0" &&
  12079. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12080. connection_closed = true;
  12081. }
  12082. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12083. // itself a trusted proxy. Otherwise any direct client could spoof
  12084. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12085. auto is_trusted_peer = std::any_of(
  12086. trusted_proxies_.begin(), trusted_proxies_.end(),
  12087. [&](const std::string &proxy) { return proxy == remote_addr; });
  12088. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12089. // Some proxies append the address they observed as a separate
  12090. // X-Forwarded-For field line instead of extending the one the client sent
  12091. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12092. // be scanned. Reading only the first occurrence would hand back the
  12093. // client-supplied, and therefore forgeable, value.
  12094. auto x_forwarded_for =
  12095. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12096. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12097. req.remote_addr = derived.empty() ? remote_addr : derived;
  12098. } else {
  12099. req.remote_addr = remote_addr;
  12100. }
  12101. req.remote_port = remote_port;
  12102. req.local_addr = local_addr;
  12103. req.local_port = local_port;
  12104. if (req.has_header("Accept")) {
  12105. auto accept_header =
  12106. detail::get_combined_header_value(req.headers, "Accept");
  12107. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12108. connection_closed = true;
  12109. res.status = StatusCode::BadRequest_400;
  12110. output_error_log(Error::HTTPParsing, &req);
  12111. return write_response(strm, close_connection, req, res);
  12112. }
  12113. }
  12114. if (req.has_header("Range")) {
  12115. const auto &range_header_value = req.get_header_value("Range");
  12116. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12117. connection_closed = true;
  12118. res.status = StatusCode::RangeNotSatisfiable_416;
  12119. output_error_log(Error::InvalidRangeHeader, &req);
  12120. return write_response(strm, close_connection, req, res);
  12121. }
  12122. }
  12123. if (setup_request) { setup_request(req); }
  12124. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12125. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12126. // must be ignored. An expectation we do not recognize is left alone; the
  12127. // 417 the section allows for one is a MAY, not a requirement.
  12128. if (req.version != "HTTP/1.0" &&
  12129. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12130. int status = StatusCode::Continue_100;
  12131. if (expect_100_continue_handler_) {
  12132. status = expect_100_continue_handler_(req, res);
  12133. }
  12134. switch (status) {
  12135. case StatusCode::Continue_100:
  12136. case StatusCode::ExpectationFailed_417:
  12137. detail::write_response_line(strm, status);
  12138. strm.write("\r\n");
  12139. break;
  12140. default:
  12141. connection_closed = true;
  12142. return write_response(strm, true, req, res);
  12143. }
  12144. }
  12145. // Setup `is_connection_closed` method
  12146. auto sock = strm.socket();
  12147. req.is_connection_closed = [sock]() {
  12148. return !detail::is_socket_alive(sock);
  12149. };
  12150. // WebSocket upgrade
  12151. // Check pre_routing_handler_ before upgrading so that authentication
  12152. // and other middleware can reject the request with an HTTP response
  12153. // (e.g., 401) before the protocol switches.
  12154. if (detail::is_websocket_upgrade(req)) {
  12155. if (pre_routing_handler_ &&
  12156. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12157. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12158. return write_response(strm, close_connection, req, res);
  12159. }
  12160. // Find matching WebSocket handler
  12161. for (const auto &entry : websocket_handlers_) {
  12162. if (entry.matcher->match(req)) {
  12163. // Compute accept key
  12164. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12165. auto accept_key = detail::websocket_accept_key(client_key);
  12166. // Negotiate subprotocol
  12167. std::string selected_subprotocol;
  12168. if (entry.sub_protocol_selector) {
  12169. auto protocol_header = detail::get_combined_header_value(
  12170. req.headers, "Sec-WebSocket-Protocol");
  12171. if (!protocol_header.empty()) {
  12172. std::vector<std::string> protocols;
  12173. detail::split(protocol_header.data(),
  12174. protocol_header.data() + protocol_header.size(), ',',
  12175. [&](const char *b, const char *e) {
  12176. protocols.emplace_back(b, e);
  12177. });
  12178. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12179. }
  12180. }
  12181. // Send 101 Switching Protocols
  12182. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12183. "Upgrade: websocket\r\n"
  12184. "Connection: Upgrade\r\n"
  12185. "Sec-WebSocket-Accept: " +
  12186. accept_key + "\r\n";
  12187. if (!selected_subprotocol.empty()) {
  12188. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12189. return false;
  12190. }
  12191. handshake_response +=
  12192. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12193. }
  12194. handshake_response += "\r\n";
  12195. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12196. 0) {
  12197. return false;
  12198. }
  12199. connection_closed = true;
  12200. if (websocket_upgraded) { *websocket_upgraded = true; }
  12201. {
  12202. #ifdef CPPHTTPLIB_SSL_ENABLED
  12203. if (req.ssl) {
  12204. // wss: the heartbeat ping thread and the read path enter the same
  12205. // TLS session from different threads. Hand the WebSocket a stream
  12206. // that serializes every TLS call, so the shared SSLSocketStream on
  12207. // the plain HTTP/HTTPS paths stays untouched.
  12208. auto ws_strm =
  12209. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12210. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12211. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12212. write_timeout_sec_, write_timeout_usec_));
  12213. ws::WebSocket ws(std::move(ws_strm), req, true,
  12214. websocket_ping_interval_sec_,
  12215. websocket_max_missed_pongs_);
  12216. entry.handler(req, ws);
  12217. return true;
  12218. }
  12219. #endif
  12220. // Use WebSocket-specific read timeout instead of HTTP timeout
  12221. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12222. 0);
  12223. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12224. websocket_max_missed_pongs_);
  12225. entry.handler(req, ws);
  12226. }
  12227. return true;
  12228. }
  12229. }
  12230. // No matching handler - fall through to 404
  12231. }
  12232. // Routing
  12233. auto routed = false;
  12234. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12235. routed = routing(req, res, strm);
  12236. #else
  12237. try {
  12238. routed = routing(req, res, strm);
  12239. } catch (std::exception &) {
  12240. if (exception_handler_) {
  12241. auto ep = std::current_exception();
  12242. exception_handler_(req, res, ep);
  12243. routed = true;
  12244. } else {
  12245. res.status = StatusCode::InternalServerError_500;
  12246. }
  12247. } catch (...) {
  12248. if (exception_handler_) {
  12249. auto ep = std::current_exception();
  12250. exception_handler_(req, res, ep);
  12251. routed = true;
  12252. } else {
  12253. res.status = StatusCode::InternalServerError_500;
  12254. }
  12255. }
  12256. #endif
  12257. auto ret = false;
  12258. if (routed) {
  12259. if (res.status == -1) {
  12260. res.status = req.ranges.empty() ? StatusCode::OK_200
  12261. : StatusCode::PartialContent_206;
  12262. }
  12263. // Serve file content by using a content provider
  12264. auto file_open_error = false;
  12265. if (!res.file_content_path_.empty()) {
  12266. const auto &path = res.file_content_path_;
  12267. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12268. if (!mm->is_open()) {
  12269. res.body.clear();
  12270. res.content_length_ = 0;
  12271. res.content_provider_ = nullptr;
  12272. res.status = StatusCode::NotFound_404;
  12273. output_error_log(Error::OpenFile, &req);
  12274. file_open_error = true;
  12275. } else {
  12276. auto content_type = res.file_content_content_type_;
  12277. if (content_type.empty()) {
  12278. content_type = detail::find_content_type(
  12279. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12280. }
  12281. detail::set_file_content_provider(
  12282. res, mm, content_type,
  12283. static_file_encoding(req, res, content_type, mm->size()));
  12284. }
  12285. }
  12286. if (file_open_error) {
  12287. ret = write_response(strm, close_connection, req, res);
  12288. } else if (detail::range_error(req, res)) {
  12289. res.body.clear();
  12290. res.content_length_ = 0;
  12291. res.content_provider_ = nullptr;
  12292. res.status = StatusCode::RangeNotSatisfiable_416;
  12293. ret = write_response(strm, close_connection, req, res);
  12294. } else {
  12295. ret = write_response_with_content(strm, close_connection, req, res);
  12296. }
  12297. } else {
  12298. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12299. ret = write_response(strm, close_connection, req, res);
  12300. }
  12301. // Drain any unconsumed framed body to prevent request smuggling on
  12302. // keep-alive. Without framing there is no body to drain — reading would
  12303. // consume the next request (issue #2450). If the response has committed the
  12304. // connection to close, there is no next request to protect.
  12305. if (!req.body_consumed_ && detail::has_framed_body(req)) {
  12306. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12307. connection_closed = true;
  12308. } else {
  12309. int dummy_status;
  12310. if (!detail::read_content(
  12311. strm, req, payload_max_length_, dummy_status, nullptr,
  12312. [](const char *, size_t, size_t, size_t) { return true; },
  12313. false)) {
  12314. connection_closed = true;
  12315. }
  12316. }
  12317. }
  12318. return ret;
  12319. }
  12320. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12321. inline bool Server::process_and_close_socket(socket_t sock) {
  12322. std::string remote_addr;
  12323. int remote_port = 0;
  12324. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12325. std::string local_addr;
  12326. int local_port = 0;
  12327. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12328. bool websocket_upgraded = false;
  12329. auto ret = serve_guarded([&]() {
  12330. return detail::process_server_socket(
  12331. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12332. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12333. write_timeout_usec_,
  12334. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12335. return process_request(strm, remote_addr, remote_port, local_addr,
  12336. local_port, close_connection,
  12337. connection_closed, nullptr,
  12338. &websocket_upgraded);
  12339. });
  12340. });
  12341. detail::drain_and_close_socket(sock);
  12342. return ret;
  12343. }
  12344. inline void Server::output_log(const Request &req, const Response &res) const {
  12345. if (logger_) {
  12346. std::lock_guard<std::mutex> guard(logger_mutex_);
  12347. logger_(req, res);
  12348. }
  12349. }
  12350. inline void Server::output_pre_compression_log(const Request &req,
  12351. const Response &res) const {
  12352. if (pre_compression_logger_) {
  12353. std::lock_guard<std::mutex> guard(logger_mutex_);
  12354. pre_compression_logger_(req, res);
  12355. }
  12356. }
  12357. inline void Server::output_error_log(const Error &err,
  12358. const Request *req) const {
  12359. if (error_logger_) {
  12360. std::lock_guard<std::mutex> guard(logger_mutex_);
  12361. error_logger_(err, req);
  12362. }
  12363. }
  12364. /*
  12365. * Group 5: ClientImpl and Client (Universal) implementation
  12366. */
  12367. // HTTP client implementation
  12368. inline ClientImpl::ClientImpl(const std::string &host)
  12369. : ClientImpl(host, 80, std::string(), std::string()) {}
  12370. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12371. : ClientImpl(host, port, std::string(), std::string()) {}
  12372. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12373. const std::string &client_cert_path,
  12374. const std::string &client_key_path)
  12375. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12376. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12377. inline ClientImpl::~ClientImpl() {
  12378. // Wait until all the requests in flight are handled.
  12379. size_t retry_count = 10;
  12380. while (retry_count-- > 0) {
  12381. {
  12382. std::lock_guard<std::mutex> guard(socket_mutex_);
  12383. if (socket_requests_in_flight_ == 0) { break; }
  12384. }
  12385. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12386. }
  12387. std::lock_guard<std::mutex> guard(socket_mutex_);
  12388. shutdown_socket(socket_);
  12389. close_socket(socket_);
  12390. }
  12391. inline bool ClientImpl::is_valid() const { return true; }
  12392. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12393. client_cert_path_ = rhs.client_cert_path_;
  12394. client_key_path_ = rhs.client_key_path_;
  12395. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12396. read_timeout_sec_ = rhs.read_timeout_sec_;
  12397. read_timeout_usec_ = rhs.read_timeout_usec_;
  12398. write_timeout_sec_ = rhs.write_timeout_sec_;
  12399. write_timeout_usec_ = rhs.write_timeout_usec_;
  12400. max_timeout_msec_ = rhs.max_timeout_msec_;
  12401. basic_auth_username_ = rhs.basic_auth_username_;
  12402. basic_auth_password_ = rhs.basic_auth_password_;
  12403. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12404. keep_alive_ = rhs.keep_alive_;
  12405. follow_location_ = rhs.follow_location_;
  12406. path_encode_ = rhs.path_encode_;
  12407. address_family_ = rhs.address_family_;
  12408. tcp_nodelay_ = rhs.tcp_nodelay_;
  12409. ipv6_v6only_ = rhs.ipv6_v6only_;
  12410. socket_options_ = rhs.socket_options_;
  12411. compress_ = rhs.compress_;
  12412. decompress_ = rhs.decompress_;
  12413. payload_max_length_ = rhs.payload_max_length_;
  12414. has_payload_max_length_ = rhs.has_payload_max_length_;
  12415. interface_ = rhs.interface_;
  12416. proxy_host_ = rhs.proxy_host_;
  12417. proxy_port_ = rhs.proxy_port_;
  12418. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12419. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12420. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12421. no_proxy_entries_ = rhs.no_proxy_entries_;
  12422. logger_ = rhs.logger_;
  12423. error_logger_ = rhs.error_logger_;
  12424. #ifdef CPPHTTPLIB_SSL_ENABLED
  12425. digest_auth_username_ = rhs.digest_auth_username_;
  12426. digest_auth_password_ = rhs.digest_auth_password_;
  12427. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12428. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12429. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12430. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12431. server_certificate_verification_ = rhs.server_certificate_verification_;
  12432. server_hostname_verification_ = rhs.server_hostname_verification_;
  12433. system_ca_mode_ = rhs.system_ca_mode_;
  12434. #endif
  12435. }
  12436. inline bool
  12437. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12438. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12439. if (no_proxy_entries_.empty()) { return true; }
  12440. // host_ is const so its normalized form is invariant; cache it. The
  12441. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12442. if (host == host_) {
  12443. if (!host_normalized_valid_) {
  12444. host_normalized_ = detail::normalize_target(host_);
  12445. host_normalized_valid_ = true;
  12446. }
  12447. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12448. }
  12449. auto target = detail::normalize_target(host);
  12450. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12451. }
  12452. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12453. if (is_proxy_enabled_for_host(host_)) {
  12454. return detail::create_client_socket(
  12455. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12456. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12457. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12458. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12459. }
  12460. // Check is custom IP or hostname specified for host_
  12461. std::string connect_host;
  12462. std::string ip;
  12463. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12464. return detail::create_client_socket(
  12465. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12466. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12467. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12468. write_timeout_usec_, interface_, error);
  12469. }
  12470. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12471. Error &error) {
  12472. auto sock = create_client_socket(error);
  12473. if (sock == INVALID_SOCKET) { return false; }
  12474. socket.sock = sock;
  12475. return true;
  12476. }
  12477. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12478. return create_and_connect_socket(socket, error);
  12479. }
  12480. inline bool ClientImpl::setup_proxy_connection(
  12481. Socket & /*socket*/,
  12482. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12483. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12484. return true;
  12485. }
  12486. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12487. bool /*shutdown_gracefully*/) {
  12488. // If there are any requests in flight from threads other than us, then it's
  12489. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12490. assert(socket_requests_in_flight_ == 0 ||
  12491. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12492. }
  12493. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12494. if (socket.sock == INVALID_SOCKET) { return; }
  12495. detail::shutdown_socket(socket.sock);
  12496. }
  12497. inline void ClientImpl::close_socket(Socket &socket) {
  12498. // If there are requests in flight in another thread, usually closing
  12499. // the socket will be fine and they will simply receive an error when
  12500. // using the closed socket, but it is still a bug since rarely the OS
  12501. // may reassign the socket id to be used for a new socket, and then
  12502. // suddenly they will be operating on a live socket that is different
  12503. // than the one they intended!
  12504. assert(socket_requests_in_flight_ == 0 ||
  12505. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12506. // It is also a bug if this happens while SSL is still active
  12507. #ifdef CPPHTTPLIB_SSL_ENABLED
  12508. assert(socket.ssl == nullptr);
  12509. #endif
  12510. if (socket.sock == INVALID_SOCKET) { return; }
  12511. detail::close_socket(socket.sock);
  12512. socket.sock = INVALID_SOCKET;
  12513. }
  12514. inline void ClientImpl::disconnect(bool gracefully) {
  12515. shutdown_ssl(socket_, gracefully);
  12516. shutdown_socket(socket_);
  12517. close_socket(socket_);
  12518. }
  12519. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12520. Response &res,
  12521. bool skip_100_continue) const {
  12522. std::array<char, 2048> buf{};
  12523. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12524. if (!line_reader.getline()) { return false; }
  12525. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12526. res.reason)) {
  12527. return req.method == "CONNECT";
  12528. }
  12529. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12530. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12531. if (!line_reader.getline()) { return false; } // CRLF
  12532. if (!line_reader.getline()) { return false; } // next response line
  12533. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12534. res.reason)) {
  12535. return false;
  12536. }
  12537. }
  12538. return true;
  12539. }
  12540. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12541. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12542. auto ret = send_(req, res, error);
  12543. if (error == Error::SSLPeerCouldBeClosed_) {
  12544. assert(!ret);
  12545. ret = send_(req, res, error);
  12546. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12547. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12548. }
  12549. return ret;
  12550. }
  12551. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12552. {
  12553. std::lock_guard<std::mutex> guard(socket_mutex_);
  12554. // Set this to false immediately - if it ever gets set to true by the end
  12555. // of the request, we know another thread instructed us to close the
  12556. // socket.
  12557. socket_should_be_closed_when_request_is_done_ = false;
  12558. auto is_alive = false;
  12559. if (socket_.is_open()) {
  12560. is_alive = detail::is_socket_alive(socket_.sock);
  12561. #ifdef CPPHTTPLIB_SSL_ENABLED
  12562. if (is_alive && is_ssl()) {
  12563. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12564. is_alive = false;
  12565. }
  12566. }
  12567. #endif
  12568. if (!is_alive) {
  12569. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12570. disconnect(/*gracefully=*/false);
  12571. }
  12572. }
  12573. if (!is_alive) {
  12574. if (!ensure_socket_connection(socket_, error)) {
  12575. output_error_log(error, &req);
  12576. return false;
  12577. }
  12578. {
  12579. auto success = true;
  12580. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12581. error)) {
  12582. if (!success) { output_error_log(error, &req); }
  12583. return success;
  12584. }
  12585. }
  12586. }
  12587. // Mark the current socket as being in use so that it cannot be closed by
  12588. // anyone else while this request is ongoing, even though we will be
  12589. // releasing the mutex.
  12590. if (socket_requests_in_flight_ > 1) {
  12591. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12592. }
  12593. socket_requests_in_flight_ += 1;
  12594. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12595. }
  12596. for (const auto &header : default_headers_) {
  12597. if (req.headers.find(header.first) == req.headers.end()) {
  12598. req.headers.insert(header);
  12599. }
  12600. }
  12601. auto ret = false;
  12602. auto close_connection = !keep_alive_;
  12603. auto se = detail::scope_exit([&]() {
  12604. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12605. std::lock_guard<std::mutex> guard(socket_mutex_);
  12606. socket_requests_in_flight_ -= 1;
  12607. if (socket_requests_in_flight_ <= 0) {
  12608. assert(socket_requests_in_flight_ == 0);
  12609. socket_requests_are_from_thread_ = std::thread::id();
  12610. }
  12611. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12612. !ret) {
  12613. disconnect(/*gracefully=*/true);
  12614. }
  12615. });
  12616. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12617. return handle_request(strm, req, res, close_connection, error);
  12618. });
  12619. if (!ret) {
  12620. if (error == Error::Success) {
  12621. error = Error::Unknown;
  12622. output_error_log(error, &req);
  12623. }
  12624. }
  12625. return ret;
  12626. }
  12627. inline Result ClientImpl::send(const Request &req) {
  12628. auto req2 = req;
  12629. return send_(std::move(req2));
  12630. }
  12631. inline Result ClientImpl::send_(Request &&req) {
  12632. auto res = detail::make_unique<Response>();
  12633. auto error = Error::Success;
  12634. auto ret = send(req, *res, error);
  12635. #ifdef CPPHTTPLIB_SSL_ENABLED
  12636. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12637. last_ssl_error_, last_backend_error_};
  12638. #else
  12639. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12640. #endif
  12641. }
  12642. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12643. const std::string &ct) {
  12644. (void)for_stream;
  12645. // Default headers are meant for the origin and may carry its credentials, so
  12646. // keep them off the CONNECT request the proxy reads.
  12647. if (r.method != "CONNECT") {
  12648. for (const auto &header : default_headers_) {
  12649. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12650. }
  12651. }
  12652. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12653. // prepend it rather than appending it after the caller's own fields.
  12654. if (!r.has_header("Host")) {
  12655. r.headers.emplace_front(
  12656. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12657. address_family_));
  12658. }
  12659. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12660. if (!r.content_receiver) {
  12661. if (!r.has_header("Accept-Encoding")) {
  12662. std::string accept_encoding;
  12663. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12664. accept_encoding = "br";
  12665. #endif
  12666. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12667. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12668. accept_encoding += "gzip, deflate";
  12669. #endif
  12670. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12671. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12672. accept_encoding += "zstd";
  12673. #endif
  12674. r.set_header("Accept-Encoding", accept_encoding);
  12675. }
  12676. detail::add_default_user_agent_header(r);
  12677. }
  12678. if (!r.body.empty()) {
  12679. if (!ct.empty() && !r.has_header("Content-Type")) {
  12680. r.headers.emplace("Content-Type", ct);
  12681. }
  12682. if (!r.has_header("Content-Length")) {
  12683. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12684. }
  12685. }
  12686. }
  12687. inline ClientImpl::StreamHandle
  12688. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12689. const Params &params, const Headers &headers,
  12690. const std::string &body,
  12691. const std::string &content_type) {
  12692. StreamHandle handle;
  12693. handle.response = detail::make_unique<Response>();
  12694. handle.error = Error::Success;
  12695. // Encode the target exactly like the buffered send path does, so that the
  12696. // same `path` produces the same request line through either API.
  12697. auto raw_query_path =
  12698. params.empty() ? path : append_query_params(path, params);
  12699. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12700. handle.connection_ = detail::make_unique<ClientConnection>();
  12701. {
  12702. std::lock_guard<std::mutex> guard(socket_mutex_);
  12703. auto is_alive = false;
  12704. if (socket_.is_open()) {
  12705. is_alive = detail::is_socket_alive(socket_.sock);
  12706. #ifdef CPPHTTPLIB_SSL_ENABLED
  12707. if (is_alive && is_ssl()) {
  12708. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12709. is_alive = false;
  12710. }
  12711. }
  12712. #endif
  12713. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12714. }
  12715. if (!is_alive) {
  12716. if (!ensure_socket_connection(socket_, handle.error)) {
  12717. handle.response.reset();
  12718. return handle;
  12719. }
  12720. {
  12721. auto success = true;
  12722. auto start_time = std::chrono::steady_clock::now();
  12723. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12724. success, handle.error)) {
  12725. if (!success) { handle.response.reset(); }
  12726. return handle;
  12727. }
  12728. }
  12729. }
  12730. transfer_socket_ownership_to_handle(handle);
  12731. }
  12732. #ifdef CPPHTTPLIB_SSL_ENABLED
  12733. if (is_ssl() && handle.connection_->session) {
  12734. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12735. handle.connection_->sock, handle.connection_->session,
  12736. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12737. write_timeout_usec_);
  12738. } else {
  12739. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12740. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12741. write_timeout_sec_, write_timeout_usec_);
  12742. }
  12743. #else
  12744. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12745. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12746. write_timeout_sec_, write_timeout_usec_);
  12747. #endif
  12748. handle.stream_ = handle.socket_stream_.get();
  12749. Request req;
  12750. req.method = method;
  12751. req.path = query_path;
  12752. req.headers = headers;
  12753. req.body = body;
  12754. prepare_default_headers(req, true, content_type);
  12755. auto &strm = *handle.stream_;
  12756. if (detail::write_request_line(strm, req.method, req.path) < 0) {
  12757. handle.error = Error::Write;
  12758. handle.response.reset();
  12759. return handle;
  12760. }
  12761. if (!detail::check_and_write_headers(strm, req.headers, header_writer_,
  12762. handle.error)) {
  12763. handle.response.reset();
  12764. return handle;
  12765. }
  12766. if (!body.empty()) {
  12767. if (strm.write(body.data(), body.size()) < 0) {
  12768. handle.error = Error::Write;
  12769. handle.response.reset();
  12770. return handle;
  12771. }
  12772. }
  12773. if (!read_response_line(strm, req, *handle.response) ||
  12774. !detail::read_headers(strm, handle.response->headers)) {
  12775. handle.error = Error::Read;
  12776. handle.response.reset();
  12777. return handle;
  12778. }
  12779. handle.body_reader_.stream = handle.stream_;
  12780. handle.body_reader_.payload_max_length = payload_max_length_;
  12781. if (handle.response->has_header("Content-Length")) {
  12782. bool is_invalid = false;
  12783. auto content_length = detail::get_header_value_u64(
  12784. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12785. if (is_invalid) {
  12786. handle.error = Error::Read;
  12787. handle.response.reset();
  12788. return handle;
  12789. }
  12790. handle.body_reader_.has_content_length = true;
  12791. handle.body_reader_.content_length = content_length;
  12792. }
  12793. handle.body_reader_.chunked =
  12794. detail::is_chunked_transfer_encoding(handle.response->headers);
  12795. auto content_encoding = detail::get_combined_header_value(
  12796. handle.response->headers, "Content-Encoding");
  12797. if (!content_encoding.empty()) {
  12798. // Same policy as prepare_content_receiver(): reject a coding we know about
  12799. // but were not built with, pass an unrecognized one through as-is.
  12800. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12801. if (!handle.decompressor_) {
  12802. if (detail::is_known_content_encoding(content_encoding)) {
  12803. handle.error = Error::UnsupportedContentEncoding;
  12804. handle.response.reset();
  12805. return handle;
  12806. }
  12807. } else if (!handle.decompressor_->is_valid()) {
  12808. handle.error = Error::Compression;
  12809. handle.response.reset();
  12810. return handle;
  12811. }
  12812. }
  12813. return handle;
  12814. }
  12815. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  12816. if (!is_valid() || !response) { return -1; }
  12817. if (decompressor_) { return read_with_decompression(buf, len); }
  12818. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  12819. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  12820. trailers_parsed_ = true;
  12821. if (body_reader_.chunked_decoder) {
  12822. if (!body_reader_.chunked_decoder->parse_trailers_into(
  12823. response->trailers, response->headers)) {
  12824. return n;
  12825. }
  12826. } else {
  12827. detail::ChunkedDecoder dec(*stream_);
  12828. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  12829. return n;
  12830. }
  12831. }
  12832. }
  12833. return n;
  12834. }
  12835. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  12836. size_t len) {
  12837. if (decompress_offset_ < decompress_buffer_.size()) {
  12838. auto available = decompress_buffer_.size() - decompress_offset_;
  12839. auto to_copy = (std::min)(len, available);
  12840. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  12841. decompress_offset_ += to_copy;
  12842. decompressed_bytes_read_ += to_copy;
  12843. return static_cast<ssize_t>(to_copy);
  12844. }
  12845. decompress_buffer_.clear();
  12846. decompress_offset_ = 0;
  12847. constexpr size_t kDecompressionBufferSize = 8192;
  12848. char compressed_buf[kDecompressionBufferSize];
  12849. while (true) {
  12850. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  12851. sizeof(compressed_buf));
  12852. if (n <= 0) { return n; }
  12853. bool decompress_ok = decompressor_->decompress(
  12854. compressed_buf, static_cast<size_t>(n),
  12855. [this](const char *data, size_t data_len) {
  12856. decompress_buffer_.append(data, data_len);
  12857. auto limit = body_reader_.payload_max_length;
  12858. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  12859. return false;
  12860. }
  12861. return true;
  12862. });
  12863. if (!decompress_ok) {
  12864. body_reader_.last_error = Error::Read;
  12865. return -1;
  12866. }
  12867. if (!decompress_buffer_.empty()) { break; }
  12868. }
  12869. auto to_copy = (std::min)(len, decompress_buffer_.size());
  12870. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  12871. decompress_offset_ = to_copy;
  12872. decompressed_bytes_read_ += to_copy;
  12873. return static_cast<ssize_t>(to_copy);
  12874. }
  12875. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  12876. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  12877. return;
  12878. }
  12879. trailers_parsed_ = true;
  12880. const auto bufsiz = 128;
  12881. char line_buf[bufsiz];
  12882. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  12883. if (!line_reader.getline()) { return; }
  12884. if (!detail::parse_trailers(line_reader, response->trailers,
  12885. response->headers)) {
  12886. return;
  12887. }
  12888. }
  12889. namespace detail {
  12890. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  12891. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  12892. size_t &out_chunk_offset,
  12893. size_t &out_chunk_total) {
  12894. if (finished) { return 0; }
  12895. if (chunk_remaining == 0) {
  12896. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12897. if (!lr.getline()) { return -1; }
  12898. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  12899. const char *p = lr.ptr();
  12900. int v = 0;
  12901. if (!is_hex(*p, v)) { return -1; }
  12902. size_t chunk_len = 0;
  12903. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  12904. for (; is_hex(*p, v); ++p) {
  12905. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  12906. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  12907. }
  12908. while (is_space_or_tab(*p)) {
  12909. ++p;
  12910. }
  12911. if (*p != '\0' && *p != ';' && *p != '\r' && *p != '\n') { return -1; }
  12912. if (chunk_len == 0) {
  12913. chunk_remaining = 0;
  12914. finished = true;
  12915. out_chunk_offset = 0;
  12916. out_chunk_total = 0;
  12917. return 0;
  12918. }
  12919. chunk_remaining = chunk_len;
  12920. last_chunk_total = chunk_remaining;
  12921. last_chunk_offset = 0;
  12922. }
  12923. auto to_read = (std::min)(chunk_remaining, len);
  12924. auto n = strm.read(buf, to_read);
  12925. if (n <= 0) { return -1; }
  12926. auto offset_before = last_chunk_offset;
  12927. last_chunk_offset += static_cast<size_t>(n);
  12928. chunk_remaining -= static_cast<size_t>(n);
  12929. out_chunk_offset = offset_before;
  12930. out_chunk_total = last_chunk_total;
  12931. if (chunk_remaining == 0) {
  12932. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12933. if (!lr.getline()) { return -1; }
  12934. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  12935. }
  12936. return n;
  12937. }
  12938. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  12939. const Headers &src_headers) {
  12940. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12941. if (!lr.getline()) { return false; }
  12942. return parse_trailers(lr, dest, src_headers);
  12943. }
  12944. } // namespace detail
  12945. inline void
  12946. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  12947. handle.connection_->sock = socket_.sock;
  12948. #ifdef CPPHTTPLIB_SSL_ENABLED
  12949. handle.connection_->session = socket_.ssl;
  12950. socket_.ssl = nullptr;
  12951. #endif
  12952. socket_.sock = INVALID_SOCKET;
  12953. }
  12954. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  12955. Response &res, bool close_connection,
  12956. Error &error) {
  12957. if (req.path.empty()) {
  12958. error = Error::Connection;
  12959. output_error_log(error, &req);
  12960. return false;
  12961. }
  12962. auto req_save = req;
  12963. bool ret;
  12964. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  12965. auto req2 = req;
  12966. req2.path = "http://" +
  12967. detail::make_host_and_port_string(host_, port_, false) +
  12968. req.path;
  12969. ret = process_request(strm, req2, res, close_connection, error);
  12970. req = std::move(req2);
  12971. req.path = req_save.path;
  12972. } else {
  12973. ret = process_request(strm, req, res, close_connection, error);
  12974. }
  12975. if (!ret) { return false; }
  12976. if (detail::has_header_token(res.headers, "Connection", "close") ||
  12977. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  12978. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  12979. // for this to be safe.
  12980. // This is safe to call because handle_request is only called by send_
  12981. // which locks the request mutex during the process. It would be a bug
  12982. // to call it from a different thread since it's a thread-safety issue
  12983. // to do these things to the socket if another thread is using the socket.
  12984. std::lock_guard<std::mutex> guard(socket_mutex_);
  12985. disconnect(/*gracefully=*/true);
  12986. }
  12987. if (300 < res.status && res.status < 400 && follow_location_) {
  12988. req = std::move(req_save);
  12989. ret = redirect(req, res, error);
  12990. }
  12991. #ifdef CPPHTTPLIB_SSL_ENABLED
  12992. if ((res.status == StatusCode::Unauthorized_401 ||
  12993. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  12994. req.authorization_count_ < 5) {
  12995. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  12996. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  12997. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  12998. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  12999. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13000. return ret;
  13001. }
  13002. const auto &username =
  13003. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13004. const auto &password =
  13005. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13006. if (!username.empty() && !password.empty()) {
  13007. std::map<std::string, std::string> auth;
  13008. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13009. Request new_req = req;
  13010. new_req.authorization_count_ += 1;
  13011. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13012. : "Authorization");
  13013. new_req.headers.insert(detail::make_digest_authentication_header(
  13014. req, auth, new_req.authorization_count_, detail::random_string(10),
  13015. username, password, is_proxy));
  13016. Response new_res;
  13017. ret = send(new_req, new_res, error);
  13018. if (ret) { res = std::move(new_res); }
  13019. }
  13020. }
  13021. }
  13022. #endif
  13023. return ret;
  13024. }
  13025. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13026. if (req.redirect_count_ == 0) {
  13027. error = Error::ExceedRedirectCount;
  13028. output_error_log(error, &req);
  13029. return false;
  13030. }
  13031. auto location = res.get_header_value("location");
  13032. if (location.empty()) { return false; }
  13033. detail::UrlComponents uc;
  13034. if (!detail::parse_url(location, uc)) { return false; }
  13035. // Only follow http/https redirects
  13036. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13037. return false;
  13038. }
  13039. auto scheme = is_ssl() ? "https" : "http";
  13040. auto next_scheme = std::move(uc.scheme);
  13041. auto next_host = std::move(uc.host);
  13042. auto port_str = std::move(uc.port);
  13043. auto next_path = std::move(uc.path);
  13044. auto next_query = std::move(uc.query);
  13045. auto next_port = port_;
  13046. if (!port_str.empty()) {
  13047. if (!detail::parse_port(port_str, next_port)) { return false; }
  13048. } else if (!next_scheme.empty()) {
  13049. next_port = next_scheme == "https" ? 443 : 80;
  13050. }
  13051. if (next_scheme.empty()) { next_scheme = scheme; }
  13052. if (next_host.empty()) { next_host = host_; }
  13053. if (next_path.empty()) { next_path = "/"; }
  13054. auto path = decode_path_component(next_path) + next_query;
  13055. // Same host redirect - use current client
  13056. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13057. return detail::redirect(*this, req, res, path, location, error);
  13058. }
  13059. // Cross-host/scheme redirect - create new client with robust setup
  13060. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13061. path, location, error);
  13062. }
  13063. // New method for robust redirect client creation
  13064. inline bool ClientImpl::create_redirect_client(
  13065. const std::string &scheme, const std::string &host, int port, Request &req,
  13066. Response &res, const std::string &path, const std::string &location,
  13067. Error &error) {
  13068. // Determine if we need SSL
  13069. auto need_ssl = (scheme == "https");
  13070. // Clean up request headers that are host/client specific
  13071. // Remove headers that should not be carried over to new host
  13072. auto headers_to_remove = std::vector<std::string>{
  13073. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13074. for (const auto &header_name : headers_to_remove) {
  13075. auto it = req.headers.find(header_name);
  13076. while (it != req.headers.end()) {
  13077. it = req.headers.erase(it);
  13078. it = req.headers.find(header_name);
  13079. }
  13080. }
  13081. // Create appropriate client type and handle redirect
  13082. if (need_ssl) {
  13083. #ifdef CPPHTTPLIB_SSL_ENABLED
  13084. // Create SSL client for HTTPS redirect
  13085. SSLClient redirect_client(host, port);
  13086. // Setup basic client configuration first
  13087. setup_redirect_client(redirect_client);
  13088. redirect_client.enable_server_certificate_verification(
  13089. server_certificate_verification_);
  13090. redirect_client.enable_server_hostname_verification(
  13091. server_hostname_verification_);
  13092. redirect_client.system_ca_mode_ = system_ca_mode_;
  13093. // Transfer CA certificate to redirect client
  13094. if (!ca_cert_pem_.empty()) {
  13095. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13096. ca_cert_pem_.size());
  13097. }
  13098. if (!ca_cert_file_path_.empty()) {
  13099. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13100. }
  13101. // Client certificates are set through constructor for SSLClient
  13102. // NOTE: SSLClient constructor already takes client_cert_path and
  13103. // client_key_path so we need to create it properly if client certs are
  13104. // needed
  13105. // Execute the redirect
  13106. return detail::redirect(redirect_client, req, res, path, location, error);
  13107. #else
  13108. // SSL not supported - set appropriate error
  13109. error = Error::SSLConnection;
  13110. output_error_log(error, &req);
  13111. return false;
  13112. #endif
  13113. } else {
  13114. // HTTP redirect
  13115. ClientImpl redirect_client(host, port);
  13116. // Setup client with robust configuration
  13117. setup_redirect_client(redirect_client);
  13118. // Execute the redirect
  13119. return detail::redirect(redirect_client, req, res, path, location, error);
  13120. }
  13121. }
  13122. // New method for robust client setup (based on basic_manual_redirect.cpp
  13123. // logic)
  13124. template <typename ClientType>
  13125. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13126. // Copy basic settings first
  13127. client.set_connection_timeout(connection_timeout_sec_);
  13128. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13129. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13130. client.set_keep_alive(keep_alive_);
  13131. client.set_follow_location(
  13132. true); // Enable redirects to handle multi-step redirects
  13133. client.set_path_encode(path_encode_);
  13134. client.set_compress(compress_);
  13135. client.set_decompress(decompress_);
  13136. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13137. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13138. // 15.4, credentials must not be forwarded when redirecting to a different
  13139. // host. This function is only called for cross-host redirects; same-host
  13140. // redirects are handled directly in ClientImpl::redirect().
  13141. // Copy the proxy configuration unconditionally; the per-target bypass is
  13142. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13143. // still use the proxy.
  13144. client.no_proxy_entries_ = no_proxy_entries_;
  13145. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13146. client.set_proxy(proxy_host_, proxy_port_);
  13147. if (!proxy_basic_auth_username_.empty()) {
  13148. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13149. proxy_basic_auth_password_);
  13150. }
  13151. if (!proxy_bearer_token_auth_token_.empty()) {
  13152. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13153. }
  13154. #ifdef CPPHTTPLIB_SSL_ENABLED
  13155. if (!proxy_digest_auth_username_.empty()) {
  13156. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13157. proxy_digest_auth_password_);
  13158. }
  13159. #endif
  13160. }
  13161. // Copy network and socket settings
  13162. client.set_address_family(address_family_);
  13163. client.set_tcp_nodelay(tcp_nodelay_);
  13164. client.set_ipv6_v6only(ipv6_v6only_);
  13165. if (socket_options_) { client.set_socket_options(socket_options_); }
  13166. if (!interface_.empty()) { client.set_interface(interface_); }
  13167. // Copy logging and headers
  13168. if (logger_) { client.set_logger(logger_); }
  13169. if (error_logger_) { client.set_error_logger(error_logger_); }
  13170. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13171. // Each new client should generate its own headers based on its target host
  13172. }
  13173. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13174. const Request &req,
  13175. Error &error) const {
  13176. auto is_shutting_down = []() { return false; };
  13177. if (req.is_chunked_content_provider_) {
  13178. auto compressor = compress_ ? detail::create_compressor().first
  13179. : std::unique_ptr<detail::compressor>();
  13180. if (!compressor) {
  13181. compressor = detail::make_unique<detail::nocompressor>();
  13182. }
  13183. return detail::write_content_chunked(strm, req.content_provider_,
  13184. is_shutting_down, *compressor, error);
  13185. } else {
  13186. return detail::write_content_with_progress(
  13187. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13188. req.upload_progress, error);
  13189. }
  13190. }
  13191. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13192. bool close_connection, Error &error,
  13193. bool skip_body) {
  13194. // Prepare additional headers
  13195. if (close_connection) {
  13196. if (!req.has_header("Connection")) {
  13197. req.set_header("Connection", "close");
  13198. }
  13199. }
  13200. std::string ct_for_defaults;
  13201. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13202. ct_for_defaults = "text/plain";
  13203. }
  13204. prepare_default_headers(req, false, ct_for_defaults);
  13205. if (req.body.empty()) {
  13206. if (req.content_provider_) {
  13207. if (!req.is_chunked_content_provider_) {
  13208. if (!req.has_header("Content-Length")) {
  13209. auto length = std::to_string(req.content_length_);
  13210. req.set_header("Content-Length", length);
  13211. }
  13212. }
  13213. } else {
  13214. if (req.method == "POST" || req.method == "PUT" ||
  13215. req.method == "PATCH") {
  13216. req.set_header("Content-Length", "0");
  13217. }
  13218. }
  13219. }
  13220. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13221. // it opens is read by the origin. Each credential goes only to its own hop.
  13222. auto is_connect = req.method == "CONNECT";
  13223. if (!is_connect && !req.has_header("Authorization")) {
  13224. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13225. req.headers.insert(make_basic_authentication_header(
  13226. basic_auth_username_, basic_auth_password_, false));
  13227. } else if (!bearer_token_auth_token_.empty()) {
  13228. req.headers.insert(make_bearer_token_authentication_header(
  13229. bearer_token_auth_token_, false));
  13230. }
  13231. }
  13232. // Proxy-Authorization is only sent when the proxy reads this message —
  13233. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13234. // would leak proxy credentials to the destination server.
  13235. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13236. if (!proxy_basic_auth_username_.empty() &&
  13237. !proxy_basic_auth_password_.empty() &&
  13238. !req.has_header("Proxy-Authorization")) {
  13239. req.headers.insert(make_basic_authentication_header(
  13240. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13241. }
  13242. if (!proxy_bearer_token_auth_token_.empty() &&
  13243. !req.has_header("Proxy-Authorization")) {
  13244. req.headers.insert(make_bearer_token_authentication_header(
  13245. proxy_bearer_token_auth_token_, true));
  13246. }
  13247. }
  13248. // Request line and headers
  13249. {
  13250. detail::BufferStream bstrm;
  13251. // Extract the query from req.path. The encoding itself is delegated to
  13252. // `encode_request_target`; the raw query is still needed here to decide
  13253. // between populating `req.params` from it and falling back to building a
  13254. // query out of caller-supplied `req.params`.
  13255. auto query_pos = req.path.find('?');
  13256. auto query_part = query_pos == std::string::npos
  13257. ? std::string()
  13258. : req.path.substr(query_pos + 1);
  13259. auto path_with_query =
  13260. detail::encode_request_target(req.path, path_encode_);
  13261. if (!query_part.empty()) {
  13262. // The query already came in through `req.path`; still populate
  13263. // `req.params` for handlers/users who read them.
  13264. detail::parse_query_text(query_part, req.params);
  13265. } else if (!req.params.empty()) {
  13266. // No query in `req.path`; build one from `req.params` so existing
  13267. // callers that pass `Params` separately continue to work.
  13268. path_with_query = append_query_params(path_with_query, req.params);
  13269. }
  13270. // Write request line and headers
  13271. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13272. // A rejected target (e.g. CR/LF smuggled in via a decoded redirect
  13273. // Location under set_path_encode(false)) must fail the request cleanly
  13274. // instead of emitting a request-line-less, header-injecting request.
  13275. error = Error::Write;
  13276. output_error_log(error, &req);
  13277. return false;
  13278. }
  13279. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13280. error)) {
  13281. output_error_log(error, &req);
  13282. return false;
  13283. }
  13284. // Flush buffer
  13285. auto &data = bstrm.get_buffer();
  13286. if (!detail::write_data(strm, data.data(), data.size())) {
  13287. error = Error::Write;
  13288. output_error_log(error, &req);
  13289. return false;
  13290. }
  13291. }
  13292. // After sending request line and headers, wait briefly for an early server
  13293. // response (e.g. 4xx) and avoid sending a potentially large request body
  13294. // unnecessarily. This workaround is only enabled on Windows because Unix
  13295. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13296. // buffering can accept large writes even when the peer already responded.
  13297. // Check the stream first (which covers SSL via `is_readable()`), then
  13298. // fall back to select on the socket. Only perform the wait for very large
  13299. // request bodies to avoid interfering with normal small requests and
  13300. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13301. // response. Skip this check when using Expect: 100-continue, as the protocol
  13302. // handles early responses properly.
  13303. #if defined(_WIN32)
  13304. if (!skip_body &&
  13305. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13306. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13307. auto start = std::chrono::high_resolution_clock::now();
  13308. for (;;) {
  13309. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13310. // from SSL internals. If the underlying socket is readable, assume an
  13311. // early response may be present.
  13312. auto sock = strm.socket();
  13313. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13314. return false;
  13315. }
  13316. // Fallback to stream-level check for non-socket streams or when the
  13317. // socket isn't reporting readable. Avoid using `is_readable()` for
  13318. // SSL, since `SSL_pending()` may report buffered records that do not
  13319. // indicate a complete application-level response yet.
  13320. if (!is_ssl() && strm.is_readable()) { return false; }
  13321. auto now = std::chrono::high_resolution_clock::now();
  13322. auto elapsed =
  13323. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13324. .count();
  13325. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13326. break;
  13327. }
  13328. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13329. }
  13330. }
  13331. #endif
  13332. // Body
  13333. if (skip_body) { return true; }
  13334. return write_request_body(strm, req, error);
  13335. }
  13336. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13337. Error &error) {
  13338. if (req.body.empty()) {
  13339. return write_content_with_provider(strm, req, error);
  13340. }
  13341. if (req.upload_progress) {
  13342. auto body_size = req.body.size();
  13343. size_t written = 0;
  13344. auto data = req.body.data();
  13345. while (written < body_size) {
  13346. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13347. if (!detail::write_data(strm, data + written, to_write)) {
  13348. error = Error::Write;
  13349. output_error_log(error, &req);
  13350. return false;
  13351. }
  13352. written += to_write;
  13353. if (!req.upload_progress(written, body_size)) {
  13354. error = Error::Canceled;
  13355. output_error_log(error, &req);
  13356. return false;
  13357. }
  13358. }
  13359. } else {
  13360. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13361. error = Error::Write;
  13362. output_error_log(error, &req);
  13363. return false;
  13364. }
  13365. }
  13366. return true;
  13367. }
  13368. inline std::unique_ptr<Response>
  13369. ClientImpl::send_with_content_provider_and_receiver(
  13370. Request &req, const char *body, size_t content_length,
  13371. ContentProvider content_provider,
  13372. ContentProviderWithoutLength content_provider_without_length,
  13373. const std::string &content_type, ContentReceiver content_receiver,
  13374. Error &error) {
  13375. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13376. auto enc = compress_
  13377. ? detail::create_compressor()
  13378. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13379. nullptr, nullptr);
  13380. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13381. if (enc.first && !content_provider_without_length) {
  13382. auto &compressor = enc.first;
  13383. if (content_provider) {
  13384. auto ok = true;
  13385. auto finished = false;
  13386. size_t offset = 0;
  13387. DataSink data_sink;
  13388. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13389. if (ok) {
  13390. auto last = offset + data_len == content_length;
  13391. auto ret = compressor->compress(
  13392. data, data_len, last,
  13393. [&](const char *compressed_data, size_t compressed_data_len) {
  13394. req.body.append(compressed_data, compressed_data_len);
  13395. return true;
  13396. });
  13397. if (ret) {
  13398. offset += data_len;
  13399. } else {
  13400. ok = false;
  13401. }
  13402. }
  13403. return ok;
  13404. };
  13405. // As in detail::write_content_with_progress(): the body is framed by
  13406. // content_length, so a provider that finishes early has truncated it.
  13407. // Stop and report that instead of calling the provider forever.
  13408. data_sink.done = [&]() { finished = true; };
  13409. while (ok && !finished && offset < content_length) {
  13410. if (!content_provider(offset, content_length - offset, data_sink)) {
  13411. error = Error::Canceled;
  13412. output_error_log(error, &req);
  13413. return nullptr;
  13414. }
  13415. }
  13416. // A short body here means either the provider stopped early or the
  13417. // compressor gave up. The branch below reports a failing compressor as
  13418. // Error::Compression, so keep the two distinguishable.
  13419. if (offset < content_length) {
  13420. error = ok ? Error::Write : Error::Compression;
  13421. output_error_log(error, &req);
  13422. return nullptr;
  13423. }
  13424. } else {
  13425. if (!compressor->compress(body, content_length, true,
  13426. [&](const char *data, size_t data_len) {
  13427. req.body.append(data, data_len);
  13428. return true;
  13429. })) {
  13430. error = Error::Compression;
  13431. output_error_log(error, &req);
  13432. return nullptr;
  13433. }
  13434. }
  13435. } else {
  13436. if (content_provider) {
  13437. req.content_length_ = content_length;
  13438. req.content_provider_ = std::move(content_provider);
  13439. req.is_chunked_content_provider_ = false;
  13440. } else if (content_provider_without_length) {
  13441. req.content_length_ = 0;
  13442. req.content_provider_ = detail::ContentProviderAdapter(
  13443. std::move(content_provider_without_length));
  13444. req.is_chunked_content_provider_ = true;
  13445. req.set_header("Transfer-Encoding", "chunked");
  13446. } else {
  13447. req.body.assign(body, content_length);
  13448. }
  13449. }
  13450. if (content_receiver) {
  13451. req.content_receiver =
  13452. [content_receiver](const char *data, size_t data_length,
  13453. size_t /*offset*/, size_t /*total_length*/) {
  13454. return content_receiver(data, data_length);
  13455. };
  13456. }
  13457. auto res = detail::make_unique<Response>();
  13458. return send(req, *res, error) ? std::move(res) : nullptr;
  13459. }
  13460. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13461. const std::string &method, const std::string &path, const Headers &headers,
  13462. const char *body, size_t content_length, ContentProvider content_provider,
  13463. ContentProviderWithoutLength content_provider_without_length,
  13464. const std::string &content_type, ContentReceiver content_receiver,
  13465. UploadProgress progress) {
  13466. Request req;
  13467. req.method = method;
  13468. req.headers = headers;
  13469. req.path = path;
  13470. req.upload_progress = std::move(progress);
  13471. if (max_timeout_msec_ > 0) {
  13472. req.start_time_ = std::chrono::steady_clock::now();
  13473. }
  13474. auto error = Error::Success;
  13475. auto res = send_with_content_provider_and_receiver(
  13476. req, body, content_length, std::move(content_provider),
  13477. std::move(content_provider_without_length), content_type,
  13478. std::move(content_receiver), error);
  13479. #ifdef CPPHTTPLIB_SSL_ENABLED
  13480. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13481. last_backend_error_};
  13482. #else
  13483. return Result{std::move(res), error, std::move(req.headers)};
  13484. #endif
  13485. }
  13486. inline void ClientImpl::output_log(const Request &req,
  13487. const Response &res) const {
  13488. if (logger_) {
  13489. std::lock_guard<std::mutex> guard(logger_mutex_);
  13490. logger_(req, res);
  13491. }
  13492. }
  13493. inline void ClientImpl::output_error_log(const Error &err,
  13494. const Request *req) const {
  13495. if (error_logger_) {
  13496. std::lock_guard<std::mutex> guard(logger_mutex_);
  13497. error_logger_(err, req);
  13498. }
  13499. }
  13500. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13501. Response &res, bool close_connection,
  13502. Error &error) {
  13503. // Auto-add Expect: 100-continue for large bodies
  13504. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13505. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13506. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13507. req.set_header("Expect", "100-continue");
  13508. }
  13509. }
  13510. // Check for Expect: 100-continue
  13511. auto expect_100_continue =
  13512. detail::has_header_token(req.headers, "Expect", "100-continue");
  13513. // Send request (skip body if using Expect: 100-continue)
  13514. auto write_request_success =
  13515. write_request(strm, req, close_connection, error, expect_100_continue);
  13516. #ifdef CPPHTTPLIB_SSL_ENABLED
  13517. if (is_ssl() && !expect_100_continue) {
  13518. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13519. if (!is_proxy_enabled) {
  13520. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13521. error = Error::SSLPeerCouldBeClosed_;
  13522. output_error_log(error, &req);
  13523. return false;
  13524. }
  13525. }
  13526. }
  13527. #endif
  13528. // Handle Expect: 100-continue.
  13529. //
  13530. // Wait for an interim/early response by attempting to read the status line
  13531. // under a short timeout, instead of trusting raw socket readability. Over
  13532. // TLS, post-handshake records (e.g. session tickets) make the socket
  13533. // readable without any HTTP response being available; relying on
  13534. // `select_read` there caused the body to be withheld forever and the
  13535. // request to fail with `Read` (#2458). If no status line arrives within the
  13536. // timeout, send the body anyway (matching curl's behavior).
  13537. auto status_line_read = false;
  13538. if (expect_100_continue && write_request_success) {
  13539. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13540. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13541. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13542. strm.set_read_timeout(sec, usec);
  13543. status_line_read = read_response_line(strm, req, res, false);
  13544. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13545. }
  13546. if (!status_line_read) {
  13547. // No interim response within the timeout: send the body and handle the
  13548. // response as usual.
  13549. if (!write_request_body(strm, req, error)) { return false; }
  13550. expect_100_continue = false; // Switch to normal response handling
  13551. }
  13552. }
  13553. // Receive response and headers
  13554. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13555. if ((!status_line_read &&
  13556. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13557. !detail::read_headers(strm, res.headers)) {
  13558. if (write_request_success) { error = Error::Read; }
  13559. output_error_log(error, &req);
  13560. return false;
  13561. }
  13562. if (!write_request_success) { return false; }
  13563. // Handle Expect: 100-continue response
  13564. if (expect_100_continue) {
  13565. if (res.status == StatusCode::Continue_100) {
  13566. // Server accepted, send the body
  13567. if (!write_request_body(strm, req, error)) { return false; }
  13568. // Read the actual response
  13569. res.headers.clear();
  13570. res.body.clear();
  13571. if (!read_response_line(strm, req, res) ||
  13572. !detail::read_headers(strm, res.headers)) {
  13573. error = Error::Read;
  13574. output_error_log(error, &req);
  13575. return false;
  13576. }
  13577. }
  13578. // If not 100 Continue, server returned an error; proceed with that response
  13579. }
  13580. // Body
  13581. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13582. req.method != "CONNECT") {
  13583. auto redirect = 300 < res.status && res.status < 400 &&
  13584. res.status != StatusCode::NotModified_304 &&
  13585. follow_location_;
  13586. if (req.response_handler && !redirect) {
  13587. if (!req.response_handler(res)) {
  13588. error = Error::Canceled;
  13589. output_error_log(error, &req);
  13590. return false;
  13591. }
  13592. }
  13593. auto out =
  13594. req.content_receiver
  13595. ? static_cast<ContentReceiverWithProgress>(
  13596. [&](const char *buf, size_t n, size_t off, size_t len) {
  13597. if (redirect) { return true; }
  13598. auto ret = req.content_receiver(buf, n, off, len);
  13599. if (!ret) {
  13600. error = Error::Canceled;
  13601. output_error_log(error, &req);
  13602. }
  13603. return ret;
  13604. })
  13605. : static_cast<ContentReceiverWithProgress>(
  13606. [&](const char *buf, size_t n, size_t /*off*/,
  13607. size_t /*len*/) {
  13608. assert(res.body.size() + n <= res.body.max_size());
  13609. if (payload_max_length_ > 0 &&
  13610. (res.body.size() >= payload_max_length_ ||
  13611. n > payload_max_length_ - res.body.size())) {
  13612. return false;
  13613. }
  13614. res.body.append(buf, n);
  13615. return true;
  13616. });
  13617. auto progress = [&](size_t current, size_t total) {
  13618. if (!req.download_progress || redirect) { return true; }
  13619. auto ret = req.download_progress(current, total);
  13620. if (!ret) {
  13621. error = Error::Canceled;
  13622. output_error_log(error, &req);
  13623. }
  13624. return ret;
  13625. };
  13626. if (res.has_header("Content-Length")) {
  13627. if (!req.content_receiver) {
  13628. auto len = res.get_header_value_u64("Content-Length");
  13629. if (len > res.body.max_size()) {
  13630. error = Error::Read;
  13631. output_error_log(error, &req);
  13632. return false;
  13633. }
  13634. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13635. // hostile or malformed server sends an enormous Content-Length.
  13636. // The actual body read below is bounded by payload_max_length_,
  13637. // so reserving more than that is never useful.
  13638. auto reserve_len = static_cast<size_t>(len);
  13639. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13640. reserve_len = payload_max_length_;
  13641. }
  13642. res.body.reserve(reserve_len);
  13643. }
  13644. }
  13645. if (res.status != StatusCode::NotModified_304) {
  13646. auto content_status = 0;
  13647. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13648. ? (std::numeric_limits<size_t>::max)()
  13649. : payload_max_length_;
  13650. if (!detail::read_content(strm, res, max_length, content_status,
  13651. std::move(progress), std::move(out),
  13652. decompress_)) {
  13653. if (error != Error::Canceled) {
  13654. // Tell the caller apart from a plain read failure when the body could
  13655. // not be decoded because of its Content-Encoding.
  13656. switch (content_status) {
  13657. case StatusCode::UnsupportedMediaType_415:
  13658. error = Error::UnsupportedContentEncoding;
  13659. break;
  13660. case StatusCode::InternalServerError_500:
  13661. error = Error::Compression;
  13662. break;
  13663. default: error = Error::Read; break;
  13664. }
  13665. }
  13666. output_error_log(error, &req);
  13667. return false;
  13668. }
  13669. }
  13670. }
  13671. // Log
  13672. output_log(req, res);
  13673. return true;
  13674. }
  13675. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13676. const std::string &boundary, const UploadFormDataItems &items,
  13677. const FormDataProviderItems &provider_items) const {
  13678. size_t cur_item = 0;
  13679. size_t cur_start = 0;
  13680. // cur_item and cur_start are copied to within the std::function and
  13681. // maintain state between successive calls
  13682. return [&, cur_item, cur_start](size_t offset,
  13683. DataSink &sink) mutable -> bool {
  13684. if (!offset && !items.empty()) {
  13685. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13686. return true;
  13687. } else if (cur_item < provider_items.size()) {
  13688. if (!cur_start) {
  13689. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13690. provider_items[cur_item], boundary);
  13691. offset += begin.size();
  13692. cur_start = offset;
  13693. sink.os << begin;
  13694. }
  13695. DataSink cur_sink;
  13696. auto has_data = true;
  13697. cur_sink.write = sink.write;
  13698. // Forward is_writable so a provider item asking whether it may keep
  13699. // going gets the outer sink's answer rather than the default `true`.
  13700. cur_sink.is_writable = sink.is_writable;
  13701. cur_sink.done = [&]() { has_data = false; };
  13702. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13703. return false;
  13704. }
  13705. if (!has_data) {
  13706. sink.os << detail::serialize_multipart_formdata_item_end();
  13707. cur_item++;
  13708. cur_start = 0;
  13709. }
  13710. return true;
  13711. } else {
  13712. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13713. sink.done();
  13714. return true;
  13715. }
  13716. };
  13717. }
  13718. inline bool ClientImpl::process_socket(
  13719. const Socket &socket,
  13720. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13721. std::function<bool(Stream &strm)> callback) {
  13722. return detail::process_client_socket(
  13723. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13724. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13725. }
  13726. inline bool ClientImpl::is_ssl() const { return false; }
  13727. inline Result ClientImpl::Get(const std::string &path,
  13728. DownloadProgress progress) {
  13729. return Get(path, Headers(), std::move(progress));
  13730. }
  13731. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13732. DownloadProgress progress) {
  13733. return Get(path, params, Headers(), std::move(progress));
  13734. }
  13735. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13736. const Headers &headers,
  13737. DownloadProgress progress) {
  13738. if (params.empty()) { return Get(path, headers); }
  13739. std::string path_with_query = append_query_params(path, params);
  13740. return Get(path_with_query, headers, std::move(progress));
  13741. }
  13742. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13743. DownloadProgress progress) {
  13744. Request req;
  13745. req.method = "GET";
  13746. req.path = path;
  13747. req.headers = headers;
  13748. req.download_progress = std::move(progress);
  13749. if (max_timeout_msec_ > 0) {
  13750. req.start_time_ = std::chrono::steady_clock::now();
  13751. }
  13752. return send_(std::move(req));
  13753. }
  13754. inline Result ClientImpl::Get(const std::string &path,
  13755. ContentReceiver content_receiver,
  13756. DownloadProgress progress) {
  13757. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13758. std::move(progress));
  13759. }
  13760. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13761. ContentReceiver content_receiver,
  13762. DownloadProgress progress) {
  13763. return Get(path, headers, nullptr, std::move(content_receiver),
  13764. std::move(progress));
  13765. }
  13766. inline Result ClientImpl::Get(const std::string &path,
  13767. ResponseHandler response_handler,
  13768. ContentReceiver content_receiver,
  13769. DownloadProgress progress) {
  13770. return Get(path, Headers(), std::move(response_handler),
  13771. std::move(content_receiver), std::move(progress));
  13772. }
  13773. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13774. ResponseHandler response_handler,
  13775. ContentReceiver content_receiver,
  13776. DownloadProgress progress) {
  13777. Request req;
  13778. req.method = "GET";
  13779. req.path = path;
  13780. req.headers = headers;
  13781. req.response_handler = std::move(response_handler);
  13782. req.content_receiver =
  13783. [content_receiver](const char *data, size_t data_length,
  13784. size_t /*offset*/, size_t /*total_length*/) {
  13785. return content_receiver(data, data_length);
  13786. };
  13787. req.download_progress = std::move(progress);
  13788. if (max_timeout_msec_ > 0) {
  13789. req.start_time_ = std::chrono::steady_clock::now();
  13790. }
  13791. return send_(std::move(req));
  13792. }
  13793. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13794. const Headers &headers,
  13795. ContentReceiver content_receiver,
  13796. DownloadProgress progress) {
  13797. return Get(path, params, headers, nullptr, std::move(content_receiver),
  13798. std::move(progress));
  13799. }
  13800. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13801. const Headers &headers,
  13802. ResponseHandler response_handler,
  13803. ContentReceiver content_receiver,
  13804. DownloadProgress progress) {
  13805. if (params.empty()) {
  13806. return Get(path, headers, std::move(response_handler),
  13807. std::move(content_receiver), std::move(progress));
  13808. }
  13809. std::string path_with_query = append_query_params(path, params);
  13810. return Get(path_with_query, headers, std::move(response_handler),
  13811. std::move(content_receiver), std::move(progress));
  13812. }
  13813. inline Result ClientImpl::Head(const std::string &path) {
  13814. return Head(path, Headers());
  13815. }
  13816. inline Result ClientImpl::Head(const std::string &path,
  13817. const Headers &headers) {
  13818. Request req;
  13819. req.method = "HEAD";
  13820. req.headers = headers;
  13821. req.path = path;
  13822. if (max_timeout_msec_ > 0) {
  13823. req.start_time_ = std::chrono::steady_clock::now();
  13824. }
  13825. return send_(std::move(req));
  13826. }
  13827. inline Result ClientImpl::Post(const std::string &path) {
  13828. return Post(path, std::string(), std::string());
  13829. }
  13830. inline Result ClientImpl::Post(const std::string &path,
  13831. const Headers &headers) {
  13832. return Post(path, headers, nullptr, 0, std::string());
  13833. }
  13834. inline Result ClientImpl::Post(const std::string &path, const char *body,
  13835. size_t content_length,
  13836. const std::string &content_type,
  13837. UploadProgress progress) {
  13838. return Post(path, Headers(), body, content_length, content_type, progress);
  13839. }
  13840. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  13841. const std::string &content_type,
  13842. UploadProgress progress) {
  13843. return Post(path, Headers(), body, content_type, progress);
  13844. }
  13845. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  13846. return Post(path, Headers(), params);
  13847. }
  13848. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13849. ContentProvider content_provider,
  13850. const std::string &content_type,
  13851. UploadProgress progress) {
  13852. return Post(path, Headers(), content_length, std::move(content_provider),
  13853. content_type, progress);
  13854. }
  13855. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13856. ContentProvider content_provider,
  13857. const std::string &content_type,
  13858. ContentReceiver content_receiver,
  13859. UploadProgress progress) {
  13860. return Post(path, Headers(), content_length, std::move(content_provider),
  13861. content_type, std::move(content_receiver), progress);
  13862. }
  13863. inline Result ClientImpl::Post(const std::string &path,
  13864. ContentProviderWithoutLength content_provider,
  13865. const std::string &content_type,
  13866. UploadProgress progress) {
  13867. return Post(path, Headers(), std::move(content_provider), content_type,
  13868. progress);
  13869. }
  13870. inline Result ClientImpl::Post(const std::string &path,
  13871. ContentProviderWithoutLength content_provider,
  13872. const std::string &content_type,
  13873. ContentReceiver content_receiver,
  13874. UploadProgress progress) {
  13875. return Post(path, Headers(), std::move(content_provider), content_type,
  13876. std::move(content_receiver), progress);
  13877. }
  13878. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13879. const Params &params) {
  13880. auto query = detail::params_to_query_str(params);
  13881. return Post(path, headers, query, "application/x-www-form-urlencoded");
  13882. }
  13883. inline Result ClientImpl::Post(const std::string &path,
  13884. const UploadFormDataItems &items,
  13885. UploadProgress progress) {
  13886. return Post(path, Headers(), items, progress);
  13887. }
  13888. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13889. const UploadFormDataItems &items,
  13890. UploadProgress progress) {
  13891. const auto &boundary = detail::make_multipart_data_boundary();
  13892. const auto &content_type =
  13893. detail::serialize_multipart_formdata_get_content_type(boundary);
  13894. auto content_length = detail::get_multipart_content_length(items, boundary);
  13895. return Post(path, headers, content_length,
  13896. detail::make_multipart_content_provider(items, boundary),
  13897. content_type, progress);
  13898. }
  13899. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13900. const UploadFormDataItems &items,
  13901. const std::string &boundary,
  13902. UploadProgress progress) {
  13903. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  13904. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  13905. }
  13906. const auto &content_type =
  13907. detail::serialize_multipart_formdata_get_content_type(boundary);
  13908. auto content_length = detail::get_multipart_content_length(items, boundary);
  13909. return Post(path, headers, content_length,
  13910. detail::make_multipart_content_provider(items, boundary),
  13911. content_type, progress);
  13912. }
  13913. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13914. const char *body, size_t content_length,
  13915. const std::string &content_type,
  13916. UploadProgress progress) {
  13917. return send_with_content_provider_and_receiver(
  13918. "POST", path, headers, body, content_length, nullptr, nullptr,
  13919. content_type, nullptr, progress);
  13920. }
  13921. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13922. const std::string &body,
  13923. const std::string &content_type,
  13924. UploadProgress progress) {
  13925. return send_with_content_provider_and_receiver(
  13926. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  13927. content_type, nullptr, progress);
  13928. }
  13929. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13930. size_t content_length,
  13931. ContentProvider content_provider,
  13932. const std::string &content_type,
  13933. UploadProgress progress) {
  13934. return send_with_content_provider_and_receiver(
  13935. "POST", path, headers, nullptr, content_length,
  13936. std::move(content_provider), nullptr, content_type, nullptr, progress);
  13937. }
  13938. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13939. size_t content_length,
  13940. ContentProvider content_provider,
  13941. const std::string &content_type,
  13942. ContentReceiver content_receiver,
  13943. DownloadProgress progress) {
  13944. return send_with_content_provider_and_receiver(
  13945. "POST", path, headers, nullptr, content_length,
  13946. std::move(content_provider), nullptr, content_type,
  13947. std::move(content_receiver), std::move(progress));
  13948. }
  13949. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13950. ContentProviderWithoutLength content_provider,
  13951. const std::string &content_type,
  13952. UploadProgress progress) {
  13953. return send_with_content_provider_and_receiver(
  13954. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13955. content_type, nullptr, progress);
  13956. }
  13957. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13958. ContentProviderWithoutLength content_provider,
  13959. const std::string &content_type,
  13960. ContentReceiver content_receiver,
  13961. DownloadProgress progress) {
  13962. return send_with_content_provider_and_receiver(
  13963. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13964. content_type, std::move(content_receiver), std::move(progress));
  13965. }
  13966. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13967. const UploadFormDataItems &items,
  13968. const FormDataProviderItems &provider_items,
  13969. UploadProgress progress) {
  13970. const auto &boundary = detail::make_multipart_data_boundary();
  13971. const auto &content_type =
  13972. detail::serialize_multipart_formdata_get_content_type(boundary);
  13973. return send_with_content_provider_and_receiver(
  13974. "POST", path, headers, nullptr, 0, nullptr,
  13975. get_multipart_content_provider(boundary, items, provider_items),
  13976. content_type, nullptr, progress);
  13977. }
  13978. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13979. const std::string &body,
  13980. const std::string &content_type,
  13981. ContentReceiver content_receiver,
  13982. DownloadProgress progress) {
  13983. Request req;
  13984. req.method = "POST";
  13985. req.path = path;
  13986. req.headers = headers;
  13987. req.body = body;
  13988. req.content_receiver =
  13989. [content_receiver](const char *data, size_t data_length,
  13990. size_t /*offset*/, size_t /*total_length*/) {
  13991. return content_receiver(data, data_length);
  13992. };
  13993. req.download_progress = std::move(progress);
  13994. if (max_timeout_msec_ > 0) {
  13995. req.start_time_ = std::chrono::steady_clock::now();
  13996. }
  13997. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13998. return send_(std::move(req));
  13999. }
  14000. inline Result ClientImpl::Put(const std::string &path) {
  14001. return Put(path, std::string(), std::string());
  14002. }
  14003. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14004. return Put(path, headers, nullptr, 0, std::string());
  14005. }
  14006. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14007. size_t content_length,
  14008. const std::string &content_type,
  14009. UploadProgress progress) {
  14010. return Put(path, Headers(), body, content_length, content_type, progress);
  14011. }
  14012. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14013. const std::string &content_type,
  14014. UploadProgress progress) {
  14015. return Put(path, Headers(), body, content_type, progress);
  14016. }
  14017. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14018. return Put(path, Headers(), params);
  14019. }
  14020. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14021. ContentProvider content_provider,
  14022. const std::string &content_type,
  14023. UploadProgress progress) {
  14024. return Put(path, Headers(), content_length, std::move(content_provider),
  14025. content_type, progress);
  14026. }
  14027. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14028. ContentProvider content_provider,
  14029. const std::string &content_type,
  14030. ContentReceiver content_receiver,
  14031. UploadProgress progress) {
  14032. return Put(path, Headers(), content_length, std::move(content_provider),
  14033. content_type, std::move(content_receiver), progress);
  14034. }
  14035. inline Result ClientImpl::Put(const std::string &path,
  14036. ContentProviderWithoutLength content_provider,
  14037. const std::string &content_type,
  14038. UploadProgress progress) {
  14039. return Put(path, Headers(), std::move(content_provider), content_type,
  14040. progress);
  14041. }
  14042. inline Result ClientImpl::Put(const std::string &path,
  14043. ContentProviderWithoutLength content_provider,
  14044. const std::string &content_type,
  14045. ContentReceiver content_receiver,
  14046. UploadProgress progress) {
  14047. return Put(path, Headers(), std::move(content_provider), content_type,
  14048. std::move(content_receiver), progress);
  14049. }
  14050. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14051. const Params &params) {
  14052. auto query = detail::params_to_query_str(params);
  14053. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14054. }
  14055. inline Result ClientImpl::Put(const std::string &path,
  14056. const UploadFormDataItems &items,
  14057. UploadProgress progress) {
  14058. return Put(path, Headers(), items, progress);
  14059. }
  14060. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14061. const UploadFormDataItems &items,
  14062. UploadProgress progress) {
  14063. const auto &boundary = detail::make_multipart_data_boundary();
  14064. const auto &content_type =
  14065. detail::serialize_multipart_formdata_get_content_type(boundary);
  14066. auto content_length = detail::get_multipart_content_length(items, boundary);
  14067. return Put(path, headers, content_length,
  14068. detail::make_multipart_content_provider(items, boundary),
  14069. content_type, progress);
  14070. }
  14071. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14072. const UploadFormDataItems &items,
  14073. const std::string &boundary,
  14074. UploadProgress progress) {
  14075. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14076. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14077. }
  14078. const auto &content_type =
  14079. detail::serialize_multipart_formdata_get_content_type(boundary);
  14080. auto content_length = detail::get_multipart_content_length(items, boundary);
  14081. return Put(path, headers, content_length,
  14082. detail::make_multipart_content_provider(items, boundary),
  14083. content_type, progress);
  14084. }
  14085. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14086. const char *body, size_t content_length,
  14087. const std::string &content_type,
  14088. UploadProgress progress) {
  14089. return send_with_content_provider_and_receiver(
  14090. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14091. content_type, nullptr, progress);
  14092. }
  14093. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14094. const std::string &body,
  14095. const std::string &content_type,
  14096. UploadProgress progress) {
  14097. return send_with_content_provider_and_receiver(
  14098. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14099. content_type, nullptr, progress);
  14100. }
  14101. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14102. size_t content_length,
  14103. ContentProvider content_provider,
  14104. const std::string &content_type,
  14105. UploadProgress progress) {
  14106. return send_with_content_provider_and_receiver(
  14107. "PUT", path, headers, nullptr, content_length,
  14108. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14109. }
  14110. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14111. size_t content_length,
  14112. ContentProvider content_provider,
  14113. const std::string &content_type,
  14114. ContentReceiver content_receiver,
  14115. UploadProgress progress) {
  14116. return send_with_content_provider_and_receiver(
  14117. "PUT", path, headers, nullptr, content_length,
  14118. std::move(content_provider), nullptr, content_type,
  14119. std::move(content_receiver), progress);
  14120. }
  14121. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14122. ContentProviderWithoutLength content_provider,
  14123. const std::string &content_type,
  14124. UploadProgress progress) {
  14125. return send_with_content_provider_and_receiver(
  14126. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14127. content_type, nullptr, progress);
  14128. }
  14129. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14130. ContentProviderWithoutLength content_provider,
  14131. const std::string &content_type,
  14132. ContentReceiver content_receiver,
  14133. UploadProgress progress) {
  14134. return send_with_content_provider_and_receiver(
  14135. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14136. content_type, std::move(content_receiver), progress);
  14137. }
  14138. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14139. const UploadFormDataItems &items,
  14140. const FormDataProviderItems &provider_items,
  14141. UploadProgress progress) {
  14142. const auto &boundary = detail::make_multipart_data_boundary();
  14143. const auto &content_type =
  14144. detail::serialize_multipart_formdata_get_content_type(boundary);
  14145. return send_with_content_provider_and_receiver(
  14146. "PUT", path, headers, nullptr, 0, nullptr,
  14147. get_multipart_content_provider(boundary, items, provider_items),
  14148. content_type, nullptr, progress);
  14149. }
  14150. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14151. const std::string &body,
  14152. const std::string &content_type,
  14153. ContentReceiver content_receiver,
  14154. DownloadProgress progress) {
  14155. Request req;
  14156. req.method = "PUT";
  14157. req.path = path;
  14158. req.headers = headers;
  14159. req.body = body;
  14160. req.content_receiver =
  14161. [content_receiver](const char *data, size_t data_length,
  14162. size_t /*offset*/, size_t /*total_length*/) {
  14163. return content_receiver(data, data_length);
  14164. };
  14165. req.download_progress = std::move(progress);
  14166. if (max_timeout_msec_ > 0) {
  14167. req.start_time_ = std::chrono::steady_clock::now();
  14168. }
  14169. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14170. return send_(std::move(req));
  14171. }
  14172. inline Result ClientImpl::Patch(const std::string &path) {
  14173. return Patch(path, std::string(), std::string());
  14174. }
  14175. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14176. UploadProgress progress) {
  14177. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14178. }
  14179. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14180. size_t content_length,
  14181. const std::string &content_type,
  14182. UploadProgress progress) {
  14183. return Patch(path, Headers(), body, content_length, content_type, progress);
  14184. }
  14185. inline Result ClientImpl::Patch(const std::string &path,
  14186. const std::string &body,
  14187. const std::string &content_type,
  14188. UploadProgress progress) {
  14189. return Patch(path, Headers(), body, content_type, progress);
  14190. }
  14191. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14192. return Patch(path, Headers(), params);
  14193. }
  14194. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14195. ContentProvider content_provider,
  14196. const std::string &content_type,
  14197. UploadProgress progress) {
  14198. return Patch(path, Headers(), content_length, std::move(content_provider),
  14199. content_type, progress);
  14200. }
  14201. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14202. ContentProvider content_provider,
  14203. const std::string &content_type,
  14204. ContentReceiver content_receiver,
  14205. UploadProgress progress) {
  14206. return Patch(path, Headers(), content_length, std::move(content_provider),
  14207. content_type, std::move(content_receiver), progress);
  14208. }
  14209. inline Result ClientImpl::Patch(const std::string &path,
  14210. ContentProviderWithoutLength content_provider,
  14211. const std::string &content_type,
  14212. UploadProgress progress) {
  14213. return Patch(path, Headers(), std::move(content_provider), content_type,
  14214. progress);
  14215. }
  14216. inline Result ClientImpl::Patch(const std::string &path,
  14217. ContentProviderWithoutLength content_provider,
  14218. const std::string &content_type,
  14219. ContentReceiver content_receiver,
  14220. UploadProgress progress) {
  14221. return Patch(path, Headers(), std::move(content_provider), content_type,
  14222. std::move(content_receiver), progress);
  14223. }
  14224. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14225. const Params &params) {
  14226. auto query = detail::params_to_query_str(params);
  14227. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14228. }
  14229. inline Result ClientImpl::Patch(const std::string &path,
  14230. const UploadFormDataItems &items,
  14231. UploadProgress progress) {
  14232. return Patch(path, Headers(), items, progress);
  14233. }
  14234. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14235. const UploadFormDataItems &items,
  14236. UploadProgress progress) {
  14237. const auto &boundary = detail::make_multipart_data_boundary();
  14238. const auto &content_type =
  14239. detail::serialize_multipart_formdata_get_content_type(boundary);
  14240. auto content_length = detail::get_multipart_content_length(items, boundary);
  14241. return Patch(path, headers, content_length,
  14242. detail::make_multipart_content_provider(items, boundary),
  14243. content_type, progress);
  14244. }
  14245. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14246. const UploadFormDataItems &items,
  14247. const std::string &boundary,
  14248. UploadProgress progress) {
  14249. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14250. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14251. }
  14252. const auto &content_type =
  14253. detail::serialize_multipart_formdata_get_content_type(boundary);
  14254. auto content_length = detail::get_multipart_content_length(items, boundary);
  14255. return Patch(path, headers, content_length,
  14256. detail::make_multipart_content_provider(items, boundary),
  14257. content_type, progress);
  14258. }
  14259. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14260. const char *body, size_t content_length,
  14261. const std::string &content_type,
  14262. UploadProgress progress) {
  14263. return send_with_content_provider_and_receiver(
  14264. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14265. content_type, nullptr, progress);
  14266. }
  14267. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14268. const std::string &body,
  14269. const std::string &content_type,
  14270. UploadProgress progress) {
  14271. return send_with_content_provider_and_receiver(
  14272. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14273. content_type, nullptr, progress);
  14274. }
  14275. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14276. size_t content_length,
  14277. ContentProvider content_provider,
  14278. const std::string &content_type,
  14279. UploadProgress progress) {
  14280. return send_with_content_provider_and_receiver(
  14281. "PATCH", path, headers, nullptr, content_length,
  14282. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14283. }
  14284. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14285. size_t content_length,
  14286. ContentProvider content_provider,
  14287. const std::string &content_type,
  14288. ContentReceiver content_receiver,
  14289. UploadProgress progress) {
  14290. return send_with_content_provider_and_receiver(
  14291. "PATCH", path, headers, nullptr, content_length,
  14292. std::move(content_provider), nullptr, content_type,
  14293. std::move(content_receiver), progress);
  14294. }
  14295. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14296. ContentProviderWithoutLength content_provider,
  14297. const std::string &content_type,
  14298. UploadProgress progress) {
  14299. return send_with_content_provider_and_receiver(
  14300. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14301. content_type, nullptr, progress);
  14302. }
  14303. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14304. ContentProviderWithoutLength content_provider,
  14305. const std::string &content_type,
  14306. ContentReceiver content_receiver,
  14307. UploadProgress progress) {
  14308. return send_with_content_provider_and_receiver(
  14309. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14310. content_type, std::move(content_receiver), progress);
  14311. }
  14312. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14313. const UploadFormDataItems &items,
  14314. const FormDataProviderItems &provider_items,
  14315. UploadProgress progress) {
  14316. const auto &boundary = detail::make_multipart_data_boundary();
  14317. const auto &content_type =
  14318. detail::serialize_multipart_formdata_get_content_type(boundary);
  14319. return send_with_content_provider_and_receiver(
  14320. "PATCH", path, headers, nullptr, 0, nullptr,
  14321. get_multipart_content_provider(boundary, items, provider_items),
  14322. content_type, nullptr, progress);
  14323. }
  14324. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14325. const std::string &body,
  14326. const std::string &content_type,
  14327. ContentReceiver content_receiver,
  14328. DownloadProgress progress) {
  14329. Request req;
  14330. req.method = "PATCH";
  14331. req.path = path;
  14332. req.headers = headers;
  14333. req.body = body;
  14334. req.content_receiver =
  14335. [content_receiver](const char *data, size_t data_length,
  14336. size_t /*offset*/, size_t /*total_length*/) {
  14337. return content_receiver(data, data_length);
  14338. };
  14339. req.download_progress = std::move(progress);
  14340. if (max_timeout_msec_ > 0) {
  14341. req.start_time_ = std::chrono::steady_clock::now();
  14342. }
  14343. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14344. return send_(std::move(req));
  14345. }
  14346. inline Result ClientImpl::Delete(const std::string &path,
  14347. DownloadProgress progress) {
  14348. return Delete(path, Headers(), std::string(), std::string(), progress);
  14349. }
  14350. inline Result ClientImpl::Delete(const std::string &path,
  14351. const Headers &headers,
  14352. DownloadProgress progress) {
  14353. return Delete(path, headers, std::string(), std::string(), progress);
  14354. }
  14355. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14356. size_t content_length,
  14357. const std::string &content_type,
  14358. DownloadProgress progress) {
  14359. return Delete(path, Headers(), body, content_length, content_type, progress);
  14360. }
  14361. inline Result ClientImpl::Delete(const std::string &path,
  14362. const std::string &body,
  14363. const std::string &content_type,
  14364. DownloadProgress progress) {
  14365. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14366. progress);
  14367. }
  14368. inline Result ClientImpl::Delete(const std::string &path,
  14369. const Headers &headers,
  14370. const std::string &body,
  14371. const std::string &content_type,
  14372. DownloadProgress progress) {
  14373. return Delete(path, headers, body.data(), body.size(), content_type,
  14374. progress);
  14375. }
  14376. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14377. DownloadProgress progress) {
  14378. return Delete(path, Headers(), params, progress);
  14379. }
  14380. inline Result ClientImpl::Delete(const std::string &path,
  14381. const Headers &headers, const Params &params,
  14382. DownloadProgress progress) {
  14383. auto query = detail::params_to_query_str(params);
  14384. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14385. progress);
  14386. }
  14387. inline Result ClientImpl::Delete(const std::string &path,
  14388. const Headers &headers, const char *body,
  14389. size_t content_length,
  14390. const std::string &content_type,
  14391. DownloadProgress progress) {
  14392. Request req;
  14393. req.method = "DELETE";
  14394. req.headers = headers;
  14395. req.path = path;
  14396. req.download_progress = std::move(progress);
  14397. if (max_timeout_msec_ > 0) {
  14398. req.start_time_ = std::chrono::steady_clock::now();
  14399. }
  14400. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14401. req.body.assign(body, content_length);
  14402. return send_(std::move(req));
  14403. }
  14404. inline Result ClientImpl::Options(const std::string &path) {
  14405. return Options(path, Headers());
  14406. }
  14407. inline Result ClientImpl::Options(const std::string &path,
  14408. const Headers &headers) {
  14409. Request req;
  14410. req.method = "OPTIONS";
  14411. req.headers = headers;
  14412. req.path = path;
  14413. if (max_timeout_msec_ > 0) {
  14414. req.start_time_ = std::chrono::steady_clock::now();
  14415. }
  14416. return send_(std::move(req));
  14417. }
  14418. inline void ClientImpl::stop() {
  14419. std::lock_guard<std::mutex> guard(socket_mutex_);
  14420. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14421. // do is to shutdown_socket, so that threads using this socket suddenly
  14422. // discover they can't read/write any more and error out. Everything else
  14423. // (closing the socket, shutting ssl down) is unsafe because these actions
  14424. // are not thread-safe.
  14425. if (socket_requests_in_flight_ > 0) {
  14426. shutdown_socket(socket_);
  14427. // Aside from that, we set a flag for the socket to be closed when we're
  14428. // done.
  14429. socket_should_be_closed_when_request_is_done_ = true;
  14430. return;
  14431. }
  14432. disconnect(/*gracefully=*/true);
  14433. }
  14434. inline std::string ClientImpl::host() const { return host_; }
  14435. inline int ClientImpl::port() const { return port_; }
  14436. inline size_t ClientImpl::is_socket_open() const {
  14437. std::lock_guard<std::mutex> guard(socket_mutex_);
  14438. return socket_.is_open();
  14439. }
  14440. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14441. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14442. connection_timeout_sec_ = sec;
  14443. connection_timeout_usec_ = usec;
  14444. }
  14445. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14446. read_timeout_sec_ = sec;
  14447. read_timeout_usec_ = usec;
  14448. }
  14449. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14450. write_timeout_sec_ = sec;
  14451. write_timeout_usec_ = usec;
  14452. }
  14453. inline void ClientImpl::set_max_timeout(time_t msec) {
  14454. max_timeout_msec_ = msec;
  14455. }
  14456. inline void ClientImpl::set_basic_auth(const std::string &username,
  14457. const std::string &password) {
  14458. basic_auth_username_ = username;
  14459. basic_auth_password_ = password;
  14460. }
  14461. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14462. bearer_token_auth_token_ = token;
  14463. }
  14464. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14465. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14466. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14467. inline void
  14468. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14469. addr_map_ = std::move(addr_map);
  14470. }
  14471. inline void ClientImpl::set_default_headers(Headers headers) {
  14472. default_headers_ = std::move(headers);
  14473. }
  14474. inline void ClientImpl::set_header_writer(
  14475. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14476. header_writer_ = writer;
  14477. }
  14478. inline void ClientImpl::set_address_family(int family) {
  14479. address_family_ = family;
  14480. }
  14481. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14482. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14483. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14484. socket_options_ = std::move(socket_options);
  14485. }
  14486. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14487. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14488. inline void ClientImpl::set_payload_max_length(size_t length) {
  14489. payload_max_length_ = length;
  14490. has_payload_max_length_ = true;
  14491. }
  14492. inline void ClientImpl::set_interface(const std::string &intf) {
  14493. interface_ = intf;
  14494. }
  14495. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14496. proxy_host_ = host;
  14497. proxy_port_ = port;
  14498. std::lock_guard<std::mutex> guard(socket_mutex_);
  14499. disconnect(/*gracefully=*/true);
  14500. }
  14501. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14502. const std::string &password) {
  14503. proxy_basic_auth_username_ = username;
  14504. proxy_basic_auth_password_ = password;
  14505. }
  14506. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14507. proxy_bearer_token_auth_token_ = token;
  14508. }
  14509. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14510. std::vector<detail::NoProxyEntry> parsed;
  14511. parsed.reserve(patterns.size());
  14512. for (const auto &p : patterns) {
  14513. auto trimmed = detail::trim_copy(p);
  14514. if (trimmed.empty()) { continue; }
  14515. detail::NoProxyEntry entry;
  14516. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14517. parsed.push_back(std::move(entry));
  14518. }
  14519. }
  14520. no_proxy_entries_ = std::move(parsed);
  14521. std::lock_guard<std::mutex> guard(socket_mutex_);
  14522. disconnect(/*gracefully=*/true);
  14523. }
  14524. #ifdef CPPHTTPLIB_SSL_ENABLED
  14525. inline void ClientImpl::set_digest_auth(const std::string &username,
  14526. const std::string &password) {
  14527. digest_auth_username_ = username;
  14528. digest_auth_password_ = password;
  14529. }
  14530. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14531. const std::string &ca_cert_dir_path) {
  14532. ca_cert_file_path_ = ca_cert_file_path;
  14533. ca_cert_dir_path_ = ca_cert_dir_path;
  14534. }
  14535. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14536. const std::string &password) {
  14537. proxy_digest_auth_username_ = username;
  14538. proxy_digest_auth_password_ = password;
  14539. }
  14540. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14541. server_certificate_verification_ = enabled;
  14542. }
  14543. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14544. server_hostname_verification_ = enabled;
  14545. }
  14546. inline void ClientImpl::enable_system_ca(bool enabled) {
  14547. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14548. }
  14549. #endif
  14550. inline void ClientImpl::set_logger(Logger logger) {
  14551. logger_ = std::move(logger);
  14552. }
  14553. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14554. error_logger_ = std::move(error_logger);
  14555. }
  14556. /*
  14557. * SSL/TLS Common Implementation
  14558. */
  14559. inline ClientConnection::~ClientConnection() {
  14560. #ifdef CPPHTTPLIB_SSL_ENABLED
  14561. if (session) {
  14562. tls::shutdown(session, true);
  14563. tls::free_session(session);
  14564. session = nullptr;
  14565. }
  14566. #endif
  14567. if (sock != INVALID_SOCKET) {
  14568. detail::close_socket(sock);
  14569. sock = INVALID_SOCKET;
  14570. }
  14571. }
  14572. // Universal client implementation
  14573. inline Client::Client(const std::string &scheme_host_port)
  14574. : Client(scheme_host_port, std::string(), std::string()) {}
  14575. inline Client::Client(const std::string &scheme_host_port,
  14576. const std::string &client_cert_path,
  14577. const std::string &client_key_path) {
  14578. detail::UrlComponents uc;
  14579. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14580. auto &scheme = uc.scheme;
  14581. #ifdef CPPHTTPLIB_SSL_ENABLED
  14582. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14583. #else
  14584. if (!scheme.empty() && scheme != "http") {
  14585. #endif
  14586. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14587. std::string msg = "'" + scheme + "' scheme is not supported.";
  14588. throw std::invalid_argument(msg);
  14589. #endif
  14590. return;
  14591. }
  14592. auto is_ssl = scheme == "https";
  14593. auto host = std::move(uc.host);
  14594. auto port = is_ssl ? 443 : 80;
  14595. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14596. if (is_ssl) {
  14597. #ifdef CPPHTTPLIB_SSL_ENABLED
  14598. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14599. client_key_path);
  14600. is_ssl_ = is_ssl;
  14601. #endif
  14602. } else {
  14603. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14604. client_key_path);
  14605. }
  14606. } else {
  14607. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14608. // if port param below changes.
  14609. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14610. client_cert_path, client_key_path);
  14611. }
  14612. }
  14613. inline Client::Client(const std::string &host, int port)
  14614. : Client(host, port, std::string(), std::string()) {}
  14615. inline Client::Client(const std::string &host, int port,
  14616. const std::string &client_cert_path,
  14617. const std::string &client_key_path)
  14618. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14619. client_key_path)) {}
  14620. inline Client::~Client() = default;
  14621. inline bool Client::is_valid() const {
  14622. return cli_ != nullptr && cli_->is_valid();
  14623. }
  14624. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14625. return cli_->Get(path, std::move(progress));
  14626. }
  14627. inline Result Client::Get(const std::string &path, const Headers &headers,
  14628. DownloadProgress progress) {
  14629. return cli_->Get(path, headers, std::move(progress));
  14630. }
  14631. inline Result Client::Get(const std::string &path,
  14632. ContentReceiver content_receiver,
  14633. DownloadProgress progress) {
  14634. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14635. }
  14636. inline Result Client::Get(const std::string &path, const Headers &headers,
  14637. ContentReceiver content_receiver,
  14638. DownloadProgress progress) {
  14639. return cli_->Get(path, headers, std::move(content_receiver),
  14640. std::move(progress));
  14641. }
  14642. inline Result Client::Get(const std::string &path,
  14643. ResponseHandler response_handler,
  14644. ContentReceiver content_receiver,
  14645. DownloadProgress progress) {
  14646. return cli_->Get(path, std::move(response_handler),
  14647. std::move(content_receiver), std::move(progress));
  14648. }
  14649. inline Result Client::Get(const std::string &path, const Headers &headers,
  14650. ResponseHandler response_handler,
  14651. ContentReceiver content_receiver,
  14652. DownloadProgress progress) {
  14653. return cli_->Get(path, headers, std::move(response_handler),
  14654. std::move(content_receiver), std::move(progress));
  14655. }
  14656. inline Result Client::Get(const std::string &path, const Params &params,
  14657. DownloadProgress progress) {
  14658. return cli_->Get(path, params, std::move(progress));
  14659. }
  14660. inline Result Client::Get(const std::string &path, const Params &params,
  14661. const Headers &headers, DownloadProgress progress) {
  14662. return cli_->Get(path, params, headers, std::move(progress));
  14663. }
  14664. inline Result Client::Get(const std::string &path, const Params &params,
  14665. const Headers &headers,
  14666. ContentReceiver content_receiver,
  14667. DownloadProgress progress) {
  14668. return cli_->Get(path, params, headers, std::move(content_receiver),
  14669. std::move(progress));
  14670. }
  14671. inline Result Client::Get(const std::string &path, const Params &params,
  14672. const Headers &headers,
  14673. ResponseHandler response_handler,
  14674. ContentReceiver content_receiver,
  14675. DownloadProgress progress) {
  14676. return cli_->Get(path, params, headers, std::move(response_handler),
  14677. std::move(content_receiver), std::move(progress));
  14678. }
  14679. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14680. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14681. return cli_->Head(path, headers);
  14682. }
  14683. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14684. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14685. return cli_->Post(path, headers);
  14686. }
  14687. inline Result Client::Post(const std::string &path, const char *body,
  14688. size_t content_length,
  14689. const std::string &content_type,
  14690. UploadProgress progress) {
  14691. return cli_->Post(path, body, content_length, content_type, progress);
  14692. }
  14693. inline Result Client::Post(const std::string &path, const Headers &headers,
  14694. const char *body, size_t content_length,
  14695. const std::string &content_type,
  14696. UploadProgress progress) {
  14697. return cli_->Post(path, headers, body, content_length, content_type,
  14698. progress);
  14699. }
  14700. inline Result Client::Post(const std::string &path, const std::string &body,
  14701. const std::string &content_type,
  14702. UploadProgress progress) {
  14703. return cli_->Post(path, body, content_type, progress);
  14704. }
  14705. inline Result Client::Post(const std::string &path, const Headers &headers,
  14706. const std::string &body,
  14707. const std::string &content_type,
  14708. UploadProgress progress) {
  14709. return cli_->Post(path, headers, body, content_type, progress);
  14710. }
  14711. inline Result Client::Post(const std::string &path, size_t content_length,
  14712. ContentProvider content_provider,
  14713. const std::string &content_type,
  14714. UploadProgress progress) {
  14715. return cli_->Post(path, content_length, std::move(content_provider),
  14716. content_type, progress);
  14717. }
  14718. inline Result Client::Post(const std::string &path, size_t content_length,
  14719. ContentProvider content_provider,
  14720. const std::string &content_type,
  14721. ContentReceiver content_receiver,
  14722. UploadProgress progress) {
  14723. return cli_->Post(path, content_length, std::move(content_provider),
  14724. content_type, std::move(content_receiver), progress);
  14725. }
  14726. inline Result Client::Post(const std::string &path,
  14727. ContentProviderWithoutLength content_provider,
  14728. const std::string &content_type,
  14729. UploadProgress progress) {
  14730. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14731. }
  14732. inline Result Client::Post(const std::string &path,
  14733. ContentProviderWithoutLength content_provider,
  14734. const std::string &content_type,
  14735. ContentReceiver content_receiver,
  14736. UploadProgress progress) {
  14737. return cli_->Post(path, std::move(content_provider), content_type,
  14738. std::move(content_receiver), progress);
  14739. }
  14740. inline Result Client::Post(const std::string &path, const Headers &headers,
  14741. size_t content_length,
  14742. ContentProvider content_provider,
  14743. const std::string &content_type,
  14744. UploadProgress progress) {
  14745. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14746. content_type, progress);
  14747. }
  14748. inline Result Client::Post(const std::string &path, const Headers &headers,
  14749. size_t content_length,
  14750. ContentProvider content_provider,
  14751. const std::string &content_type,
  14752. ContentReceiver content_receiver,
  14753. DownloadProgress progress) {
  14754. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14755. content_type, std::move(content_receiver), progress);
  14756. }
  14757. inline Result Client::Post(const std::string &path, const Headers &headers,
  14758. ContentProviderWithoutLength content_provider,
  14759. const std::string &content_type,
  14760. UploadProgress progress) {
  14761. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14762. progress);
  14763. }
  14764. inline Result Client::Post(const std::string &path, const Headers &headers,
  14765. ContentProviderWithoutLength content_provider,
  14766. const std::string &content_type,
  14767. ContentReceiver content_receiver,
  14768. DownloadProgress progress) {
  14769. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14770. std::move(content_receiver), progress);
  14771. }
  14772. inline Result Client::Post(const std::string &path, const Params &params) {
  14773. return cli_->Post(path, params);
  14774. }
  14775. inline Result Client::Post(const std::string &path, const Headers &headers,
  14776. const Params &params) {
  14777. return cli_->Post(path, headers, params);
  14778. }
  14779. inline Result Client::Post(const std::string &path,
  14780. const UploadFormDataItems &items,
  14781. UploadProgress progress) {
  14782. return cli_->Post(path, items, progress);
  14783. }
  14784. inline Result Client::Post(const std::string &path, const Headers &headers,
  14785. const UploadFormDataItems &items,
  14786. UploadProgress progress) {
  14787. return cli_->Post(path, headers, items, progress);
  14788. }
  14789. inline Result Client::Post(const std::string &path, const Headers &headers,
  14790. const UploadFormDataItems &items,
  14791. const std::string &boundary,
  14792. UploadProgress progress) {
  14793. return cli_->Post(path, headers, items, boundary, progress);
  14794. }
  14795. inline Result Client::Post(const std::string &path, const Headers &headers,
  14796. const UploadFormDataItems &items,
  14797. const FormDataProviderItems &provider_items,
  14798. UploadProgress progress) {
  14799. return cli_->Post(path, headers, items, provider_items, progress);
  14800. }
  14801. inline Result Client::Post(const std::string &path, const Headers &headers,
  14802. const std::string &body,
  14803. const std::string &content_type,
  14804. ContentReceiver content_receiver,
  14805. DownloadProgress progress) {
  14806. return cli_->Post(path, headers, body, content_type,
  14807. std::move(content_receiver), progress);
  14808. }
  14809. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  14810. inline Result Client::Put(const std::string &path, const Headers &headers) {
  14811. return cli_->Put(path, headers);
  14812. }
  14813. inline Result Client::Put(const std::string &path, const char *body,
  14814. size_t content_length,
  14815. const std::string &content_type,
  14816. UploadProgress progress) {
  14817. return cli_->Put(path, body, content_length, content_type, progress);
  14818. }
  14819. inline Result Client::Put(const std::string &path, const Headers &headers,
  14820. const char *body, size_t content_length,
  14821. const std::string &content_type,
  14822. UploadProgress progress) {
  14823. return cli_->Put(path, headers, body, content_length, content_type, progress);
  14824. }
  14825. inline Result Client::Put(const std::string &path, const std::string &body,
  14826. const std::string &content_type,
  14827. UploadProgress progress) {
  14828. return cli_->Put(path, body, content_type, progress);
  14829. }
  14830. inline Result Client::Put(const std::string &path, const Headers &headers,
  14831. const std::string &body,
  14832. const std::string &content_type,
  14833. UploadProgress progress) {
  14834. return cli_->Put(path, headers, body, content_type, progress);
  14835. }
  14836. inline Result Client::Put(const std::string &path, size_t content_length,
  14837. ContentProvider content_provider,
  14838. const std::string &content_type,
  14839. UploadProgress progress) {
  14840. return cli_->Put(path, content_length, std::move(content_provider),
  14841. content_type, progress);
  14842. }
  14843. inline Result Client::Put(const std::string &path, size_t content_length,
  14844. ContentProvider content_provider,
  14845. const std::string &content_type,
  14846. ContentReceiver content_receiver,
  14847. UploadProgress progress) {
  14848. return cli_->Put(path, content_length, std::move(content_provider),
  14849. content_type, std::move(content_receiver), progress);
  14850. }
  14851. inline Result Client::Put(const std::string &path,
  14852. ContentProviderWithoutLength content_provider,
  14853. const std::string &content_type,
  14854. UploadProgress progress) {
  14855. return cli_->Put(path, std::move(content_provider), content_type, progress);
  14856. }
  14857. inline Result Client::Put(const std::string &path,
  14858. ContentProviderWithoutLength content_provider,
  14859. const std::string &content_type,
  14860. ContentReceiver content_receiver,
  14861. UploadProgress progress) {
  14862. return cli_->Put(path, std::move(content_provider), content_type,
  14863. std::move(content_receiver), progress);
  14864. }
  14865. inline Result Client::Put(const std::string &path, const Headers &headers,
  14866. size_t content_length,
  14867. ContentProvider content_provider,
  14868. const std::string &content_type,
  14869. UploadProgress progress) {
  14870. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14871. content_type, progress);
  14872. }
  14873. inline Result Client::Put(const std::string &path, const Headers &headers,
  14874. size_t content_length,
  14875. ContentProvider content_provider,
  14876. const std::string &content_type,
  14877. ContentReceiver content_receiver,
  14878. UploadProgress progress) {
  14879. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14880. content_type, std::move(content_receiver), progress);
  14881. }
  14882. inline Result Client::Put(const std::string &path, const Headers &headers,
  14883. ContentProviderWithoutLength content_provider,
  14884. const std::string &content_type,
  14885. UploadProgress progress) {
  14886. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14887. progress);
  14888. }
  14889. inline Result Client::Put(const std::string &path, const Headers &headers,
  14890. ContentProviderWithoutLength content_provider,
  14891. const std::string &content_type,
  14892. ContentReceiver content_receiver,
  14893. UploadProgress progress) {
  14894. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14895. std::move(content_receiver), progress);
  14896. }
  14897. inline Result Client::Put(const std::string &path, const Params &params) {
  14898. return cli_->Put(path, params);
  14899. }
  14900. inline Result Client::Put(const std::string &path, const Headers &headers,
  14901. const Params &params) {
  14902. return cli_->Put(path, headers, params);
  14903. }
  14904. inline Result Client::Put(const std::string &path,
  14905. const UploadFormDataItems &items,
  14906. UploadProgress progress) {
  14907. return cli_->Put(path, items, progress);
  14908. }
  14909. inline Result Client::Put(const std::string &path, const Headers &headers,
  14910. const UploadFormDataItems &items,
  14911. UploadProgress progress) {
  14912. return cli_->Put(path, headers, items, progress);
  14913. }
  14914. inline Result Client::Put(const std::string &path, const Headers &headers,
  14915. const UploadFormDataItems &items,
  14916. const std::string &boundary,
  14917. UploadProgress progress) {
  14918. return cli_->Put(path, headers, items, boundary, progress);
  14919. }
  14920. inline Result Client::Put(const std::string &path, const Headers &headers,
  14921. const UploadFormDataItems &items,
  14922. const FormDataProviderItems &provider_items,
  14923. UploadProgress progress) {
  14924. return cli_->Put(path, headers, items, provider_items, progress);
  14925. }
  14926. inline Result Client::Put(const std::string &path, const Headers &headers,
  14927. const std::string &body,
  14928. const std::string &content_type,
  14929. ContentReceiver content_receiver,
  14930. DownloadProgress progress) {
  14931. return cli_->Put(path, headers, body, content_type, content_receiver,
  14932. progress);
  14933. }
  14934. inline Result Client::Patch(const std::string &path) {
  14935. return cli_->Patch(path);
  14936. }
  14937. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  14938. return cli_->Patch(path, headers);
  14939. }
  14940. inline Result Client::Patch(const std::string &path, const char *body,
  14941. size_t content_length,
  14942. const std::string &content_type,
  14943. UploadProgress progress) {
  14944. return cli_->Patch(path, body, content_length, content_type, progress);
  14945. }
  14946. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14947. const char *body, size_t content_length,
  14948. const std::string &content_type,
  14949. UploadProgress progress) {
  14950. return cli_->Patch(path, headers, body, content_length, content_type,
  14951. progress);
  14952. }
  14953. inline Result Client::Patch(const std::string &path, const std::string &body,
  14954. const std::string &content_type,
  14955. UploadProgress progress) {
  14956. return cli_->Patch(path, body, content_type, progress);
  14957. }
  14958. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14959. const std::string &body,
  14960. const std::string &content_type,
  14961. UploadProgress progress) {
  14962. return cli_->Patch(path, headers, body, content_type, progress);
  14963. }
  14964. inline Result Client::Patch(const std::string &path, size_t content_length,
  14965. ContentProvider content_provider,
  14966. const std::string &content_type,
  14967. UploadProgress progress) {
  14968. return cli_->Patch(path, content_length, std::move(content_provider),
  14969. content_type, progress);
  14970. }
  14971. inline Result Client::Patch(const std::string &path, size_t content_length,
  14972. ContentProvider content_provider,
  14973. const std::string &content_type,
  14974. ContentReceiver content_receiver,
  14975. UploadProgress progress) {
  14976. return cli_->Patch(path, content_length, std::move(content_provider),
  14977. content_type, std::move(content_receiver), progress);
  14978. }
  14979. inline Result Client::Patch(const std::string &path,
  14980. ContentProviderWithoutLength content_provider,
  14981. const std::string &content_type,
  14982. UploadProgress progress) {
  14983. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  14984. }
  14985. inline Result Client::Patch(const std::string &path,
  14986. ContentProviderWithoutLength content_provider,
  14987. const std::string &content_type,
  14988. ContentReceiver content_receiver,
  14989. UploadProgress progress) {
  14990. return cli_->Patch(path, std::move(content_provider), content_type,
  14991. std::move(content_receiver), progress);
  14992. }
  14993. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14994. size_t content_length,
  14995. ContentProvider content_provider,
  14996. const std::string &content_type,
  14997. UploadProgress progress) {
  14998. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  14999. content_type, progress);
  15000. }
  15001. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15002. size_t content_length,
  15003. ContentProvider content_provider,
  15004. const std::string &content_type,
  15005. ContentReceiver content_receiver,
  15006. UploadProgress progress) {
  15007. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15008. content_type, std::move(content_receiver), progress);
  15009. }
  15010. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15011. ContentProviderWithoutLength content_provider,
  15012. const std::string &content_type,
  15013. UploadProgress progress) {
  15014. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15015. progress);
  15016. }
  15017. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15018. ContentProviderWithoutLength content_provider,
  15019. const std::string &content_type,
  15020. ContentReceiver content_receiver,
  15021. UploadProgress progress) {
  15022. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15023. std::move(content_receiver), progress);
  15024. }
  15025. inline Result Client::Patch(const std::string &path, const Params &params) {
  15026. return cli_->Patch(path, params);
  15027. }
  15028. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15029. const Params &params) {
  15030. return cli_->Patch(path, headers, params);
  15031. }
  15032. inline Result Client::Patch(const std::string &path,
  15033. const UploadFormDataItems &items,
  15034. UploadProgress progress) {
  15035. return cli_->Patch(path, items, progress);
  15036. }
  15037. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15038. const UploadFormDataItems &items,
  15039. UploadProgress progress) {
  15040. return cli_->Patch(path, headers, items, progress);
  15041. }
  15042. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15043. const UploadFormDataItems &items,
  15044. const std::string &boundary,
  15045. UploadProgress progress) {
  15046. return cli_->Patch(path, headers, items, boundary, progress);
  15047. }
  15048. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15049. const UploadFormDataItems &items,
  15050. const FormDataProviderItems &provider_items,
  15051. UploadProgress progress) {
  15052. return cli_->Patch(path, headers, items, provider_items, progress);
  15053. }
  15054. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15055. const std::string &body,
  15056. const std::string &content_type,
  15057. ContentReceiver content_receiver,
  15058. DownloadProgress progress) {
  15059. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15060. progress);
  15061. }
  15062. inline Result Client::Delete(const std::string &path,
  15063. DownloadProgress progress) {
  15064. return cli_->Delete(path, progress);
  15065. }
  15066. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15067. DownloadProgress progress) {
  15068. return cli_->Delete(path, headers, progress);
  15069. }
  15070. inline Result Client::Delete(const std::string &path, const char *body,
  15071. size_t content_length,
  15072. const std::string &content_type,
  15073. DownloadProgress progress) {
  15074. return cli_->Delete(path, body, content_length, content_type, progress);
  15075. }
  15076. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15077. const char *body, size_t content_length,
  15078. const std::string &content_type,
  15079. DownloadProgress progress) {
  15080. return cli_->Delete(path, headers, body, content_length, content_type,
  15081. progress);
  15082. }
  15083. inline Result Client::Delete(const std::string &path, const std::string &body,
  15084. const std::string &content_type,
  15085. DownloadProgress progress) {
  15086. return cli_->Delete(path, body, content_type, progress);
  15087. }
  15088. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15089. const std::string &body,
  15090. const std::string &content_type,
  15091. DownloadProgress progress) {
  15092. return cli_->Delete(path, headers, body, content_type, progress);
  15093. }
  15094. inline Result Client::Delete(const std::string &path, const Params &params,
  15095. DownloadProgress progress) {
  15096. return cli_->Delete(path, params, progress);
  15097. }
  15098. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15099. const Params &params, DownloadProgress progress) {
  15100. return cli_->Delete(path, headers, params, progress);
  15101. }
  15102. inline Result Client::Options(const std::string &path) {
  15103. return cli_->Options(path);
  15104. }
  15105. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15106. return cli_->Options(path, headers);
  15107. }
  15108. inline ClientImpl::StreamHandle
  15109. Client::open_stream(const std::string &method, const std::string &path,
  15110. const Params &params, const Headers &headers,
  15111. const std::string &body, const std::string &content_type) {
  15112. return cli_->open_stream(method, path, params, headers, body, content_type);
  15113. }
  15114. inline bool Client::send(Request &req, Response &res, Error &error) {
  15115. return cli_->send(req, res, error);
  15116. }
  15117. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15118. inline void Client::stop() { cli_->stop(); }
  15119. inline std::string Client::host() const { return cli_->host(); }
  15120. inline int Client::port() const { return cli_->port(); }
  15121. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15122. inline socket_t Client::socket() const { return cli_->socket(); }
  15123. inline void
  15124. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15125. cli_->set_hostname_addr_map(std::move(addr_map));
  15126. }
  15127. inline void Client::set_default_headers(Headers headers) {
  15128. cli_->set_default_headers(std::move(headers));
  15129. }
  15130. inline void Client::set_header_writer(
  15131. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15132. cli_->set_header_writer(writer);
  15133. }
  15134. inline void Client::set_address_family(int family) {
  15135. cli_->set_address_family(family);
  15136. }
  15137. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15138. inline void Client::set_socket_options(SocketOptions socket_options) {
  15139. cli_->set_socket_options(std::move(socket_options));
  15140. }
  15141. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15142. cli_->set_connection_timeout(sec, usec);
  15143. }
  15144. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15145. cli_->set_read_timeout(sec, usec);
  15146. }
  15147. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15148. cli_->set_write_timeout(sec, usec);
  15149. }
  15150. inline void Client::set_basic_auth(const std::string &username,
  15151. const std::string &password) {
  15152. cli_->set_basic_auth(username, password);
  15153. }
  15154. inline void Client::set_bearer_token_auth(const std::string &token) {
  15155. cli_->set_bearer_token_auth(token);
  15156. }
  15157. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15158. inline void Client::set_follow_location(bool on) {
  15159. cli_->set_follow_location(on);
  15160. }
  15161. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15162. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15163. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15164. inline void Client::set_payload_max_length(size_t length) {
  15165. cli_->set_payload_max_length(length);
  15166. }
  15167. inline void Client::set_interface(const std::string &intf) {
  15168. cli_->set_interface(intf);
  15169. }
  15170. inline void Client::set_proxy(const std::string &host, int port) {
  15171. cli_->set_proxy(host, port);
  15172. }
  15173. inline void Client::set_proxy_basic_auth(const std::string &username,
  15174. const std::string &password) {
  15175. cli_->set_proxy_basic_auth(username, password);
  15176. }
  15177. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15178. cli_->set_proxy_bearer_token_auth(token);
  15179. }
  15180. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15181. cli_->set_no_proxy(patterns);
  15182. }
  15183. inline void Client::set_logger(Logger logger) {
  15184. cli_->set_logger(std::move(logger));
  15185. }
  15186. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15187. cli_->set_error_logger(std::move(error_logger));
  15188. }
  15189. /*
  15190. * Group 6: SSL Server and Client implementation
  15191. */
  15192. #ifdef CPPHTTPLIB_SSL_ENABLED
  15193. // SSL HTTP server implementation
  15194. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15195. const char *client_ca_cert_file_path,
  15196. const char *client_ca_cert_dir_path,
  15197. const char *private_key_password) {
  15198. using namespace tls;
  15199. ctx_ = create_server_context();
  15200. if (!ctx_) { return; }
  15201. // Load server certificate and private key
  15202. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15203. private_key_password)) {
  15204. last_ssl_error_ = static_cast<int>(get_error());
  15205. free_context(ctx_);
  15206. ctx_ = nullptr;
  15207. return;
  15208. }
  15209. // Load client CA certificates for client authentication
  15210. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15211. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15212. client_ca_cert_dir_path)) {
  15213. last_ssl_error_ = static_cast<int>(get_error());
  15214. free_context(ctx_);
  15215. ctx_ = nullptr;
  15216. return;
  15217. }
  15218. // Enable client certificate verification
  15219. set_verify_client(ctx_, true);
  15220. }
  15221. }
  15222. inline SSLServer::SSLServer(const PemMemory &pem) {
  15223. using namespace tls;
  15224. ctx_ = create_server_context();
  15225. if (ctx_) {
  15226. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15227. pem.private_key_password)) {
  15228. last_ssl_error_ = static_cast<int>(get_error());
  15229. free_context(ctx_);
  15230. ctx_ = nullptr;
  15231. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15232. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15233. last_ssl_error_ = static_cast<int>(get_error());
  15234. free_context(ctx_);
  15235. ctx_ = nullptr;
  15236. } else {
  15237. set_verify_client(ctx_, true);
  15238. }
  15239. }
  15240. }
  15241. }
  15242. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15243. using namespace tls;
  15244. ctx_ = create_server_context();
  15245. if (ctx_) {
  15246. if (!setup_callback(ctx_)) {
  15247. free_context(ctx_);
  15248. ctx_ = nullptr;
  15249. }
  15250. }
  15251. }
  15252. inline SSLServer::~SSLServer() {
  15253. if (ctx_) { tls::free_context(ctx_); }
  15254. }
  15255. inline bool SSLServer::is_valid() const {
  15256. return ctx_ != nullptr && Server::is_valid();
  15257. }
  15258. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15259. using namespace tls;
  15260. // Create TLS session with mutex protection
  15261. session_t session = nullptr;
  15262. {
  15263. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15264. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15265. }
  15266. if (!session) {
  15267. last_ssl_error_ = static_cast<int>(get_error());
  15268. detail::shutdown_socket(sock);
  15269. detail::close_socket(sock);
  15270. return false;
  15271. }
  15272. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15273. bool handshake_done = false;
  15274. bool ret = false;
  15275. bool websocket_upgraded = false;
  15276. auto cleanup = detail::scope_exit([&] {
  15277. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15278. free_session(session);
  15279. detail::shutdown_socket(sock);
  15280. detail::close_socket(sock);
  15281. });
  15282. // Perform TLS accept handshake with timeout
  15283. TlsError tls_err;
  15284. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15285. &tls_err)) {
  15286. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15287. // Map TlsError to legacy ssl_error for backward compatibility
  15288. if (tls_err.code == ErrorCode::WantRead) {
  15289. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15290. } else if (tls_err.code == ErrorCode::WantWrite) {
  15291. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15292. } else {
  15293. last_ssl_error_ = SSL_ERROR_SSL;
  15294. }
  15295. #else
  15296. last_ssl_error_ = static_cast<int>(get_error());
  15297. #endif
  15298. return false;
  15299. }
  15300. handshake_done = true;
  15301. std::string remote_addr;
  15302. int remote_port = 0;
  15303. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15304. std::string local_addr;
  15305. int local_port = 0;
  15306. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15307. ret = serve_guarded([&]() {
  15308. return detail::process_server_socket_ssl(
  15309. svr_sock_, session, sock, keep_alive_max_count_,
  15310. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15311. write_timeout_sec_, write_timeout_usec_,
  15312. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15313. return process_request(
  15314. strm, remote_addr, remote_port, local_addr, local_port,
  15315. close_connection, connection_closed,
  15316. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15317. });
  15318. });
  15319. return ret;
  15320. }
  15321. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15322. const char *key_pem,
  15323. const char *client_ca_pem,
  15324. const char *password) {
  15325. if (!ctx_) { return false; }
  15326. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15327. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15328. return false;
  15329. }
  15330. if (client_ca_pem) {
  15331. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15332. }
  15333. return true;
  15334. }
  15335. // SSL HTTP client implementation
  15336. inline SSLClient::~SSLClient() {
  15337. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15338. // base function rather than the derived function once we get to the
  15339. // base class destructor, and won't free the SSL (causing a leak).
  15340. // This must happen before the context is freed below: some backends
  15341. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15342. // context, so freeing the context first leaves close_notify reading
  15343. // freed memory.
  15344. shutdown_ssl_impl(socket_, true);
  15345. if (ctx_) {
  15346. tls::free_context(ctx_);
  15347. ctx_ = nullptr;
  15348. }
  15349. }
  15350. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15351. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15352. shutdown_ssl_impl(socket, shutdown_gracefully);
  15353. }
  15354. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15355. bool shutdown_gracefully) {
  15356. if (socket.sock == INVALID_SOCKET) {
  15357. assert(socket.ssl == nullptr);
  15358. return;
  15359. }
  15360. if (socket.ssl) {
  15361. tls::shutdown(socket.ssl, shutdown_gracefully);
  15362. {
  15363. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15364. tls::free_session(socket.ssl);
  15365. }
  15366. socket.ssl = nullptr;
  15367. }
  15368. assert(socket.ssl == nullptr);
  15369. }
  15370. inline bool SSLClient::process_socket(
  15371. const Socket &socket,
  15372. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15373. std::function<bool(Stream &strm)> callback) {
  15374. assert(socket.ssl);
  15375. return detail::process_client_socket_ssl(
  15376. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15377. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15378. std::move(callback));
  15379. }
  15380. inline bool SSLClient::is_ssl() const { return true; }
  15381. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15382. if (!is_valid()) {
  15383. error = Error::SSLConnection;
  15384. return false;
  15385. }
  15386. return ClientImpl::create_and_connect_socket(socket, error);
  15387. }
  15388. inline bool SSLClient::setup_proxy_connection(
  15389. Socket &socket,
  15390. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15391. Response &res, bool &success, Error &error) {
  15392. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15393. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15394. return false;
  15395. }
  15396. if (!initialize_ssl(socket, error)) {
  15397. success = false;
  15398. return false;
  15399. }
  15400. return true;
  15401. }
  15402. // Assumes that socket_mutex_ is locked and that there are no requests in
  15403. // flight
  15404. inline bool SSLClient::connect_with_proxy(
  15405. Socket &socket,
  15406. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15407. Response &res, bool &success, Error &error) {
  15408. success = true;
  15409. Response proxy_res;
  15410. if (!detail::process_client_socket(
  15411. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15412. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15413. start_time, [&](Stream &strm) {
  15414. Request req2;
  15415. req2.method = "CONNECT";
  15416. req2.path =
  15417. detail::make_host_and_port_string_always_port(host_, port_);
  15418. if (max_timeout_msec_ > 0) {
  15419. req2.start_time_ = std::chrono::steady_clock::now();
  15420. }
  15421. return process_request(strm, req2, proxy_res, false, error);
  15422. })) {
  15423. // Thread-safe to close everything because we are assuming there are no
  15424. // requests in flight
  15425. shutdown_ssl(socket, true);
  15426. shutdown_socket(socket);
  15427. close_socket(socket);
  15428. success = false;
  15429. return false;
  15430. }
  15431. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15432. if (!proxy_digest_auth_username_.empty() &&
  15433. !proxy_digest_auth_password_.empty()) {
  15434. std::map<std::string, std::string> auth;
  15435. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15436. // Close the current socket and create a new one for the authenticated
  15437. // request
  15438. shutdown_ssl(socket, true);
  15439. shutdown_socket(socket);
  15440. close_socket(socket);
  15441. // Create a new socket for the authenticated CONNECT request
  15442. if (!ensure_socket_connection(socket, error)) {
  15443. success = false;
  15444. output_error_log(error, nullptr);
  15445. return false;
  15446. }
  15447. proxy_res = Response();
  15448. if (!detail::process_client_socket(
  15449. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15450. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15451. start_time, [&](Stream &strm) {
  15452. Request req3;
  15453. req3.method = "CONNECT";
  15454. req3.path = detail::make_host_and_port_string_always_port(
  15455. host_, port_);
  15456. req3.headers.insert(detail::make_digest_authentication_header(
  15457. req3, auth, 1, detail::random_string(10),
  15458. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15459. true));
  15460. if (max_timeout_msec_ > 0) {
  15461. req3.start_time_ = std::chrono::steady_clock::now();
  15462. }
  15463. return process_request(strm, req3, proxy_res, false, error);
  15464. })) {
  15465. // Thread-safe to close everything because we are assuming there are
  15466. // no requests in flight
  15467. shutdown_ssl(socket, true);
  15468. shutdown_socket(socket);
  15469. close_socket(socket);
  15470. success = false;
  15471. return false;
  15472. }
  15473. }
  15474. }
  15475. }
  15476. // If status code is not 200, proxy request is failed.
  15477. // Set error to ProxyConnection and return proxy response
  15478. // as the response of the request
  15479. if (proxy_res.status != StatusCode::OK_200) {
  15480. error = Error::ProxyConnection;
  15481. output_error_log(error, nullptr);
  15482. res = std::move(proxy_res);
  15483. // Thread-safe to close everything because we are assuming there are
  15484. // no requests in flight
  15485. shutdown_ssl(socket, true);
  15486. shutdown_socket(socket);
  15487. close_socket(socket);
  15488. return false;
  15489. }
  15490. return true;
  15491. }
  15492. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15493. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15494. if (is_proxy_enabled_for_host(host_)) { return true; }
  15495. if (!initialize_ssl(socket, error)) {
  15496. shutdown_socket(socket);
  15497. close_socket(socket);
  15498. return false;
  15499. }
  15500. return true;
  15501. }
  15502. // SSL HTTP client implementation
  15503. inline SSLClient::SSLClient(const std::string &host)
  15504. : SSLClient(host, 443, std::string(), std::string()) {}
  15505. inline SSLClient::SSLClient(const std::string &host, int port)
  15506. : SSLClient(host, port, std::string(), std::string()) {}
  15507. inline void SSLClient::init_ctx() {
  15508. ctx_ = tls::create_client_context();
  15509. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15510. }
  15511. inline void SSLClient::reset_ctx_on_error() {
  15512. last_backend_error_ = tls::get_error();
  15513. tls::free_context(ctx_);
  15514. ctx_ = nullptr;
  15515. }
  15516. inline SSLClient::SSLClient(const std::string &host, int port,
  15517. const std::string &client_cert_path,
  15518. const std::string &client_key_path,
  15519. const std::string &private_key_password)
  15520. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15521. init_ctx();
  15522. if (!ctx_) { return; }
  15523. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15524. const char *password =
  15525. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15526. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15527. client_key_path.c_str(), password)) {
  15528. reset_ctx_on_error();
  15529. }
  15530. }
  15531. }
  15532. inline SSLClient::SSLClient(const std::string &host, int port,
  15533. const PemMemory &pem)
  15534. : ClientImpl(host, port) {
  15535. init_ctx();
  15536. if (!ctx_) { return; }
  15537. if (pem.cert_pem && pem.key_pem) {
  15538. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15539. pem.private_key_password)) {
  15540. reset_ctx_on_error();
  15541. }
  15542. }
  15543. }
  15544. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15545. if (ca_cert_store && ctx_) {
  15546. // set_ca_store takes ownership of ca_cert_store
  15547. tls::set_ca_store(ctx_, ca_cert_store);
  15548. ca_cert_store_set_ = true;
  15549. } else if (ca_cert_store) {
  15550. tls::free_ca_store(ca_cert_store);
  15551. }
  15552. }
  15553. inline void
  15554. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15555. if (!ctx_) { return; }
  15556. tls::set_verify_callback(ctx_, verifier);
  15557. }
  15558. inline void SSLClient::set_session_verifier(
  15559. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15560. session_verifier_ = std::move(verifier);
  15561. }
  15562. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15563. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15564. enable_windows_cert_verification_ = enabled;
  15565. }
  15566. #endif
  15567. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15568. std::size_t size) {
  15569. if (ctx_ && ca_cert && size > 0) {
  15570. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15571. tls::load_ca_pem(ctx_, ca_cert, size);
  15572. }
  15573. }
  15574. inline bool SSLClient::load_certs() {
  15575. auto ret = true;
  15576. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15577. // one client is shared across concurrent requests here.
  15578. std::call_once(initialize_cert_, [&]() {
  15579. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15580. ret = detail::load_client_ca_config(
  15581. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15582. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15583. last_backend_error_);
  15584. });
  15585. return ret;
  15586. }
  15587. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15588. // Load CA certificates if server verification is enabled
  15589. if (server_certificate_verification_) {
  15590. if (!load_certs()) {
  15591. error = Error::SSLLoadingCerts;
  15592. output_error_log(error, nullptr);
  15593. return false;
  15594. }
  15595. }
  15596. detail::ClientTlsSessionOptions options;
  15597. options.server_hostname_verification = server_hostname_verification_;
  15598. options.session_verifier = session_verifier_;
  15599. options.ctx_mutex = &ctx_mutex_;
  15600. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15601. // Skip Schannel when a custom CA cert is specified, as the Windows
  15602. // certificate store would not know about user-provided CA certificates.
  15603. // Also skip when system CA trust is explicitly disabled.
  15604. options.windows_cert_verification =
  15605. enable_windows_cert_verification_ &&
  15606. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15607. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15608. #endif
  15609. tls::session_t session = nullptr;
  15610. // Use scope_exit to ensure session is freed on error paths
  15611. bool success = false;
  15612. auto session_guard = detail::scope_exit([&] {
  15613. if (!success) { tls::free_session(session); }
  15614. });
  15615. detail::ClientTlsSessionError tls_error;
  15616. if (!detail::setup_client_tls_session(
  15617. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15618. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15619. options)) {
  15620. error = tls_error.error;
  15621. last_ssl_error_ = tls_error.ssl_error;
  15622. last_backend_error_ = tls_error.backend_error;
  15623. output_error_log(error, nullptr);
  15624. return false;
  15625. }
  15626. success = true;
  15627. socket.ssl = session;
  15628. return true;
  15629. }
  15630. inline void Client::set_digest_auth(const std::string &username,
  15631. const std::string &password) {
  15632. cli_->set_digest_auth(username, password);
  15633. }
  15634. inline void Client::set_proxy_digest_auth(const std::string &username,
  15635. const std::string &password) {
  15636. cli_->set_proxy_digest_auth(username, password);
  15637. }
  15638. inline void Client::enable_server_certificate_verification(bool enabled) {
  15639. cli_->enable_server_certificate_verification(enabled);
  15640. }
  15641. inline void Client::enable_server_hostname_verification(bool enabled) {
  15642. cli_->enable_server_hostname_verification(enabled);
  15643. }
  15644. inline void Client::enable_system_ca(bool enabled) {
  15645. cli_->enable_system_ca(enabled);
  15646. }
  15647. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15648. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15649. if (is_ssl_) {
  15650. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15651. enabled);
  15652. }
  15653. }
  15654. #endif
  15655. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15656. const std::string &ca_cert_dir_path) {
  15657. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15658. }
  15659. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15660. if (is_ssl_) {
  15661. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15662. } else if (ca_cert_store) {
  15663. tls::free_ca_store(ca_cert_store);
  15664. }
  15665. }
  15666. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15667. if (is_ssl_) {
  15668. // Use the PEM-based path so the CA data is retained for redirect transfer
  15669. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15670. }
  15671. }
  15672. inline void
  15673. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15674. if (is_ssl_) {
  15675. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15676. std::move(verifier));
  15677. }
  15678. }
  15679. inline void Client::set_session_verifier(
  15680. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15681. if (is_ssl_) {
  15682. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15683. }
  15684. }
  15685. inline tls::ctx_t Client::tls_context() const {
  15686. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15687. return nullptr;
  15688. }
  15689. #endif // CPPHTTPLIB_SSL_ENABLED
  15690. /*
  15691. * Group 7: TLS abstraction layer - Common API
  15692. */
  15693. #ifdef CPPHTTPLIB_SSL_ENABLED
  15694. namespace tls {
  15695. // Helper for PeerCert construction
  15696. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15697. return PeerCert(get_peer_cert(session));
  15698. }
  15699. namespace impl {
  15700. inline VerifyCallback &get_verify_callback() {
  15701. static thread_local VerifyCallback callback;
  15702. return callback;
  15703. }
  15704. inline VerifyCallback &get_mbedtls_verify_callback() {
  15705. static thread_local VerifyCallback callback;
  15706. return callback;
  15707. }
  15708. // Check if a string is an IPv4 address
  15709. inline bool is_ipv4_address(const std::string &str) {
  15710. int dots = 0;
  15711. for (char c : str) {
  15712. if (c == '.') {
  15713. dots++;
  15714. } else if (!detail::is_ascii_digit(c)) {
  15715. return false;
  15716. }
  15717. }
  15718. return dots == 3;
  15719. }
  15720. // Parse IPv4 address string to bytes
  15721. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15722. const char *p = str.c_str();
  15723. for (int i = 0; i < 4; i++) {
  15724. if (i > 0) {
  15725. if (*p != '.') { return false; }
  15726. p++;
  15727. }
  15728. int val = 0;
  15729. int digits = 0;
  15730. while (detail::is_ascii_digit(*p)) {
  15731. val = val * 10 + (*p - '0');
  15732. if (val > 255) { return false; }
  15733. p++;
  15734. digits++;
  15735. }
  15736. if (digits == 0) { return false; }
  15737. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15738. if (digits > 1 && *(p - digits) == '0') { return false; }
  15739. out[i] = static_cast<unsigned char>(val);
  15740. }
  15741. return *p == '\0';
  15742. }
  15743. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15744. // `out` must have room for at least 16 bytes. Returns the address length
  15745. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15746. // literal. Used to match a host against iPAddress SANs the same way the
  15747. // OpenSSL backend does via X509_check_ip.
  15748. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15749. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15750. struct in6_addr addr6 = {};
  15751. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15752. memcpy(out, &addr6, 16);
  15753. return 16;
  15754. }
  15755. return 0;
  15756. }
  15757. #ifdef _WIN32
  15758. // Enumerate Windows system certificates and call callback with DER data
  15759. template <typename Callback>
  15760. inline bool enumerate_windows_system_certs(Callback cb) {
  15761. bool loaded = false;
  15762. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15763. for (auto store_name : store_names) {
  15764. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15765. if (hStore) {
  15766. PCCERT_CONTEXT pContext = nullptr;
  15767. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15768. nullptr) {
  15769. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  15770. loaded = true;
  15771. }
  15772. }
  15773. CertCloseStore(hStore, 0);
  15774. }
  15775. }
  15776. return loaded;
  15777. }
  15778. #endif
  15779. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  15780. // Enumerate macOS Keychain certificates and call callback with DER data
  15781. template <typename Callback>
  15782. inline bool enumerate_macos_keychain_certs(Callback cb) {
  15783. bool loaded = false;
  15784. const SecTrustSettingsDomain domains[] = {
  15785. kSecTrustSettingsDomainSystem,
  15786. kSecTrustSettingsDomainAdmin,
  15787. kSecTrustSettingsDomainUser,
  15788. };
  15789. for (auto domain : domains) {
  15790. CFArrayRef certs = nullptr;
  15791. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  15792. if (status != errSecSuccess || !certs) {
  15793. if (certs) CFRelease(certs);
  15794. continue;
  15795. }
  15796. CFIndex count = CFArrayGetCount(certs);
  15797. for (CFIndex i = 0; i < count; i++) {
  15798. SecCertificateRef cert =
  15799. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  15800. CFDataRef data = SecCertificateCopyData(cert);
  15801. if (data) {
  15802. if (cb(CFDataGetBytePtr(data),
  15803. static_cast<size_t>(CFDataGetLength(data)))) {
  15804. loaded = true;
  15805. }
  15806. CFRelease(data);
  15807. }
  15808. }
  15809. CFRelease(certs);
  15810. }
  15811. return loaded;
  15812. }
  15813. #endif
  15814. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  15815. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  15816. // Common CA certificate file paths on Linux/Unix
  15817. inline const char **system_ca_paths() {
  15818. static const char *paths[] = {
  15819. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  15820. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  15821. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  15822. "/etc/pki/tls/cacert.pem", // OpenELEC
  15823. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  15824. nullptr};
  15825. return paths;
  15826. }
  15827. // Common CA certificate directory paths on Linux/Unix
  15828. inline const char **system_ca_dirs() {
  15829. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  15830. "/etc/pki/tls/certs", // RHEL/CentOS
  15831. "/usr/share/ca-certificates", // Other
  15832. nullptr};
  15833. return dirs;
  15834. }
  15835. #endif
  15836. } // namespace impl
  15837. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  15838. const char *ca_dir) {
  15839. if (!ctx) { return false; }
  15840. bool success = true;
  15841. if (ca_file && *ca_file) {
  15842. if (!load_ca_file(ctx, ca_file)) { success = false; }
  15843. }
  15844. if (ca_dir && *ca_dir) {
  15845. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  15846. }
  15847. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15848. // Set CA list for client certificate request (CertificateRequest message)
  15849. if (ca_file && *ca_file) {
  15850. auto list = SSL_load_client_CA_file(ca_file);
  15851. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  15852. }
  15853. #endif
  15854. return success;
  15855. }
  15856. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  15857. const char *password) {
  15858. return set_client_cert_pem(ctx, cert, key, password);
  15859. }
  15860. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  15861. const char *key_path, const char *password) {
  15862. return set_client_cert_file(ctx, cert_path, key_path, password);
  15863. }
  15864. // PeerCert implementation
  15865. inline PeerCert::PeerCert() = default;
  15866. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  15867. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  15868. other.cert_ = nullptr;
  15869. }
  15870. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  15871. if (this != &other) {
  15872. if (cert_) { free_cert(cert_); }
  15873. cert_ = other.cert_;
  15874. other.cert_ = nullptr;
  15875. }
  15876. return *this;
  15877. }
  15878. inline PeerCert::~PeerCert() {
  15879. if (cert_) { free_cert(cert_); }
  15880. }
  15881. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  15882. inline std::string PeerCert::subject_cn() const {
  15883. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  15884. }
  15885. inline std::string PeerCert::issuer_name() const {
  15886. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  15887. }
  15888. inline bool PeerCert::check_hostname(const char *hostname) const {
  15889. return cert_ ? verify_hostname(cert_, hostname) : false;
  15890. }
  15891. inline std::vector<SanEntry> PeerCert::sans() const {
  15892. std::vector<SanEntry> result;
  15893. if (cert_) { get_cert_sans(cert_, result); }
  15894. return result;
  15895. }
  15896. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  15897. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  15898. }
  15899. inline std::string PeerCert::serial() const {
  15900. return cert_ ? get_cert_serial(cert_) : std::string();
  15901. }
  15902. // VerifyContext method implementations
  15903. inline std::string VerifyContext::subject_cn() const {
  15904. return cert ? get_cert_subject_cn(cert) : std::string();
  15905. }
  15906. inline std::string VerifyContext::issuer_name() const {
  15907. return cert ? get_cert_issuer_name(cert) : std::string();
  15908. }
  15909. inline bool VerifyContext::check_hostname(const char *hostname) const {
  15910. return cert ? verify_hostname(cert, hostname) : false;
  15911. }
  15912. inline std::vector<SanEntry> VerifyContext::sans() const {
  15913. std::vector<SanEntry> result;
  15914. if (cert) { get_cert_sans(cert, result); }
  15915. return result;
  15916. }
  15917. inline bool VerifyContext::validity(time_t &not_before,
  15918. time_t &not_after) const {
  15919. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  15920. }
  15921. inline std::string VerifyContext::serial() const {
  15922. return cert ? get_cert_serial(cert) : std::string();
  15923. }
  15924. // TlsError static method implementation
  15925. inline std::string TlsError::verify_error_to_string(long error_code) {
  15926. return verify_error_string(error_code);
  15927. }
  15928. } // namespace tls
  15929. // Request::peer_cert() implementation
  15930. inline tls::PeerCert Request::peer_cert() const {
  15931. return tls::get_peer_cert_from_session(ssl);
  15932. }
  15933. // Request::sni() implementation
  15934. inline std::string Request::sni() const {
  15935. if (!ssl) { return std::string(); }
  15936. const char *s = tls::get_sni(ssl);
  15937. return s ? std::string(s) : std::string();
  15938. }
  15939. #endif // CPPHTTPLIB_SSL_ENABLED
  15940. /*
  15941. * Group 8: TLS abstraction layer - OpenSSL backend
  15942. */
  15943. /*
  15944. * OpenSSL Backend Implementation
  15945. */
  15946. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15947. namespace tls {
  15948. namespace impl {
  15949. // Helper to map OpenSSL SSL_get_error to ErrorCode
  15950. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  15951. switch (ssl_error) {
  15952. case SSL_ERROR_NONE: return ErrorCode::Success;
  15953. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  15954. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  15955. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  15956. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  15957. case SSL_ERROR_SSL:
  15958. default: return ErrorCode::Fatal;
  15959. }
  15960. }
  15961. // Helper: Create client CA list from PEM string
  15962. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  15963. // Caller takes ownership of returned list
  15964. inline STACK_OF(X509_NAME) *
  15965. create_client_ca_list_from_pem(const char *ca_pem) {
  15966. if (!ca_pem) { return nullptr; }
  15967. auto ca_list = sk_X509_NAME_new_null();
  15968. if (!ca_list) { return nullptr; }
  15969. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  15970. if (!bio) {
  15971. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  15972. return nullptr;
  15973. }
  15974. X509 *cert = nullptr;
  15975. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  15976. nullptr) {
  15977. const X509_NAME *name = X509_get_subject_name(cert);
  15978. if (name) {
  15979. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  15980. }
  15981. X509_free(cert);
  15982. }
  15983. BIO_free(bio);
  15984. return ca_list;
  15985. }
  15986. // OpenSSL verify callback wrapper
  15987. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  15988. auto &callback = get_verify_callback();
  15989. if (!callback) { return preverify_ok; }
  15990. // Get SSL object from X509_STORE_CTX
  15991. auto ssl = static_cast<SSL *>(
  15992. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  15993. if (!ssl) { return preverify_ok; }
  15994. // Get current certificate and depth
  15995. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  15996. int depth = X509_STORE_CTX_get_error_depth(ctx);
  15997. int error = X509_STORE_CTX_get_error(ctx);
  15998. // Build context
  15999. VerifyContext verify_ctx;
  16000. verify_ctx.session = static_cast<session_t>(ssl);
  16001. verify_ctx.cert = static_cast<cert_t>(cert);
  16002. verify_ctx.depth = depth;
  16003. verify_ctx.preverify_ok = (preverify_ok != 0);
  16004. verify_ctx.error_code = error;
  16005. verify_ctx.error_string =
  16006. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16007. return callback(verify_ctx) ? 1 : 0;
  16008. }
  16009. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16010. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16011. // that must be released with release_store_objects
  16012. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16013. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16014. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16015. #endif
  16016. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16017. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16018. return X509_STORE_get1_objects(store);
  16019. #else
  16020. return X509_STORE_get0_objects(store);
  16021. #endif
  16022. }
  16023. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16024. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16025. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16026. #else
  16027. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16028. #endif
  16029. }
  16030. } // namespace impl
  16031. inline ctx_t create_client_context() {
  16032. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16033. if (ctx) {
  16034. // Disable auto-retry to properly handle non-blocking I/O
  16035. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16036. // Set minimum TLS version
  16037. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16038. }
  16039. return static_cast<ctx_t>(ctx);
  16040. }
  16041. inline void free_context(ctx_t ctx) {
  16042. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16043. }
  16044. inline bool set_min_version(ctx_t ctx, Version version) {
  16045. if (!ctx) return false;
  16046. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16047. static_cast<int>(version)) == 1;
  16048. }
  16049. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16050. if (!ctx || !pem || len == 0) return false;
  16051. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16052. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16053. if (!store) return false;
  16054. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16055. if (!bio) return false;
  16056. bool ok = true;
  16057. X509 *cert = nullptr;
  16058. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16059. nullptr) {
  16060. if (X509_STORE_add_cert(store, cert) != 1) {
  16061. // Ignore duplicate errors
  16062. auto err = ERR_peek_last_error();
  16063. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16064. ok = false;
  16065. }
  16066. }
  16067. X509_free(cert);
  16068. if (!ok) break;
  16069. }
  16070. BIO_free(bio);
  16071. // Clear any "no more certificates" errors
  16072. ERR_clear_error();
  16073. return ok;
  16074. }
  16075. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16076. if (!ctx || !file_path) return false;
  16077. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16078. nullptr) == 1;
  16079. }
  16080. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16081. if (!ctx || !dir_path) return false;
  16082. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16083. dir_path) == 1;
  16084. }
  16085. inline bool load_system_certs(ctx_t ctx) {
  16086. if (!ctx) return false;
  16087. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16088. #ifdef _WIN32
  16089. // Windows: Load from system certificate store (ROOT and CA)
  16090. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16091. if (!store) return false;
  16092. bool loaded_any = false;
  16093. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16094. for (auto store_name : store_names) {
  16095. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16096. if (!hStore) continue;
  16097. PCCERT_CONTEXT pContext = nullptr;
  16098. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16099. nullptr) {
  16100. const unsigned char *data = pContext->pbCertEncoded;
  16101. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16102. if (x509) {
  16103. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16104. X509_free(x509);
  16105. }
  16106. }
  16107. CertCloseStore(hStore, 0);
  16108. }
  16109. return loaded_any;
  16110. #elif defined(__APPLE__)
  16111. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16112. // macOS: Load from Keychain
  16113. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16114. if (!store) return false;
  16115. bool loaded_any = false;
  16116. const SecTrustSettingsDomain domains[] = {
  16117. kSecTrustSettingsDomainSystem,
  16118. kSecTrustSettingsDomainAdmin,
  16119. kSecTrustSettingsDomainUser,
  16120. };
  16121. for (auto domain : domains) {
  16122. CFArrayRef certs = nullptr;
  16123. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16124. !certs) {
  16125. if (certs) CFRelease(certs);
  16126. continue;
  16127. }
  16128. auto count = CFArrayGetCount(certs);
  16129. for (CFIndex i = 0; i < count; i++) {
  16130. auto cert = reinterpret_cast<SecCertificateRef>(
  16131. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16132. CFDataRef der = SecCertificateCopyData(cert);
  16133. if (der) {
  16134. const unsigned char *data = CFDataGetBytePtr(der);
  16135. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16136. if (x509) {
  16137. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16138. X509_free(x509);
  16139. }
  16140. CFRelease(der);
  16141. }
  16142. }
  16143. CFRelease(certs);
  16144. }
  16145. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16146. #else
  16147. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16148. #endif
  16149. #else
  16150. // Other Unix: use default verify paths
  16151. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16152. #endif
  16153. }
  16154. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16155. const char *password) {
  16156. if (!ctx || !cert || !key) return false;
  16157. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16158. // Load certificate
  16159. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16160. if (!cert_bio) return false;
  16161. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16162. BIO_free(cert_bio);
  16163. if (!x509) return false;
  16164. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16165. X509_free(x509);
  16166. if (!cert_ok) return false;
  16167. // Load private key
  16168. auto key_bio = BIO_new_mem_buf(key, -1);
  16169. if (!key_bio) return false;
  16170. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16171. password ? const_cast<char *>(password)
  16172. : nullptr);
  16173. BIO_free(key_bio);
  16174. if (!pkey) return false;
  16175. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16176. EVP_PKEY_free(pkey);
  16177. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16178. }
  16179. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16180. const char *key_path, const char *password) {
  16181. if (!ctx || !cert_path || !key_path) return false;
  16182. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16183. if (password && password[0] != '\0') {
  16184. SSL_CTX_set_default_passwd_cb_userdata(
  16185. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16186. }
  16187. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16188. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16189. }
  16190. inline ctx_t create_server_context() {
  16191. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16192. if (ctx) {
  16193. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16194. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16195. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16196. }
  16197. return static_cast<ctx_t>(ctx);
  16198. }
  16199. inline void set_verify_client(ctx_t ctx, bool require) {
  16200. if (!ctx) return;
  16201. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16202. require
  16203. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16204. : SSL_VERIFY_NONE,
  16205. nullptr);
  16206. }
  16207. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16208. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16209. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16210. SSL *ssl = SSL_new(ssl_ctx);
  16211. if (!ssl) return nullptr;
  16212. // Disable auto-retry for proper non-blocking I/O handling
  16213. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16214. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16215. if (!bio) {
  16216. SSL_free(ssl);
  16217. return nullptr;
  16218. }
  16219. SSL_set_bio(ssl, bio, bio);
  16220. return static_cast<session_t>(ssl);
  16221. }
  16222. inline void free_session(session_t session) {
  16223. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16224. }
  16225. inline bool set_sni(session_t session, const char *hostname,
  16226. bool /*verify_hostname*/) {
  16227. if (!session || !hostname) return false;
  16228. auto ssl = static_cast<SSL *>(session);
  16229. // Set SNI (Server Name Indication) only - does not enable verification.
  16230. // OpenSSL never binds identity checking to SNI (that happens post-
  16231. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16232. #if defined(OPENSSL_IS_BORINGSSL)
  16233. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16234. #else
  16235. // Direct call instead of macro to suppress -Wold-style-cast warning
  16236. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16237. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16238. #endif
  16239. }
  16240. inline TlsError connect(session_t session) {
  16241. if (!session) { return TlsError(); }
  16242. auto ssl = static_cast<SSL *>(session);
  16243. auto ret = SSL_connect(ssl);
  16244. TlsError err;
  16245. if (ret == 1) {
  16246. err.code = ErrorCode::Success;
  16247. } else {
  16248. auto ssl_err = SSL_get_error(ssl, ret);
  16249. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16250. err.backend_code = ERR_get_error();
  16251. }
  16252. return err;
  16253. }
  16254. inline TlsError accept(session_t session) {
  16255. if (!session) { return TlsError(); }
  16256. auto ssl = static_cast<SSL *>(session);
  16257. auto ret = SSL_accept(ssl);
  16258. TlsError err;
  16259. if (ret == 1) {
  16260. err.code = ErrorCode::Success;
  16261. } else {
  16262. auto ssl_err = SSL_get_error(ssl, ret);
  16263. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16264. err.backend_code = ERR_get_error();
  16265. }
  16266. return err;
  16267. }
  16268. inline bool connect_nonblocking(session_t session, socket_t sock,
  16269. time_t timeout_sec, time_t timeout_usec,
  16270. TlsError *err) {
  16271. if (!session) {
  16272. if (err) { err->code = ErrorCode::Fatal; }
  16273. return false;
  16274. }
  16275. auto ssl = static_cast<SSL *>(session);
  16276. auto bio = SSL_get_rbio(ssl);
  16277. // Set non-blocking mode for handshake
  16278. detail::set_nonblocking(sock, true);
  16279. if (bio) { BIO_set_nbio(bio, 1); }
  16280. auto cleanup = detail::scope_exit([&]() {
  16281. // Restore blocking mode after handshake
  16282. if (bio) { BIO_set_nbio(bio, 0); }
  16283. detail::set_nonblocking(sock, false);
  16284. });
  16285. auto res = 0;
  16286. while ((res = SSL_connect(ssl)) != 1) {
  16287. auto ssl_err = SSL_get_error(ssl, res);
  16288. switch (ssl_err) {
  16289. case SSL_ERROR_WANT_READ:
  16290. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16291. continue;
  16292. }
  16293. break;
  16294. case SSL_ERROR_WANT_WRITE:
  16295. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16296. continue;
  16297. }
  16298. break;
  16299. default: break;
  16300. }
  16301. if (err) {
  16302. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16303. err->backend_code = ERR_get_error();
  16304. }
  16305. return false;
  16306. }
  16307. if (err) { err->code = ErrorCode::Success; }
  16308. return true;
  16309. }
  16310. inline bool accept_nonblocking(session_t session, socket_t sock,
  16311. time_t timeout_sec, time_t timeout_usec,
  16312. TlsError *err) {
  16313. if (!session) {
  16314. if (err) { err->code = ErrorCode::Fatal; }
  16315. return false;
  16316. }
  16317. auto ssl = static_cast<SSL *>(session);
  16318. auto bio = SSL_get_rbio(ssl);
  16319. // Set non-blocking mode for handshake
  16320. detail::set_nonblocking(sock, true);
  16321. if (bio) { BIO_set_nbio(bio, 1); }
  16322. auto cleanup = detail::scope_exit([&]() {
  16323. // Restore blocking mode after handshake
  16324. if (bio) { BIO_set_nbio(bio, 0); }
  16325. detail::set_nonblocking(sock, false);
  16326. });
  16327. auto res = 0;
  16328. while ((res = SSL_accept(ssl)) != 1) {
  16329. auto ssl_err = SSL_get_error(ssl, res);
  16330. switch (ssl_err) {
  16331. case SSL_ERROR_WANT_READ:
  16332. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16333. continue;
  16334. }
  16335. break;
  16336. case SSL_ERROR_WANT_WRITE:
  16337. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16338. continue;
  16339. }
  16340. break;
  16341. default: break;
  16342. }
  16343. if (err) {
  16344. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16345. err->backend_code = ERR_get_error();
  16346. }
  16347. return false;
  16348. }
  16349. if (err) { err->code = ErrorCode::Success; }
  16350. return true;
  16351. }
  16352. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16353. if (!session || !buf) {
  16354. err.code = ErrorCode::Fatal;
  16355. return -1;
  16356. }
  16357. auto ssl = static_cast<SSL *>(session);
  16358. constexpr auto max_len =
  16359. static_cast<size_t>((std::numeric_limits<int>::max)());
  16360. if (len > max_len) { len = max_len; }
  16361. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16362. if (ret > 0) {
  16363. err.code = ErrorCode::Success;
  16364. return ret;
  16365. }
  16366. auto ssl_err = SSL_get_error(ssl, ret);
  16367. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16368. if (err.code == ErrorCode::PeerClosed) {
  16369. return 0;
  16370. } // Gracefully handle the peer closed state.
  16371. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16372. return -1;
  16373. }
  16374. inline ssize_t write(session_t session, const void *buf, size_t len,
  16375. TlsError &err) {
  16376. if (!session || !buf) {
  16377. err.code = ErrorCode::Fatal;
  16378. return -1;
  16379. }
  16380. auto ssl = static_cast<SSL *>(session);
  16381. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16382. if (ret > 0) {
  16383. err.code = ErrorCode::Success;
  16384. return ret;
  16385. }
  16386. auto ssl_err = SSL_get_error(ssl, ret);
  16387. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16388. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16389. return -1;
  16390. }
  16391. inline int pending(const_session_t session) {
  16392. if (!session) return 0;
  16393. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16394. }
  16395. inline void shutdown(session_t session, bool graceful) {
  16396. if (!session) return;
  16397. auto ssl = static_cast<SSL *>(session);
  16398. if (graceful) {
  16399. // First call sends close_notify
  16400. if (SSL_shutdown(ssl) == 0) {
  16401. // Second call waits for peer's close_notify
  16402. SSL_shutdown(ssl);
  16403. }
  16404. }
  16405. }
  16406. inline bool is_peer_closed(session_t session, socket_t sock) {
  16407. if (!session) return true;
  16408. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16409. detail::set_nonblocking(sock, true);
  16410. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16411. auto ssl = static_cast<SSL *>(session);
  16412. char buf;
  16413. auto ret = SSL_peek(ssl, &buf, 1);
  16414. if (ret > 0) return false;
  16415. auto err = SSL_get_error(ssl, ret);
  16416. return err == SSL_ERROR_ZERO_RETURN;
  16417. }
  16418. inline cert_t get_peer_cert(const_session_t session) {
  16419. if (!session) return nullptr;
  16420. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16421. static_cast<SSL *>(const_cast<void *>(session))));
  16422. }
  16423. inline void free_cert(cert_t cert) {
  16424. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16425. }
  16426. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16427. if (!cert || !hostname) return false;
  16428. auto x509 = static_cast<X509 *>(cert);
  16429. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16430. if (detail::is_ip_address(hostname)) {
  16431. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16432. }
  16433. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16434. }
  16435. inline uint64_t hostname_mismatch_code() {
  16436. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16437. }
  16438. inline long get_verify_result(const_session_t session) {
  16439. if (!session) return X509_V_ERR_UNSPECIFIED;
  16440. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16441. }
  16442. inline std::string get_cert_subject_cn(cert_t cert) {
  16443. if (!cert) return "";
  16444. auto x509 = static_cast<X509 *>(cert);
  16445. auto subject_name = X509_get_subject_name(x509);
  16446. if (!subject_name) return "";
  16447. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16448. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16449. if (idx < 0) return "";
  16450. auto entry = X509_NAME_get_entry(subject_name, idx);
  16451. if (!entry) return "";
  16452. auto data = X509_NAME_ENTRY_get_data(entry);
  16453. if (!data) return "";
  16454. return std::string(
  16455. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16456. static_cast<size_t>(ASN1_STRING_length(data)));
  16457. }
  16458. inline std::string get_cert_issuer_name(cert_t cert) {
  16459. if (!cert) return "";
  16460. auto x509 = static_cast<X509 *>(cert);
  16461. auto issuer_name = X509_get_issuer_name(x509);
  16462. if (!issuer_name) return "";
  16463. char buf[256];
  16464. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16465. return std::string(buf);
  16466. }
  16467. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16468. sans.clear();
  16469. if (!cert) return false;
  16470. auto x509 = static_cast<X509 *>(cert);
  16471. auto names = static_cast<GENERAL_NAMES *>(
  16472. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16473. if (!names) return true; // No SANs is valid
  16474. auto count = sk_GENERAL_NAME_num(names);
  16475. for (decltype(count) i = 0; i < count; i++) {
  16476. auto gen = sk_GENERAL_NAME_value(names, i);
  16477. if (!gen) continue;
  16478. SanEntry entry;
  16479. switch (gen->type) {
  16480. case GEN_DNS:
  16481. entry.type = SanType::DNS;
  16482. if (gen->d.dNSName) {
  16483. entry.value = std::string(
  16484. reinterpret_cast<const char *>(
  16485. ASN1_STRING_get0_data(gen->d.dNSName)),
  16486. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16487. }
  16488. break;
  16489. case GEN_IPADD:
  16490. entry.type = SanType::IP;
  16491. if (gen->d.iPAddress) {
  16492. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16493. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16494. if (len == 4) {
  16495. // IPv4
  16496. char buf[INET_ADDRSTRLEN];
  16497. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16498. entry.value = buf;
  16499. } else if (len == 16) {
  16500. // IPv6
  16501. char buf[INET6_ADDRSTRLEN];
  16502. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16503. entry.value = buf;
  16504. }
  16505. }
  16506. break;
  16507. case GEN_EMAIL:
  16508. entry.type = SanType::EMAIL;
  16509. if (gen->d.rfc822Name) {
  16510. entry.value = std::string(
  16511. reinterpret_cast<const char *>(
  16512. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16513. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16514. }
  16515. break;
  16516. case GEN_URI:
  16517. entry.type = SanType::URI;
  16518. if (gen->d.uniformResourceIdentifier) {
  16519. entry.value = std::string(
  16520. reinterpret_cast<const char *>(
  16521. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16522. static_cast<size_t>(
  16523. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16524. }
  16525. break;
  16526. default: entry.type = SanType::OTHER; break;
  16527. }
  16528. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16529. }
  16530. GENERAL_NAMES_free(names);
  16531. return true;
  16532. }
  16533. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16534. time_t &not_after) {
  16535. if (!cert) return false;
  16536. auto x509 = static_cast<X509 *>(cert);
  16537. auto nb = X509_get0_notBefore(x509);
  16538. auto na = X509_get0_notAfter(x509);
  16539. if (!nb || !na) return false;
  16540. ASN1_TIME *epoch = ASN1_TIME_new();
  16541. if (!epoch) return false;
  16542. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16543. if (!ASN1_TIME_set(epoch, 0)) return false;
  16544. int pday, psec;
  16545. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16546. not_before = 86400 * (time_t)pday + psec;
  16547. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16548. not_after = 86400 * (time_t)pday + psec;
  16549. return true;
  16550. }
  16551. inline std::string get_cert_serial(cert_t cert) {
  16552. if (!cert) return "";
  16553. auto x509 = static_cast<X509 *>(cert);
  16554. auto serial = X509_get_serialNumber(x509);
  16555. if (!serial) return "";
  16556. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16557. if (!bn) return "";
  16558. auto hex = BN_bn2hex(bn);
  16559. BN_free(bn);
  16560. if (!hex) return "";
  16561. std::string result(hex);
  16562. OPENSSL_free(hex);
  16563. return result;
  16564. }
  16565. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16566. if (!cert) return false;
  16567. auto x509 = static_cast<X509 *>(cert);
  16568. auto len = i2d_X509(x509, nullptr);
  16569. if (len < 0) return false;
  16570. der.resize(static_cast<size_t>(len));
  16571. auto p = der.data();
  16572. i2d_X509(x509, &p);
  16573. return true;
  16574. }
  16575. inline const char *get_sni(const_session_t session) {
  16576. if (!session) return nullptr;
  16577. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16578. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16579. }
  16580. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16581. inline uint64_t get_error() { return ERR_get_error(); }
  16582. inline std::string error_string(uint64_t code) {
  16583. char buf[256];
  16584. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16585. return std::string(buf);
  16586. }
  16587. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16588. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16589. if (!mem) { return nullptr; }
  16590. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16591. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16592. if (!inf) { return nullptr; }
  16593. auto store = X509_STORE_new();
  16594. if (store) {
  16595. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16596. auto itmp = sk_X509_INFO_value(inf, i);
  16597. if (!itmp) { continue; }
  16598. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16599. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16600. }
  16601. }
  16602. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16603. return static_cast<ca_store_t>(store);
  16604. }
  16605. inline void free_ca_store(ca_store_t store) {
  16606. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16607. }
  16608. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16609. if (!ctx || !store) { return false; }
  16610. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16611. auto x509_store = static_cast<X509_STORE *>(store);
  16612. // Check if same store is already set
  16613. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16614. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16615. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16616. return true;
  16617. }
  16618. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16619. certs.clear();
  16620. if (!ctx) { return 0; }
  16621. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16622. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16623. if (!store) { return 0; }
  16624. auto objs = impl::get_store_objects(store);
  16625. if (!objs) { return 0; }
  16626. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16627. auto count = sk_X509_OBJECT_num(objs);
  16628. for (decltype(count) i = 0; i < count; i++) {
  16629. auto obj = sk_X509_OBJECT_value(objs, i);
  16630. if (!obj) { continue; }
  16631. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16632. auto x509 = X509_OBJECT_get0_X509(obj);
  16633. if (x509) {
  16634. // Increment reference count so caller can free it
  16635. X509_up_ref(x509);
  16636. certs.push_back(static_cast<cert_t>(x509));
  16637. }
  16638. }
  16639. }
  16640. return certs.size();
  16641. }
  16642. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16643. std::vector<std::string> names;
  16644. if (!ctx) { return names; }
  16645. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16646. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16647. if (!store) { return names; }
  16648. auto objs = impl::get_store_objects(store);
  16649. if (!objs) { return names; }
  16650. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16651. auto count = sk_X509_OBJECT_num(objs);
  16652. for (decltype(count) i = 0; i < count; i++) {
  16653. auto obj = sk_X509_OBJECT_value(objs, i);
  16654. if (!obj) { continue; }
  16655. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16656. auto x509 = X509_OBJECT_get0_X509(obj);
  16657. if (x509) {
  16658. auto subject = X509_get_subject_name(x509);
  16659. if (subject) {
  16660. char buf[512];
  16661. X509_NAME_oneline(subject, buf, sizeof(buf));
  16662. names.push_back(buf);
  16663. }
  16664. }
  16665. }
  16666. }
  16667. return names;
  16668. }
  16669. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16670. const char *key_pem, const char *password) {
  16671. if (!ctx || !cert_pem || !key_pem) { return false; }
  16672. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16673. // Load certificate from PEM
  16674. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16675. if (!cert_bio) { return false; }
  16676. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16677. BIO_free(cert_bio);
  16678. if (!cert) { return false; }
  16679. // Load private key from PEM
  16680. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16681. if (!key_bio) {
  16682. X509_free(cert);
  16683. return false;
  16684. }
  16685. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16686. password ? const_cast<char *>(password)
  16687. : nullptr);
  16688. BIO_free(key_bio);
  16689. if (!key) {
  16690. X509_free(cert);
  16691. return false;
  16692. }
  16693. // Update certificate and key
  16694. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16695. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16696. X509_free(cert);
  16697. EVP_PKEY_free(key);
  16698. return ret;
  16699. }
  16700. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16701. if (!ctx || !ca_pem) { return false; }
  16702. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16703. // Create new X509_STORE from PEM
  16704. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16705. if (!store) { return false; }
  16706. // SSL_CTX_set_cert_store takes ownership
  16707. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16708. // Set client CA list for client certificate request
  16709. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16710. if (ca_list) {
  16711. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16712. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16713. }
  16714. return true;
  16715. }
  16716. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16717. if (!ctx) { return false; }
  16718. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16719. impl::get_verify_callback() = std::move(callback);
  16720. if (impl::get_verify_callback()) {
  16721. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16722. } else {
  16723. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16724. }
  16725. return true;
  16726. }
  16727. inline long get_verify_error(const_session_t session) {
  16728. if (!session) { return -1; }
  16729. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16730. return SSL_get_verify_result(ssl);
  16731. }
  16732. inline std::string verify_error_string(long error_code) {
  16733. if (error_code == X509_V_OK) { return ""; }
  16734. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16735. return str ? str : "unknown error";
  16736. }
  16737. } // namespace tls
  16738. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16739. /*
  16740. * Group 9: TLS abstraction layer - Mbed TLS backend
  16741. */
  16742. /*
  16743. * Mbed TLS Backend Implementation
  16744. */
  16745. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16746. namespace tls {
  16747. namespace impl {
  16748. // Mbed TLS session wrapper
  16749. struct MbedTlsSession {
  16750. mbedtls_ssl_context ssl;
  16751. socket_t sock = INVALID_SOCKET;
  16752. std::string hostname; // For client: set via set_sni
  16753. std::string sni_hostname; // For server: received from client via SNI callback
  16754. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  16755. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  16756. // (e.g. a response that arrived while this side was still in its post-write
  16757. // check), the byte is pushed back here and served by the next read().
  16758. unsigned char peeked_byte = 0;
  16759. bool has_peeked_byte = false;
  16760. // Set by set_sni() when the caller disabled hostname verification, so the
  16761. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  16762. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  16763. // OpenSSL and wolfSSL keep them independent).
  16764. bool suppress_hostname_mismatch = false;
  16765. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  16766. // decide which verify callback to install when hostname verification is
  16767. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  16768. // wired for this context, or a self-contained one otherwise, so a session
  16769. // that never opted into a callback never consults the process-wide
  16770. // set_verify_callback() slot (which some other, unrelated client may have
  16771. // populated).
  16772. bool has_verify_callback = false;
  16773. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  16774. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  16775. MbedTlsSession(const MbedTlsSession &) = delete;
  16776. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  16777. };
  16778. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  16779. // queue)
  16780. inline int &mbedtls_last_error() {
  16781. static thread_local int err = 0;
  16782. return err;
  16783. }
  16784. // Helper to map Mbed TLS error to ErrorCode
  16785. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  16786. uint32_t verify_flags) {
  16787. if (ret == 0) { return ErrorCode::Success; }
  16788. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  16789. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  16790. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  16791. return ErrorCode::PeerClosed;
  16792. }
  16793. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  16794. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  16795. out_errno = errno;
  16796. return ErrorCode::SyscallError;
  16797. }
  16798. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  16799. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  16800. // the handshake's chain verification (see set_sni()); a mismatch there
  16801. // is reported the same way as any other verify_flags bit. Report it as
  16802. // HostnameMismatch, matching the other backends and the post-handshake
  16803. // identity check below, but only when naming is the sole problem -
  16804. // if the chain itself is also untrusted/expired/etc., that takes
  16805. // priority over the naming detail.
  16806. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  16807. return ErrorCode::HostnameMismatch;
  16808. }
  16809. return ErrorCode::CertVerifyFailed;
  16810. }
  16811. return ErrorCode::Fatal;
  16812. }
  16813. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  16814. // return value, including the verify-flags-dependent HostnameMismatch
  16815. // mapping; shared by connect() and connect_nonblocking() so the
  16816. // backend_code policy for that mapping only lives in one place.
  16817. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  16818. int ret) {
  16819. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  16820. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  16821. err.backend_code = err.code == ErrorCode::HostnameMismatch
  16822. ? static_cast<uint64_t>(verify_flags)
  16823. : static_cast<uint64_t>(-ret);
  16824. }
  16825. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  16826. // non-fatal notification delivered between records, not an error and not
  16827. // application data, so I/O calls that see it should just be retried. Kept in
  16828. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  16829. // splitting the closing brace across an #if.
  16830. inline bool mbedtls_is_session_ticket(int ret) {
  16831. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  16832. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  16833. #else
  16834. (void)ret;
  16835. return false;
  16836. #endif
  16837. }
  16838. // BIO-like send callback for Mbed TLS
  16839. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  16840. size_t len) {
  16841. auto sock = *static_cast<socket_t *>(ctx);
  16842. #ifdef _WIN32
  16843. auto ret =
  16844. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  16845. if (ret == SOCKET_ERROR) {
  16846. int err = WSAGetLastError();
  16847. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  16848. return MBEDTLS_ERR_NET_SEND_FAILED;
  16849. }
  16850. #else
  16851. auto ret = send(sock, buf, len, 0);
  16852. if (ret < 0) {
  16853. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16854. return MBEDTLS_ERR_SSL_WANT_WRITE;
  16855. }
  16856. return MBEDTLS_ERR_NET_SEND_FAILED;
  16857. }
  16858. #endif
  16859. return static_cast<int>(ret);
  16860. }
  16861. // BIO-like recv callback for Mbed TLS
  16862. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  16863. auto sock = *static_cast<socket_t *>(ctx);
  16864. #ifdef _WIN32
  16865. auto ret =
  16866. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  16867. if (ret == SOCKET_ERROR) {
  16868. int err = WSAGetLastError();
  16869. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  16870. return MBEDTLS_ERR_NET_RECV_FAILED;
  16871. }
  16872. #else
  16873. auto ret = recv(sock, buf, len, 0);
  16874. if (ret < 0) {
  16875. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16876. return MBEDTLS_ERR_SSL_WANT_READ;
  16877. }
  16878. return MBEDTLS_ERR_NET_RECV_FAILED;
  16879. }
  16880. #endif
  16881. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  16882. return static_cast<int>(ret);
  16883. }
  16884. // MbedTlsContext constructor/destructor implementations
  16885. inline MbedTlsContext::MbedTlsContext() {
  16886. mbedtls_ssl_config_init(&conf);
  16887. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16888. mbedtls_entropy_init(&entropy);
  16889. mbedtls_ctr_drbg_init(&ctr_drbg);
  16890. #endif
  16891. mbedtls_x509_crt_init(&ca_chain);
  16892. mbedtls_x509_crt_init(&own_cert);
  16893. mbedtls_pk_init(&own_key);
  16894. }
  16895. inline MbedTlsContext::~MbedTlsContext() {
  16896. mbedtls_pk_free(&own_key);
  16897. mbedtls_x509_crt_free(&own_cert);
  16898. mbedtls_x509_crt_free(&ca_chain);
  16899. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16900. mbedtls_ctr_drbg_free(&ctr_drbg);
  16901. mbedtls_entropy_free(&entropy);
  16902. #endif
  16903. mbedtls_ssl_config_free(&conf);
  16904. }
  16905. // Thread-local storage for SNI captured during handshake
  16906. // This is needed because the SNI callback doesn't have a way to pass
  16907. // session-specific data before the session is fully set up
  16908. inline std::string &mbedpending_sni() {
  16909. static thread_local std::string sni;
  16910. return sni;
  16911. }
  16912. // SNI callback for Mbed TLS server to capture client's SNI hostname
  16913. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  16914. const unsigned char *name, size_t name_len) {
  16915. (void)p_ctx;
  16916. (void)ssl;
  16917. // Store SNI name in thread-local storage
  16918. // It will be retrieved and stored in the session after handshake
  16919. if (name && name_len > 0) {
  16920. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  16921. } else {
  16922. mbedpending_sni().clear();
  16923. }
  16924. return 0; // Accept any SNI
  16925. }
  16926. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  16927. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  16928. }
  16929. // Verify callback used when hostname verification is disabled for a session
  16930. // that has no user-supplied verify callback of its own (MbedTlsSession::
  16931. // has_verify_callback is false). Deliberately does not consult
  16932. // get_verify_callback(): that slot is process-wide, so reading it here would
  16933. // pick up whatever another, unrelated client last installed there.
  16934. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  16935. mbedtls_x509_crt *, int,
  16936. uint32_t *flags) {
  16937. (void)data;
  16938. mbedtls_clear_cn_mismatch(flags);
  16939. return 0;
  16940. }
  16941. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16942. int cert_depth, uint32_t *flags);
  16943. // MbedTLS verify callback wrapper
  16944. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16945. int cert_depth, uint32_t *flags) {
  16946. // data points to the MbedTlsSession
  16947. auto *session = static_cast<MbedTlsSession *>(data);
  16948. // set_sni() disabled hostname verification for this session: drop the
  16949. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  16950. // the OpenSSL/wolfSSL backends where identity checking is independent of
  16951. // SNI. The final pass/fail decision still comes from the remaining flags
  16952. // (or, below, from the user's own verify callback).
  16953. if (session && session->suppress_hostname_mismatch) {
  16954. mbedtls_clear_cn_mismatch(flags);
  16955. }
  16956. auto &callback = get_verify_callback();
  16957. if (!callback) { return 0; } // Continue with default verification
  16958. // Build context
  16959. VerifyContext verify_ctx;
  16960. verify_ctx.session = static_cast<session_t>(session);
  16961. verify_ctx.cert = static_cast<cert_t>(crt);
  16962. verify_ctx.depth = cert_depth;
  16963. verify_ctx.preverify_ok = (*flags == 0);
  16964. verify_ctx.error_code = static_cast<long>(*flags);
  16965. // Convert Mbed TLS flags to error string
  16966. static thread_local char error_buf[256];
  16967. if (*flags != 0) {
  16968. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  16969. verify_ctx.error_string = error_buf;
  16970. } else {
  16971. verify_ctx.error_string = nullptr;
  16972. }
  16973. bool accepted = callback(verify_ctx);
  16974. if (accepted) {
  16975. *flags = 0; // Clear all error flags
  16976. return 0;
  16977. }
  16978. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  16979. }
  16980. } // namespace impl
  16981. inline ctx_t create_client_context() {
  16982. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  16983. if (!ctx) { return nullptr; }
  16984. ctx->is_server = false;
  16985. #ifdef CPPHTTPLIB_MBEDTLS_V4
  16986. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  16987. if (!detail::ensure_mbedtls_psa_crypto()) {
  16988. delete ctx;
  16989. return nullptr;
  16990. }
  16991. int ret;
  16992. #else
  16993. // Seed the random number generator
  16994. const char *pers = "httplib_client";
  16995. int ret = mbedtls_ctr_drbg_seed(
  16996. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  16997. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  16998. if (ret != 0) {
  16999. impl::mbedtls_last_error() = ret;
  17000. delete ctx;
  17001. return nullptr;
  17002. }
  17003. #endif
  17004. // Set up SSL config for client
  17005. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17006. MBEDTLS_SSL_TRANSPORT_STREAM,
  17007. MBEDTLS_SSL_PRESET_DEFAULT);
  17008. if (ret != 0) {
  17009. impl::mbedtls_last_error() = ret;
  17010. delete ctx;
  17011. return nullptr;
  17012. }
  17013. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17014. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17015. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17016. #endif
  17017. // Default: verify peer certificate
  17018. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17019. // Set minimum TLS version to 1.2
  17020. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17021. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17022. #else
  17023. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17024. MBEDTLS_SSL_MINOR_VERSION_3);
  17025. #endif
  17026. return static_cast<ctx_t>(ctx);
  17027. }
  17028. inline ctx_t create_server_context() {
  17029. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17030. if (!ctx) { return nullptr; }
  17031. ctx->is_server = true;
  17032. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17033. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17034. if (!detail::ensure_mbedtls_psa_crypto()) {
  17035. delete ctx;
  17036. return nullptr;
  17037. }
  17038. int ret;
  17039. #else
  17040. // Seed the random number generator
  17041. const char *pers = "httplib_server";
  17042. int ret = mbedtls_ctr_drbg_seed(
  17043. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17044. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17045. if (ret != 0) {
  17046. impl::mbedtls_last_error() = ret;
  17047. delete ctx;
  17048. return nullptr;
  17049. }
  17050. #endif
  17051. // Set up SSL config for server
  17052. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17053. MBEDTLS_SSL_TRANSPORT_STREAM,
  17054. MBEDTLS_SSL_PRESET_DEFAULT);
  17055. if (ret != 0) {
  17056. impl::mbedtls_last_error() = ret;
  17057. delete ctx;
  17058. return nullptr;
  17059. }
  17060. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17061. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17062. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17063. #endif
  17064. // Default: don't verify client
  17065. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17066. // Set minimum TLS version to 1.2
  17067. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17068. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17069. #else
  17070. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17071. MBEDTLS_SSL_MINOR_VERSION_3);
  17072. #endif
  17073. // Set SNI callback to capture client's SNI hostname
  17074. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17075. return static_cast<ctx_t>(ctx);
  17076. }
  17077. inline void free_context(ctx_t ctx) {
  17078. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17079. }
  17080. inline bool set_min_version(ctx_t ctx, Version version) {
  17081. if (!ctx) { return false; }
  17082. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17083. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17084. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17085. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17086. if (version >= Version::TLS1_3) {
  17087. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17088. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17089. #endif
  17090. }
  17091. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17092. #else
  17093. // Mbed TLS 2.x uses major/minor version numbers
  17094. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17095. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17096. if (version >= Version::TLS1_3) {
  17097. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17098. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17099. #else
  17100. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17101. #endif
  17102. }
  17103. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17104. #endif
  17105. return true;
  17106. }
  17107. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17108. if (!ctx || !pem) { return false; }
  17109. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17110. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17111. // Add null terminator if not present
  17112. std::string pem_str(pem, len);
  17113. int ret = mbedtls_x509_crt_parse(
  17114. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17115. pem_str.size() + 1);
  17116. if (ret != 0) {
  17117. impl::mbedtls_last_error() = ret;
  17118. return false;
  17119. }
  17120. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17121. return true;
  17122. }
  17123. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17124. if (!ctx || !file_path) { return false; }
  17125. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17126. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17127. if (ret != 0) {
  17128. impl::mbedtls_last_error() = ret;
  17129. return false;
  17130. }
  17131. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17132. return true;
  17133. }
  17134. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17135. if (!ctx || !dir_path) { return false; }
  17136. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17137. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17138. if (ret < 0) { // Returns number of certs on success, negative on error
  17139. impl::mbedtls_last_error() = ret;
  17140. return false;
  17141. }
  17142. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17143. return true;
  17144. }
  17145. inline bool load_system_certs(ctx_t ctx) {
  17146. if (!ctx) { return false; }
  17147. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17148. bool loaded = false;
  17149. #ifdef _WIN32
  17150. loaded = impl::enumerate_windows_system_certs(
  17151. [&](const unsigned char *data, size_t len) {
  17152. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17153. });
  17154. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17155. loaded = impl::enumerate_macos_keychain_certs(
  17156. [&](const unsigned char *data, size_t len) {
  17157. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17158. });
  17159. #else
  17160. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17161. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17162. loaded = true;
  17163. break;
  17164. }
  17165. }
  17166. if (!loaded) {
  17167. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17168. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17169. loaded = true;
  17170. break;
  17171. }
  17172. }
  17173. }
  17174. #endif
  17175. if (loaded) {
  17176. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17177. }
  17178. return loaded;
  17179. }
  17180. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17181. const char *password) {
  17182. if (!ctx || !cert || !key) { return false; }
  17183. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17184. // Parse certificate
  17185. std::string cert_str(cert);
  17186. int ret = mbedtls_x509_crt_parse(
  17187. &mctx->own_cert,
  17188. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17189. cert_str.size() + 1);
  17190. if (ret != 0) {
  17191. impl::mbedtls_last_error() = ret;
  17192. return false;
  17193. }
  17194. // Parse private key
  17195. std::string key_str(key);
  17196. const unsigned char *pwd =
  17197. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17198. size_t pwd_len = password ? strlen(password) : 0;
  17199. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17200. ret = mbedtls_pk_parse_key(
  17201. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17202. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17203. &mctx->ctr_drbg);
  17204. #else
  17205. ret = mbedtls_pk_parse_key(
  17206. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17207. key_str.size() + 1, pwd, pwd_len);
  17208. #endif
  17209. if (ret != 0) {
  17210. impl::mbedtls_last_error() = ret;
  17211. return false;
  17212. }
  17213. // Verify that the certificate and private key match.
  17214. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17215. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17216. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17217. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17218. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17219. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17220. #else
  17221. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17222. #endif
  17223. if (ret != 0) {
  17224. impl::mbedtls_last_error() = ret;
  17225. return false;
  17226. }
  17227. #endif
  17228. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17229. if (ret != 0) {
  17230. impl::mbedtls_last_error() = ret;
  17231. return false;
  17232. }
  17233. return true;
  17234. }
  17235. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17236. const char *key_path, const char *password) {
  17237. if (!ctx || !cert_path || !key_path) { return false; }
  17238. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17239. // Parse certificate file
  17240. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17241. if (ret != 0) {
  17242. impl::mbedtls_last_error() = ret;
  17243. return false;
  17244. }
  17245. // Parse private key file
  17246. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17247. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17248. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17249. #else
  17250. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17251. #endif
  17252. if (ret != 0) {
  17253. impl::mbedtls_last_error() = ret;
  17254. return false;
  17255. }
  17256. // Verify that the certificate and private key match.
  17257. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17258. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17259. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17260. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17261. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17262. #else
  17263. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17264. #endif
  17265. if (ret != 0) {
  17266. impl::mbedtls_last_error() = ret;
  17267. return false;
  17268. }
  17269. #endif
  17270. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17271. if (ret != 0) {
  17272. impl::mbedtls_last_error() = ret;
  17273. return false;
  17274. }
  17275. return true;
  17276. }
  17277. inline void set_verify_client(ctx_t ctx, bool require) {
  17278. if (!ctx) { return; }
  17279. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17280. mctx->verify_client = require;
  17281. if (require) {
  17282. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17283. } else {
  17284. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17285. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17286. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17287. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17288. : MBEDTLS_SSL_VERIFY_NONE);
  17289. }
  17290. }
  17291. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17292. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17293. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17294. auto session = new (std::nothrow) impl::MbedTlsSession();
  17295. if (!session) { return nullptr; }
  17296. session->sock = sock;
  17297. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17298. if (ret != 0) {
  17299. impl::mbedtls_last_error() = ret;
  17300. delete session;
  17301. return nullptr;
  17302. }
  17303. // Explicitly opt out of in-handshake hostname verification by default;
  17304. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17305. // fails outright when no hostname was set. set_sni() installs the real
  17306. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17307. // caller verifies the certificate identity post-handshake via
  17308. // verify_hostname().
  17309. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17310. // Set BIO callbacks
  17311. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17312. impl::mbedtls_net_recv_cb, nullptr);
  17313. // Set per-session verify callback with session pointer if callback is
  17314. // registered
  17315. session->has_verify_callback = mctx->has_verify_callback;
  17316. if (mctx->has_verify_callback) {
  17317. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17318. session);
  17319. }
  17320. return static_cast<session_t>(session);
  17321. }
  17322. inline void free_session(session_t session) {
  17323. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17324. }
  17325. inline bool set_sni(session_t session, const char *hostname,
  17326. bool verify_hostname) {
  17327. if (!session || !hostname) { return false; }
  17328. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17329. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17330. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17331. // independently, so a disabled hostname check is handled below by masking
  17332. // the resulting mismatch flag instead of skipping this call.
  17333. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17334. if (ret != 0) {
  17335. impl::mbedtls_last_error() = ret;
  17336. return false;
  17337. }
  17338. msession->hostname = hostname;
  17339. if (!verify_hostname) {
  17340. msession->suppress_hostname_mismatch = true;
  17341. // If a user verify callback is already wired for this session,
  17342. // mbedtls_verify_callback() masks the mismatch flag itself before
  17343. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17344. // here would be redundant. Otherwise install the self-contained masking
  17345. // callback, which never touches the process-wide callback slot.
  17346. if (!msession->has_verify_callback) {
  17347. mbedtls_ssl_set_verify(&msession->ssl,
  17348. impl::mbedtls_mask_hostname_mismatch_callback,
  17349. msession);
  17350. }
  17351. }
  17352. return true;
  17353. }
  17354. inline TlsError connect(session_t session) {
  17355. TlsError err;
  17356. if (!session) {
  17357. err.code = ErrorCode::Fatal;
  17358. return err;
  17359. }
  17360. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17361. int ret;
  17362. do {
  17363. ret = mbedtls_ssl_handshake(&msession->ssl);
  17364. } while (impl::mbedtls_is_session_ticket(ret));
  17365. if (ret == 0) {
  17366. err.code = ErrorCode::Success;
  17367. } else {
  17368. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17369. impl::mbedtls_last_error() = ret;
  17370. }
  17371. return err;
  17372. }
  17373. inline TlsError accept(session_t session) {
  17374. // Same as connect for Mbed TLS - handshake works for both client and server
  17375. auto result = connect(session);
  17376. // After successful handshake, capture SNI from thread-local storage
  17377. if (result.code == ErrorCode::Success && session) {
  17378. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17379. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17380. impl::mbedpending_sni().clear();
  17381. }
  17382. return result;
  17383. }
  17384. inline bool connect_nonblocking(session_t session, socket_t sock,
  17385. time_t timeout_sec, time_t timeout_usec,
  17386. TlsError *err) {
  17387. if (!session) {
  17388. if (err) { err->code = ErrorCode::Fatal; }
  17389. return false;
  17390. }
  17391. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17392. // Set socket to non-blocking mode
  17393. detail::set_nonblocking(sock, true);
  17394. auto cleanup =
  17395. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17396. int ret;
  17397. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17398. // Non-fatal TLS 1.3 ticket; retry immediately.
  17399. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17400. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17401. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17402. continue;
  17403. }
  17404. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17405. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17406. continue;
  17407. }
  17408. }
  17409. // TlsError or timeout
  17410. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17411. impl::mbedtls_last_error() = ret;
  17412. return false;
  17413. }
  17414. if (err) { err->code = ErrorCode::Success; }
  17415. return true;
  17416. }
  17417. inline bool accept_nonblocking(session_t session, socket_t sock,
  17418. time_t timeout_sec, time_t timeout_usec,
  17419. TlsError *err) {
  17420. // Same implementation as connect for Mbed TLS
  17421. bool result =
  17422. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17423. // After successful handshake, capture SNI from thread-local storage
  17424. if (result && session) {
  17425. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17426. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17427. impl::mbedpending_sni().clear();
  17428. }
  17429. return result;
  17430. }
  17431. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17432. if (!session || !buf) {
  17433. err.code = ErrorCode::Fatal;
  17434. return -1;
  17435. }
  17436. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17437. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17438. if (msession->has_peeked_byte) {
  17439. if (len == 0) { return 0; }
  17440. auto p = static_cast<unsigned char *>(buf);
  17441. p[0] = msession->peeked_byte;
  17442. msession->has_peeked_byte = false;
  17443. size_t n = 1;
  17444. // Top up with any already-decrypted bytes without risking a block.
  17445. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17446. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17447. if (extra > 0) { n += static_cast<size_t>(extra); }
  17448. }
  17449. err.code = ErrorCode::Success;
  17450. return static_cast<ssize_t>(n);
  17451. }
  17452. int ret;
  17453. do {
  17454. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17455. len);
  17456. } while (impl::mbedtls_is_session_ticket(ret));
  17457. if (ret > 0) {
  17458. err.code = ErrorCode::Success;
  17459. return static_cast<ssize_t>(ret);
  17460. }
  17461. if (ret == 0) {
  17462. err.code = ErrorCode::PeerClosed;
  17463. return 0;
  17464. }
  17465. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17466. err.backend_code = static_cast<uint64_t>(-ret);
  17467. impl::mbedtls_last_error() = ret;
  17468. // mbedTLS signals a clean close_notify via a negative error code rather
  17469. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17470. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17471. return -1;
  17472. }
  17473. inline ssize_t write(session_t session, const void *buf, size_t len,
  17474. TlsError &err) {
  17475. if (!session || !buf) {
  17476. err.code = ErrorCode::Fatal;
  17477. return -1;
  17478. }
  17479. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17480. int ret;
  17481. do {
  17482. ret = mbedtls_ssl_write(&msession->ssl,
  17483. static_cast<const unsigned char *>(buf), len);
  17484. } while (impl::mbedtls_is_session_ticket(ret));
  17485. if (ret > 0) {
  17486. err.code = ErrorCode::Success;
  17487. return static_cast<ssize_t>(ret);
  17488. }
  17489. if (ret == 0) {
  17490. err.code = ErrorCode::PeerClosed;
  17491. return 0;
  17492. }
  17493. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17494. err.backend_code = static_cast<uint64_t>(-ret);
  17495. impl::mbedtls_last_error() = ret;
  17496. return -1;
  17497. }
  17498. inline int pending(const_session_t session) {
  17499. if (!session) { return 0; }
  17500. auto msession =
  17501. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17502. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17503. (msession->has_peeked_byte ? 1 : 0);
  17504. }
  17505. inline void shutdown(session_t session, bool graceful) {
  17506. if (!session) { return; }
  17507. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17508. if (graceful) {
  17509. // Try to send close_notify, but don't block forever
  17510. int ret;
  17511. int attempts = 0;
  17512. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17513. attempts < 3) {
  17514. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17515. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17516. break;
  17517. }
  17518. attempts++;
  17519. }
  17520. }
  17521. }
  17522. inline bool is_peer_closed(session_t session, socket_t sock) {
  17523. if (!session || sock == INVALID_SOCKET) { return true; }
  17524. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17525. // Check if there's already decrypted or pushed-back data available.
  17526. // If so, the connection is definitely alive.
  17527. if (msession->has_peeked_byte ||
  17528. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17529. return false;
  17530. }
  17531. // Set socket to non-blocking to avoid blocking on read
  17532. detail::set_nonblocking(sock, true);
  17533. auto cleanup =
  17534. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17535. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17536. // on application data — e.g. a response that already arrived — push the
  17537. // byte back so the next read() delivers it instead of losing it.
  17538. unsigned char buf;
  17539. int ret;
  17540. do {
  17541. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17542. } while (impl::mbedtls_is_session_ticket(ret));
  17543. // If we got data or WANT_READ (would block), connection is alive
  17544. if (ret > 0) {
  17545. msession->peeked_byte = buf;
  17546. msession->has_peeked_byte = true;
  17547. return false;
  17548. }
  17549. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17550. // If we get a peer close notify or a connection reset, the peer is closed
  17551. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17552. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17553. }
  17554. inline cert_t get_peer_cert(const_session_t session) {
  17555. if (!session) { return nullptr; }
  17556. auto msession =
  17557. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17558. // Mbed TLS returns a pointer to the internal peer cert chain.
  17559. // WARNING: This pointer is only valid while the session is active.
  17560. // Do not use the certificate after calling free_session().
  17561. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17562. return const_cast<mbedtls_x509_crt *>(cert);
  17563. }
  17564. inline void free_cert(cert_t cert) {
  17565. // Mbed TLS: peer certificate is owned by the SSL context.
  17566. // No-op here, but callers should still call this for cross-backend
  17567. // portability.
  17568. (void)cert;
  17569. }
  17570. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17571. if (!cert || !hostname) { return false; }
  17572. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17573. std::string host_str(hostname);
  17574. // Check if hostname is an IP address (IPv4 or IPv6)
  17575. unsigned char ip_bytes[16];
  17576. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17577. auto is_ip = ip_len > 0;
  17578. // Check Subject Alternative Names (SAN)
  17579. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17580. // - DNS names: raw string bytes
  17581. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17582. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17583. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17584. const unsigned char *p = san->buf.p;
  17585. size_t len = san->buf.len;
  17586. if (is_ip) {
  17587. // For an IP host, only a matching iPAddress SAN of the same family
  17588. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17589. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17590. } else {
  17591. // Check if this SAN is a DNS name (printable ASCII string)
  17592. bool is_dns = len > 0;
  17593. for (size_t i = 0; i < len && is_dns; i++) {
  17594. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17595. }
  17596. if (is_dns) {
  17597. std::string san_name(reinterpret_cast<const char *>(p), len);
  17598. if (detail::match_hostname(san_name, host_str)) { return true; }
  17599. }
  17600. }
  17601. san = san->next;
  17602. }
  17603. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17604. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17605. // the OpenSSL backend's X509_check_ip behaves the same way).
  17606. if (!is_ip) {
  17607. char cn[256];
  17608. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17609. if (ret > 0) {
  17610. std::string cn_str(cn);
  17611. // Look for "CN=" in the DN string
  17612. size_t cn_pos = cn_str.find("CN=");
  17613. if (cn_pos != std::string::npos) {
  17614. size_t start = cn_pos + 3;
  17615. size_t end = cn_str.find(',', start);
  17616. std::string cn_value =
  17617. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17618. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17619. }
  17620. }
  17621. }
  17622. return false;
  17623. }
  17624. inline uint64_t hostname_mismatch_code() {
  17625. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17626. }
  17627. inline long get_verify_result(const_session_t session) {
  17628. if (!session) { return -1; }
  17629. auto msession =
  17630. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17631. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17632. // Return 0 (X509_V_OK equivalent) if verification passed
  17633. return flags == 0 ? 0 : static_cast<long>(flags);
  17634. }
  17635. inline std::string get_cert_subject_cn(cert_t cert) {
  17636. if (!cert) return "";
  17637. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17638. // Find the CN in the subject
  17639. const mbedtls_x509_name *name = &x509->subject;
  17640. while (name != nullptr) {
  17641. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17642. return std::string(reinterpret_cast<const char *>(name->val.p),
  17643. name->val.len);
  17644. }
  17645. name = name->next;
  17646. }
  17647. return "";
  17648. }
  17649. inline std::string get_cert_issuer_name(cert_t cert) {
  17650. if (!cert) return "";
  17651. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17652. // Build a human-readable issuer name string
  17653. char buf[512];
  17654. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17655. if (ret < 0) return "";
  17656. return std::string(buf);
  17657. }
  17658. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17659. sans.clear();
  17660. if (!cert) return false;
  17661. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17662. // Parse the Subject Alternative Name extension
  17663. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17664. while (cur != nullptr) {
  17665. if (cur->buf.len > 0) {
  17666. // Mbed TLS stores SAN as ASN.1 sequences
  17667. // The tag byte indicates the type
  17668. const unsigned char *p = cur->buf.p;
  17669. size_t len = cur->buf.len;
  17670. // First byte is the tag
  17671. unsigned char tag = *p;
  17672. p++;
  17673. len--;
  17674. // Parse length (simple single-byte length assumed)
  17675. if (len > 0 && *p < 0x80) {
  17676. size_t value_len = *p;
  17677. p++;
  17678. len--;
  17679. if (value_len <= len) {
  17680. SanEntry entry;
  17681. // ASN.1 context tags for GeneralName
  17682. switch (tag & 0x1F) {
  17683. case 2: // dNSName
  17684. entry.type = SanType::DNS;
  17685. entry.value =
  17686. std::string(reinterpret_cast<const char *>(p), value_len);
  17687. break;
  17688. case 7: // iPAddress
  17689. entry.type = SanType::IP;
  17690. if (value_len == 4) {
  17691. // IPv4
  17692. char buf[16];
  17693. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17694. entry.value = buf;
  17695. } else if (value_len == 16) {
  17696. // IPv6
  17697. char buf[64];
  17698. snprintf(buf, sizeof(buf),
  17699. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17700. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17701. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17702. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17703. entry.value = buf;
  17704. }
  17705. break;
  17706. case 1: // rfc822Name (email)
  17707. entry.type = SanType::EMAIL;
  17708. entry.value =
  17709. std::string(reinterpret_cast<const char *>(p), value_len);
  17710. break;
  17711. case 6: // uniformResourceIdentifier
  17712. entry.type = SanType::URI;
  17713. entry.value =
  17714. std::string(reinterpret_cast<const char *>(p), value_len);
  17715. break;
  17716. default: entry.type = SanType::OTHER; break;
  17717. }
  17718. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17719. }
  17720. }
  17721. }
  17722. cur = cur->next;
  17723. }
  17724. return true;
  17725. }
  17726. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17727. time_t &not_after) {
  17728. if (!cert) return false;
  17729. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17730. // Convert mbedtls_x509_time to time_t
  17731. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17732. struct tm tm_time = {};
  17733. tm_time.tm_year = t.year - 1900;
  17734. tm_time.tm_mon = t.mon - 1;
  17735. tm_time.tm_mday = t.day;
  17736. tm_time.tm_hour = t.hour;
  17737. tm_time.tm_min = t.min;
  17738. tm_time.tm_sec = t.sec;
  17739. #ifdef _WIN32
  17740. return _mkgmtime(&tm_time);
  17741. #else
  17742. return timegm(&tm_time);
  17743. #endif
  17744. };
  17745. not_before = to_time_t(x509->valid_from);
  17746. not_after = to_time_t(x509->valid_to);
  17747. return true;
  17748. }
  17749. inline std::string get_cert_serial(cert_t cert) {
  17750. if (!cert) return "";
  17751. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17752. // Convert serial number to hex string
  17753. std::string result;
  17754. result.reserve(x509->serial.len * 2);
  17755. for (size_t i = 0; i < x509->serial.len; i++) {
  17756. char hex[3];
  17757. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  17758. result += hex;
  17759. }
  17760. return result;
  17761. }
  17762. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17763. if (!cert) return false;
  17764. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  17765. if (!crt->raw.p || crt->raw.len == 0) return false;
  17766. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  17767. return true;
  17768. }
  17769. inline const char *get_sni(const_session_t session) {
  17770. if (!session) return nullptr;
  17771. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  17772. // For server: return SNI received from client during handshake
  17773. if (!msession->sni_hostname.empty()) {
  17774. return msession->sni_hostname.c_str();
  17775. }
  17776. // For client: return the hostname set via set_sni
  17777. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  17778. return nullptr;
  17779. }
  17780. inline uint64_t peek_error() {
  17781. // Mbed TLS doesn't have an error queue, return the last error
  17782. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  17783. }
  17784. inline uint64_t get_error() {
  17785. // Mbed TLS doesn't have an error queue, return and clear the last error
  17786. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  17787. impl::mbedtls_last_error() = 0;
  17788. return err;
  17789. }
  17790. inline std::string error_string(uint64_t code) {
  17791. char buf[256];
  17792. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  17793. return std::string(buf);
  17794. }
  17795. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17796. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  17797. if (!ca_chain) { return nullptr; }
  17798. mbedtls_x509_crt_init(ca_chain);
  17799. // mbedtls_x509_crt_parse expects null-terminated PEM
  17800. int ret = mbedtls_x509_crt_parse(ca_chain,
  17801. reinterpret_cast<const unsigned char *>(pem),
  17802. len + 1); // +1 for null terminator
  17803. if (ret != 0) {
  17804. // Try without +1 in case PEM is already null-terminated
  17805. ret = mbedtls_x509_crt_parse(
  17806. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  17807. if (ret != 0) {
  17808. mbedtls_x509_crt_free(ca_chain);
  17809. delete ca_chain;
  17810. return nullptr;
  17811. }
  17812. }
  17813. return static_cast<ca_store_t>(ca_chain);
  17814. }
  17815. inline void free_ca_store(ca_store_t store) {
  17816. if (store) {
  17817. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17818. mbedtls_x509_crt_free(ca_chain);
  17819. delete ca_chain;
  17820. }
  17821. }
  17822. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17823. if (!ctx || !store) { return false; }
  17824. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17825. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17826. // Free existing CA chain
  17827. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17828. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17829. // Copy the CA chain (deep copy)
  17830. // Parse from the raw data of the source cert
  17831. mbedtls_x509_crt *src = ca_chain;
  17832. while (src != nullptr) {
  17833. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  17834. src->raw.len);
  17835. if (ret != 0) {
  17836. free_ca_store(store);
  17837. return false;
  17838. }
  17839. src = src->next;
  17840. }
  17841. // This function takes ownership of the store; the chain was deep-copied
  17842. // above, so release the source
  17843. free_ca_store(store);
  17844. // Update the SSL config to use the new CA chain
  17845. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17846. return true;
  17847. }
  17848. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17849. certs.clear();
  17850. if (!ctx) { return 0; }
  17851. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17852. // Iterate through the CA chain
  17853. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17854. while (cert != nullptr && cert->raw.len > 0) {
  17855. // Create a copy of the certificate for the caller
  17856. auto *copy = new mbedtls_x509_crt;
  17857. mbedtls_x509_crt_init(copy);
  17858. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  17859. if (ret == 0) {
  17860. certs.push_back(static_cast<cert_t>(copy));
  17861. } else {
  17862. mbedtls_x509_crt_free(copy);
  17863. delete copy;
  17864. }
  17865. cert = cert->next;
  17866. }
  17867. return certs.size();
  17868. }
  17869. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17870. std::vector<std::string> names;
  17871. if (!ctx) { return names; }
  17872. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17873. // Iterate through the CA chain
  17874. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17875. while (cert != nullptr && cert->raw.len > 0) {
  17876. char buf[512];
  17877. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  17878. if (ret > 0) { names.push_back(buf); }
  17879. cert = cert->next;
  17880. }
  17881. return names;
  17882. }
  17883. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17884. const char *key_pem, const char *password) {
  17885. if (!ctx || !cert_pem || !key_pem) { return false; }
  17886. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17887. // Free existing certificate and key
  17888. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  17889. mbedtls_pk_free(&mbed_ctx->own_key);
  17890. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  17891. mbedtls_pk_init(&mbed_ctx->own_key);
  17892. // Parse certificate PEM
  17893. int ret = mbedtls_x509_crt_parse(
  17894. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  17895. strlen(cert_pem) + 1);
  17896. if (ret != 0) {
  17897. impl::mbedtls_last_error() = ret;
  17898. return false;
  17899. }
  17900. // Parse private key PEM
  17901. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17902. ret = mbedtls_pk_parse_key(
  17903. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17904. strlen(key_pem) + 1,
  17905. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17906. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  17907. &mbed_ctx->ctr_drbg);
  17908. #else
  17909. ret = mbedtls_pk_parse_key(
  17910. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17911. strlen(key_pem) + 1,
  17912. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17913. password ? strlen(password) : 0);
  17914. #endif
  17915. if (ret != 0) {
  17916. impl::mbedtls_last_error() = ret;
  17917. return false;
  17918. }
  17919. // Configure SSL to use the new certificate and key
  17920. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  17921. &mbed_ctx->own_key);
  17922. if (ret != 0) {
  17923. impl::mbedtls_last_error() = ret;
  17924. return false;
  17925. }
  17926. return true;
  17927. }
  17928. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17929. if (!ctx || !ca_pem) { return false; }
  17930. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17931. // Free existing CA chain
  17932. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17933. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17934. // Parse CA PEM
  17935. int ret = mbedtls_x509_crt_parse(
  17936. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  17937. strlen(ca_pem) + 1);
  17938. if (ret != 0) {
  17939. impl::mbedtls_last_error() = ret;
  17940. return false;
  17941. }
  17942. // Update SSL config to use new CA chain
  17943. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17944. return true;
  17945. }
  17946. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17947. if (!ctx) { return false; }
  17948. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17949. impl::get_verify_callback() = std::move(callback);
  17950. mbed_ctx->has_verify_callback =
  17951. static_cast<bool>(impl::get_verify_callback());
  17952. if (mbed_ctx->has_verify_callback) {
  17953. // Set OPTIONAL mode to ensure callback is called even when verification
  17954. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  17955. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  17956. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  17957. nullptr);
  17958. } else {
  17959. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  17960. }
  17961. return true;
  17962. }
  17963. inline long get_verify_error(const_session_t session) {
  17964. if (!session) { return -1; }
  17965. auto *msession =
  17966. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17967. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  17968. }
  17969. inline std::string verify_error_string(long error_code) {
  17970. if (error_code == 0) { return ""; }
  17971. char buf[256];
  17972. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  17973. static_cast<uint32_t>(error_code));
  17974. // Remove trailing newline if present
  17975. std::string result(buf);
  17976. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  17977. result.pop_back();
  17978. }
  17979. return result;
  17980. }
  17981. } // namespace tls
  17982. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  17983. /*
  17984. * Group 10: TLS abstraction layer - wolfSSL backend
  17985. */
  17986. /*
  17987. * wolfSSL Backend Implementation
  17988. */
  17989. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  17990. namespace tls {
  17991. namespace impl {
  17992. // wolfSSL session wrapper
  17993. struct WolfSSLSession {
  17994. WOLFSSL *ssl = nullptr;
  17995. socket_t sock = INVALID_SOCKET;
  17996. std::string hostname; // For client: set via set_sni
  17997. std::string sni_hostname; // For server: received from client via SNI callback
  17998. WolfSSLSession() = default;
  17999. ~WolfSSLSession() {
  18000. if (ssl) { wolfSSL_free(ssl); }
  18001. }
  18002. WolfSSLSession(const WolfSSLSession &) = delete;
  18003. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18004. };
  18005. // Thread-local error code accessor for wolfSSL
  18006. inline uint64_t &wolfssl_last_error() {
  18007. static thread_local uint64_t err = 0;
  18008. return err;
  18009. }
  18010. // Helper to map wolfSSL error to ErrorCode.
  18011. // ssl_error is the value from wolfSSL_get_error().
  18012. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18013. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18014. int &out_errno) {
  18015. switch (ssl_error) {
  18016. case SSL_ERROR_NONE: return ErrorCode::Success;
  18017. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18018. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18019. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18020. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18021. default:
  18022. if (ssl) {
  18023. // wolfSSL stores the low-level error code as a negative value.
  18024. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18025. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18026. if (low_err == DOMAIN_NAME_MISMATCH) {
  18027. return ErrorCode::HostnameMismatch;
  18028. }
  18029. // Check verify result to distinguish cert verification from generic SSL
  18030. // errors.
  18031. long vr = wolfSSL_get_verify_result(ssl);
  18032. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18033. }
  18034. return ErrorCode::Fatal;
  18035. }
  18036. }
  18037. // WolfSSLContext constructor/destructor implementations
  18038. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18039. inline WolfSSLContext::~WolfSSLContext() {
  18040. if (ctx) { wolfSSL_CTX_free(ctx); }
  18041. }
  18042. // Thread-local storage for SNI captured during handshake
  18043. inline std::string &wolfssl_pending_sni() {
  18044. static thread_local std::string sni;
  18045. return sni;
  18046. }
  18047. // SNI callback for wolfSSL server to capture client's SNI hostname
  18048. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18049. (void)ret;
  18050. (void)exArg;
  18051. void *name_data = nullptr;
  18052. unsigned short name_len =
  18053. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18054. if (name_data && name_len > 0) {
  18055. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18056. name_len);
  18057. } else {
  18058. wolfssl_pending_sni().clear();
  18059. }
  18060. return 0; // Continue regardless
  18061. }
  18062. // wolfSSL verify callback wrapper
  18063. inline int wolfssl_verify_callback(int preverify_ok,
  18064. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18065. auto &callback = get_verify_callback();
  18066. if (!callback) { return preverify_ok; }
  18067. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18068. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18069. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18070. // Get the WOLFSSL object from the X509_STORE_CTX
  18071. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18072. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18073. VerifyContext verify_ctx;
  18074. verify_ctx.session = static_cast<session_t>(ssl);
  18075. verify_ctx.cert = static_cast<cert_t>(cert);
  18076. verify_ctx.depth = depth;
  18077. verify_ctx.preverify_ok = (preverify_ok != 0);
  18078. verify_ctx.error_code = static_cast<long>(err);
  18079. if (err != 0) {
  18080. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18081. } else {
  18082. verify_ctx.error_string = nullptr;
  18083. }
  18084. bool accepted = callback(verify_ctx);
  18085. return accepted ? 1 : 0;
  18086. }
  18087. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18088. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18089. wolfSSL_CTX_set_default_passwd_cb(
  18090. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18091. auto *pwd = static_cast<const char *>(userdata);
  18092. if (!pwd) return 0;
  18093. auto len = static_cast<int>(strlen(pwd));
  18094. if (len > size) len = size;
  18095. memcpy(buf, pwd, static_cast<size_t>(len));
  18096. return len;
  18097. });
  18098. }
  18099. } // namespace impl
  18100. inline ctx_t create_client_context() {
  18101. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18102. if (!ctx) { return nullptr; }
  18103. ctx->is_server = false;
  18104. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18105. if (!method) {
  18106. delete ctx;
  18107. return nullptr;
  18108. }
  18109. ctx->ctx = wolfSSL_CTX_new(method);
  18110. if (!ctx->ctx) {
  18111. delete ctx;
  18112. return nullptr;
  18113. }
  18114. // Default: verify peer certificate
  18115. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18116. return static_cast<ctx_t>(ctx);
  18117. }
  18118. inline ctx_t create_server_context() {
  18119. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18120. if (!ctx) { return nullptr; }
  18121. ctx->is_server = true;
  18122. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18123. if (!method) {
  18124. delete ctx;
  18125. return nullptr;
  18126. }
  18127. ctx->ctx = wolfSSL_CTX_new(method);
  18128. if (!ctx->ctx) {
  18129. delete ctx;
  18130. return nullptr;
  18131. }
  18132. // Default: don't verify client
  18133. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18134. // Enable SNI on server
  18135. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18136. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18137. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18138. return static_cast<ctx_t>(ctx);
  18139. }
  18140. inline void free_context(ctx_t ctx) {
  18141. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18142. }
  18143. inline bool set_min_version(ctx_t ctx, Version version) {
  18144. if (!ctx) { return false; }
  18145. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18146. int min_ver = WOLFSSL_TLSV1_2;
  18147. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18148. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18149. }
  18150. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18151. if (!ctx || !pem) { return false; }
  18152. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18153. int ret = wolfSSL_CTX_load_verify_buffer(
  18154. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18155. static_cast<long>(len), SSL_FILETYPE_PEM);
  18156. if (ret != SSL_SUCCESS) {
  18157. impl::wolfssl_last_error() =
  18158. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18159. return false;
  18160. }
  18161. wctx->ca_pem_data_.append(pem, len);
  18162. return true;
  18163. }
  18164. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18165. if (!ctx || !file_path) { return false; }
  18166. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18167. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18168. if (ret != SSL_SUCCESS) {
  18169. impl::wolfssl_last_error() =
  18170. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18171. return false;
  18172. }
  18173. return true;
  18174. }
  18175. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18176. if (!ctx || !dir_path) { return false; }
  18177. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18178. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18179. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18180. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18181. // immediately. Return true even on failure since the CA file may have
  18182. // already been loaded, matching OpenSSL's lenient behavior.
  18183. (void)ret;
  18184. return true;
  18185. }
  18186. inline bool load_system_certs(ctx_t ctx) {
  18187. if (!ctx) { return false; }
  18188. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18189. bool loaded = false;
  18190. #ifdef _WIN32
  18191. loaded = impl::enumerate_windows_system_certs(
  18192. [&](const unsigned char *data, size_t len) {
  18193. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18194. static_cast<long>(len),
  18195. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18196. });
  18197. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18198. loaded = impl::enumerate_macos_keychain_certs(
  18199. [&](const unsigned char *data, size_t len) {
  18200. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18201. static_cast<long>(len),
  18202. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18203. });
  18204. #else
  18205. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18206. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18207. SSL_SUCCESS) {
  18208. loaded = true;
  18209. break;
  18210. }
  18211. }
  18212. if (!loaded) {
  18213. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18214. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18215. SSL_SUCCESS) {
  18216. loaded = true;
  18217. break;
  18218. }
  18219. }
  18220. }
  18221. #endif
  18222. return loaded;
  18223. }
  18224. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18225. const char *password) {
  18226. if (!ctx || !cert || !key) { return false; }
  18227. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18228. // Load certificate
  18229. int ret = wolfSSL_CTX_use_certificate_buffer(
  18230. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18231. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18232. if (ret != SSL_SUCCESS) {
  18233. impl::wolfssl_last_error() =
  18234. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18235. return false;
  18236. }
  18237. // Set password callback if password is provided
  18238. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18239. // Load private key
  18240. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18241. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18242. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18243. if (ret != SSL_SUCCESS) {
  18244. impl::wolfssl_last_error() =
  18245. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18246. return false;
  18247. }
  18248. // Verify that the certificate and private key match
  18249. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18250. }
  18251. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18252. const char *key_path, const char *password) {
  18253. if (!ctx || !cert_path || !key_path) { return false; }
  18254. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18255. // Load certificate file
  18256. int ret =
  18257. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18258. if (ret != SSL_SUCCESS) {
  18259. impl::wolfssl_last_error() =
  18260. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18261. return false;
  18262. }
  18263. // Set password callback if password is provided
  18264. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18265. // Load private key file
  18266. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18267. if (ret != SSL_SUCCESS) {
  18268. impl::wolfssl_last_error() =
  18269. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18270. return false;
  18271. }
  18272. // Verify that the certificate and private key match
  18273. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18274. }
  18275. inline void set_verify_client(ctx_t ctx, bool require) {
  18276. if (!ctx) { return; }
  18277. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18278. wctx->verify_client = require;
  18279. if (require) {
  18280. wolfSSL_CTX_set_verify(
  18281. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18282. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18283. } else {
  18284. if (wctx->has_verify_callback) {
  18285. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18286. impl::wolfssl_verify_callback);
  18287. } else {
  18288. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18289. }
  18290. }
  18291. }
  18292. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18293. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18294. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18295. auto session = new (std::nothrow) impl::WolfSSLSession();
  18296. if (!session) { return nullptr; }
  18297. session->sock = sock;
  18298. session->ssl = wolfSSL_new(wctx->ctx);
  18299. if (!session->ssl) {
  18300. impl::wolfssl_last_error() =
  18301. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18302. delete session;
  18303. return nullptr;
  18304. }
  18305. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18306. return static_cast<session_t>(session);
  18307. }
  18308. inline void free_session(session_t session) {
  18309. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18310. }
  18311. inline bool set_sni(session_t session, const char *hostname,
  18312. bool verify_hostname) {
  18313. if (!session || !hostname) { return false; }
  18314. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18315. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18316. static_cast<word16>(strlen(hostname)));
  18317. if (ret != WOLFSSL_SUCCESS) {
  18318. impl::wolfssl_last_error() =
  18319. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18320. return false;
  18321. }
  18322. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18323. // separately from the SNI extension sent above; skip it when hostname
  18324. // verification is disabled so only the chain is checked, matching OpenSSL.
  18325. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18326. wsession->hostname = hostname;
  18327. return true;
  18328. }
  18329. inline TlsError connect(session_t session) {
  18330. TlsError err;
  18331. if (!session) {
  18332. err.code = ErrorCode::Fatal;
  18333. return err;
  18334. }
  18335. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18336. int ret = wolfSSL_connect(wsession->ssl);
  18337. if (ret == SSL_SUCCESS) {
  18338. err.code = ErrorCode::Success;
  18339. } else {
  18340. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18341. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18342. err.backend_code = static_cast<uint64_t>(ssl_error);
  18343. impl::wolfssl_last_error() = err.backend_code;
  18344. }
  18345. return err;
  18346. }
  18347. inline TlsError accept(session_t session) {
  18348. TlsError err;
  18349. if (!session) {
  18350. err.code = ErrorCode::Fatal;
  18351. return err;
  18352. }
  18353. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18354. int ret = wolfSSL_accept(wsession->ssl);
  18355. if (ret == SSL_SUCCESS) {
  18356. err.code = ErrorCode::Success;
  18357. // Capture SNI from thread-local storage after successful handshake
  18358. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18359. impl::wolfssl_pending_sni().clear();
  18360. } else {
  18361. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18362. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18363. err.backend_code = static_cast<uint64_t>(ssl_error);
  18364. impl::wolfssl_last_error() = err.backend_code;
  18365. }
  18366. return err;
  18367. }
  18368. inline bool connect_nonblocking(session_t session, socket_t sock,
  18369. time_t timeout_sec, time_t timeout_usec,
  18370. TlsError *err) {
  18371. if (!session) {
  18372. if (err) { err->code = ErrorCode::Fatal; }
  18373. return false;
  18374. }
  18375. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18376. // Set socket to non-blocking mode
  18377. detail::set_nonblocking(sock, true);
  18378. auto cleanup =
  18379. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18380. int ret;
  18381. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18382. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18383. if (ssl_error == SSL_ERROR_WANT_READ) {
  18384. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18385. continue;
  18386. }
  18387. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18388. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18389. continue;
  18390. }
  18391. }
  18392. // Error or timeout
  18393. if (err) {
  18394. err->code =
  18395. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18396. err->backend_code = static_cast<uint64_t>(ssl_error);
  18397. }
  18398. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18399. return false;
  18400. }
  18401. if (err) { err->code = ErrorCode::Success; }
  18402. return true;
  18403. }
  18404. inline bool accept_nonblocking(session_t session, socket_t sock,
  18405. time_t timeout_sec, time_t timeout_usec,
  18406. TlsError *err) {
  18407. if (!session) {
  18408. if (err) { err->code = ErrorCode::Fatal; }
  18409. return false;
  18410. }
  18411. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18412. // Set socket to non-blocking mode
  18413. detail::set_nonblocking(sock, true);
  18414. auto cleanup =
  18415. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18416. int ret;
  18417. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18418. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18419. if (ssl_error == SSL_ERROR_WANT_READ) {
  18420. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18421. continue;
  18422. }
  18423. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18424. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18425. continue;
  18426. }
  18427. }
  18428. // Error or timeout
  18429. if (err) {
  18430. err->code =
  18431. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18432. err->backend_code = static_cast<uint64_t>(ssl_error);
  18433. }
  18434. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18435. return false;
  18436. }
  18437. if (err) { err->code = ErrorCode::Success; }
  18438. // Capture SNI from thread-local storage after successful handshake
  18439. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18440. impl::wolfssl_pending_sni().clear();
  18441. return true;
  18442. }
  18443. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18444. if (!session || !buf) {
  18445. err.code = ErrorCode::Fatal;
  18446. return -1;
  18447. }
  18448. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18449. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18450. if (ret > 0) {
  18451. err.code = ErrorCode::Success;
  18452. return static_cast<ssize_t>(ret);
  18453. }
  18454. if (ret == 0) {
  18455. err.code = ErrorCode::PeerClosed;
  18456. return 0;
  18457. }
  18458. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18459. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18460. err.backend_code = static_cast<uint64_t>(ssl_error);
  18461. impl::wolfssl_last_error() = err.backend_code;
  18462. return -1;
  18463. }
  18464. inline ssize_t write(session_t session, const void *buf, size_t len,
  18465. TlsError &err) {
  18466. if (!session || !buf) {
  18467. err.code = ErrorCode::Fatal;
  18468. return -1;
  18469. }
  18470. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18471. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18472. if (ret > 0) {
  18473. err.code = ErrorCode::Success;
  18474. return static_cast<ssize_t>(ret);
  18475. }
  18476. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18477. // Treat this as an error (return -1) so callers don't spin in a
  18478. // write loop adding zero to the offset.
  18479. if (ret == 0) {
  18480. err.code = ErrorCode::PeerClosed;
  18481. return -1;
  18482. }
  18483. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18484. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18485. err.backend_code = static_cast<uint64_t>(ssl_error);
  18486. impl::wolfssl_last_error() = err.backend_code;
  18487. return -1;
  18488. }
  18489. inline int pending(const_session_t session) {
  18490. if (!session) { return 0; }
  18491. auto wsession =
  18492. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18493. return wolfSSL_pending(wsession->ssl);
  18494. }
  18495. inline void shutdown(session_t session, bool graceful) {
  18496. if (!session) { return; }
  18497. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18498. if (graceful) {
  18499. int ret;
  18500. int attempts = 0;
  18501. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18502. attempts < 3) {
  18503. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18504. if (ssl_error != SSL_ERROR_WANT_READ &&
  18505. ssl_error != SSL_ERROR_WANT_WRITE) {
  18506. break;
  18507. }
  18508. attempts++;
  18509. }
  18510. } else {
  18511. wolfSSL_shutdown(wsession->ssl);
  18512. }
  18513. }
  18514. inline bool is_peer_closed(session_t session, socket_t sock) {
  18515. if (!session || sock == INVALID_SOCKET) { return true; }
  18516. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18517. // Check if there's already decrypted data available
  18518. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18519. // Set socket to non-blocking to avoid blocking on read
  18520. detail::set_nonblocking(sock, true);
  18521. auto cleanup =
  18522. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18523. // Peek 1 byte to check connection status without consuming data
  18524. unsigned char buf;
  18525. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18526. // If we got data or WANT_READ (would block), connection is alive
  18527. if (ret > 0) { return false; }
  18528. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18529. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18530. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18531. ret == 0;
  18532. }
  18533. inline cert_t get_peer_cert(const_session_t session) {
  18534. if (!session) { return nullptr; }
  18535. auto wsession =
  18536. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18537. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18538. return static_cast<cert_t>(cert);
  18539. }
  18540. inline void free_cert(cert_t cert) {
  18541. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18542. }
  18543. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18544. if (!cert || !hostname) { return false; }
  18545. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18546. std::string host_str(hostname);
  18547. // Check if hostname is an IP address (IPv4 or IPv6)
  18548. unsigned char ip_bytes[16];
  18549. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18550. auto is_ip = ip_len > 0;
  18551. // Check Subject Alternative Names
  18552. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18553. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18554. if (san_names) {
  18555. int san_count = wolfSSL_sk_num(san_names);
  18556. for (int i = 0; i < san_count; i++) {
  18557. auto *names =
  18558. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18559. if (!names) continue;
  18560. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18561. // DNS name
  18562. unsigned char *dns_name = nullptr;
  18563. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18564. if (dns_name && dns_len > 0) {
  18565. std::string san_name(reinterpret_cast<char *>(dns_name),
  18566. static_cast<size_t>(dns_len));
  18567. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18568. if (detail::match_hostname(san_name, host_str)) {
  18569. wolfSSL_sk_free(san_names);
  18570. return true;
  18571. }
  18572. }
  18573. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18574. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18575. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18576. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18577. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18578. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18579. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18580. wolfSSL_sk_free(san_names);
  18581. return true;
  18582. }
  18583. }
  18584. }
  18585. wolfSSL_sk_free(san_names);
  18586. }
  18587. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18588. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18589. // the OpenSSL backend's X509_check_ip behaves the same way).
  18590. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18591. if (subject) {
  18592. char cn[256] = {};
  18593. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18594. sizeof(cn));
  18595. if (cn_len > 0) {
  18596. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18597. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18598. }
  18599. }
  18600. return false;
  18601. }
  18602. inline uint64_t hostname_mismatch_code() {
  18603. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18604. }
  18605. inline long get_verify_result(const_session_t session) {
  18606. if (!session) { return -1; }
  18607. auto wsession =
  18608. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18609. long result = wolfSSL_get_verify_result(wsession->ssl);
  18610. return result;
  18611. }
  18612. inline std::string get_cert_subject_cn(cert_t cert) {
  18613. if (!cert) return "";
  18614. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18615. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18616. if (!subject) return "";
  18617. char cn[256] = {};
  18618. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18619. sizeof(cn));
  18620. if (cn_len <= 0) return "";
  18621. return std::string(cn, static_cast<size_t>(cn_len));
  18622. }
  18623. inline std::string get_cert_issuer_name(cert_t cert) {
  18624. if (!cert) return "";
  18625. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18626. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18627. if (!issuer) return "";
  18628. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18629. if (!name_str) return "";
  18630. std::string result(name_str);
  18631. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18632. return result;
  18633. }
  18634. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18635. sans.clear();
  18636. if (!cert) return false;
  18637. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18638. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18639. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18640. if (!san_names) return true; // No SANs is not an error
  18641. int count = wolfSSL_sk_num(san_names);
  18642. for (int i = 0; i < count; i++) {
  18643. auto *name =
  18644. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18645. if (!name) continue;
  18646. SanEntry entry;
  18647. switch (name->type) {
  18648. case WOLFSSL_GEN_DNS: {
  18649. entry.type = SanType::DNS;
  18650. unsigned char *dns_name = nullptr;
  18651. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18652. if (dns_name && dns_len > 0) {
  18653. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18654. static_cast<size_t>(dns_len));
  18655. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18656. }
  18657. break;
  18658. }
  18659. case WOLFSSL_GEN_IPADD: {
  18660. entry.type = SanType::IP;
  18661. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18662. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18663. if (ip_data && ip_len == 4) {
  18664. char buf[16];
  18665. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18666. ip_data[2], ip_data[3]);
  18667. entry.value = buf;
  18668. } else if (ip_data && ip_len == 16) {
  18669. char buf[64];
  18670. snprintf(buf, sizeof(buf),
  18671. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18672. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18673. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18674. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18675. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18676. ip_data[14], ip_data[15]);
  18677. entry.value = buf;
  18678. }
  18679. break;
  18680. }
  18681. case WOLFSSL_GEN_EMAIL:
  18682. entry.type = SanType::EMAIL;
  18683. {
  18684. unsigned char *email = nullptr;
  18685. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18686. if (email && email_len > 0) {
  18687. entry.value = std::string(reinterpret_cast<char *>(email),
  18688. static_cast<size_t>(email_len));
  18689. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18690. }
  18691. }
  18692. break;
  18693. case WOLFSSL_GEN_URI:
  18694. entry.type = SanType::URI;
  18695. {
  18696. unsigned char *uri = nullptr;
  18697. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18698. &uri, name->d.uniformResourceIdentifier);
  18699. if (uri && uri_len > 0) {
  18700. entry.value = std::string(reinterpret_cast<char *>(uri),
  18701. static_cast<size_t>(uri_len));
  18702. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18703. }
  18704. }
  18705. break;
  18706. default: entry.type = SanType::OTHER; break;
  18707. }
  18708. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18709. }
  18710. wolfSSL_sk_free(san_names);
  18711. return true;
  18712. }
  18713. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18714. time_t &not_after) {
  18715. if (!cert) return false;
  18716. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18717. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18718. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18719. if (!nb || !na) return false;
  18720. // wolfSSL_ASN1_TIME_to_tm is available
  18721. struct tm tm_nb = {}, tm_na = {};
  18722. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18723. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  18724. #ifdef _WIN32
  18725. not_before = _mkgmtime(&tm_nb);
  18726. not_after = _mkgmtime(&tm_na);
  18727. #else
  18728. not_before = timegm(&tm_nb);
  18729. not_after = timegm(&tm_na);
  18730. #endif
  18731. return true;
  18732. }
  18733. inline std::string get_cert_serial(cert_t cert) {
  18734. if (!cert) return "";
  18735. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18736. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  18737. if (!serial_asn1) return "";
  18738. // Get the serial number data
  18739. int len = serial_asn1->length;
  18740. unsigned char *data = serial_asn1->data;
  18741. if (!data || len <= 0) return "";
  18742. std::string result;
  18743. result.reserve(static_cast<size_t>(len) * 2);
  18744. for (int i = 0; i < len; i++) {
  18745. char hex[3];
  18746. snprintf(hex, sizeof(hex), "%02X", data[i]);
  18747. result += hex;
  18748. }
  18749. return result;
  18750. }
  18751. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18752. if (!cert) return false;
  18753. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18754. int der_len = 0;
  18755. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  18756. if (!der_data || der_len <= 0) return false;
  18757. der.assign(der_data, der_data + der_len);
  18758. return true;
  18759. }
  18760. inline const char *get_sni(const_session_t session) {
  18761. if (!session) return nullptr;
  18762. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  18763. // For server: return SNI received from client during handshake
  18764. if (!wsession->sni_hostname.empty()) {
  18765. return wsession->sni_hostname.c_str();
  18766. }
  18767. // For client: return the hostname set via set_sni
  18768. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  18769. return nullptr;
  18770. }
  18771. inline uint64_t peek_error() {
  18772. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18773. }
  18774. inline uint64_t get_error() {
  18775. uint64_t err = impl::wolfssl_last_error();
  18776. impl::wolfssl_last_error() = 0;
  18777. return err;
  18778. }
  18779. inline std::string error_string(uint64_t code) {
  18780. char buf[256];
  18781. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  18782. return std::string(buf);
  18783. }
  18784. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18785. if (!pem || len == 0) { return nullptr; }
  18786. // Validate by attempting to load into a temporary ctx
  18787. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  18788. if (!tmp_ctx) { return nullptr; }
  18789. int ret = wolfSSL_CTX_load_verify_buffer(
  18790. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  18791. static_cast<long>(len), SSL_FILETYPE_PEM);
  18792. wolfSSL_CTX_free(tmp_ctx);
  18793. if (ret != SSL_SUCCESS) { return nullptr; }
  18794. return static_cast<ca_store_t>(
  18795. new impl::WolfSSLCAStore{std::string(pem, len)});
  18796. }
  18797. inline void free_ca_store(ca_store_t store) {
  18798. delete static_cast<impl::WolfSSLCAStore *>(store);
  18799. }
  18800. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18801. if (!ctx || !store) { return false; }
  18802. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18803. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  18804. int ret = wolfSSL_CTX_load_verify_buffer(
  18805. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  18806. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  18807. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  18808. // This function takes ownership of the store; the PEM data was copied into
  18809. // the context, so release the source
  18810. free_ca_store(store);
  18811. return ret == SSL_SUCCESS;
  18812. }
  18813. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18814. certs.clear();
  18815. if (!ctx) { return 0; }
  18816. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18817. if (wctx->ca_pem_data_.empty()) { return 0; }
  18818. const std::string &pem = wctx->ca_pem_data_;
  18819. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18820. const std::string end_marker = "-----END CERTIFICATE-----";
  18821. size_t pos = 0;
  18822. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18823. size_t end_pos = pem.find(end_marker, pos);
  18824. if (end_pos == std::string::npos) { break; }
  18825. end_pos += end_marker.size();
  18826. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18827. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18828. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18829. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18830. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18831. pos = end_pos;
  18832. }
  18833. return certs.size();
  18834. }
  18835. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18836. std::vector<std::string> names;
  18837. if (!ctx) { return names; }
  18838. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18839. if (wctx->ca_pem_data_.empty()) { return names; }
  18840. const std::string &pem = wctx->ca_pem_data_;
  18841. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18842. const std::string end_marker = "-----END CERTIFICATE-----";
  18843. size_t pos = 0;
  18844. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18845. size_t end_pos = pem.find(end_marker, pos);
  18846. if (end_pos == std::string::npos) { break; }
  18847. end_pos += end_marker.size();
  18848. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18849. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18850. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18851. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18852. if (x509) {
  18853. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18854. if (subject) {
  18855. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  18856. if (name_str) {
  18857. names.push_back(name_str);
  18858. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18859. }
  18860. }
  18861. wolfSSL_X509_free(x509);
  18862. }
  18863. pos = end_pos;
  18864. }
  18865. return names;
  18866. }
  18867. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18868. const char *key_pem, const char *password) {
  18869. if (!ctx || !cert_pem || !key_pem) { return false; }
  18870. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18871. // Load new certificate
  18872. int ret = wolfSSL_CTX_use_certificate_buffer(
  18873. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  18874. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  18875. if (ret != SSL_SUCCESS) {
  18876. impl::wolfssl_last_error() =
  18877. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18878. return false;
  18879. }
  18880. // Set password if provided
  18881. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18882. // Load new private key
  18883. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18884. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  18885. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  18886. if (ret != SSL_SUCCESS) {
  18887. impl::wolfssl_last_error() =
  18888. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18889. return false;
  18890. }
  18891. return true;
  18892. }
  18893. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18894. if (!ctx || !ca_pem) { return false; }
  18895. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18896. int ret = wolfSSL_CTX_load_verify_buffer(
  18897. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  18898. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  18899. if (ret != SSL_SUCCESS) {
  18900. impl::wolfssl_last_error() =
  18901. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18902. return false;
  18903. }
  18904. return true;
  18905. }
  18906. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18907. if (!ctx) { return false; }
  18908. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18909. impl::get_verify_callback() = std::move(callback);
  18910. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  18911. if (wctx->has_verify_callback) {
  18912. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18913. impl::wolfssl_verify_callback);
  18914. } else {
  18915. wolfSSL_CTX_set_verify(
  18916. wctx->ctx,
  18917. wctx->verify_client
  18918. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  18919. : SSL_VERIFY_NONE,
  18920. nullptr);
  18921. }
  18922. return true;
  18923. }
  18924. inline long get_verify_error(const_session_t session) {
  18925. if (!session) { return -1; }
  18926. auto *wsession =
  18927. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18928. return wolfSSL_get_verify_result(wsession->ssl);
  18929. }
  18930. inline std::string verify_error_string(long error_code) {
  18931. if (error_code == 0) { return ""; }
  18932. const char *str =
  18933. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  18934. return str ? std::string(str) : std::string();
  18935. }
  18936. } // namespace tls
  18937. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  18938. // WebSocket implementation
  18939. namespace ws {
  18940. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  18941. bool fin) {
  18942. std::lock_guard<std::mutex> lock(write_mutex_);
  18943. if (closed_) { return false; }
  18944. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  18945. }
  18946. inline ReadResult WebSocket::read(std::string &msg) {
  18947. std::unique_lock<std::mutex> read_lock(read_mutex_);
  18948. while (!closed_) {
  18949. Opcode opcode;
  18950. std::string payload;
  18951. bool fin;
  18952. impl::FrameRead r =
  18953. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  18954. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  18955. // A timeout landed on a frame boundary: the connection is untouched and
  18956. // still usable, so hand control back without closing it.
  18957. if (r == impl::FrameRead::Timeout) { return Timeout; }
  18958. if (r != impl::FrameRead::Ok) {
  18959. closed_ = true;
  18960. return Fail;
  18961. }
  18962. switch (opcode) {
  18963. case Opcode::Ping: {
  18964. std::lock_guard<std::mutex> lock(write_mutex_);
  18965. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  18966. payload.size(), true, !is_server_);
  18967. continue;
  18968. }
  18969. case Opcode::Pong: {
  18970. std::lock_guard<std::mutex> lock(ping_mutex_);
  18971. unacked_pings_ = 0;
  18972. continue;
  18973. }
  18974. case Opcode::Close: {
  18975. if (!closed_.exchange(true)) {
  18976. // Echo close frame back
  18977. std::lock_guard<std::mutex> lock(write_mutex_);
  18978. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  18979. payload.size(), true, !is_server_);
  18980. }
  18981. return Fail;
  18982. }
  18983. case Opcode::Text:
  18984. case Opcode::Binary: {
  18985. auto result = opcode == Opcode::Text ? Text : Binary;
  18986. msg = std::move(payload);
  18987. // Handle fragmentation
  18988. if (!fin) {
  18989. while (true) {
  18990. Opcode cont_opcode;
  18991. std::string cont_payload;
  18992. bool cont_fin;
  18993. // A timeout is not reportable here: half of a fragmented message is
  18994. // already in `msg` and read() has no way to resume it, so it is a
  18995. // failure like any other. Timeouts are only ever seen on a message
  18996. // boundary.
  18997. if (impl::read_websocket_frame(
  18998. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  18999. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19000. impl::FrameRead::Ok) {
  19001. closed_ = true;
  19002. return Fail;
  19003. }
  19004. if (cont_opcode == Opcode::Ping) {
  19005. std::lock_guard<std::mutex> lock(write_mutex_);
  19006. detail::write_websocket_frame(
  19007. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19008. true, !is_server_);
  19009. continue;
  19010. }
  19011. if (cont_opcode == Opcode::Pong) {
  19012. std::lock_guard<std::mutex> lock(ping_mutex_);
  19013. unacked_pings_ = 0;
  19014. continue;
  19015. }
  19016. if (cont_opcode == Opcode::Close) {
  19017. if (!closed_.exchange(true)) {
  19018. std::lock_guard<std::mutex> lock(write_mutex_);
  19019. detail::write_websocket_frame(
  19020. strm_, Opcode::Close, cont_payload.data(),
  19021. cont_payload.size(), true, !is_server_);
  19022. }
  19023. return Fail;
  19024. }
  19025. // RFC 6455: continuation frames must use opcode 0x0
  19026. if (cont_opcode != Opcode::Continuation) {
  19027. closed_ = true;
  19028. return Fail;
  19029. }
  19030. msg += cont_payload;
  19031. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19032. closed_ = true;
  19033. return Fail;
  19034. }
  19035. if (cont_fin) { break; }
  19036. }
  19037. }
  19038. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19039. if (result == Text && !impl::is_valid_utf8(msg)) {
  19040. // close() takes the read lock to wait for the peer's Close reply, so
  19041. // it must not run while this thread still holds it.
  19042. read_lock.unlock();
  19043. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19044. return Fail;
  19045. }
  19046. return result;
  19047. }
  19048. default: closed_ = true; return Fail;
  19049. }
  19050. }
  19051. return Fail;
  19052. }
  19053. inline bool WebSocket::send(const std::string &data) {
  19054. return send_frame(Opcode::Text, data.data(), data.size());
  19055. }
  19056. inline bool WebSocket::send(const char *data, size_t len) {
  19057. return send_frame(Opcode::Binary, data, len);
  19058. }
  19059. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19060. if (closed_.exchange(true)) { return; }
  19061. ping_cv_.notify_all();
  19062. std::string payload;
  19063. auto code = static_cast<uint16_t>(status);
  19064. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19065. payload.push_back(static_cast<char>(code & 0xFF));
  19066. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19067. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19068. payload += reason.substr(0, 123);
  19069. {
  19070. std::lock_guard<std::mutex> lock(write_mutex_);
  19071. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19072. payload.size(), true, !is_server_);
  19073. }
  19074. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19075. // Close response before closing the TCP connection.
  19076. //
  19077. // Wait only when no other thread is parsing frames. When one is, it is the
  19078. // thread positioned to see the peer's reply, and reading here would take
  19079. // bytes out of the message it is assembling. Bailing out also leaves the
  19080. // stream, including its read timeout, entirely to that thread.
  19081. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19082. if (!read_lock.owns_lock()) { return; }
  19083. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19084. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19085. Opcode op;
  19086. std::string resp;
  19087. bool fin;
  19088. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19089. impl::FrameRead::Ok) {
  19090. if (op == Opcode::Close) { break; }
  19091. }
  19092. }
  19093. inline WebSocket::~WebSocket() {
  19094. {
  19095. std::lock_guard<std::mutex> lock(ping_mutex_);
  19096. closed_ = true;
  19097. }
  19098. ping_cv_.notify_all();
  19099. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19100. }
  19101. inline void WebSocket::start_heartbeat() {
  19102. if (ping_interval_sec_ == 0) { return; }
  19103. ping_thread_ = std::thread([this]() {
  19104. std::unique_lock<std::mutex> lock(ping_mutex_);
  19105. while (!closed_) {
  19106. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19107. if (closed_) { break; }
  19108. // If the peer has failed to respond to the previous pings, give up.
  19109. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19110. // opt-in liveness check controlled by max_missed_pongs_.
  19111. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19112. lock.unlock();
  19113. close(CloseStatus::GoingAway, "pong timeout");
  19114. return;
  19115. }
  19116. lock.unlock();
  19117. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19118. lock.lock();
  19119. closed_ = true;
  19120. break;
  19121. }
  19122. lock.lock();
  19123. unacked_pings_++;
  19124. }
  19125. });
  19126. }
  19127. inline const Request &WebSocket::request() const { return req_; }
  19128. inline bool WebSocket::is_open() const { return !closed_; }
  19129. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19130. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19131. // poll(), where 0 would instead mean "return immediately", so hand it the
  19132. // negative poll uses for an unbounded wait.
  19133. if (sec == 0 && usec == 0) { sec = -1; }
  19134. strm_.set_read_timeout(sec, usec);
  19135. }
  19136. // WebSocketClient implementation
  19137. inline WebSocketClient::WebSocketClient(
  19138. const std::string &scheme_host_port_path, const Headers &headers)
  19139. : headers_(headers) {
  19140. detail::UrlComponents uc;
  19141. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19142. !uc.host.empty() && !uc.path.empty()) {
  19143. auto &scheme = uc.scheme;
  19144. #ifdef CPPHTTPLIB_SSL_ENABLED
  19145. if (scheme != "ws" && scheme != "wss") {
  19146. #else
  19147. if (scheme != "ws") {
  19148. #endif
  19149. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19150. std::string msg = "'" + scheme + "' scheme is not supported.";
  19151. throw std::invalid_argument(msg);
  19152. #endif
  19153. return;
  19154. }
  19155. auto is_ssl = scheme == "wss";
  19156. host_ = std::move(uc.host);
  19157. port_ = is_ssl ? 443 : 80;
  19158. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19159. path_ = std::move(uc.path);
  19160. if (!uc.query.empty()) { path_ += uc.query; }
  19161. #ifdef CPPHTTPLIB_SSL_ENABLED
  19162. is_ssl_ = is_ssl;
  19163. if (is_ssl_) {
  19164. // The context lives as long as the client so that CA configuration
  19165. // survives reconnects; sessions are created per connection.
  19166. tls_ctx_ = tls::create_client_context();
  19167. if (!tls_ctx_) { return; }
  19168. }
  19169. #else
  19170. if (is_ssl) { return; }
  19171. #endif
  19172. is_valid_ = true;
  19173. }
  19174. }
  19175. #ifdef CPPHTTPLIB_SSL_ENABLED
  19176. inline WebSocketClient::WebSocketClient(
  19177. const std::string &scheme_host_port_path, const PemMemory &pem,
  19178. const Headers &headers)
  19179. : WebSocketClient(scheme_host_port_path, headers) {
  19180. // For ws:// URLs the client certificate is silently ignored, consistent
  19181. // with the TLS-only setters such as set_ca_cert_path().
  19182. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19183. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19184. pem.private_key_password)) {
  19185. tls::free_context(tls_ctx_);
  19186. tls_ctx_ = nullptr;
  19187. is_valid_ = false;
  19188. }
  19189. }
  19190. }
  19191. #endif
  19192. inline WebSocketClient::~WebSocketClient() {
  19193. shutdown_and_close();
  19194. #ifdef CPPHTTPLIB_SSL_ENABLED
  19195. if (tls_ctx_) {
  19196. tls::free_context(tls_ctx_);
  19197. tls_ctx_ = nullptr;
  19198. }
  19199. #endif
  19200. }
  19201. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19202. inline void WebSocketClient::shutdown_and_close() {
  19203. // Send the close frame while the TLS session is still alive: ws_ holds an
  19204. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19205. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19206. if (ws_ && ws_->is_open()) { ws_->close(); }
  19207. ws_.reset();
  19208. #ifdef CPPHTTPLIB_SSL_ENABLED
  19209. if (is_ssl_) {
  19210. if (tls_session_) {
  19211. tls::shutdown(tls_session_, true);
  19212. tls::free_session(tls_session_);
  19213. tls_session_ = nullptr;
  19214. }
  19215. }
  19216. #endif
  19217. if (sock_ != INVALID_SOCKET) {
  19218. detail::shutdown_socket(sock_);
  19219. detail::close_socket(sock_);
  19220. sock_ = INVALID_SOCKET;
  19221. }
  19222. }
  19223. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19224. Error &error, int &ssl_error,
  19225. uint64_t &ssl_backend_error) {
  19226. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19227. // The streams wait with poll(), where 0 instead means "return immediately",
  19228. // so they are given the negative poll uses for an unbounded wait.
  19229. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19230. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19231. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19232. // The handshake belongs to establishing the connection, so an unset read
  19233. // timeout leaves it bounded by the connection timeout instead of forever.
  19234. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19235. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19236. #ifdef CPPHTTPLIB_SSL_ENABLED
  19237. if (is_ssl_) {
  19238. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19239. // is not safe to call concurrently on one client to begin with, since
  19240. // nothing else here is guarded either.
  19241. if (server_certificate_verification_ && !certs_loaded_) {
  19242. uint64_t backend_error = 0;
  19243. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19244. ca_cert_dir_path_, custom_ca_loaded_,
  19245. system_ca_mode_, backend_error);
  19246. certs_loaded_ = true;
  19247. }
  19248. detail::ClientTlsSessionOptions options;
  19249. options.server_hostname_verification = server_hostname_verification_;
  19250. detail::ClientTlsSessionError tls_error;
  19251. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19252. server_certificate_verification_,
  19253. hs_sec, hs_usec, &tls_error,
  19254. options)) {
  19255. error = tls_error.error;
  19256. ssl_error = tls_error.ssl_error;
  19257. ssl_backend_error = tls_error.backend_error;
  19258. return false;
  19259. }
  19260. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19261. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19262. write_timeout_usec_));
  19263. return true;
  19264. }
  19265. #else
  19266. (void)error;
  19267. (void)ssl_error;
  19268. (void)ssl_backend_error;
  19269. (void)hs_sec;
  19270. (void)hs_usec;
  19271. #endif
  19272. strm = std::unique_ptr<Stream>(
  19273. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19274. write_timeout_sec_, write_timeout_usec_));
  19275. return true;
  19276. }
  19277. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19278. #ifdef CPPHTTPLIB_SSL_ENABLED
  19279. auto is_ssl = is_ssl_;
  19280. #else
  19281. auto is_ssl = false;
  19282. #endif
  19283. if (!req.has_header("Host")) {
  19284. req.headers.emplace("Host", detail::make_default_host_header_value(
  19285. host_, port_, is_ssl, address_family_));
  19286. }
  19287. detail::add_default_user_agent_header(req);
  19288. }
  19289. inline Result WebSocketClient::connect() {
  19290. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19291. shutdown_and_close();
  19292. // Check is custom IP or hostname specified for host_
  19293. std::string connect_host;
  19294. std::string ip;
  19295. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19296. auto error = Error::Success;
  19297. sock_ = detail::create_client_socket(
  19298. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19299. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19300. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19301. write_timeout_usec_, interface_, error);
  19302. if (sock_ == INVALID_SOCKET) {
  19303. if (error == Error::Success) { error = Error::Connection; }
  19304. return Result{error, -1, Headers{}};
  19305. }
  19306. std::unique_ptr<Stream> strm;
  19307. auto stream_error = Error::SSLConnection;
  19308. int ssl_error = 0;
  19309. uint64_t ssl_backend_error = 0;
  19310. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19311. shutdown_and_close();
  19312. #ifdef CPPHTTPLIB_SSL_ENABLED
  19313. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19314. #else
  19315. return Result{stream_error, -1, Headers{}};
  19316. #endif
  19317. }
  19318. Request req;
  19319. req.method = "GET";
  19320. req.path = path_;
  19321. req.headers = headers_;
  19322. prepare_default_headers(req);
  19323. detail::WebSocketUpgradeResponse upgrade;
  19324. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19325. shutdown_and_close();
  19326. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19327. }
  19328. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19329. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19330. websocket_ping_interval_sec_,
  19331. websocket_max_missed_pongs_));
  19332. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19333. }
  19334. inline ReadResult WebSocketClient::read(std::string &msg) {
  19335. if (!ws_) { return Fail; }
  19336. return ws_->read(msg);
  19337. }
  19338. inline bool WebSocketClient::send(const std::string &data) {
  19339. if (!ws_) { return false; }
  19340. return ws_->send(data);
  19341. }
  19342. inline bool WebSocketClient::send(const char *data, size_t len) {
  19343. if (!ws_) { return false; }
  19344. return ws_->send(data, len);
  19345. }
  19346. inline void WebSocketClient::close(CloseStatus status,
  19347. const std::string &reason) {
  19348. if (ws_) { ws_->close(status, reason); }
  19349. }
  19350. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19351. inline const std::string &WebSocketClient::subprotocol() const {
  19352. return subprotocol_;
  19353. }
  19354. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19355. read_timeout_sec_ = sec;
  19356. read_timeout_usec_ = usec;
  19357. // The members above only seed the next connect(); read() consults the
  19358. // stream, so an already-open connection has to be told directly.
  19359. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19360. }
  19361. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19362. write_timeout_sec_ = sec;
  19363. write_timeout_usec_ = usec;
  19364. }
  19365. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19366. websocket_ping_interval_sec_ = sec;
  19367. }
  19368. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19369. websocket_max_missed_pongs_ = count;
  19370. }
  19371. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19372. inline void WebSocketClient::set_address_family(int family) {
  19373. address_family_ = family;
  19374. }
  19375. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19376. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19377. socket_options_ = std::move(socket_options);
  19378. }
  19379. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19380. connection_timeout_sec_ = sec;
  19381. connection_timeout_usec_ = usec;
  19382. }
  19383. inline void WebSocketClient::set_interface(const std::string &intf) {
  19384. interface_ = intf;
  19385. }
  19386. inline void WebSocketClient::set_hostname_addr_map(
  19387. std::map<std::string, std::string> addr_map) {
  19388. addr_map_ = std::move(addr_map);
  19389. }
  19390. #ifdef CPPHTTPLIB_SSL_ENABLED
  19391. inline void
  19392. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19393. const std::string &ca_cert_dir_path) {
  19394. ca_cert_file_path_ = ca_cert_file_path;
  19395. ca_cert_dir_path_ = ca_cert_dir_path;
  19396. }
  19397. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19398. if (store && tls_ctx_) {
  19399. // set_ca_store takes ownership of store
  19400. tls::set_ca_store(tls_ctx_, store);
  19401. custom_ca_loaded_ = true;
  19402. } else if (store) {
  19403. tls::free_ca_store(store);
  19404. }
  19405. }
  19406. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19407. std::size_t size) {
  19408. if (tls_ctx_ && ca_cert && size > 0) {
  19409. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19410. custom_ca_loaded_ = true;
  19411. }
  19412. }
  19413. inline void
  19414. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19415. server_certificate_verification_ = enabled;
  19416. }
  19417. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19418. server_hostname_verification_ = enabled;
  19419. }
  19420. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19421. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19422. }
  19423. #endif // CPPHTTPLIB_SSL_ENABLED
  19424. } // namespace ws
  19425. // ----------------------------------------------------------------------------
  19426. } // namespace httplib
  19427. #endif // CPPHTTPLIB_HTTPLIB_H