httplib.h 841 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345
  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.64.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x004000"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. // How much of an unread request body the server skips to reuse the connection,
  113. // 0 for no limit
  114. #ifndef CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH
  115. #define CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH (256 * 1024) // 256KB
  116. #endif
  117. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  118. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  119. #endif
  120. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  121. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  124. // 1400 rather than a round number: a body that already fits in one 1500-byte
  125. // MTU gains nothing from being made smaller.
  126. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  127. #endif
  128. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  129. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  130. #endif
  131. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  132. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  133. #endif
  134. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  135. // recurses roughly once per matched character for quantified patterns such
  136. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  137. // a default ~8MB thread stack that has been observed to take on the order of
  138. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  139. // margin below that (well under the 8192-byte request URI limit) while still
  140. // fitting any realistic route segment; raise it if a route legitimately needs
  141. // longer paths. Regex routes are never applied to paths longer than this.
  142. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  143. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  144. #endif
  145. #ifndef CPPHTTPLIB_TCP_NODELAY
  146. #define CPPHTTPLIB_TCP_NODELAY false
  147. #endif
  148. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  149. #define CPPHTTPLIB_IPV6_V6ONLY false
  150. #endif
  151. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  152. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  153. #endif
  154. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  155. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  156. #endif
  157. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  158. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  159. #endif
  160. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  161. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  162. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  163. ? std::thread::hardware_concurrency() - 1 \
  164. : 0))
  165. #endif
  166. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  167. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  168. #endif
  169. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  170. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  171. #endif
  172. #ifndef CPPHTTPLIB_RECV_FLAGS
  173. #define CPPHTTPLIB_RECV_FLAGS 0
  174. #endif
  175. #ifndef CPPHTTPLIB_SEND_FLAGS
  176. #define CPPHTTPLIB_SEND_FLAGS 0
  177. #endif
  178. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  179. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  180. #endif
  181. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  182. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  183. #endif
  184. // These bound the parsing of every request, so 0 cannot lift them.
  185. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  186. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  187. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  188. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  189. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  190. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  191. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  192. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  193. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  194. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  195. #endif
  196. // One macro used to set the read timeout for both sides. They want different
  197. // defaults: a client's read timeout is the caller's own tool (it waits forever
  198. // until asked not to), while a server keeps a ceiling that reclaims a worker
  199. // from a peer that has gone quiet. The old name still works and sets both.
  200. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  201. #pragma message( \
  202. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  203. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  204. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  207. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  208. #endif
  209. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  210. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  211. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  212. #endif
  213. #endif
  214. // 0 waits forever. A read timeout is how a caller gets control back to send on
  215. // the same connection; it is not a liveness check (that is ping/pong). Only a
  216. // timeout set at runtime through set_read_timeout() is reported as
  217. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  218. // ws::Fail and closes the connection.
  219. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  220. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  221. #endif
  222. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  223. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  224. #endif
  225. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  226. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  227. #endif
  228. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  229. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  230. #endif
  231. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  232. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  233. #endif
  234. /*
  235. * Headers
  236. */
  237. #ifdef _WIN32
  238. #ifndef _CRT_SECURE_NO_WARNINGS
  239. #define _CRT_SECURE_NO_WARNINGS
  240. #endif //_CRT_SECURE_NO_WARNINGS
  241. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  242. #define _CRT_NONSTDC_NO_DEPRECATE
  243. #endif //_CRT_NONSTDC_NO_DEPRECATE
  244. #if defined(_MSC_VER)
  245. #if _MSC_VER < 1900
  246. #error Sorry, Visual Studio versions prior to 2015 are not supported
  247. #endif
  248. #pragma comment(lib, "ws2_32.lib")
  249. #ifndef _SSIZE_T_DEFINED
  250. using ssize_t = __int64;
  251. #define _SSIZE_T_DEFINED
  252. #endif
  253. #endif // _MSC_VER
  254. #ifndef S_ISREG
  255. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  256. #endif // S_ISREG
  257. #ifndef S_ISDIR
  258. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  259. #endif // S_ISDIR
  260. #ifndef NOMINMAX
  261. #define NOMINMAX
  262. #endif // NOMINMAX
  263. #include <io.h>
  264. #include <winsock2.h>
  265. #include <ws2tcpip.h>
  266. #if defined(__has_include)
  267. #if __has_include(<afunix.h>)
  268. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  269. #include <afunix.h>
  270. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  271. #endif
  272. #endif
  273. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  274. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  275. #endif
  276. using nfds_t = unsigned long;
  277. using socket_t = SOCKET;
  278. using socklen_t = int;
  279. #else // not _WIN32
  280. #include <arpa/inet.h>
  281. #if !defined(_AIX) && !defined(__MVS__)
  282. #include <ifaddrs.h>
  283. #endif
  284. #ifdef __MVS__
  285. #include <strings.h>
  286. #ifndef NI_MAXHOST
  287. #define NI_MAXHOST 1025
  288. #endif
  289. #endif
  290. #include <net/if.h>
  291. #include <netdb.h>
  292. #include <netinet/in.h>
  293. #ifdef __linux__
  294. #include <resolv.h>
  295. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  296. #endif
  297. #include <csignal>
  298. #include <netinet/tcp.h>
  299. #include <poll.h>
  300. #include <pthread.h>
  301. #include <sys/socket.h>
  302. #include <sys/un.h>
  303. #include <unistd.h>
  304. using socket_t = int;
  305. #ifndef INVALID_SOCKET
  306. #define INVALID_SOCKET (-1)
  307. #endif
  308. #endif //_WIN32
  309. #if defined(__APPLE__)
  310. #include <TargetConditionals.h>
  311. #endif
  312. #include <algorithm>
  313. #include <array>
  314. #include <atomic>
  315. #include <cassert>
  316. #include <chrono>
  317. #include <climits>
  318. #include <condition_variable>
  319. #include <cstdlib>
  320. #include <cstring>
  321. #include <errno.h>
  322. #include <exception>
  323. #include <fcntl.h>
  324. #include <fstream>
  325. #include <functional>
  326. #include <iomanip>
  327. #include <iostream>
  328. #include <iterator>
  329. #include <list>
  330. #include <map>
  331. #include <memory>
  332. #include <mutex>
  333. #include <random>
  334. #include <regex>
  335. #include <set>
  336. #include <sstream>
  337. #include <string>
  338. #include <sys/stat.h>
  339. #include <system_error>
  340. #include <thread>
  341. #include <type_traits>
  342. #include <unordered_map>
  343. #include <unordered_set>
  344. #include <utility>
  345. #include <vector>
  346. // On macOS with a TLS backend, enable Keychain root certificates by default
  347. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  348. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  349. // only; on those platforms the user must provide a CA bundle explicitly.
  350. #if defined(__APPLE__) && defined(__clang__) && \
  351. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  352. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  353. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  354. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  355. #if TARGET_OS_OSX
  356. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  357. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  358. #endif
  359. #endif
  360. #endif
  361. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  362. defined(__APPLE__) && !TARGET_OS_OSX
  363. #error \
  364. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  365. #endif
  366. // On Windows, enable Schannel certificate verification by default
  367. // unless the user explicitly opts out.
  368. #if defined(_WIN32) && \
  369. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  370. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  371. #endif
  372. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  373. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  374. #if TARGET_OS_MAC && defined(__clang__)
  375. #include <CFNetwork/CFHost.h>
  376. #include <CoreFoundation/CoreFoundation.h>
  377. #endif
  378. #endif
  379. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  380. #ifdef _WIN32
  381. #include <wincrypt.h>
  382. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  383. // used
  384. #undef X509_NAME
  385. #undef X509_CERT_PAIR
  386. #undef X509_EXTENSIONS
  387. #undef PKCS7_SIGNER_INFO
  388. #ifdef _MSC_VER
  389. #pragma comment(lib, "crypt32.lib")
  390. #endif
  391. #endif // _WIN32
  392. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  393. #if TARGET_OS_OSX
  394. #include <Security/Security.h>
  395. #endif
  396. #endif
  397. #include <openssl/err.h>
  398. #include <openssl/evp.h>
  399. #include <openssl/rand.h>
  400. #include <openssl/ssl.h>
  401. #include <openssl/x509v3.h>
  402. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  403. #include <openssl/applink.c>
  404. #endif
  405. #include <iostream>
  406. #include <sstream>
  407. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  408. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  409. #error Please use OpenSSL or a current version of BoringSSL
  410. #endif
  411. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  412. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  413. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  414. #endif
  415. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  416. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  417. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  418. // in with this first include group so the version gating below can use it.
  419. #include <mbedtls/error.h>
  420. #include <mbedtls/net_sockets.h>
  421. #include <mbedtls/oid.h>
  422. #include <mbedtls/pk.h>
  423. #include <mbedtls/ssl.h>
  424. #include <mbedtls/version.h>
  425. #include <mbedtls/x509_crt.h>
  426. #if MBEDTLS_VERSION_MAJOR >= 4
  427. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  428. #include <psa/crypto.h>
  429. #else
  430. #include <mbedtls/ctr_drbg.h>
  431. #include <mbedtls/entropy.h>
  432. #include <mbedtls/md5.h>
  433. #include <mbedtls/sha1.h>
  434. #include <mbedtls/sha256.h>
  435. #include <mbedtls/sha512.h>
  436. #endif
  437. #ifdef _WIN32
  438. #include <wincrypt.h>
  439. #ifdef _MSC_VER
  440. #pragma comment(lib, "crypt32.lib")
  441. #endif
  442. #endif // _WIN32
  443. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  444. #if TARGET_OS_OSX
  445. #include <Security/Security.h>
  446. #endif
  447. #endif
  448. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  449. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  450. #if MBEDTLS_VERSION_MAJOR >= 4
  451. #define CPPHTTPLIB_MBEDTLS_V4
  452. #endif
  453. #if MBEDTLS_VERSION_MAJOR >= 3
  454. #define CPPHTTPLIB_MBEDTLS_V3
  455. #endif
  456. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  457. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  458. #include <wolfssl/options.h>
  459. #include <wolfssl/openssl/x509v3.h>
  460. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  461. #ifndef WOLFSSL_GEN_EMAIL
  462. #define WOLFSSL_GEN_EMAIL 1
  463. #endif
  464. #ifndef WOLFSSL_GEN_DNS
  465. #define WOLFSSL_GEN_DNS 2
  466. #endif
  467. #ifndef WOLFSSL_GEN_URI
  468. #define WOLFSSL_GEN_URI 6
  469. #endif
  470. #ifndef WOLFSSL_GEN_IPADD
  471. #define WOLFSSL_GEN_IPADD 7
  472. #endif
  473. #include <wolfssl/ssl.h>
  474. #include <wolfssl/wolfcrypt/hash.h>
  475. #include <wolfssl/wolfcrypt/md5.h>
  476. #include <wolfssl/wolfcrypt/sha256.h>
  477. #include <wolfssl/wolfcrypt/sha512.h>
  478. #ifdef _WIN32
  479. #include <wincrypt.h>
  480. #ifdef _MSC_VER
  481. #pragma comment(lib, "crypt32.lib")
  482. #endif
  483. #endif // _WIN32
  484. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  485. #if TARGET_OS_OSX
  486. #include <Security/Security.h>
  487. #endif
  488. #endif
  489. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  490. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  491. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  492. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  493. #define CPPHTTPLIB_SSL_ENABLED
  494. #endif
  495. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  496. #include <zlib.h>
  497. #endif
  498. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  499. #include <brotli/decode.h>
  500. #include <brotli/encode.h>
  501. #endif
  502. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  503. #include <zstd.h>
  504. #endif
  505. /*
  506. * Declaration
  507. */
  508. namespace httplib {
  509. namespace ws {
  510. class WebSocket;
  511. } // namespace ws
  512. namespace sse {
  513. class SSEClient;
  514. } // namespace sse
  515. namespace detail {
  516. /*
  517. * Backport std::make_unique from C++14.
  518. *
  519. * NOTE: This code came up with the following stackoverflow post:
  520. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  521. *
  522. */
  523. template <class T, class... Args>
  524. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(Args &&...args) {
  526. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  527. }
  528. template <class T>
  529. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  530. make_unique(std::size_t n) {
  531. typedef typename std::remove_extent<T>::type RT;
  532. return std::unique_ptr<T>(new RT[n]);
  533. }
  534. // Locale-independent ASCII character classification. The <cctype>
  535. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  536. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  537. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  538. // classified without regard to the locale.
  539. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  540. inline bool is_ascii_alpha(char c) {
  541. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  542. }
  543. inline bool is_ascii_alnum(char c) {
  544. return is_ascii_digit(c) || is_ascii_alpha(c);
  545. }
  546. namespace case_ignore {
  547. inline unsigned char to_lower(int c) {
  548. const static unsigned char table[256] = {
  549. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  550. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  551. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  552. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  553. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  554. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  555. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  556. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  557. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  558. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  559. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  560. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  561. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  562. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  563. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  564. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  565. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  566. 255,
  567. };
  568. return table[(unsigned char)(char)c];
  569. }
  570. inline std::string to_lower(const std::string &s) {
  571. std::string result = s;
  572. std::transform(
  573. result.begin(), result.end(), result.begin(),
  574. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  575. return result;
  576. }
  577. inline bool equal(const std::string &a, const std::string &b) {
  578. return a.size() == b.size() &&
  579. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  580. return to_lower(ca) == to_lower(cb);
  581. });
  582. }
  583. // For a literal, without building a std::string from it.
  584. template <size_t N>
  585. inline bool equal(const std::string &a, const char (&b)[N]) {
  586. return a.size() == N - 1 &&
  587. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  588. return to_lower(ca) == to_lower(cb);
  589. });
  590. }
  591. struct equal_to {
  592. bool operator()(const std::string &a, const std::string &b) const {
  593. return equal(a, b);
  594. }
  595. };
  596. struct hash {
  597. size_t operator()(const std::string &key) const {
  598. size_t h = 0;
  599. for (auto c : key) {
  600. // Unsets the 6 high bits of h, therefore no overflow happens
  601. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  602. static_cast<unsigned char>(to_lower(c));
  603. }
  604. return h;
  605. }
  606. };
  607. template <typename T>
  608. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  609. detail::case_ignore::equal_to>;
  610. } // namespace case_ignore
  611. // This is based on
  612. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  613. struct scope_exit {
  614. explicit scope_exit(std::function<void(void)> &&f)
  615. : exit_function(std::move(f)), execute_on_destruction{true} {}
  616. scope_exit(scope_exit &&rhs) noexcept
  617. : exit_function(std::move(rhs.exit_function)),
  618. execute_on_destruction{rhs.execute_on_destruction} {
  619. rhs.release();
  620. }
  621. ~scope_exit() {
  622. if (execute_on_destruction) { this->exit_function(); }
  623. }
  624. void release() { this->execute_on_destruction = false; }
  625. private:
  626. scope_exit(const scope_exit &) = delete;
  627. void operator=(const scope_exit &) = delete;
  628. scope_exit &operator=(scope_exit &&) = delete;
  629. std::function<void(void)> exit_function;
  630. bool execute_on_destruction;
  631. };
  632. // Simple from_chars implementation for integer and double types (C++17
  633. // substitute)
  634. template <typename T> struct from_chars_result {
  635. const char *ptr;
  636. std::errc ec;
  637. };
  638. template <typename T>
  639. inline from_chars_result<T> from_chars(const char *first, const char *last,
  640. T &value, int base = 10) {
  641. value = 0;
  642. const char *p = first;
  643. bool negative = false;
  644. if (p != last && *p == '-') {
  645. negative = true;
  646. ++p;
  647. }
  648. if (p == last) { return {first, std::errc::invalid_argument}; }
  649. auto radix = static_cast<T>(base);
  650. T result = 0;
  651. for (; p != last; ++p) {
  652. char c = *p;
  653. int digit = -1;
  654. if (is_ascii_digit(c)) {
  655. digit = c - '0';
  656. } else if ('a' <= c && c <= 'z') {
  657. digit = c - 'a' + 10;
  658. } else if ('A' <= c && c <= 'Z') {
  659. digit = c - 'A' + 10;
  660. } else {
  661. break;
  662. }
  663. if (digit < 0 || digit >= base) { break; }
  664. auto d = static_cast<T>(digit);
  665. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  666. return {p, std::errc::result_out_of_range};
  667. }
  668. result = result * radix + d;
  669. }
  670. if (p == first || (negative && p == first + 1)) {
  671. return {first, std::errc::invalid_argument};
  672. }
  673. value = negative ? T(0) - result : result;
  674. return {p, std::errc{}};
  675. }
  676. // from_chars for double (hand-written, locale-independent)
  677. //
  678. // The only double consumed by this library is the HTTP quality value, whose
  679. // grammar is (RFC 9110 12.4.2):
  680. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  681. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  682. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  683. // '.' always the decimal separator (std::strtod would instead read it from the
  684. // global C locale, mis-parsing q-values once an embedder calls
  685. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  686. // the result to [0, 1], so inputs outside that range need not be distinguished
  687. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  688. // cases that exponent and wide-range handling would introduce.
  689. inline from_chars_result<double> from_chars(const char *first, const char *last,
  690. double &value) {
  691. value = 0.0;
  692. const char *p = first;
  693. // Each 1eN is exactly representable, so a single final division by the
  694. // matching entry yields a correctly-rounded result.
  695. static const double powers_of_ten[] = {
  696. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  697. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  698. const int max_frac_digits =
  699. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  700. // Accumulate digits into a 64-bit integer and remember how many were
  701. // fractional. Two independent caps keep this bounded and safe:
  702. // * accumulation saturates before mantissa could overflow uint64_t, and
  703. // * frac_digits is capped at max_frac_digits so it is always a valid index
  704. // into powers_of_ten (without this an input like "0.000...0" would never
  705. // grow mantissa, so the saturation cap alone would not bound it).
  706. // Both caps only drop digits far beyond the precision a q-value needs; any
  707. // value they would change is well outside [0, 1] and rejected by the caller.
  708. uint64_t mantissa = 0;
  709. int frac_digits = 0;
  710. bool seen_digit = false;
  711. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  712. auto accumulate = [&](char c) {
  713. if (mantissa <= limit) {
  714. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  715. return true;
  716. }
  717. return false;
  718. };
  719. for (; p != last && is_ascii_digit(*p); ++p) {
  720. seen_digit = true;
  721. accumulate(*p);
  722. }
  723. if (p != last && *p == '.') {
  724. ++p;
  725. for (; p != last && is_ascii_digit(*p); ++p) {
  726. seen_digit = true;
  727. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  728. }
  729. }
  730. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  731. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  732. return {p, std::errc{}};
  733. }
  734. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  735. int &out) {
  736. int val = 0;
  737. auto r = from_chars(s, s + len, val);
  738. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  739. return false;
  740. }
  741. out = val;
  742. return true;
  743. }
  744. inline bool parse_port(const char *s, size_t len, int &port) {
  745. return parse_int_in_range(s, len, 1, 65535, port);
  746. }
  747. inline bool parse_port(const std::string &s, int &port) {
  748. return parse_port(s.data(), s.size(), port);
  749. }
  750. struct UrlComponents {
  751. std::string scheme;
  752. std::string host;
  753. std::string port;
  754. std::string path;
  755. std::string query;
  756. };
  757. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  758. uc = {};
  759. size_t pos = 0;
  760. auto sep = url.find("://");
  761. if (sep != std::string::npos) {
  762. uc.scheme = url.substr(0, sep);
  763. // Scheme must be [a-z]+ only
  764. if (uc.scheme.empty()) { return false; }
  765. for (auto c : uc.scheme) {
  766. if (c < 'a' || c > 'z') { return false; }
  767. }
  768. pos = sep + 3;
  769. } else if (url.compare(0, 2, "//") == 0) {
  770. pos = 2;
  771. }
  772. auto has_authority_prefix = pos > 0;
  773. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  774. url[0] != '?' && url[0] != '#');
  775. if (has_authority) {
  776. // userinfo is not supported, and a backslash that some parsers take for
  777. // '/' would leave them seeing another host than this one.
  778. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  779. return false;
  780. }
  781. if (pos < url.size() && url[pos] == '[') {
  782. auto close = url.find(']', pos);
  783. if (close == std::string::npos) { return false; }
  784. uc.host = url.substr(pos + 1, close - pos - 1);
  785. // IPv6 host must be [a-fA-F0-9:]+ only
  786. if (uc.host.empty()) { return false; }
  787. for (auto c : uc.host) {
  788. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  789. (c >= 'A' && c <= 'F') || c == ':')) {
  790. return false;
  791. }
  792. }
  793. pos = close + 1;
  794. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  795. // path, query or fragment delimiter (or the end of input). Otherwise the
  796. // trailing bytes would be folded into the path while the connection
  797. // still targets the bracketed address.
  798. if (pos < url.size()) {
  799. auto c = url[pos];
  800. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  801. }
  802. } else {
  803. auto end = url.find_first_of(":/?#", pos);
  804. if (end == std::string::npos) { end = url.size(); }
  805. uc.host = url.substr(pos, end - pos);
  806. pos = end;
  807. }
  808. if (pos < url.size() && url[pos] == ':') {
  809. ++pos;
  810. auto end = url.find_first_of("/?#", pos);
  811. if (end == std::string::npos) { end = url.size(); }
  812. uc.port = url.substr(pos, end - pos);
  813. pos = end;
  814. }
  815. // Without :// or //, the entire input must be consumed as host[:port].
  816. // If there is leftover (path, query, etc.), this is not a valid
  817. // host[:port] string — clear and reparse as a plain path.
  818. if (!has_authority_prefix && pos < url.size()) {
  819. uc.host.clear();
  820. uc.port.clear();
  821. pos = 0;
  822. }
  823. }
  824. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  825. auto end = url.find_first_of("?#", pos);
  826. if (end == std::string::npos) { end = url.size(); }
  827. uc.path = url.substr(pos, end - pos);
  828. pos = end;
  829. }
  830. if (pos < url.size() && url[pos] == '?') {
  831. auto end = url.find('#', pos);
  832. if (end == std::string::npos) { end = url.size(); }
  833. uc.query = url.substr(pos, end - pos);
  834. }
  835. return true;
  836. }
  837. // Removes "." and ".." segments from a path that starts with '/' (RFC 3986
  838. // section 5.2.4).
  839. inline std::string remove_dot_segments(const std::string &path) {
  840. std::string out;
  841. size_t i = 0;
  842. while (i < path.size()) {
  843. auto next = (std::min)(path.find('/', i + 1), path.size());
  844. auto segment = path.substr(i + 1, next - i - 1);
  845. auto is_last = next == path.size();
  846. if (segment == "." || segment == "..") {
  847. if (segment == "..") {
  848. out.erase((std::min)(out.rfind('/'), out.size()));
  849. }
  850. if (is_last) { out += '/'; }
  851. } else {
  852. out += '/';
  853. out += segment;
  854. }
  855. i = next;
  856. }
  857. if (out.empty()) { out = "/"; }
  858. return out;
  859. }
  860. // Resolves a relative-path or query-only Location value against the path of
  861. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  862. // references starting with '/' are returned unchanged.
  863. inline std::string resolve_relative_location(const std::string &location,
  864. const std::string &base) {
  865. if (location.empty() || location[0] == '/') { return location; }
  866. // A ':' in the first segment means the value has a scheme.
  867. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  868. // A path starting with "//" would be re-parsed as an authority. Prefix "/."
  869. // (as the URL Standard does); remove_dot_segments strips it later.
  870. auto on_this_host = [](std::string path) -> std::string {
  871. if (path.compare(0, 2, "//") == 0) { path.insert(0, "/."); }
  872. return path;
  873. };
  874. if (location[0] == '#') {
  875. return on_this_host(base.substr(0, base.find('#')) + location);
  876. }
  877. auto base_path = base.substr(0, base.find_first_of("?#"));
  878. if (location[0] == '?') { return on_this_host(base_path + location); }
  879. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  880. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  881. // Remove "." and ".." segments from the merged path.
  882. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  883. return on_this_host(remove_dot_segments(merged.substr(0, path_end)) +
  884. merged.substr(path_end));
  885. }
  886. } // namespace detail
  887. enum class SSLVerifierResponse {
  888. // no decision has been made, use the built-in certificate verifier
  889. NoDecisionMade,
  890. // connection certificate is verified and accepted
  891. CertificateAccepted,
  892. // connection certificate was processed but is rejected
  893. CertificateRejected
  894. };
  895. // System CA loading policy for SSL clients. Auto (the default) loads system
  896. // CA certs only when no custom CA is configured; enable_system_ca() switches
  897. // to an explicit policy.
  898. enum class SystemCAMode { Auto, Enabled, Disabled };
  899. enum StatusCode {
  900. // Information responses
  901. Continue_100 = 100,
  902. SwitchingProtocol_101 = 101,
  903. Processing_102 = 102,
  904. EarlyHints_103 = 103,
  905. // Successful responses
  906. OK_200 = 200,
  907. Created_201 = 201,
  908. Accepted_202 = 202,
  909. NonAuthoritativeInformation_203 = 203,
  910. NoContent_204 = 204,
  911. ResetContent_205 = 205,
  912. PartialContent_206 = 206,
  913. MultiStatus_207 = 207,
  914. AlreadyReported_208 = 208,
  915. IMUsed_226 = 226,
  916. // Redirection messages
  917. MultipleChoices_300 = 300,
  918. MovedPermanently_301 = 301,
  919. Found_302 = 302,
  920. SeeOther_303 = 303,
  921. NotModified_304 = 304,
  922. UseProxy_305 = 305,
  923. unused_306 = 306,
  924. TemporaryRedirect_307 = 307,
  925. PermanentRedirect_308 = 308,
  926. // Client error responses
  927. BadRequest_400 = 400,
  928. Unauthorized_401 = 401,
  929. PaymentRequired_402 = 402,
  930. Forbidden_403 = 403,
  931. NotFound_404 = 404,
  932. MethodNotAllowed_405 = 405,
  933. NotAcceptable_406 = 406,
  934. ProxyAuthenticationRequired_407 = 407,
  935. RequestTimeout_408 = 408,
  936. Conflict_409 = 409,
  937. Gone_410 = 410,
  938. LengthRequired_411 = 411,
  939. PreconditionFailed_412 = 412,
  940. PayloadTooLarge_413 = 413,
  941. UriTooLong_414 = 414,
  942. UnsupportedMediaType_415 = 415,
  943. RangeNotSatisfiable_416 = 416,
  944. ExpectationFailed_417 = 417,
  945. ImATeapot_418 = 418,
  946. MisdirectedRequest_421 = 421,
  947. UnprocessableContent_422 = 422,
  948. Locked_423 = 423,
  949. FailedDependency_424 = 424,
  950. TooEarly_425 = 425,
  951. UpgradeRequired_426 = 426,
  952. PreconditionRequired_428 = 428,
  953. TooManyRequests_429 = 429,
  954. RequestHeaderFieldsTooLarge_431 = 431,
  955. UnavailableForLegalReasons_451 = 451,
  956. // Server error responses
  957. InternalServerError_500 = 500,
  958. NotImplemented_501 = 501,
  959. BadGateway_502 = 502,
  960. ServiceUnavailable_503 = 503,
  961. GatewayTimeout_504 = 504,
  962. HttpVersionNotSupported_505 = 505,
  963. VariantAlsoNegotiates_506 = 506,
  964. InsufficientStorage_507 = 507,
  965. LoopDetected_508 = 508,
  966. NotExtended_510 = 510,
  967. NetworkAuthenticationRequired_511 = 511,
  968. };
  969. namespace detail {
  970. // A multimap that keeps its entries in the order they were inserted.
  971. //
  972. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  973. // fields sharing a field name significant and forbids a proxy from reordering
  974. // them, and a query string's parameters are meaningful in the order the caller
  975. // wrote them. Neither standard container expresses it: std::unordered_multimap
  976. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  977. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  978. // key, which would drop control data such as Host behind whatever else the
  979. // message carries and alphabetise a query string.
  980. //
  981. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  982. // scan, which beats hashing for the handful of entries a message carries
  983. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  984. //
  985. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  986. // Params, whose parameter names are case-sensitive, not.
  987. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  988. public:
  989. using key_type = std::string;
  990. using mapped_type = Mapped;
  991. using value_type = std::pair<std::string, Mapped>;
  992. using size_type = std::size_t;
  993. using difference_type = std::ptrdiff_t;
  994. using reference = value_type &;
  995. using const_reference = const value_type &;
  996. private:
  997. static size_type npos() { return static_cast<size_type>(-1); }
  998. static bool keys_equal(const std::string &a, const std::string &b) {
  999. return KeyEqual()(a, b);
  1000. }
  1001. // Iterating yields every entry in insertion order, but equal_range() and
  1002. // find() have to walk only the entries sharing one key, which are not
  1003. // adjacent. Both are the same iterator type: key_idx_ selects between the
  1004. // two traversals, and since equality compares only the position, an iterator
  1005. // restricted to one key still compares equal to end().
  1006. template <typename V> class iterator_t {
  1007. public:
  1008. using iterator_category = std::bidirectional_iterator_tag;
  1009. using value_type = insertion_ordered_multimap::value_type;
  1010. using difference_type = insertion_ordered_multimap::difference_type;
  1011. using pointer = V *;
  1012. using reference = V &;
  1013. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1014. template <typename U,
  1015. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1016. int>::type = 0>
  1017. iterator_t(const iterator_t<U> &rhs)
  1018. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1019. key_idx_(rhs.key_idx_) {}
  1020. reference operator*() const { return data_[idx_]; }
  1021. pointer operator->() const { return data_ + idx_; }
  1022. iterator_t &operator++() {
  1023. // Saturating, so that advancing past the last entry of a key stays at
  1024. // end() instead of running off the container.
  1025. if (idx_ >= size_) { return *this; }
  1026. ++idx_;
  1027. if (key_idx_ != npos()) {
  1028. while (idx_ < size_ && !matches(idx_)) {
  1029. ++idx_;
  1030. }
  1031. }
  1032. return *this;
  1033. }
  1034. iterator_t operator++(int) {
  1035. auto tmp = *this;
  1036. ++*this;
  1037. return tmp;
  1038. }
  1039. iterator_t &operator--() {
  1040. if (idx_ == 0) { return *this; }
  1041. --idx_;
  1042. if (key_idx_ != npos()) {
  1043. while (idx_ > 0 && !matches(idx_)) {
  1044. --idx_;
  1045. }
  1046. }
  1047. return *this;
  1048. }
  1049. iterator_t operator--(int) {
  1050. auto tmp = *this;
  1051. --*this;
  1052. return tmp;
  1053. }
  1054. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1055. return idx_ == rhs.idx_;
  1056. }
  1057. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1058. return idx_ != rhs.idx_;
  1059. }
  1060. private:
  1061. friend class insertion_ordered_multimap;
  1062. template <typename> friend class iterator_t;
  1063. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1064. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1065. bool matches(size_type i) const {
  1066. return keys_equal(data_[i].first, data_[key_idx_].first);
  1067. }
  1068. V *data_;
  1069. size_type idx_;
  1070. size_type size_;
  1071. size_type key_idx_;
  1072. };
  1073. public:
  1074. using iterator = iterator_t<value_type>;
  1075. using const_iterator = iterator_t<const value_type>;
  1076. insertion_ordered_multimap() = default;
  1077. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1078. : entries_(il) {}
  1079. template <typename InputIt>
  1080. insertion_ordered_multimap(InputIt first, InputIt last)
  1081. : entries_(first, last) {}
  1082. iterator begin() { return make_iter(0, npos()); }
  1083. iterator end() { return make_iter(entries_.size(), npos()); }
  1084. const_iterator begin() const { return make_citer(0, npos()); }
  1085. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1086. const_iterator cbegin() const { return begin(); }
  1087. const_iterator cend() const { return end(); }
  1088. bool empty() const { return entries_.empty(); }
  1089. size_type size() const { return entries_.size(); }
  1090. void clear() { entries_.clear(); }
  1091. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1092. iterator insert(const value_type &val) {
  1093. entries_.push_back(val);
  1094. return make_iter(entries_.size() - 1, npos());
  1095. }
  1096. iterator insert(value_type &&val) {
  1097. entries_.push_back(std::move(val));
  1098. return make_iter(entries_.size() - 1, npos());
  1099. }
  1100. template <typename... Args> iterator emplace(Args &&...args) {
  1101. entries_.emplace_back(std::forward<Args>(args)...);
  1102. return make_iter(entries_.size() - 1, npos());
  1103. }
  1104. // For entries that have to lead the message, such as the Host header field
  1105. // (RFC 9110 5.3 recommends sending control data first).
  1106. template <typename... Args> iterator emplace_front(Args &&...args) {
  1107. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1108. return make_iter(0, npos());
  1109. }
  1110. iterator find(const std::string &key) {
  1111. auto i = index_of(key);
  1112. return i == npos() ? end() : make_iter(i, i);
  1113. }
  1114. const_iterator find(const std::string &key) const {
  1115. auto i = index_of(key);
  1116. return i == npos() ? end() : make_citer(i, i);
  1117. }
  1118. size_type count(const std::string &key) const {
  1119. size_type n = 0;
  1120. for (const auto &entry : entries_) {
  1121. if (keys_equal(entry.first, key)) { n++; }
  1122. }
  1123. return n;
  1124. }
  1125. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1126. auto i = index_of(key);
  1127. return i == npos() ? std::make_pair(end(), end())
  1128. : std::make_pair(make_iter(i, i), end());
  1129. }
  1130. std::pair<const_iterator, const_iterator>
  1131. equal_range(const std::string &key) const {
  1132. auto i = index_of(key);
  1133. return i == npos() ? std::make_pair(end(), end())
  1134. : std::make_pair(make_citer(i, i), end());
  1135. }
  1136. size_type erase(const std::string &key) {
  1137. auto before = entries_.size();
  1138. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1139. [&](const value_type &entry) {
  1140. return keys_equal(entry.first, key);
  1141. }),
  1142. entries_.end());
  1143. return before - entries_.size();
  1144. }
  1145. iterator erase(const_iterator pos) {
  1146. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1147. return make_iter(pos.idx_, npos());
  1148. }
  1149. // Erases what iterating [first, last) would actually visit, so erasing an
  1150. // equal_range() removes only the entries with that key, not everything
  1151. // positioned between them.
  1152. iterator erase(const_iterator first, const_iterator last) {
  1153. auto from = first.idx_;
  1154. auto to = last.idx_;
  1155. if (from >= to) { return make_iter(from, npos()); }
  1156. auto begin_it = entries_.begin();
  1157. auto from_it = begin_it + static_cast<difference_type>(from);
  1158. auto to_it = begin_it + static_cast<difference_type>(to);
  1159. if (first.key_idx_ == npos()) {
  1160. entries_.erase(from_it, to_it);
  1161. } else {
  1162. auto key = entries_[first.key_idx_].first;
  1163. auto keep = from_it;
  1164. for (auto it = from_it; it != to_it; ++it) {
  1165. if (!keys_equal(it->first, key)) {
  1166. if (keep != it) { *keep = std::move(*it); }
  1167. ++keep;
  1168. }
  1169. }
  1170. if (keep != to_it) {
  1171. keep = std::move(to_it, entries_.end(), keep);
  1172. } else {
  1173. keep = entries_.end();
  1174. }
  1175. entries_.erase(keep, entries_.end());
  1176. }
  1177. return make_iter(from, npos());
  1178. }
  1179. friend bool operator==(const insertion_ordered_multimap &lhs,
  1180. const insertion_ordered_multimap &rhs) {
  1181. return lhs.entries_ == rhs.entries_;
  1182. }
  1183. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1184. const insertion_ordered_multimap &rhs) {
  1185. return !(lhs == rhs);
  1186. }
  1187. private:
  1188. size_type index_of(const std::string &key) const {
  1189. for (size_type i = 0; i < entries_.size(); i++) {
  1190. if (keys_equal(entries_[i].first, key)) { return i; }
  1191. }
  1192. return npos();
  1193. }
  1194. iterator make_iter(size_type idx, size_type key_idx) {
  1195. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1196. }
  1197. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1198. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1199. }
  1200. std::vector<value_type> entries_;
  1201. };
  1202. } // namespace detail
  1203. using Headers =
  1204. detail::insertion_ordered_multimap<std::string,
  1205. detail::case_ignore::equal_to>;
  1206. // Query parameter names are case-sensitive, unlike header field names.
  1207. using Params =
  1208. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1209. using Match = std::smatch;
  1210. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1211. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1212. /*
  1213. * detail: type-erased storage used by UserData.
  1214. * ABI-stable regardless of C++ standard — always uses this custom
  1215. * implementation instead of std::any.
  1216. */
  1217. namespace detail {
  1218. using any_type_id = const void *;
  1219. template <typename T> any_type_id any_typeid() noexcept {
  1220. static const char id = 0;
  1221. return &id;
  1222. }
  1223. struct any_storage {
  1224. virtual ~any_storage() = default;
  1225. virtual std::unique_ptr<any_storage> clone() const = 0;
  1226. virtual any_type_id type_id() const noexcept = 0;
  1227. };
  1228. template <typename T> struct any_value final : any_storage {
  1229. T value;
  1230. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1231. std::unique_ptr<any_storage> clone() const override {
  1232. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1233. }
  1234. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1235. };
  1236. } // namespace detail
  1237. class UserData {
  1238. public:
  1239. UserData() = default;
  1240. UserData(UserData &&) noexcept = default;
  1241. UserData &operator=(UserData &&) noexcept = default;
  1242. UserData(const UserData &o) {
  1243. for (const auto &e : o.entries_) {
  1244. if (e.second) { entries_[e.first] = e.second->clone(); }
  1245. }
  1246. }
  1247. UserData &operator=(const UserData &o) {
  1248. if (this != &o) {
  1249. entries_.clear();
  1250. for (const auto &e : o.entries_) {
  1251. if (e.second) { entries_[e.first] = e.second->clone(); }
  1252. }
  1253. }
  1254. return *this;
  1255. }
  1256. template <typename T> void set(const std::string &key, T &&value) {
  1257. using D = typename std::decay<T>::type;
  1258. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1259. }
  1260. template <typename T> T *get(const std::string &key) noexcept {
  1261. auto it = entries_.find(key);
  1262. if (it == entries_.end() || !it->second) { return nullptr; }
  1263. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1264. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1265. }
  1266. template <typename T> const T *get(const std::string &key) const noexcept {
  1267. auto it = entries_.find(key);
  1268. if (it == entries_.end() || !it->second) { return nullptr; }
  1269. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1270. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1271. }
  1272. bool has(const std::string &key) const noexcept {
  1273. return entries_.find(key) != entries_.end();
  1274. }
  1275. void erase(const std::string &key) { entries_.erase(key); }
  1276. void clear() noexcept { entries_.clear(); }
  1277. private:
  1278. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1279. entries_;
  1280. };
  1281. struct Response;
  1282. using ResponseHandler = std::function<bool(const Response &response)>;
  1283. struct FormData {
  1284. std::string name;
  1285. std::string content;
  1286. std::string filename;
  1287. std::string content_type;
  1288. Headers headers;
  1289. };
  1290. struct FormField {
  1291. std::string name;
  1292. std::string content;
  1293. Headers headers;
  1294. };
  1295. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1296. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1297. // should see the parts as they were sent. A std::multimap sorts by field name
  1298. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1299. // than the case-insensitive predicate Headers uses.
  1300. using FormFields =
  1301. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1302. using FormFiles =
  1303. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1304. struct MultipartFormData {
  1305. FormFields fields; // Text fields from multipart
  1306. FormFiles files; // Files from multipart
  1307. // Text field access
  1308. std::string get_field(const std::string &key, size_t id = 0) const;
  1309. std::vector<std::string> get_fields(const std::string &key) const;
  1310. bool has_field(const std::string &key) const;
  1311. size_t get_field_count(const std::string &key) const;
  1312. // File access
  1313. FormData get_file(const std::string &key, size_t id = 0) const;
  1314. std::vector<FormData> get_files(const std::string &key) const;
  1315. bool has_file(const std::string &key) const;
  1316. size_t get_file_count(const std::string &key) const;
  1317. };
  1318. struct UploadFormData {
  1319. std::string name;
  1320. std::string content;
  1321. std::string filename;
  1322. std::string content_type;
  1323. };
  1324. using UploadFormDataItems = std::vector<UploadFormData>;
  1325. class DataSink {
  1326. public:
  1327. DataSink() : os(&sb_), sb_(*this) {}
  1328. DataSink(const DataSink &) = delete;
  1329. DataSink &operator=(const DataSink &) = delete;
  1330. DataSink(DataSink &&) = delete;
  1331. DataSink &operator=(DataSink &&) = delete;
  1332. std::function<bool(const char *data, size_t data_len)> write;
  1333. // Only `write` is mandatory. The rest are defaulted so that a provider
  1334. // calling one on a writer that does not set it gets sensible behaviour
  1335. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1336. // `this` is safe: DataSink is neither copyable nor movable.
  1337. std::function<bool()> is_writable = []() { return true; };
  1338. std::function<void()> done = []() {};
  1339. std::function<void(const Headers &trailer)> done_with_trailer =
  1340. [this](const Headers & /*trailer*/) { done(); };
  1341. std::ostream os;
  1342. private:
  1343. class data_sink_streambuf final : public std::streambuf {
  1344. public:
  1345. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1346. protected:
  1347. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1348. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1349. return 0;
  1350. }
  1351. private:
  1352. DataSink &sink_;
  1353. };
  1354. data_sink_streambuf sb_;
  1355. };
  1356. using ContentProvider =
  1357. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1358. using ContentProviderWithoutLength =
  1359. std::function<bool(size_t offset, DataSink &sink)>;
  1360. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1361. struct FormDataProvider {
  1362. std::string name;
  1363. ContentProviderWithoutLength provider;
  1364. std::string filename;
  1365. std::string content_type;
  1366. };
  1367. using FormDataProviderItems = std::vector<FormDataProvider>;
  1368. inline FormDataProvider
  1369. make_file_provider(const std::string &name, const std::string &filepath,
  1370. const std::string &filename = std::string(),
  1371. const std::string &content_type = std::string()) {
  1372. FormDataProvider fdp;
  1373. fdp.name = name;
  1374. fdp.filename = filename.empty() ? filepath : filename;
  1375. fdp.content_type = content_type;
  1376. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1377. std::ifstream f(filepath, std::ios::binary);
  1378. if (!f) { return false; }
  1379. if (offset > 0) {
  1380. f.seekg(static_cast<std::streamoff>(offset));
  1381. if (!f.good()) {
  1382. sink.done();
  1383. return true;
  1384. }
  1385. }
  1386. char buf[8192];
  1387. f.read(buf, sizeof(buf));
  1388. auto n = static_cast<size_t>(f.gcount());
  1389. if (n > 0) { return sink.write(buf, n); }
  1390. sink.done(); // EOF
  1391. return true;
  1392. };
  1393. return fdp;
  1394. }
  1395. inline std::pair<size_t, ContentProvider>
  1396. make_file_body(const std::string &filepath) {
  1397. size_t size = 0;
  1398. {
  1399. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1400. if (!f) { return {0, ContentProvider{}}; }
  1401. size = static_cast<size_t>(f.tellg());
  1402. }
  1403. ContentProvider provider = [filepath](size_t offset, size_t length,
  1404. DataSink &sink) -> bool {
  1405. std::ifstream f(filepath, std::ios::binary);
  1406. if (!f) { return false; }
  1407. f.seekg(static_cast<std::streamoff>(offset));
  1408. if (!f.good()) { return false; }
  1409. char buf[8192];
  1410. while (length > 0) {
  1411. auto to_read = (std::min)(sizeof(buf), length);
  1412. f.read(buf, static_cast<std::streamsize>(to_read));
  1413. auto n = static_cast<size_t>(f.gcount());
  1414. // The file is shorter than the size make_file_body() measured, which the
  1415. // caller has already committed to as Content-Length. The body cannot be
  1416. // completed, so fail as every other error here does.
  1417. if (n == 0) { return false; }
  1418. if (!sink.write(buf, n)) { return false; }
  1419. length -= n;
  1420. }
  1421. return true;
  1422. };
  1423. return {size, std::move(provider)};
  1424. }
  1425. using ContentReceiverWithProgress = std::function<bool(
  1426. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1427. using ContentReceiver =
  1428. std::function<bool(const char *data, size_t data_length)>;
  1429. using FormDataHeader = std::function<bool(const FormData &file)>;
  1430. class ContentReader {
  1431. public:
  1432. using Reader = std::function<bool(ContentReceiver receiver)>;
  1433. using FormDataReader =
  1434. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1435. ContentReader(Reader reader, FormDataReader multipart_reader)
  1436. : reader_(std::move(reader)),
  1437. formdata_reader_(std::move(multipart_reader)) {}
  1438. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1439. return formdata_reader_(std::move(header), std::move(receiver));
  1440. }
  1441. bool operator()(ContentReceiver receiver) const {
  1442. return reader_(std::move(receiver));
  1443. }
  1444. Reader reader_;
  1445. FormDataReader formdata_reader_;
  1446. };
  1447. using Range = std::pair<ssize_t, ssize_t>;
  1448. using Ranges = std::vector<Range>;
  1449. #ifdef CPPHTTPLIB_SSL_ENABLED
  1450. // TLS abstraction layer - public type definitions and API
  1451. namespace tls {
  1452. // Opaque handles (defined as void* for abstraction)
  1453. using ctx_t = void *;
  1454. using session_t = void *;
  1455. using const_session_t = const void *; // For read-only session access
  1456. using cert_t = void *;
  1457. using ca_store_t = void *;
  1458. // TLS versions
  1459. enum class Version {
  1460. TLS1_2 = 0x0303,
  1461. TLS1_3 = 0x0304,
  1462. };
  1463. // Subject Alternative Names (SAN) entry types
  1464. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1465. // SAN entry structure
  1466. struct SanEntry {
  1467. SanType type;
  1468. std::string value;
  1469. };
  1470. // Verification context for certificate verification callback
  1471. struct VerifyContext {
  1472. session_t session; // TLS session handle
  1473. cert_t cert; // Current certificate being verified
  1474. int depth; // Certificate chain depth (0 = leaf)
  1475. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1476. long error_code; // Backend-specific error code (0 = no error)
  1477. const char *error_string; // Human-readable error description
  1478. // Certificate introspection methods
  1479. std::string subject_cn() const;
  1480. std::string issuer_name() const;
  1481. bool check_hostname(const char *hostname) const;
  1482. std::vector<SanEntry> sans() const;
  1483. bool validity(time_t &not_before, time_t &not_after) const;
  1484. std::string serial() const;
  1485. };
  1486. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1487. // TlsError codes for TLS operations (backend-independent)
  1488. enum class ErrorCode : int {
  1489. Success = 0,
  1490. WantRead, // Non-blocking: need to wait for read
  1491. WantWrite, // Non-blocking: need to wait for write
  1492. PeerClosed, // Peer closed the connection
  1493. Fatal, // Unrecoverable error
  1494. SyscallError, // System call error (check sys_errno)
  1495. CertVerifyFailed, // Certificate verification failed
  1496. HostnameMismatch, // Hostname verification failed
  1497. };
  1498. // TLS error information
  1499. struct TlsError {
  1500. ErrorCode code = ErrorCode::Fatal;
  1501. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1502. int sys_errno = 0; // errno when SyscallError
  1503. // Convert verification error code to human-readable string
  1504. static std::string verify_error_to_string(long error_code);
  1505. };
  1506. // RAII wrapper for peer certificate
  1507. class PeerCert {
  1508. public:
  1509. PeerCert();
  1510. PeerCert(PeerCert &&other) noexcept;
  1511. PeerCert &operator=(PeerCert &&other) noexcept;
  1512. ~PeerCert();
  1513. PeerCert(const PeerCert &) = delete;
  1514. PeerCert &operator=(const PeerCert &) = delete;
  1515. explicit operator bool() const;
  1516. std::string subject_cn() const;
  1517. std::string issuer_name() const;
  1518. bool check_hostname(const char *hostname) const;
  1519. std::vector<SanEntry> sans() const;
  1520. bool validity(time_t &not_before, time_t &not_after) const;
  1521. std::string serial() const;
  1522. private:
  1523. explicit PeerCert(cert_t cert);
  1524. cert_t cert_ = nullptr;
  1525. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1526. };
  1527. // Callback for TLS context setup (used by SSLServer constructor)
  1528. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1529. } // namespace tls
  1530. #endif
  1531. struct Request {
  1532. std::string method;
  1533. std::string path;
  1534. std::string matched_route;
  1535. Params params;
  1536. Headers headers;
  1537. Headers trailers;
  1538. std::string body;
  1539. std::string remote_addr;
  1540. int remote_port = -1;
  1541. std::string local_addr;
  1542. int local_port = -1;
  1543. // for server
  1544. std::string version;
  1545. std::string target;
  1546. MultipartFormData form;
  1547. Ranges ranges;
  1548. Match matches;
  1549. std::unordered_map<std::string, std::string> path_params;
  1550. std::function<bool()> is_connection_closed = []() { return true; };
  1551. // for client
  1552. std::vector<std::string> accept_content_types;
  1553. ResponseHandler response_handler;
  1554. ContentReceiverWithProgress content_receiver;
  1555. DownloadProgress download_progress;
  1556. UploadProgress upload_progress;
  1557. bool has_header(const std::string &key) const;
  1558. std::string get_header_value(const std::string &key, const char *def = "",
  1559. size_t id = 0) const;
  1560. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1561. size_t id = 0) const;
  1562. size_t get_header_value_count(const std::string &key) const;
  1563. void set_header(const std::string &key, const std::string &val);
  1564. bool has_trailer(const std::string &key) const;
  1565. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1566. size_t get_trailer_value_count(const std::string &key) const;
  1567. bool has_param(const std::string &key) const;
  1568. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1569. std::vector<std::string> get_param_values(const std::string &key) const;
  1570. size_t get_param_value_count(const std::string &key) const;
  1571. bool is_multipart_form_data() const;
  1572. // private members...
  1573. bool body_read_started_ = false;
  1574. bool body_consumed_ = false;
  1575. bool expect_100_continue_pending_ = false;
  1576. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1577. size_t content_length_ = 0;
  1578. ContentProvider content_provider_;
  1579. bool is_chunked_content_provider_ = false;
  1580. size_t authorization_count_ = 0;
  1581. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1582. (std::chrono::steady_clock::time_point::min)();
  1583. #ifdef CPPHTTPLIB_SSL_ENABLED
  1584. tls::const_session_t ssl = nullptr;
  1585. tls::PeerCert peer_cert() const;
  1586. std::string sni() const;
  1587. #endif
  1588. };
  1589. namespace detail {
  1590. // Declared up here, away from the rest of the compression helpers, because
  1591. // `Response` stores one.
  1592. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1593. } // namespace detail
  1594. struct Response {
  1595. std::string version;
  1596. int status = -1;
  1597. std::string reason;
  1598. Headers headers;
  1599. Headers trailers;
  1600. std::string body;
  1601. std::string location; // Redirect location
  1602. // User-defined context — set by pre-routing/pre-request handlers and read
  1603. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1604. UserData user_data;
  1605. bool has_header(const std::string &key) const;
  1606. std::string get_header_value(const std::string &key, const char *def = "",
  1607. size_t id = 0) const;
  1608. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1609. size_t id = 0) const;
  1610. size_t get_header_value_count(const std::string &key) const;
  1611. void set_header(const std::string &key, const std::string &val);
  1612. bool has_trailer(const std::string &key) const;
  1613. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1614. size_t get_trailer_value_count(const std::string &key) const;
  1615. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1616. void set_content(const char *s, size_t n, const std::string &content_type);
  1617. void set_content(const std::string &s, const std::string &content_type);
  1618. void set_content(std::string &&s, const std::string &content_type);
  1619. void set_content_provider(
  1620. size_t length, const std::string &content_type, ContentProvider provider,
  1621. ContentProviderResourceReleaser resource_releaser = nullptr);
  1622. void set_content_provider(
  1623. const std::string &content_type, ContentProviderWithoutLength provider,
  1624. ContentProviderResourceReleaser resource_releaser = nullptr);
  1625. void set_chunked_content_provider(
  1626. const std::string &content_type, ContentProviderWithoutLength provider,
  1627. ContentProviderResourceReleaser resource_releaser = nullptr);
  1628. void set_file_content(const std::string &path,
  1629. const std::string &content_type);
  1630. void set_file_content(const std::string &path);
  1631. Response() = default;
  1632. Response(const Response &) = default;
  1633. Response &operator=(const Response &) = default;
  1634. Response(Response &&) = default;
  1635. Response &operator=(Response &&) = default;
  1636. ~Response() {
  1637. if (content_provider_resource_releaser_) {
  1638. content_provider_resource_releaser_(content_provider_success_);
  1639. }
  1640. }
  1641. // private members...
  1642. size_t content_length_ = 0;
  1643. ContentProvider content_provider_;
  1644. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1645. bool is_chunked_content_provider_ = false;
  1646. bool is_file_content_provider_ = false;
  1647. bool content_provider_success_ = false;
  1648. std::string file_content_path_;
  1649. std::string file_content_content_type_;
  1650. // Content coding chosen for the response body, decided once so that the
  1651. // headers and the body cannot disagree: where the file is opened for a
  1652. // file-backed content provider (keeping the ETag honest), and in
  1653. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1654. // for every other kind of response.
  1655. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1656. };
  1657. enum class Error {
  1658. Success = 0,
  1659. Unknown,
  1660. Connection,
  1661. BindIPAddress,
  1662. Read,
  1663. Write,
  1664. ExceedRedirectCount,
  1665. Canceled,
  1666. SSLConnection,
  1667. SSLLoadingCerts,
  1668. SSLServerVerification,
  1669. SSLServerHostnameVerification,
  1670. UnsupportedMultipartBoundaryChars,
  1671. Compression,
  1672. ConnectionTimeout,
  1673. ProxyConnection,
  1674. ConnectionClosed,
  1675. Timeout,
  1676. ResourceExhaustion,
  1677. TooManyFormDataFiles,
  1678. ExceedMaxPayloadSize,
  1679. ExceedUriMaxLength,
  1680. ExceedMaxSocketDescriptorCount,
  1681. InvalidRequestLine,
  1682. InvalidHTTPMethod,
  1683. InvalidHTTPVersion,
  1684. InvalidHeaders,
  1685. MultipartParsing,
  1686. OpenFile,
  1687. Listen,
  1688. GetSockName,
  1689. UnsupportedAddressFamily,
  1690. HTTPParsing,
  1691. InvalidRangeHeader,
  1692. UnsupportedContentEncoding,
  1693. WebSocketHandshake,
  1694. UserCallbackException,
  1695. // For internal use only
  1696. SSLPeerCouldBeClosed_,
  1697. };
  1698. std::string to_string(Error error);
  1699. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1700. class Stream {
  1701. public:
  1702. virtual ~Stream() = default;
  1703. virtual bool is_readable() const = 0;
  1704. virtual bool wait_readable() const = 0;
  1705. virtual bool wait_writable() const = 0;
  1706. virtual bool is_peer_alive() const { return wait_writable(); }
  1707. virtual ssize_t read(char *ptr, size_t size) = 0;
  1708. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1709. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1710. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1711. virtual socket_t socket() const = 0;
  1712. virtual time_t duration() const = 0;
  1713. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1714. (void)sec;
  1715. (void)usec;
  1716. }
  1717. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1718. // each one. 0 lifts the bound.
  1719. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1720. // Lets a wait for data end early once `interrupted` returns true, so that
  1721. // another thread can stop a blocked read on every platform.
  1722. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1723. (void)interrupted;
  1724. }
  1725. // Bytes already pulled off the socket and sitting in this stream's own
  1726. // buffer. Exposing them lets a line reader scan for a terminator in one
  1727. // pass instead of asking for a byte at a time. A stream that does no
  1728. // buffering of its own reports none, and readers fall back to read().
  1729. virtual const char *buffered_data(size_t &size) const {
  1730. size = 0;
  1731. return nullptr;
  1732. }
  1733. // Discards `size` bytes previously returned by buffered_data().
  1734. virtual void consume_buffered(size_t size) { (void)size; }
  1735. ssize_t write(const char *ptr);
  1736. ssize_t write(const std::string &s);
  1737. Error get_error() const { return error_; }
  1738. protected:
  1739. Error error_ = Error::Success;
  1740. };
  1741. class TaskQueue {
  1742. public:
  1743. TaskQueue() = default;
  1744. virtual ~TaskQueue() = default;
  1745. virtual bool enqueue(std::function<void()> fn) = 0;
  1746. virtual void shutdown() = 0;
  1747. virtual void on_idle() {}
  1748. };
  1749. class ThreadPool final : public TaskQueue {
  1750. public:
  1751. explicit ThreadPool(
  1752. size_t n, size_t max_n = 0, size_t mqr = 0,
  1753. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1754. ThreadPool(const ThreadPool &) = delete;
  1755. ~ThreadPool() override = default;
  1756. bool enqueue(std::function<void()> fn) override;
  1757. void shutdown() override;
  1758. private:
  1759. void worker(bool is_dynamic);
  1760. void move_to_finished(std::thread::id id);
  1761. void cleanup_finished_threads();
  1762. size_t base_thread_count_;
  1763. size_t max_thread_count_;
  1764. size_t max_queued_requests_;
  1765. time_t idle_timeout_sec_;
  1766. size_t idle_thread_count_;
  1767. bool shutdown_;
  1768. std::list<std::function<void()>> jobs_;
  1769. std::vector<std::thread> threads_; // base threads
  1770. std::list<std::thread> dynamic_threads_; // dynamic threads
  1771. std::vector<std::thread>
  1772. finished_threads_; // exited dynamic threads awaiting join
  1773. std::condition_variable cond_;
  1774. std::mutex mutex_;
  1775. };
  1776. using Logger = std::function<void(const Request &, const Response &)>;
  1777. // Forward declaration for Error type
  1778. enum class Error;
  1779. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1780. using SocketOptions = std::function<void(socket_t sock)>;
  1781. void default_socket_options(socket_t sock);
  1782. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1783. const char *status_message(int status);
  1784. std::string to_string(Error error);
  1785. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1786. std::string get_bearer_token_auth(const Request &req);
  1787. namespace detail {
  1788. class MatcherBase {
  1789. public:
  1790. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1791. virtual ~MatcherBase() = default;
  1792. const std::string &pattern() const { return pattern_; }
  1793. // Match request path and populate its matches and
  1794. virtual bool match(Request &request) const = 0;
  1795. private:
  1796. std::string pattern_;
  1797. };
  1798. /**
  1799. * Captures parameters in request path and stores them in Request::path_params
  1800. *
  1801. * Capture name is a substring of a pattern from : to /.
  1802. * The rest of the pattern is matched against the request path directly
  1803. * Parameters are captured starting from the next character after
  1804. * the end of the last matched static pattern fragment until the next /.
  1805. *
  1806. * Example pattern:
  1807. * "/path/fragments/:capture/more/fragments/:second_capture"
  1808. * Static fragments:
  1809. * "/path/fragments/", "more/fragments/"
  1810. *
  1811. * Given the following request path:
  1812. * "/path/fragments/:1/more/fragments/:2"
  1813. * the resulting capture will be
  1814. * {{"capture", "1"}, {"second_capture", "2"}}
  1815. */
  1816. class PathParamsMatcher final : public MatcherBase {
  1817. public:
  1818. PathParamsMatcher(const std::string &pattern);
  1819. bool match(Request &request) const override;
  1820. private:
  1821. // Treat segment separators as the end of path parameter capture
  1822. // Does not need to handle query parameters as they are parsed before path
  1823. // matching
  1824. static constexpr char separator = '/';
  1825. // Contains static path fragments to match against, excluding the '/' after
  1826. // path params
  1827. // Fragments are separated by path params
  1828. std::vector<std::string> static_fragments_;
  1829. // Stores the names of the path parameters to be used as keys in the
  1830. // Request::path_params map
  1831. std::vector<std::string> param_names_;
  1832. };
  1833. /**
  1834. * Performs std::regex_match on request path
  1835. * and stores the result in Request::matches
  1836. *
  1837. * Note that regex match is performed directly on the whole request.
  1838. * This means that wildcard patterns may match multiple path segments with /:
  1839. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1840. */
  1841. class RegexMatcher final : public MatcherBase {
  1842. public:
  1843. RegexMatcher(const std::string &pattern)
  1844. : MatcherBase(pattern), regex_(pattern) {}
  1845. bool match(Request &request) const override;
  1846. private:
  1847. std::regex regex_;
  1848. };
  1849. int close_socket(socket_t sock) noexcept;
  1850. bool is_accept_resource_error();
  1851. bool is_accept_transient_error();
  1852. ssize_t write_headers(Stream &strm, const Headers &headers);
  1853. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1854. time_t usec);
  1855. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1856. const std::string &boundary);
  1857. ContentProvider
  1858. make_multipart_content_provider(const UploadFormDataItems &items,
  1859. const std::string &boundary);
  1860. } // namespace detail
  1861. bool is_valid_multipart_boundary(const std::string &boundary);
  1862. // Serializer for multipart/form-data request bodies. The boundary is owned
  1863. // by the writer so that per-part framing and the final terminator always
  1864. // agree. Field names and filenames are escaped following the WHATWG HTML
  1865. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1866. // in content types.
  1867. class MultipartFormDataWriter {
  1868. public:
  1869. MultipartFormDataWriter();
  1870. // precondition: is_valid_multipart_boundary(boundary)
  1871. explicit MultipartFormDataWriter(std::string boundary);
  1872. const std::string &boundary() const;
  1873. std::string content_type() const;
  1874. // In-memory items -> whole body (known length)
  1875. std::string serialize(const UploadFormDataItems &items) const;
  1876. size_t content_length(const UploadFormDataItems &items) const;
  1877. // Per-part framing for streaming via a content provider
  1878. std::string item_begin(const UploadFormData &item) const;
  1879. static std::string item_end();
  1880. std::string finish() const;
  1881. private:
  1882. std::string boundary_;
  1883. };
  1884. class Server {
  1885. public:
  1886. using Handler = std::function<void(const Request &, Response &)>;
  1887. using ExceptionHandler =
  1888. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1889. enum class HandlerResponse {
  1890. Handled,
  1891. Unhandled,
  1892. };
  1893. using HandlerWithResponse =
  1894. std::function<HandlerResponse(const Request &, Response &)>;
  1895. using HandlerWithContentReader = std::function<void(
  1896. const Request &, Response &, const ContentReader &content_reader)>;
  1897. using Expect100ContinueHandler =
  1898. std::function<int(const Request &, Response &)>;
  1899. using StartHandler = std::function<void()>;
  1900. using WebSocketHandler =
  1901. std::function<void(const Request &, ws::WebSocket &)>;
  1902. using SubProtocolSelector =
  1903. std::function<std::string(const std::vector<std::string> &protocols)>;
  1904. Server();
  1905. virtual ~Server();
  1906. virtual bool is_valid() const;
  1907. Server &Get(const std::string &pattern, Handler handler);
  1908. Server &Post(const std::string &pattern, Handler handler);
  1909. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1910. Server &Put(const std::string &pattern, Handler handler);
  1911. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1912. Server &Patch(const std::string &pattern, Handler handler);
  1913. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1914. Server &Delete(const std::string &pattern, Handler handler);
  1915. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1916. Server &Options(const std::string &pattern, Handler handler);
  1917. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1918. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1919. // server accept it; an unregistered method is still rejected with 400.
  1920. // `method` must be a valid HTTP method token and must not be one of the
  1921. // built-in methods, which have their own registration functions above. A
  1922. // rejected registration makes is_valid() return false, so listen() fails.
  1923. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1924. Handler handler);
  1925. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1926. HandlerWithContentReader handler);
  1927. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1928. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1929. SubProtocolSelector sub_protocol_selector);
  1930. bool set_base_dir(const std::string &dir,
  1931. const std::string &mount_point = std::string());
  1932. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1933. Headers headers = Headers());
  1934. bool remove_mount_point(const std::string &mount_point);
  1935. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1936. const std::string &mime);
  1937. Server &set_default_file_mimetype(const std::string &mime);
  1938. Server &set_file_request_handler(Handler handler);
  1939. template <class ErrorHandlerFunc>
  1940. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1941. return set_error_handler_core(
  1942. std::forward<ErrorHandlerFunc>(handler),
  1943. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1944. }
  1945. Server &set_exception_handler(ExceptionHandler handler);
  1946. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1947. Server &set_post_routing_handler(Handler handler);
  1948. Server &set_pre_request_handler(HandlerWithResponse handler);
  1949. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1950. Server &set_start_handler(StartHandler handler);
  1951. Server &set_logger(Logger logger);
  1952. Server &set_pre_compression_logger(Logger logger);
  1953. Server &set_error_logger(ErrorLogger error_logger);
  1954. Server &set_address_family(int family);
  1955. Server &set_tcp_nodelay(bool on);
  1956. Server &set_ipv6_v6only(bool on);
  1957. Server &set_socket_options(SocketOptions socket_options);
  1958. Server &set_default_headers(Headers headers);
  1959. Server &
  1960. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1961. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1962. Server &set_keep_alive_max_count(size_t count);
  1963. Server &set_keep_alive_timeout(time_t sec);
  1964. template <class Rep, class Period>
  1965. Server &
  1966. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1967. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1968. template <class Rep, class Period>
  1969. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1970. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1971. template <class Rep, class Period>
  1972. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1973. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1974. template <class Rep, class Period>
  1975. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1976. Server &set_payload_max_length(size_t length);
  1977. Server &set_compress(bool on);
  1978. Server &set_static_file_compression(bool on);
  1979. Server &set_static_file_compression_min_length(size_t length);
  1980. Server &set_static_file_compression_max_length(size_t length);
  1981. Server &set_websocket_ping_interval(time_t sec);
  1982. template <class Rep, class Period>
  1983. Server &set_websocket_ping_interval(
  1984. const std::chrono::duration<Rep, Period> &duration);
  1985. Server &set_websocket_max_missed_pongs(int count);
  1986. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1987. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1988. bool listen_after_bind();
  1989. bool listen(const std::string &host, int port, int socket_flags = 0);
  1990. bool is_running() const;
  1991. void wait_until_ready() const;
  1992. void stop() noexcept;
  1993. void decommission();
  1994. std::function<TaskQueue *(void)> new_task_queue;
  1995. protected:
  1996. bool process_request(Stream &strm, const std::string &remote_addr,
  1997. int remote_port, const std::string &local_addr,
  1998. int local_port, bool close_connection,
  1999. bool &connection_closed,
  2000. const std::function<void(Request &)> &setup_request,
  2001. bool *websocket_upgraded = nullptr);
  2002. // Runs the per-connection serving loop and stops an exception thrown by a
  2003. // user callback from escaping the worker thread.
  2004. //
  2005. // process_request() wraps only routing() and the hooks before a WebSocket
  2006. // upgrade in a try/catch. Content providers, the post-routing, error,
  2007. // logging and expect-100 handlers and WebSocket handlers all run outside
  2008. // it, and the task queue calls the job without a catch, so an exception
  2009. // from any of those would terminate the process.
  2010. //
  2011. // No 500 is possible here: by the time a content provider runs, the status
  2012. // line and headers are already on the wire. Report it through the error
  2013. // logger and drop the connection, which is what the peer observes either
  2014. // way. Other connections are unaffected.
  2015. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2016. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2017. return serve();
  2018. #else
  2019. try {
  2020. return serve();
  2021. } catch (...) {
  2022. // The error logger is a user callback too, so it must not be able to
  2023. // throw the guard back open.
  2024. try {
  2025. output_error_log(Error::UserCallbackException, nullptr);
  2026. } catch (...) {}
  2027. return false;
  2028. }
  2029. #endif
  2030. }
  2031. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2032. std::vector<std::string> trusted_proxies_;
  2033. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2034. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2035. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2036. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2037. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2038. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2039. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2040. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2041. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2042. bool compress_ = true;
  2043. bool static_file_compression_ = false;
  2044. size_t static_file_compression_min_length_ =
  2045. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2046. size_t static_file_compression_max_length_ =
  2047. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2048. time_t websocket_ping_interval_sec_ =
  2049. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2050. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2051. private:
  2052. using Handlers =
  2053. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2054. using HandlersForContentReader =
  2055. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2056. HandlerWithContentReader>>;
  2057. // Both handler tables for one custom method live in a single entry, so that
  2058. // routing() needs only one map lookup per request to reach either of them.
  2059. struct CustomHandlerEntry {
  2060. Handlers handlers;
  2061. HandlersForContentReader handlers_for_content_reader;
  2062. };
  2063. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2064. static std::unique_ptr<detail::MatcherBase>
  2065. make_matcher(const std::string &pattern);
  2066. static const std::set<std::string> &builtin_methods();
  2067. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2068. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2069. template <typename H>
  2070. Server &add_handler(
  2071. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2072. const std::string &pattern, H handler) {
  2073. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2074. return *this;
  2075. }
  2076. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2077. Server &set_error_handler_core(Handler handler, std::false_type);
  2078. socket_t create_server_socket(const std::string &host, int port,
  2079. int socket_flags,
  2080. SocketOptions socket_options) const;
  2081. int bind_internal(const std::string &host, int port, int socket_flags);
  2082. bool listen_internal();
  2083. bool routing(Request &req, Response &res, Stream &strm,
  2084. bool skip_pre_routing);
  2085. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2086. bool handle_exception(Request &req, Response &res);
  2087. #endif
  2088. bool handle_file_request(Request &req, Response &res);
  2089. bool check_if_not_modified(const Request &req, Response &res,
  2090. const std::string &etag, time_t mtime) const;
  2091. bool check_if_range(Request &req, const std::string &etag,
  2092. time_t mtime) const;
  2093. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2094. Stream &strm);
  2095. bool dispatch_request_for_content_reader(
  2096. Request &req, Response &res, ContentReader content_reader,
  2097. const HandlersForContentReader &handlers) const;
  2098. bool parse_request_line(const char *s, Request &req) const;
  2099. detail::EncodingType static_file_encoding(const Request &req,
  2100. const Response &res,
  2101. const std::string &content_type,
  2102. size_t length) const;
  2103. bool apply_static_file_compression(const Request &req, Response &res) const;
  2104. void apply_ranges(const Request &req, Response &res,
  2105. std::string &content_type, std::string &boundary) const;
  2106. bool write_response(Stream &strm, bool close_connection, Request &req,
  2107. Response &res);
  2108. bool write_response_with_content(Stream &strm, bool close_connection,
  2109. const Request &req, Response &res);
  2110. bool write_response_core(Stream &strm, bool close_connection,
  2111. const Request &req, Response &res,
  2112. bool need_apply_ranges);
  2113. bool write_content_with_provider(Stream &strm, const Request &req,
  2114. Response &res, const std::string &boundary,
  2115. const std::string &content_type);
  2116. bool read_content(Stream &strm, Request &req, Response &res);
  2117. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2118. Response &res,
  2119. ContentReceiver receiver,
  2120. FormDataHeader multipart_header,
  2121. ContentReceiver multipart_receiver);
  2122. bool read_content_core(Stream &strm, Request &req, Response &res,
  2123. ContentReceiver receiver,
  2124. FormDataHeader multipart_header,
  2125. ContentReceiver multipart_receiver) const;
  2126. virtual bool process_and_close_socket(socket_t sock);
  2127. void output_log(const Request &req, const Response &res) const;
  2128. void output_pre_compression_log(const Request &req,
  2129. const Response &res) const;
  2130. void output_error_log(const Error &err, const Request *req) const;
  2131. std::atomic<bool> is_running_{false};
  2132. std::atomic<bool> is_decommissioned{false};
  2133. // Set when CustomRoute() refuses a registration. Written before listen(),
  2134. // read by is_valid() on the same thread, so it needs no synchronization.
  2135. bool has_invalid_registration_ = false;
  2136. struct MountPointEntry {
  2137. std::string mount_point;
  2138. std::string base_dir;
  2139. std::string resolved_base_dir;
  2140. Headers headers;
  2141. };
  2142. std::vector<MountPointEntry> base_dirs_;
  2143. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2144. std::string default_file_mimetype_ = "application/octet-stream";
  2145. Handler file_request_handler_;
  2146. Handlers get_handlers_;
  2147. Handlers post_handlers_;
  2148. HandlersForContentReader post_handlers_for_content_reader_;
  2149. Handlers put_handlers_;
  2150. HandlersForContentReader put_handlers_for_content_reader_;
  2151. Handlers patch_handlers_;
  2152. HandlersForContentReader patch_handlers_for_content_reader_;
  2153. Handlers delete_handlers_;
  2154. HandlersForContentReader delete_handlers_for_content_reader_;
  2155. Handlers options_handlers_;
  2156. CustomHandlers custom_handlers_;
  2157. struct WebSocketHandlerEntry {
  2158. std::unique_ptr<detail::MatcherBase> matcher;
  2159. WebSocketHandler handler;
  2160. SubProtocolSelector sub_protocol_selector;
  2161. };
  2162. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2163. WebSocketHandlers websocket_handlers_;
  2164. HandlerWithResponse error_handler_;
  2165. ExceptionHandler exception_handler_;
  2166. HandlerWithResponse pre_routing_handler_;
  2167. Handler post_routing_handler_;
  2168. HandlerWithResponse pre_request_handler_;
  2169. Expect100ContinueHandler expect_100_continue_handler_;
  2170. StartHandler start_handler_;
  2171. mutable std::mutex logger_mutex_;
  2172. Logger logger_;
  2173. Logger pre_compression_logger_;
  2174. ErrorLogger error_logger_;
  2175. int address_family_ = AF_UNSPEC;
  2176. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2177. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2178. SocketOptions socket_options_ = default_socket_options;
  2179. Headers default_headers_;
  2180. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2181. detail::write_headers;
  2182. };
  2183. class Result {
  2184. public:
  2185. Result() = default;
  2186. Result(std::unique_ptr<Response> &&res, Error err,
  2187. Headers &&request_headers = Headers{})
  2188. : res_(std::move(res)), err_(err),
  2189. request_headers_(std::move(request_headers)) {}
  2190. // Response
  2191. operator bool() const { return res_ != nullptr; }
  2192. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2193. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2194. const Response &value() const { return *res_; }
  2195. Response &value() { return *res_; }
  2196. const Response &operator*() const { return *res_; }
  2197. Response &operator*() { return *res_; }
  2198. const Response *operator->() const { return res_.get(); }
  2199. Response *operator->() { return res_.get(); }
  2200. // Error
  2201. Error error() const { return err_; }
  2202. // Request Headers
  2203. bool has_request_header(const std::string &key) const;
  2204. std::string get_request_header_value(const std::string &key,
  2205. const char *def = "",
  2206. size_t id = 0) const;
  2207. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2208. size_t id = 0) const;
  2209. size_t get_request_header_value_count(const std::string &key) const;
  2210. private:
  2211. std::unique_ptr<Response> res_;
  2212. Error err_ = Error::Unknown;
  2213. Headers request_headers_;
  2214. #ifdef CPPHTTPLIB_SSL_ENABLED
  2215. public:
  2216. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2217. int ssl_error)
  2218. : res_(std::move(res)), err_(err),
  2219. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2220. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2221. int ssl_error, uint64_t ssl_backend_error)
  2222. : res_(std::move(res)), err_(err),
  2223. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2224. ssl_backend_error_(ssl_backend_error) {}
  2225. int ssl_error() const { return ssl_error_; }
  2226. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2227. private:
  2228. int ssl_error_ = 0;
  2229. uint64_t ssl_backend_error_ = 0;
  2230. #endif
  2231. };
  2232. struct ClientConnection {
  2233. socket_t sock = INVALID_SOCKET;
  2234. bool is_open() const { return sock != INVALID_SOCKET; }
  2235. ClientConnection() = default;
  2236. ~ClientConnection();
  2237. ClientConnection(const ClientConnection &) = delete;
  2238. ClientConnection &operator=(const ClientConnection &) = delete;
  2239. ClientConnection(ClientConnection &&other) noexcept
  2240. : sock(other.sock)
  2241. #ifdef CPPHTTPLIB_SSL_ENABLED
  2242. ,
  2243. session(other.session)
  2244. #endif
  2245. {
  2246. other.sock = INVALID_SOCKET;
  2247. #ifdef CPPHTTPLIB_SSL_ENABLED
  2248. other.session = nullptr;
  2249. #endif
  2250. }
  2251. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2252. if (this != &other) {
  2253. sock = other.sock;
  2254. other.sock = INVALID_SOCKET;
  2255. #ifdef CPPHTTPLIB_SSL_ENABLED
  2256. session = other.session;
  2257. other.session = nullptr;
  2258. #endif
  2259. }
  2260. return *this;
  2261. }
  2262. #ifdef CPPHTTPLIB_SSL_ENABLED
  2263. tls::session_t session = nullptr;
  2264. #endif
  2265. };
  2266. namespace detail {
  2267. struct ChunkedDecoder;
  2268. struct BodyReader {
  2269. Stream *stream = nullptr;
  2270. bool has_content_length = false;
  2271. size_t content_length = 0;
  2272. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2273. size_t bytes_read = 0;
  2274. bool chunked = false;
  2275. bool eof = false;
  2276. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2277. Error last_error = Error::Success;
  2278. ssize_t read(char *buf, size_t len);
  2279. bool has_error() const { return last_error != Error::Success; }
  2280. };
  2281. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2282. size_t len) {
  2283. (void)stream;
  2284. return br.read(buf, len);
  2285. }
  2286. class decompressor;
  2287. enum class NoProxyKind {
  2288. Wildcard, // "*"
  2289. HostnameSuffix, // "example.com" or ".example.com"
  2290. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2291. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2292. };
  2293. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2294. // Lets one CIDR matcher cover both families.
  2295. using IPBytes = std::array<uint8_t, 16>;
  2296. struct NoProxyEntry {
  2297. NoProxyKind kind = NoProxyKind::Wildcard;
  2298. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2299. IPBytes net{};
  2300. int prefix_bits = 0;
  2301. };
  2302. struct NormalizedTarget {
  2303. std::string hostname; // lowercase; brackets and trailing dot removed
  2304. bool is_ipv4 = false;
  2305. bool is_ipv6 = false;
  2306. IPBytes ip{};
  2307. };
  2308. } // namespace detail
  2309. class ClientImpl {
  2310. public:
  2311. explicit ClientImpl(const std::string &host);
  2312. explicit ClientImpl(const std::string &host, int port);
  2313. explicit ClientImpl(const std::string &host, int port,
  2314. const std::string &client_cert_path,
  2315. const std::string &client_key_path);
  2316. virtual ~ClientImpl();
  2317. virtual bool is_valid() const;
  2318. struct StreamHandle {
  2319. std::unique_ptr<Response> response;
  2320. Error error = Error::Success;
  2321. StreamHandle() = default;
  2322. StreamHandle(const StreamHandle &) = delete;
  2323. StreamHandle &operator=(const StreamHandle &) = delete;
  2324. StreamHandle(StreamHandle &&) = default;
  2325. StreamHandle &operator=(StreamHandle &&) = default;
  2326. ~StreamHandle() = default;
  2327. bool is_valid() const {
  2328. return response != nullptr && error == Error::Success;
  2329. }
  2330. ssize_t read(char *buf, size_t len);
  2331. void parse_trailers_if_needed();
  2332. Error get_read_error() const { return body_reader_.last_error; }
  2333. bool has_read_error() const { return body_reader_.has_error(); }
  2334. bool trailers_parsed_ = false;
  2335. private:
  2336. friend class ClientImpl;
  2337. friend class sse::SSEClient;
  2338. ssize_t read_with_decompression(char *buf, size_t len);
  2339. std::unique_ptr<ClientConnection> connection_;
  2340. std::unique_ptr<Stream> socket_stream_;
  2341. Stream *stream_ = nullptr;
  2342. detail::BodyReader body_reader_;
  2343. std::unique_ptr<detail::decompressor> decompressor_;
  2344. std::string decompress_buffer_;
  2345. size_t decompress_offset_ = 0;
  2346. size_t decompressed_bytes_read_ = 0;
  2347. };
  2348. // clang-format off
  2349. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2350. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2351. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2352. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2353. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2354. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2355. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2356. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2357. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2358. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2359. Result Head(const std::string &path);
  2360. Result Head(const std::string &path, const Headers &headers);
  2361. Result Post(const std::string &path);
  2362. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2363. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2364. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2365. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2366. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2367. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2368. Result Post(const std::string &path, const Params &params);
  2369. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2370. Result Post(const std::string &path, const Headers &headers);
  2371. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2372. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2373. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2374. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2375. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2376. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2377. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2378. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2379. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2380. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2381. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2382. Result Put(const std::string &path);
  2383. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2385. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2386. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2387. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2388. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2389. Result Put(const std::string &path, const Params &params);
  2390. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2391. Result Put(const std::string &path, const Headers &headers);
  2392. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2393. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2394. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2395. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2396. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2397. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2398. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2399. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2400. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2401. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2402. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2403. Result Patch(const std::string &path);
  2404. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2405. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2406. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2407. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2408. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2409. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2410. Result Patch(const std::string &path, const Params &params);
  2411. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2412. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2413. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2414. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2415. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2416. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2417. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2418. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2419. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2420. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2421. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2422. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2423. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2424. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2425. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2426. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2427. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2428. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2429. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2430. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2431. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2432. Result Options(const std::string &path);
  2433. Result Options(const std::string &path, const Headers &headers);
  2434. // clang-format on
  2435. // Streaming API: Open a stream for reading response body incrementally
  2436. // Socket ownership is transferred to StreamHandle for true streaming
  2437. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2438. StreamHandle open_stream(const std::string &method, const std::string &path,
  2439. const Params &params = {},
  2440. const Headers &headers = {},
  2441. const std::string &body = {},
  2442. const std::string &content_type = {});
  2443. bool send(Request &req, Response &res, Error &error);
  2444. Result send(const Request &req);
  2445. void stop();
  2446. std::string host() const;
  2447. int port() const;
  2448. size_t is_socket_open() const;
  2449. socket_t socket() const;
  2450. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2451. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2452. void
  2453. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2454. void
  2455. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2456. void set_default_headers(Headers headers);
  2457. void
  2458. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2459. void set_address_family(int family);
  2460. void set_tcp_nodelay(bool on);
  2461. void set_ipv6_v6only(bool on);
  2462. void set_socket_options(SocketOptions socket_options);
  2463. void set_connection_timeout(time_t sec, time_t usec = 0);
  2464. template <class Rep, class Period>
  2465. void
  2466. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2467. void set_read_timeout(time_t sec, time_t usec = 0);
  2468. template <class Rep, class Period>
  2469. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2470. void set_write_timeout(time_t sec, time_t usec = 0);
  2471. template <class Rep, class Period>
  2472. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2473. void set_max_timeout(time_t msec);
  2474. template <class Rep, class Period>
  2475. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2476. void set_basic_auth(const std::string &username, const std::string &password);
  2477. void set_bearer_token_auth(const std::string &token);
  2478. void set_keep_alive(bool on);
  2479. void set_follow_location(bool on);
  2480. void set_path_encode(bool on);
  2481. void set_compress(bool on);
  2482. void set_decompress(bool on);
  2483. void set_payload_max_length(size_t length);
  2484. void set_interface(const std::string &intf);
  2485. void set_proxy(const std::string &host, int port);
  2486. void set_proxy_basic_auth(const std::string &username,
  2487. const std::string &password);
  2488. void set_proxy_bearer_token_auth(const std::string &token);
  2489. void set_no_proxy(const std::vector<std::string> &patterns);
  2490. void set_logger(Logger logger);
  2491. void set_error_logger(ErrorLogger error_logger);
  2492. protected:
  2493. struct Socket {
  2494. socket_t sock = INVALID_SOCKET;
  2495. // For Mbed TLS compatibility: start_time for request timeout tracking
  2496. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2497. bool is_open() const { return sock != INVALID_SOCKET; }
  2498. #ifdef CPPHTTPLIB_SSL_ENABLED
  2499. tls::session_t ssl = nullptr;
  2500. #endif
  2501. };
  2502. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2503. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2504. virtual bool setup_proxy_connection(
  2505. Socket &socket,
  2506. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2507. Response &res, bool &success, Error &error);
  2508. bool is_proxy_enabled_for_host(const std::string &host) const;
  2509. // All of:
  2510. // shutdown_ssl
  2511. // shutdown_socket
  2512. // close_socket
  2513. // disconnect
  2514. // should ONLY be called when socket_mutex_ is locked, and only when
  2515. // no other thread is using the socket.
  2516. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2517. void shutdown_socket(Socket &socket) const;
  2518. void close_socket(Socket &socket);
  2519. void disconnect(bool gracefully);
  2520. // Under socket_mutex_: whether the connection kept alive can take another
  2521. // request. One the peer has closed, or one set up under TLS settings changed
  2522. // since, is closed instead.
  2523. bool socket_reusable();
  2524. // TLS settings apply as a connection is set up, so a change makes the
  2525. // connection kept alive unfit for the next request.
  2526. void tls_settings_changed() { tls_settings_version_++; }
  2527. std::string make_request_target(const Request &req) const;
  2528. bool process_request(Stream &strm, Request &req, Response &res,
  2529. bool close_connection, Error &error);
  2530. bool write_content_with_provider(Stream &strm, const Request &req,
  2531. Error &error) const;
  2532. void output_log(const Request &req, const Response &res) const;
  2533. void output_error_log(const Error &err, const Request *req) const;
  2534. // Socket endpoint information
  2535. const std::string host_;
  2536. const int port_;
  2537. // Current open socket
  2538. Socket socket_;
  2539. mutable std::mutex socket_mutex_;
  2540. std::recursive_mutex request_mutex_;
  2541. // How many send() calls are running on this client, guarded by
  2542. // request_mutex_
  2543. size_t send_depth_ = 0;
  2544. // These are all protected under socket_mutex
  2545. size_t socket_requests_in_flight_ = 0;
  2546. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2547. bool socket_should_be_closed_when_request_is_done_ = false;
  2548. size_t socket_tls_settings_version_ = 0;
  2549. // Set by stop() while a request is in flight. The request's reads poll it,
  2550. // because shutting the socket down does not wake a read on Windows.
  2551. std::atomic<bool> stop_requested_{false};
  2552. std::atomic<size_t> tls_settings_version_{0};
  2553. // Hostname to connection target map. The value is an IP literal or another
  2554. // hostname; only the connection target changes, never the identity.
  2555. std::map<std::string, std::string> addr_map_;
  2556. // Hostname to CONNECT target map, used only through a proxy.
  2557. std::map<std::string, std::string> tunnel_addr_map_;
  2558. // Default headers
  2559. Headers default_headers_;
  2560. // Header writer
  2561. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2562. detail::write_headers;
  2563. // Settings
  2564. std::string client_cert_path_;
  2565. std::string client_key_path_;
  2566. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2567. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2568. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2569. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2570. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2571. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2572. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2573. std::string basic_auth_username_;
  2574. std::string basic_auth_password_;
  2575. std::string bearer_token_auth_token_;
  2576. bool keep_alive_ = false;
  2577. bool follow_location_ = false;
  2578. bool path_encode_ = true;
  2579. int address_family_ = AF_UNSPEC;
  2580. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2581. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2582. SocketOptions socket_options_ = nullptr;
  2583. bool compress_ = false;
  2584. bool decompress_ = true;
  2585. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2586. bool has_payload_max_length_ = false;
  2587. std::string interface_;
  2588. std::string proxy_host_;
  2589. int proxy_port_ = -1;
  2590. std::string proxy_basic_auth_username_;
  2591. std::string proxy_basic_auth_password_;
  2592. std::string proxy_bearer_token_auth_token_;
  2593. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2594. mutable detail::NormalizedTarget host_normalized_;
  2595. mutable bool host_normalized_valid_ = false;
  2596. mutable std::mutex logger_mutex_;
  2597. Logger logger_;
  2598. ErrorLogger error_logger_;
  2599. private:
  2600. bool send_(Request &req, Response &res, Error &error);
  2601. Result send_(Request &&req);
  2602. socket_t create_client_socket(Error &error) const;
  2603. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2604. bool skip_100_continue = true) const;
  2605. bool write_request(Stream &strm, Request &req, bool close_connection,
  2606. Error &error, bool skip_body, bool &rejected_locally);
  2607. bool write_request_body(Stream &strm, Request &req, Error &error);
  2608. void prepare_default_headers(Request &r, bool for_stream,
  2609. const std::string &ct);
  2610. bool redirect(Request &req, Response &res, Error &error);
  2611. bool create_redirect_client(const std::string &scheme,
  2612. const std::string &host, int port, Request &req,
  2613. Response &res, const std::string &path,
  2614. const std::string &location, Error &error);
  2615. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2616. bool handle_request(Stream &strm, Request &req, Response &res,
  2617. bool close_connection, Error &error);
  2618. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2619. Request &req, const char *body, size_t content_length,
  2620. ContentProvider content_provider,
  2621. ContentProviderWithoutLength content_provider_without_length,
  2622. const std::string &content_type, ContentReceiver content_receiver,
  2623. Error &error);
  2624. Result send_with_content_provider_and_receiver(
  2625. const std::string &method, const std::string &path,
  2626. const Headers &headers, const char *body, size_t content_length,
  2627. ContentProvider content_provider,
  2628. ContentProviderWithoutLength content_provider_without_length,
  2629. const std::string &content_type, ContentReceiver content_receiver,
  2630. UploadProgress progress);
  2631. ContentProviderWithoutLength get_multipart_content_provider(
  2632. const std::string &boundary, const UploadFormDataItems &items,
  2633. const FormDataProviderItems &provider_items) const;
  2634. virtual bool
  2635. process_socket(const Socket &socket,
  2636. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2637. std::function<bool(Stream &strm)> callback);
  2638. virtual bool is_ssl() const;
  2639. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2640. StreamHandle open_stream_(Request &req);
  2641. void add_credential_headers(Request &req);
  2642. std::string proxy_target_prefix() const;
  2643. #ifdef CPPHTTPLIB_SSL_ENABLED
  2644. public:
  2645. void set_digest_auth(const std::string &username,
  2646. const std::string &password);
  2647. void set_proxy_digest_auth(const std::string &username,
  2648. const std::string &password);
  2649. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2650. const std::string &ca_cert_dir_path = std::string());
  2651. void enable_server_certificate_verification(bool enabled);
  2652. void enable_server_hostname_verification(bool enabled);
  2653. void enable_system_ca(bool enabled);
  2654. protected:
  2655. std::string digest_auth_username_;
  2656. std::string digest_auth_password_;
  2657. std::string proxy_digest_auth_username_;
  2658. std::string proxy_digest_auth_password_;
  2659. std::string ca_cert_file_path_;
  2660. std::string ca_cert_dir_path_;
  2661. bool server_certificate_verification_ = true;
  2662. bool server_hostname_verification_ = true;
  2663. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2664. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2665. int last_ssl_error_ = 0;
  2666. uint64_t last_backend_error_ = 0;
  2667. #endif
  2668. };
  2669. namespace detail {
  2670. // Stands in for a client that Client could not make from its arguments, so a
  2671. // request fails rather than going through a null pointer.
  2672. class InvalidClientImpl final : public ClientImpl {
  2673. public:
  2674. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2675. bool is_valid() const override { return false; }
  2676. private:
  2677. bool create_and_connect_socket(Socket &, Error &error) override {
  2678. error = Error::Connection;
  2679. return false;
  2680. }
  2681. };
  2682. } // namespace detail
  2683. class Client {
  2684. public:
  2685. // Universal interface
  2686. explicit Client(const std::string &scheme_host_port);
  2687. explicit Client(const std::string &scheme_host_port,
  2688. const std::string &client_cert_path,
  2689. const std::string &client_key_path);
  2690. // HTTP only interface
  2691. explicit Client(const std::string &host, int port);
  2692. explicit Client(const std::string &host, int port,
  2693. const std::string &client_cert_path,
  2694. const std::string &client_key_path);
  2695. Client(Client &&) = default;
  2696. Client &operator=(Client &&) = default;
  2697. ~Client();
  2698. bool is_valid() const;
  2699. // clang-format off
  2700. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2701. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2702. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2703. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2704. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2705. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2706. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2707. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2708. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2709. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2710. Result Head(const std::string &path);
  2711. Result Head(const std::string &path, const Headers &headers);
  2712. Result Post(const std::string &path);
  2713. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2714. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2715. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2716. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2717. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2718. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2719. Result Post(const std::string &path, const Params &params);
  2720. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2721. Result Post(const std::string &path, const Headers &headers);
  2722. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2723. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2724. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2725. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2726. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2727. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2728. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2729. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2730. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2731. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2732. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2733. Result Put(const std::string &path);
  2734. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2735. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2736. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2737. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2738. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2739. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2740. Result Put(const std::string &path, const Params &params);
  2741. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2742. Result Put(const std::string &path, const Headers &headers);
  2743. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2744. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2745. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2746. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2747. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2748. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2749. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2750. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2751. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2752. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2753. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2754. Result Patch(const std::string &path);
  2755. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2756. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2757. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2758. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2759. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2760. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2761. Result Patch(const std::string &path, const Params &params);
  2762. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2763. Result Patch(const std::string &path, const Headers &headers);
  2764. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2765. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2766. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2767. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2768. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2769. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2770. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2771. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2772. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2773. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2774. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2775. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2776. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2777. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2778. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2779. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2780. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2781. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2782. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2783. Result Options(const std::string &path);
  2784. Result Options(const std::string &path, const Headers &headers);
  2785. // clang-format on
  2786. // Streaming API: Open a stream for reading response body incrementally
  2787. // Socket ownership is transferred to StreamHandle for true streaming
  2788. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2789. ClientImpl::StreamHandle open_stream(const std::string &method,
  2790. const std::string &path,
  2791. const Params &params = {},
  2792. const Headers &headers = {},
  2793. const std::string &body = {},
  2794. const std::string &content_type = {});
  2795. bool send(Request &req, Response &res, Error &error);
  2796. Result send(const Request &req);
  2797. void stop();
  2798. std::string host() const;
  2799. int port() const;
  2800. size_t is_socket_open() const;
  2801. socket_t socket() const;
  2802. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2803. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2804. void
  2805. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2806. void
  2807. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2808. void set_default_headers(Headers headers);
  2809. void
  2810. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2811. void set_address_family(int family);
  2812. void set_tcp_nodelay(bool on);
  2813. void set_socket_options(SocketOptions socket_options);
  2814. void set_connection_timeout(time_t sec, time_t usec = 0);
  2815. template <class Rep, class Period>
  2816. void
  2817. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2818. void set_read_timeout(time_t sec, time_t usec = 0);
  2819. template <class Rep, class Period>
  2820. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2821. void set_write_timeout(time_t sec, time_t usec = 0);
  2822. template <class Rep, class Period>
  2823. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2824. void set_max_timeout(time_t msec);
  2825. template <class Rep, class Period>
  2826. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2827. void set_basic_auth(const std::string &username, const std::string &password);
  2828. void set_bearer_token_auth(const std::string &token);
  2829. void set_keep_alive(bool on);
  2830. void set_follow_location(bool on);
  2831. void set_path_encode(bool on);
  2832. void set_compress(bool on);
  2833. void set_decompress(bool on);
  2834. void set_payload_max_length(size_t length);
  2835. void set_interface(const std::string &intf);
  2836. void set_proxy(const std::string &host, int port);
  2837. void set_proxy_basic_auth(const std::string &username,
  2838. const std::string &password);
  2839. void set_proxy_bearer_token_auth(const std::string &token);
  2840. void set_no_proxy(const std::vector<std::string> &patterns);
  2841. void set_logger(Logger logger);
  2842. void set_error_logger(ErrorLogger error_logger);
  2843. private:
  2844. std::unique_ptr<ClientImpl> cli_;
  2845. #ifdef CPPHTTPLIB_SSL_ENABLED
  2846. public:
  2847. void set_digest_auth(const std::string &username,
  2848. const std::string &password);
  2849. void set_proxy_digest_auth(const std::string &username,
  2850. const std::string &password);
  2851. void enable_server_certificate_verification(bool enabled);
  2852. void enable_server_hostname_verification(bool enabled);
  2853. void enable_system_ca(bool enabled);
  2854. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2855. const std::string &ca_cert_dir_path = std::string());
  2856. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2857. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2858. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2859. void set_session_verifier(
  2860. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2861. tls::ctx_t tls_context() const;
  2862. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2863. void enable_windows_certificate_verification(bool enabled);
  2864. #endif
  2865. private:
  2866. bool is_ssl_ = false;
  2867. #endif
  2868. };
  2869. #ifdef CPPHTTPLIB_SSL_ENABLED
  2870. class SSLServer : public Server {
  2871. public:
  2872. SSLServer(const char *cert_path, const char *private_key_path,
  2873. const char *client_ca_cert_file_path = nullptr,
  2874. const char *client_ca_cert_dir_path = nullptr,
  2875. const char *private_key_password = nullptr);
  2876. struct PemMemory {
  2877. const char *cert_pem;
  2878. size_t cert_pem_len;
  2879. const char *key_pem;
  2880. size_t key_pem_len;
  2881. const char *client_ca_pem;
  2882. size_t client_ca_pem_len;
  2883. const char *private_key_password;
  2884. };
  2885. explicit SSLServer(const PemMemory &pem);
  2886. // The callback receives the ctx_t handle which can be cast to the
  2887. // appropriate backend type (SSL_CTX* for OpenSSL,
  2888. // tls::impl::MbedTlsContext* for Mbed TLS)
  2889. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2890. ~SSLServer() override;
  2891. bool is_valid() const override;
  2892. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2893. const char *client_ca_pem = nullptr,
  2894. const char *password = nullptr);
  2895. tls::ctx_t tls_context() const { return ctx_; }
  2896. int ssl_last_error() const { return last_ssl_error_; }
  2897. private:
  2898. bool process_and_close_socket(socket_t sock) override;
  2899. tls::ctx_t ctx_ = nullptr;
  2900. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2901. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2902. // bounds, and new ones wait while it is pending so that they cannot keep it
  2903. // waiting.
  2904. std::mutex ctx_mutex_;
  2905. std::condition_variable ctx_cv_;
  2906. size_t handshakes_in_progress_ = 0;
  2907. size_t updates_pending_ = 0;
  2908. int last_ssl_error_ = 0;
  2909. };
  2910. class SSLClient final : public ClientImpl {
  2911. public:
  2912. explicit SSLClient(const std::string &host);
  2913. explicit SSLClient(const std::string &host, int port);
  2914. explicit SSLClient(const std::string &host, int port,
  2915. const std::string &client_cert_path,
  2916. const std::string &client_key_path,
  2917. const std::string &private_key_password = std::string());
  2918. struct PemMemory {
  2919. const char *cert_pem;
  2920. size_t cert_pem_len;
  2921. const char *key_pem;
  2922. size_t key_pem_len;
  2923. const char *private_key_password;
  2924. };
  2925. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2926. ~SSLClient() override;
  2927. bool is_valid() const override;
  2928. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2929. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2930. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2931. // Post-handshake session verifier (backend-independent)
  2932. void set_session_verifier(
  2933. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2934. tls::ctx_t tls_context() const { return ctx_; }
  2935. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2936. void enable_windows_certificate_verification(bool enabled);
  2937. #endif
  2938. private:
  2939. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2940. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2941. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2942. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2943. bool
  2944. process_socket(const Socket &socket,
  2945. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2946. std::function<bool(Stream &strm)> callback) override;
  2947. bool is_ssl() const override;
  2948. bool setup_proxy_connection(
  2949. Socket &socket,
  2950. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2951. Response &res, bool &success, Error &error) override;
  2952. bool connect_with_proxy(
  2953. Socket &sock,
  2954. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2955. Response &res, bool &success, Error &error);
  2956. bool initialize_ssl(Socket &socket, Error &error);
  2957. void init_ctx();
  2958. void reset_ctx_on_error();
  2959. bool load_certs();
  2960. tls::ctx_t ctx_ = nullptr;
  2961. std::mutex ctx_mutex_;
  2962. std::once_flag initialize_cert_;
  2963. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2964. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2965. bool ca_cert_store_set_ = false;
  2966. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2967. // no certificate, so that a CA that failed to come through fails
  2968. // verification instead of letting the system CAs in.
  2969. bool custom_ca_loaded_ = false;
  2970. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2971. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2972. // set_server_certificate_verifier() installed there.
  2973. tls::VerifyCallback server_certificate_verifier_;
  2974. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2975. bool enable_windows_cert_verification_ = true;
  2976. #endif
  2977. friend class ClientImpl;
  2978. };
  2979. #endif // CPPHTTPLIB_SSL_ENABLED
  2980. namespace detail {
  2981. template <typename T, typename U>
  2982. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2983. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2984. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2985. duration - std::chrono::seconds(sec))
  2986. .count();
  2987. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2988. }
  2989. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2990. return N - 1;
  2991. }
  2992. inline bool is_numeric(const std::string &str) {
  2993. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2994. }
  2995. // std::ranges::next(first, n, last) for C++11
  2996. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2997. for (; n > 0 && first != last; --n) {
  2998. ++first;
  2999. }
  3000. return first;
  3001. }
  3002. inline size_t get_header_value_u64(const Headers &headers,
  3003. const std::string &key, size_t def,
  3004. size_t id, bool &is_invalid_value) {
  3005. is_invalid_value = false;
  3006. auto rng = headers.equal_range(key);
  3007. auto it = bounded_next(rng.first, id, rng.second);
  3008. if (it != rng.second) {
  3009. if (is_numeric(it->second)) {
  3010. // Parse at size_t width so an out-of-range Content-Length is reported
  3011. // rather than silently saturated/truncated (a value above 2^32 would
  3012. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  3013. // and return SIZE_MAX so the existing oversized-value guards reject it.
  3014. size_t val = 0;
  3015. const auto &s = it->second;
  3016. auto r = from_chars(s.data(), s.data() + s.size(), val);
  3017. if (r.ec == std::errc::result_out_of_range) {
  3018. is_invalid_value = true;
  3019. return (std::numeric_limits<size_t>::max)();
  3020. }
  3021. return val;
  3022. } else {
  3023. is_invalid_value = true;
  3024. }
  3025. }
  3026. return def;
  3027. }
  3028. inline size_t get_header_value_u64(const Headers &headers,
  3029. const std::string &key, size_t def,
  3030. size_t id) {
  3031. auto dummy = false;
  3032. return get_header_value_u64(headers, key, def, id, dummy);
  3033. }
  3034. } // namespace detail
  3035. template <class Rep, class Period>
  3036. inline Server &
  3037. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3038. detail::duration_to_sec_and_usec(
  3039. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3040. return *this;
  3041. }
  3042. template <class Rep, class Period>
  3043. inline Server &
  3044. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3045. detail::duration_to_sec_and_usec(
  3046. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3047. return *this;
  3048. }
  3049. template <class Rep, class Period>
  3050. inline Server &
  3051. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3052. detail::duration_to_sec_and_usec(
  3053. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3054. return *this;
  3055. }
  3056. template <class Rep, class Period>
  3057. inline void ClientImpl::set_connection_timeout(
  3058. const std::chrono::duration<Rep, Period> &duration) {
  3059. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3060. set_connection_timeout(sec, usec);
  3061. });
  3062. }
  3063. template <class Rep, class Period>
  3064. inline void ClientImpl::set_read_timeout(
  3065. const std::chrono::duration<Rep, Period> &duration) {
  3066. detail::duration_to_sec_and_usec(
  3067. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3068. }
  3069. template <class Rep, class Period>
  3070. inline void ClientImpl::set_write_timeout(
  3071. const std::chrono::duration<Rep, Period> &duration) {
  3072. detail::duration_to_sec_and_usec(
  3073. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3074. }
  3075. template <class Rep, class Period>
  3076. inline void ClientImpl::set_max_timeout(
  3077. const std::chrono::duration<Rep, Period> &duration) {
  3078. auto msec =
  3079. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3080. set_max_timeout(static_cast<time_t>(msec));
  3081. }
  3082. template <class Rep, class Period>
  3083. inline void Client::set_connection_timeout(
  3084. const std::chrono::duration<Rep, Period> &duration) {
  3085. cli_->set_connection_timeout(duration);
  3086. }
  3087. template <class Rep, class Period>
  3088. inline void
  3089. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3090. cli_->set_read_timeout(duration);
  3091. }
  3092. template <class Rep, class Period>
  3093. inline void
  3094. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3095. cli_->set_write_timeout(duration);
  3096. }
  3097. inline void Client::set_max_timeout(time_t msec) {
  3098. cli_->set_max_timeout(msec);
  3099. }
  3100. template <class Rep, class Period>
  3101. inline void
  3102. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3103. cli_->set_max_timeout(duration);
  3104. }
  3105. /*
  3106. * Forward declarations and types that will be part of the .h file if split into
  3107. * .h + .cc.
  3108. */
  3109. std::string hosted_at(const std::string &hostname);
  3110. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3111. // JavaScript-style URL encoding/decoding functions
  3112. std::string encode_uri_component(const std::string &value);
  3113. std::string encode_uri(const std::string &value);
  3114. std::string decode_uri_component(const std::string &value);
  3115. std::string decode_uri(const std::string &value);
  3116. // RFC 3986 compliant URL component encoding/decoding functions
  3117. std::string encode_path_component(const std::string &component);
  3118. std::string decode_path_component(const std::string &component);
  3119. std::string encode_query_component(const std::string &component,
  3120. bool space_as_plus = true);
  3121. std::string decode_query_component(const std::string &component,
  3122. bool plus_as_space = true);
  3123. std::string sanitize_filename(const std::string &filename);
  3124. std::string append_query_params(const std::string &path, const Params &params);
  3125. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3126. std::pair<std::string, std::string>
  3127. make_basic_authentication_header(const std::string &username,
  3128. const std::string &password,
  3129. bool is_proxy = false);
  3130. namespace detail {
  3131. #if defined(_WIN32)
  3132. inline std::wstring u8string_to_wstring(const char *s) {
  3133. if (!s) { return std::wstring(); }
  3134. auto len = static_cast<int>(strlen(s));
  3135. if (!len) { return std::wstring(); }
  3136. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3137. if (!wlen) { return std::wstring(); }
  3138. std::wstring ws;
  3139. ws.resize(wlen);
  3140. wlen = ::MultiByteToWideChar(
  3141. CP_UTF8, 0, s, len,
  3142. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3143. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3144. return ws;
  3145. }
  3146. #endif
  3147. struct FileStat {
  3148. FileStat(const std::string &path);
  3149. bool is_file() const;
  3150. bool is_dir() const;
  3151. time_t mtime() const;
  3152. size_t size() const;
  3153. private:
  3154. #if defined(_WIN32)
  3155. struct _stat st_;
  3156. #else
  3157. struct stat st_;
  3158. #endif
  3159. int ret_ = -1;
  3160. };
  3161. std::string make_host_and_port_string(const std::string &host, int port,
  3162. bool is_ssl);
  3163. template <typename T>
  3164. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3165. Error &error);
  3166. bool write_data(Stream &strm, const char *d, size_t l);
  3167. std::string trim_copy(const std::string &s);
  3168. void divide(
  3169. const char *data, std::size_t size, char d,
  3170. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3171. fn);
  3172. void divide(
  3173. const std::string &str, char d,
  3174. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3175. fn);
  3176. void split(const char *b, const char *e, char d,
  3177. std::function<void(const char *, const char *)> fn);
  3178. void split(const char *b, const char *e, char d, size_t m,
  3179. std::function<void(const char *, const char *)> fn);
  3180. bool split_find(const char *b, const char *e, char d,
  3181. std::function<bool(const char *, const char *)> fn);
  3182. bool has_header_token(const Headers &headers, const std::string &key,
  3183. const std::string &token);
  3184. std::string websocket_accept_key(const std::string &client_key);
  3185. bool is_websocket_upgrade(const Request &req);
  3186. bool process_client_socket(
  3187. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3188. time_t write_timeout_sec, time_t write_timeout_usec,
  3189. time_t max_timeout_msec,
  3190. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3191. std::function<bool(Stream &)> callback);
  3192. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3193. int port, int address_family, bool tcp_nodelay,
  3194. bool ipv6_v6only, SocketOptions socket_options,
  3195. time_t connection_timeout_sec,
  3196. time_t connection_timeout_usec,
  3197. time_t read_timeout_sec, time_t read_timeout_usec,
  3198. time_t write_timeout_sec,
  3199. time_t write_timeout_usec,
  3200. const std::string &intf, Error &error);
  3201. const char *get_header_value(const Headers &headers, const std::string &key,
  3202. const char *def, size_t id);
  3203. std::string get_combined_header_value(const Headers &headers,
  3204. const std::string &key);
  3205. std::string params_to_query_str(const Params &params);
  3206. void parse_query_text(const char *data, std::size_t size, Params &params);
  3207. void parse_query_text(const std::string &s, Params &params);
  3208. bool parse_multipart_boundary(const std::string &content_type,
  3209. std::string &boundary);
  3210. bool parse_range_header(const std::string &s, Ranges &ranges);
  3211. bool parse_accept_header(const std::string &s,
  3212. std::vector<std::string> &content_types);
  3213. void parse_disposition_params(const std::string &s, Params &params);
  3214. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3215. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3216. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3217. EncodingType encoding_type(const Request &req, const Response &res,
  3218. const std::string &content_type);
  3219. EncodingType encoding_type(const Request &req, const Response &res);
  3220. class BufferStream final : public Stream {
  3221. public:
  3222. BufferStream() = default;
  3223. ~BufferStream() override = default;
  3224. bool is_readable() const override;
  3225. bool wait_readable() const override;
  3226. bool wait_writable() const override;
  3227. ssize_t read(char *ptr, size_t size) override;
  3228. ssize_t write(const char *ptr, size_t size) override;
  3229. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3230. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3231. socket_t socket() const override;
  3232. time_t duration() const override;
  3233. const std::string &get_buffer() const;
  3234. private:
  3235. std::string buffer;
  3236. size_t position = 0;
  3237. };
  3238. class compressor {
  3239. public:
  3240. virtual ~compressor() = default;
  3241. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3242. virtual bool compress(const char *data, size_t data_length, bool last,
  3243. Callback callback) = 0;
  3244. };
  3245. class decompressor {
  3246. public:
  3247. virtual ~decompressor() = default;
  3248. virtual bool is_valid() const = 0;
  3249. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3250. virtual bool decompress(const char *data, size_t data_length,
  3251. Callback callback) = 0;
  3252. };
  3253. class nocompressor final : public compressor {
  3254. public:
  3255. ~nocompressor() override = default;
  3256. bool compress(const char *data, size_t data_length, bool /*last*/,
  3257. Callback callback) override;
  3258. };
  3259. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3260. class gzip_compressor final : public compressor {
  3261. public:
  3262. gzip_compressor();
  3263. ~gzip_compressor() override;
  3264. bool compress(const char *data, size_t data_length, bool last,
  3265. Callback callback) override;
  3266. private:
  3267. bool is_valid_ = false;
  3268. z_stream strm_;
  3269. };
  3270. class gzip_decompressor final : public decompressor {
  3271. public:
  3272. gzip_decompressor();
  3273. ~gzip_decompressor() override;
  3274. bool is_valid() const override;
  3275. bool decompress(const char *data, size_t data_length,
  3276. Callback callback) override;
  3277. private:
  3278. bool is_valid_ = false;
  3279. z_stream strm_;
  3280. };
  3281. #endif
  3282. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3283. class brotli_compressor final : public compressor {
  3284. public:
  3285. brotli_compressor();
  3286. ~brotli_compressor();
  3287. bool compress(const char *data, size_t data_length, bool last,
  3288. Callback callback) override;
  3289. private:
  3290. BrotliEncoderState *state_ = nullptr;
  3291. };
  3292. class brotli_decompressor final : public decompressor {
  3293. public:
  3294. brotli_decompressor();
  3295. ~brotli_decompressor();
  3296. bool is_valid() const override;
  3297. bool decompress(const char *data, size_t data_length,
  3298. Callback callback) override;
  3299. private:
  3300. BrotliDecoderResult decoder_r;
  3301. BrotliDecoderState *decoder_s = nullptr;
  3302. };
  3303. #endif
  3304. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3305. class zstd_compressor : public compressor {
  3306. public:
  3307. zstd_compressor();
  3308. ~zstd_compressor();
  3309. bool compress(const char *data, size_t data_length, bool last,
  3310. Callback callback) override;
  3311. private:
  3312. ZSTD_CCtx *ctx_ = nullptr;
  3313. };
  3314. class zstd_decompressor : public decompressor {
  3315. public:
  3316. zstd_decompressor();
  3317. ~zstd_decompressor();
  3318. bool is_valid() const override;
  3319. bool decompress(const char *data, size_t data_length,
  3320. Callback callback) override;
  3321. private:
  3322. ZSTD_DCtx *ctx_ = nullptr;
  3323. };
  3324. #endif
  3325. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3326. // to store data. The call can set memory on stack for performance.
  3327. class stream_line_reader {
  3328. public:
  3329. stream_line_reader(Stream &strm, char *fixed_buffer,
  3330. size_t fixed_buffer_size);
  3331. const char *ptr() const;
  3332. size_t size() const;
  3333. bool end_with_crlf() const;
  3334. bool getline();
  3335. private:
  3336. void append(char c);
  3337. void append(const char *data, size_t size);
  3338. Stream &strm_;
  3339. char *fixed_buffer_;
  3340. const size_t fixed_buffer_size_;
  3341. size_t fixed_buffer_used_size_ = 0;
  3342. std::string growable_buffer_;
  3343. };
  3344. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3345. const Headers &src_headers);
  3346. struct ChunkedDecoder {
  3347. Stream &strm;
  3348. size_t chunk_remaining = 0;
  3349. bool finished = false;
  3350. char line_buf[64];
  3351. size_t last_chunk_total = 0;
  3352. size_t last_chunk_offset = 0;
  3353. size_t overhead = 0;
  3354. explicit ChunkedDecoder(Stream &s);
  3355. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3356. size_t &out_chunk_total);
  3357. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3358. };
  3359. // A regular file opened to be served: mapped on Windows, read with pread()
  3360. // elsewhere.
  3361. class mmap {
  3362. public:
  3363. mmap(const char *path);
  3364. ~mmap();
  3365. bool open(const char *path);
  3366. void close();
  3367. bool is_open() const;
  3368. size_t size() const;
  3369. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3370. // down to 0, if the file has shrunk since it was opened.
  3371. size_t read(size_t offset, char *buf, size_t len) const;
  3372. private:
  3373. #if defined(_WIN32)
  3374. HANDLE hFile_ = NULL;
  3375. HANDLE hMapping_ = NULL;
  3376. void *addr_ = nullptr;
  3377. bool is_open_empty_file = false;
  3378. #else
  3379. int fd_ = -1;
  3380. #endif
  3381. size_t size_ = 0;
  3382. };
  3383. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3384. namespace fields {
  3385. bool is_token_char(char c);
  3386. bool is_token(const std::string &s);
  3387. bool is_field_name(const std::string &s);
  3388. bool is_vchar(char c);
  3389. bool is_obs_text(char c);
  3390. bool is_field_vchar(char c);
  3391. bool is_field_content(const std::string &s);
  3392. bool is_field_value(const std::string &s);
  3393. bool is_field_valid(const std::string &name, const std::string &value);
  3394. bool is_request_target(const std::string &s);
  3395. bool is_host(const std::string &s);
  3396. } // namespace fields
  3397. } // namespace detail
  3398. /*
  3399. * TLS Abstraction Layer Declarations
  3400. */
  3401. #ifdef CPPHTTPLIB_SSL_ENABLED
  3402. // TLS abstraction layer - backend-specific type declarations
  3403. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3404. namespace tls {
  3405. namespace impl {
  3406. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3407. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3408. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3409. struct MbedTlsContext {
  3410. mbedtls_ssl_config conf;
  3411. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3412. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3413. mbedtls_entropy_context entropy;
  3414. mbedtls_ctr_drbg_context ctr_drbg;
  3415. #endif
  3416. mbedtls_x509_crt ca_chain;
  3417. mbedtls_x509_crt own_cert;
  3418. mbedtls_pk_context own_key;
  3419. bool is_server = false;
  3420. // Peer certificate required (set_verify_client()); a client defaults to true
  3421. bool verify_client = false;
  3422. // Set by tls::set_verify_callback().
  3423. VerifyCallback verify_callback;
  3424. MbedTlsContext();
  3425. ~MbedTlsContext();
  3426. MbedTlsContext(const MbedTlsContext &) = delete;
  3427. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3428. };
  3429. } // namespace impl
  3430. } // namespace tls
  3431. #endif
  3432. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3433. namespace tls {
  3434. namespace impl {
  3435. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3436. // This struct is accessible via tls::impl for use in SSL context
  3437. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3438. struct WolfSSLContext {
  3439. WOLFSSL_CTX *ctx = nullptr;
  3440. bool is_server = false;
  3441. // Peer certificate required (set_verify_client()); a client defaults to true
  3442. bool verify_client = false;
  3443. // Replaced under verify_callback_mutex()
  3444. std::shared_ptr<VerifyCallback> verify_callback;
  3445. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3446. WolfSSLContext();
  3447. ~WolfSSLContext();
  3448. WolfSSLContext(const WolfSSLContext &) = delete;
  3449. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3450. };
  3451. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3452. struct WolfSSLCAStore {
  3453. std::string pem_data;
  3454. };
  3455. } // namespace impl
  3456. } // namespace tls
  3457. #endif
  3458. #endif // CPPHTTPLIB_SSL_ENABLED
  3459. namespace stream {
  3460. class Result {
  3461. public:
  3462. Result();
  3463. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3464. Result(Result &&other) noexcept;
  3465. Result &operator=(Result &&other) noexcept;
  3466. Result(const Result &) = delete;
  3467. Result &operator=(const Result &) = delete;
  3468. // Response info
  3469. bool is_valid() const;
  3470. explicit operator bool() const;
  3471. int status() const;
  3472. const Headers &headers() const;
  3473. std::string get_header_value(const std::string &key,
  3474. const char *def = "") const;
  3475. bool has_header(const std::string &key) const;
  3476. Error error() const;
  3477. Error read_error() const;
  3478. bool has_read_error() const;
  3479. // Stream reading
  3480. bool next();
  3481. const char *data() const;
  3482. size_t size() const;
  3483. std::string read_all();
  3484. private:
  3485. ClientImpl::StreamHandle handle_;
  3486. std::string buffer_;
  3487. size_t current_size_ = 0;
  3488. size_t chunk_size_;
  3489. bool finished_ = false;
  3490. };
  3491. // GET
  3492. template <typename ClientType>
  3493. inline Result Get(ClientType &cli, const std::string &path,
  3494. size_t chunk_size = 8192) {
  3495. return Result{cli.open_stream("GET", path), chunk_size};
  3496. }
  3497. template <typename ClientType>
  3498. inline Result Get(ClientType &cli, const std::string &path,
  3499. const Headers &headers, size_t chunk_size = 8192) {
  3500. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3501. }
  3502. template <typename ClientType>
  3503. inline Result Get(ClientType &cli, const std::string &path,
  3504. const Params &params, size_t chunk_size = 8192) {
  3505. return Result{cli.open_stream("GET", path, params), chunk_size};
  3506. }
  3507. template <typename ClientType>
  3508. inline Result Get(ClientType &cli, const std::string &path,
  3509. const Params &params, const Headers &headers,
  3510. size_t chunk_size = 8192) {
  3511. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3512. }
  3513. // POST
  3514. template <typename ClientType>
  3515. inline Result Post(ClientType &cli, const std::string &path,
  3516. const std::string &body, const std::string &content_type,
  3517. size_t chunk_size = 8192) {
  3518. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3519. chunk_size};
  3520. }
  3521. template <typename ClientType>
  3522. inline Result Post(ClientType &cli, const std::string &path,
  3523. const Headers &headers, const std::string &body,
  3524. const std::string &content_type, size_t chunk_size = 8192) {
  3525. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3526. chunk_size};
  3527. }
  3528. template <typename ClientType>
  3529. inline Result Post(ClientType &cli, const std::string &path,
  3530. const Params &params, const std::string &body,
  3531. const std::string &content_type, size_t chunk_size = 8192) {
  3532. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3533. chunk_size};
  3534. }
  3535. template <typename ClientType>
  3536. inline Result Post(ClientType &cli, const std::string &path,
  3537. const Params &params, const Headers &headers,
  3538. const std::string &body, const std::string &content_type,
  3539. size_t chunk_size = 8192) {
  3540. return Result{
  3541. cli.open_stream("POST", path, params, headers, body, content_type),
  3542. chunk_size};
  3543. }
  3544. // PUT
  3545. template <typename ClientType>
  3546. inline Result Put(ClientType &cli, const std::string &path,
  3547. const std::string &body, const std::string &content_type,
  3548. size_t chunk_size = 8192) {
  3549. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3550. chunk_size};
  3551. }
  3552. template <typename ClientType>
  3553. inline Result Put(ClientType &cli, const std::string &path,
  3554. const Headers &headers, const std::string &body,
  3555. const std::string &content_type, size_t chunk_size = 8192) {
  3556. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3557. chunk_size};
  3558. }
  3559. template <typename ClientType>
  3560. inline Result Put(ClientType &cli, const std::string &path,
  3561. const Params &params, const std::string &body,
  3562. const std::string &content_type, size_t chunk_size = 8192) {
  3563. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3564. chunk_size};
  3565. }
  3566. template <typename ClientType>
  3567. inline Result Put(ClientType &cli, const std::string &path,
  3568. const Params &params, const Headers &headers,
  3569. const std::string &body, const std::string &content_type,
  3570. size_t chunk_size = 8192) {
  3571. return Result{
  3572. cli.open_stream("PUT", path, params, headers, body, content_type),
  3573. chunk_size};
  3574. }
  3575. // PATCH
  3576. template <typename ClientType>
  3577. inline Result Patch(ClientType &cli, const std::string &path,
  3578. const std::string &body, const std::string &content_type,
  3579. size_t chunk_size = 8192) {
  3580. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3581. chunk_size};
  3582. }
  3583. template <typename ClientType>
  3584. inline Result Patch(ClientType &cli, const std::string &path,
  3585. const Headers &headers, const std::string &body,
  3586. const std::string &content_type, size_t chunk_size = 8192) {
  3587. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3588. chunk_size};
  3589. }
  3590. template <typename ClientType>
  3591. inline Result Patch(ClientType &cli, const std::string &path,
  3592. const Params &params, const std::string &body,
  3593. const std::string &content_type, size_t chunk_size = 8192) {
  3594. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3595. chunk_size};
  3596. }
  3597. template <typename ClientType>
  3598. inline Result Patch(ClientType &cli, const std::string &path,
  3599. const Params &params, const Headers &headers,
  3600. const std::string &body, const std::string &content_type,
  3601. size_t chunk_size = 8192) {
  3602. return Result{
  3603. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3604. chunk_size};
  3605. }
  3606. // DELETE
  3607. template <typename ClientType>
  3608. inline Result Delete(ClientType &cli, const std::string &path,
  3609. size_t chunk_size = 8192) {
  3610. return Result{cli.open_stream("DELETE", path), chunk_size};
  3611. }
  3612. template <typename ClientType>
  3613. inline Result Delete(ClientType &cli, const std::string &path,
  3614. const Headers &headers, size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3616. }
  3617. template <typename ClientType>
  3618. inline Result Delete(ClientType &cli, const std::string &path,
  3619. const std::string &body, const std::string &content_type,
  3620. size_t chunk_size = 8192) {
  3621. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3622. chunk_size};
  3623. }
  3624. template <typename ClientType>
  3625. inline Result Delete(ClientType &cli, const std::string &path,
  3626. const Headers &headers, const std::string &body,
  3627. const std::string &content_type,
  3628. size_t chunk_size = 8192) {
  3629. return Result{
  3630. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3631. chunk_size};
  3632. }
  3633. template <typename ClientType>
  3634. inline Result Delete(ClientType &cli, const std::string &path,
  3635. const Params &params, size_t chunk_size = 8192) {
  3636. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3637. }
  3638. template <typename ClientType>
  3639. inline Result Delete(ClientType &cli, const std::string &path,
  3640. const Params &params, const Headers &headers,
  3641. size_t chunk_size = 8192) {
  3642. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3643. }
  3644. template <typename ClientType>
  3645. inline Result Delete(ClientType &cli, const std::string &path,
  3646. const Params &params, const std::string &body,
  3647. const std::string &content_type,
  3648. size_t chunk_size = 8192) {
  3649. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3650. chunk_size};
  3651. }
  3652. template <typename ClientType>
  3653. inline Result Delete(ClientType &cli, const std::string &path,
  3654. const Params &params, const Headers &headers,
  3655. const std::string &body, const std::string &content_type,
  3656. size_t chunk_size = 8192) {
  3657. return Result{
  3658. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3659. chunk_size};
  3660. }
  3661. // HEAD
  3662. template <typename ClientType>
  3663. inline Result Head(ClientType &cli, const std::string &path,
  3664. size_t chunk_size = 8192) {
  3665. return Result{cli.open_stream("HEAD", path), chunk_size};
  3666. }
  3667. template <typename ClientType>
  3668. inline Result Head(ClientType &cli, const std::string &path,
  3669. const Headers &headers, size_t chunk_size = 8192) {
  3670. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3671. }
  3672. template <typename ClientType>
  3673. inline Result Head(ClientType &cli, const std::string &path,
  3674. const Params &params, size_t chunk_size = 8192) {
  3675. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3676. }
  3677. template <typename ClientType>
  3678. inline Result Head(ClientType &cli, const std::string &path,
  3679. const Params &params, const Headers &headers,
  3680. size_t chunk_size = 8192) {
  3681. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3682. }
  3683. // OPTIONS
  3684. template <typename ClientType>
  3685. inline Result Options(ClientType &cli, const std::string &path,
  3686. size_t chunk_size = 8192) {
  3687. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3688. }
  3689. template <typename ClientType>
  3690. inline Result Options(ClientType &cli, const std::string &path,
  3691. const Headers &headers, size_t chunk_size = 8192) {
  3692. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3693. }
  3694. template <typename ClientType>
  3695. inline Result Options(ClientType &cli, const std::string &path,
  3696. const Params &params, size_t chunk_size = 8192) {
  3697. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3698. }
  3699. template <typename ClientType>
  3700. inline Result Options(ClientType &cli, const std::string &path,
  3701. const Params &params, const Headers &headers,
  3702. size_t chunk_size = 8192) {
  3703. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3704. }
  3705. } // namespace stream
  3706. namespace sse {
  3707. struct SSEMessage {
  3708. std::string event; // Event type (default: "message")
  3709. std::string data; // Event payload
  3710. std::string id; // Event ID for Last-Event-ID header
  3711. SSEMessage();
  3712. void clear();
  3713. };
  3714. class SSEClient {
  3715. public:
  3716. using MessageHandler = std::function<void(const SSEMessage &)>;
  3717. using ErrorHandler = std::function<void(Error)>;
  3718. using OpenHandler = std::function<void()>;
  3719. SSEClient(Client &client, const std::string &path);
  3720. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3721. ~SSEClient();
  3722. SSEClient(const SSEClient &) = delete;
  3723. SSEClient &operator=(const SSEClient &) = delete;
  3724. // Event handlers
  3725. SSEClient &on_message(MessageHandler handler);
  3726. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3727. SSEClient &on_open(OpenHandler handler);
  3728. SSEClient &on_error(ErrorHandler handler);
  3729. SSEClient &set_reconnect_interval(int ms);
  3730. SSEClient &set_max_reconnect_attempts(int n);
  3731. // Update headers (thread-safe)
  3732. SSEClient &set_headers(const Headers &headers);
  3733. // State accessors
  3734. bool is_connected() const;
  3735. std::string last_event_id() const;
  3736. // Blocking start - runs event loop with auto-reconnect
  3737. void start();
  3738. // Non-blocking start - runs in background thread
  3739. void start_async();
  3740. // Stop the client (thread-safe)
  3741. void stop();
  3742. private:
  3743. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3744. bool &has_data, bool &has_id);
  3745. void run_event_loop();
  3746. void dispatch_event(const SSEMessage &msg);
  3747. bool should_reconnect(int count) const;
  3748. void wait_for_reconnect();
  3749. // Client and path
  3750. Client &client_;
  3751. std::string path_;
  3752. Headers headers_;
  3753. mutable std::mutex headers_mutex_;
  3754. // Callbacks
  3755. MessageHandler on_message_;
  3756. std::map<std::string, MessageHandler> event_handlers_;
  3757. OpenHandler on_open_;
  3758. ErrorHandler on_error_;
  3759. // Configuration
  3760. int reconnect_interval_ms_ = 3000;
  3761. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3762. // State
  3763. std::atomic<bool> running_{false};
  3764. std::atomic<bool> connected_{false};
  3765. // Written by the event loop, which start_async() runs on its own thread
  3766. std::string last_event_id_;
  3767. mutable std::mutex last_event_id_mutex_;
  3768. // Async support
  3769. std::thread async_thread_;
  3770. };
  3771. } // namespace sse
  3772. namespace ws {
  3773. class WebSocketClient;
  3774. enum class Opcode : uint8_t {
  3775. Continuation = 0x0,
  3776. Text = 0x1,
  3777. Binary = 0x2,
  3778. Close = 0x8,
  3779. Ping = 0x9,
  3780. Pong = 0xA,
  3781. };
  3782. enum class CloseStatus : uint16_t {
  3783. Normal = 1000,
  3784. GoingAway = 1001,
  3785. ProtocolError = 1002,
  3786. UnsupportedData = 1003,
  3787. NoStatus = 1005,
  3788. Abnormal = 1006,
  3789. InvalidPayload = 1007,
  3790. PolicyViolation = 1008,
  3791. MessageTooBig = 1009,
  3792. MandatoryExtension = 1010,
  3793. InternalError = 1011,
  3794. };
  3795. // Timeout is returned only when a read timeout was set and it elapsed before
  3796. // any byte of a frame arrived: nothing was consumed and the connection is
  3797. // still open, so the caller can send on it and read again. `msg` is left
  3798. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3799. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3800. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3801. // upgrade handshake fully succeeded. On failure error() identifies the
  3802. // failing layer; status()/headers() expose the server's upgrade response
  3803. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3804. // CONNECT when error() is ProxyConnection.
  3805. class Result {
  3806. public:
  3807. Result() = default;
  3808. Result(Error err, int status, Headers &&headers)
  3809. : err_(err), status_(status), headers_(std::move(headers)) {}
  3810. explicit operator bool() const { return err_ == Error::Success; }
  3811. Error error() const { return err_; }
  3812. // Upgrade response info
  3813. int status() const { return status_; }
  3814. const Headers &headers() const { return headers_; }
  3815. std::string get_header_value(const std::string &key,
  3816. const char *def = "") const {
  3817. return detail::get_header_value(headers_, key, def, 0);
  3818. }
  3819. bool has_header(const std::string &key) const {
  3820. return headers_.find(key) != headers_.end();
  3821. }
  3822. #ifdef CPPHTTPLIB_SSL_ENABLED
  3823. Result(Error err, int status, Headers &&headers, int ssl_error,
  3824. uint64_t ssl_backend_error)
  3825. : err_(err), status_(status), headers_(std::move(headers)),
  3826. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3827. int ssl_error() const { return ssl_error_; }
  3828. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3829. #endif
  3830. private:
  3831. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3832. int status_ = -1;
  3833. Headers headers_;
  3834. #ifdef CPPHTTPLIB_SSL_ENABLED
  3835. int ssl_error_ = 0;
  3836. uint64_t ssl_backend_error_ = 0;
  3837. #endif
  3838. };
  3839. class WebSocket {
  3840. public:
  3841. WebSocket(const WebSocket &) = delete;
  3842. WebSocket &operator=(const WebSocket &) = delete;
  3843. ~WebSocket();
  3844. ReadResult read(std::string &msg);
  3845. bool send(const std::string &data);
  3846. bool send(const char *data, size_t len);
  3847. void close(CloseStatus status = CloseStatus::Normal,
  3848. const std::string &reason = "");
  3849. const Request &request() const;
  3850. bool is_open() const;
  3851. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3852. // A server handler owns its connection's timeout this way; a client sets it
  3853. // through WebSocketClient. Safe to call while another thread is in read().
  3854. //
  3855. // Only a timeout set here is reported as Timeout. The compile-time default
  3856. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3857. // than a request for control, so when it elapses read() returns Fail and
  3858. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3859. void set_read_timeout(time_t sec, time_t usec = 0);
  3860. template <class Rep, class Period>
  3861. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3862. private:
  3863. friend class httplib::Server;
  3864. friend class httplib::ws::WebSocketClient;
  3865. WebSocket(
  3866. Stream &strm, const Request &req, bool is_server,
  3867. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3868. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3869. : strm_(strm), req_(req), is_server_(is_server),
  3870. ping_interval_sec_(ping_interval_sec),
  3871. max_missed_pongs_(max_missed_pongs) {
  3872. start_heartbeat();
  3873. }
  3874. WebSocket(
  3875. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3876. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3877. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3878. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3879. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3880. max_missed_pongs_(max_missed_pongs) {
  3881. start_heartbeat();
  3882. }
  3883. void start_heartbeat();
  3884. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3885. Stream &strm_;
  3886. std::unique_ptr<Stream> owned_strm_;
  3887. Request req_;
  3888. bool is_server_;
  3889. time_t ping_interval_sec_;
  3890. int max_missed_pongs_;
  3891. int unacked_pings_ = 0;
  3892. std::atomic<bool> closed_{false};
  3893. // Set when the peer stopped answering pings, to end a read() waiting on it
  3894. std::atomic<bool> pong_timed_out_{false};
  3895. // Set once the caller has bounded read() through set_read_timeout(). Until
  3896. // then the timeout in effect is the compile-time default, and elapsing it
  3897. // is a failure that closes the connection, not a Timeout.
  3898. std::atomic<bool> read_timeout_set_{false};
  3899. std::mutex write_mutex_;
  3900. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3901. // may do so: read_websocket_frame() reads a payload until it has the whole
  3902. // declared length, so a second parser stealing bytes silently corrupts the
  3903. // message the first one is assembling.
  3904. std::mutex read_mutex_;
  3905. std::thread ping_thread_;
  3906. std::mutex ping_mutex_;
  3907. std::condition_variable ping_cv_;
  3908. };
  3909. class WebSocketClient {
  3910. public:
  3911. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3912. const Headers &headers = {});
  3913. ~WebSocketClient();
  3914. WebSocketClient(const WebSocketClient &) = delete;
  3915. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3916. bool is_valid() const;
  3917. Result connect();
  3918. ReadResult read(std::string &msg);
  3919. bool send(const std::string &data);
  3920. bool send(const char *data, size_t len);
  3921. void close(CloseStatus status = CloseStatus::Normal,
  3922. const std::string &reason = "");
  3923. bool is_open() const;
  3924. const std::string &subprotocol() const;
  3925. void set_read_timeout(time_t sec, time_t usec = 0);
  3926. template <class Rep, class Period>
  3927. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3928. void set_write_timeout(time_t sec, time_t usec = 0);
  3929. template <class Rep, class Period>
  3930. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3931. void set_websocket_ping_interval(time_t sec);
  3932. void set_websocket_max_missed_pongs(int count);
  3933. void set_tcp_nodelay(bool on);
  3934. void set_address_family(int family);
  3935. void set_ipv6_v6only(bool on);
  3936. void set_socket_options(SocketOptions socket_options);
  3937. void set_connection_timeout(time_t sec, time_t usec = 0);
  3938. template <class Rep, class Period>
  3939. void
  3940. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3941. void set_interface(const std::string &intf);
  3942. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  3943. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3944. void
  3945. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3946. void
  3947. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3948. void set_basic_auth(const std::string &username, const std::string &password);
  3949. void set_bearer_token_auth(const std::string &token);
  3950. void set_proxy(const std::string &host, int port);
  3951. void set_proxy_basic_auth(const std::string &username,
  3952. const std::string &password);
  3953. void set_proxy_bearer_token_auth(const std::string &token);
  3954. void set_no_proxy(const std::vector<std::string> &patterns);
  3955. #ifdef CPPHTTPLIB_SSL_ENABLED
  3956. struct PemMemory {
  3957. const char *cert_pem;
  3958. size_t cert_pem_len;
  3959. const char *key_pem;
  3960. size_t key_pem_len;
  3961. const char *private_key_password;
  3962. };
  3963. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3964. const PemMemory &pem, const Headers &headers = {});
  3965. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3966. const std::string &ca_cert_dir_path = std::string());
  3967. void set_ca_cert_store(tls::ca_store_t store);
  3968. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3969. void enable_server_certificate_verification(bool enabled);
  3970. void enable_server_hostname_verification(bool enabled);
  3971. void enable_system_ca(bool enabled);
  3972. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3973. void set_session_verifier(
  3974. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3975. void set_proxy_digest_auth(const std::string &username,
  3976. const std::string &password);
  3977. #endif
  3978. private:
  3979. void shutdown_and_close();
  3980. std::pair<time_t, time_t> handshake_timeout() const;
  3981. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3982. int &ssl_error, uint64_t &ssl_backend_error);
  3983. void prepare_default_headers(Request &req);
  3984. bool is_proxy_enabled() const;
  3985. bool create_and_connect_socket(Error &error);
  3986. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3987. bool connect_with_proxy(Response &proxy_res, Error &error);
  3988. std::string host_;
  3989. int port_;
  3990. std::string path_;
  3991. Headers headers_;
  3992. std::string subprotocol_;
  3993. bool is_valid_ = false;
  3994. socket_t sock_ = INVALID_SOCKET;
  3995. std::unique_ptr<WebSocket> ws_;
  3996. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3997. time_t read_timeout_usec_ = 0;
  3998. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3999. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  4000. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  4001. time_t websocket_ping_interval_sec_ =
  4002. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  4003. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  4004. int address_family_ = AF_UNSPEC;
  4005. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  4006. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  4007. SocketOptions socket_options_ = nullptr;
  4008. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  4009. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  4010. std::string interface_;
  4011. // Hostname to connection target map. The value is an IP literal or another
  4012. // hostname; only the connection target changes, never the identity.
  4013. std::map<std::string, std::string> addr_map_;
  4014. // Hostname to CONNECT target map, used only through a proxy.
  4015. std::map<std::string, std::string> tunnel_addr_map_;
  4016. std::string basic_auth_username_;
  4017. std::string basic_auth_password_;
  4018. std::string bearer_token_auth_token_;
  4019. std::string proxy_host_;
  4020. int proxy_port_ = -1;
  4021. std::string proxy_basic_auth_username_;
  4022. std::string proxy_basic_auth_password_;
  4023. std::string proxy_bearer_token_auth_token_;
  4024. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  4025. #ifdef CPPHTTPLIB_SSL_ENABLED
  4026. bool is_ssl_ = false;
  4027. tls::ctx_t tls_ctx_ = nullptr;
  4028. tls::session_t tls_session_ = nullptr;
  4029. std::string ca_cert_file_path_;
  4030. std::string ca_cert_dir_path_;
  4031. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  4032. // no certificate, so that a CA that failed to come through fails
  4033. // verification instead of letting the system CAs in.
  4034. bool custom_ca_loaded_ = false;
  4035. bool certs_loaded_ = false;
  4036. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  4037. bool server_certificate_verification_ = true;
  4038. bool server_hostname_verification_ = true;
  4039. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  4040. std::string proxy_digest_auth_username_;
  4041. std::string proxy_digest_auth_password_;
  4042. #endif
  4043. };
  4044. template <class Rep, class Period>
  4045. inline void WebSocket::set_read_timeout(
  4046. const std::chrono::duration<Rep, Period> &duration) {
  4047. detail::duration_to_sec_and_usec(
  4048. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4049. }
  4050. template <class Rep, class Period>
  4051. inline void WebSocketClient::set_read_timeout(
  4052. const std::chrono::duration<Rep, Period> &duration) {
  4053. detail::duration_to_sec_and_usec(
  4054. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4055. }
  4056. template <class Rep, class Period>
  4057. inline void WebSocketClient::set_write_timeout(
  4058. const std::chrono::duration<Rep, Period> &duration) {
  4059. detail::duration_to_sec_and_usec(
  4060. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4061. }
  4062. template <class Rep, class Period>
  4063. inline void WebSocketClient::set_connection_timeout(
  4064. const std::chrono::duration<Rep, Period> &duration) {
  4065. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4066. set_connection_timeout(sec, usec);
  4067. });
  4068. }
  4069. namespace impl {
  4070. bool is_valid_utf8(const std::string &s);
  4071. // Three states, because a failure that consumed bytes and one that consumed
  4072. // none are not the same thing: the first has left the stream in the middle of
  4073. // a frame and the connection cannot be reused, the second can just be retried.
  4074. enum class FrameRead { Ok, Fail, Timeout };
  4075. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4076. std::string &payload, bool &fin,
  4077. bool expect_masked, size_t max_len);
  4078. } // namespace impl
  4079. } // namespace ws
  4080. // ----------------------------------------------------------------------------
  4081. /*
  4082. * Implementation that will be part of the .cc file if split into .h + .cc.
  4083. */
  4084. namespace stream {
  4085. // stream::Result implementations
  4086. inline Result::Result() : chunk_size_(8192) {}
  4087. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4088. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4089. inline Result::Result(Result &&other) noexcept
  4090. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4091. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4092. finished_(other.finished_) {
  4093. other.current_size_ = 0;
  4094. other.finished_ = true;
  4095. }
  4096. inline Result &Result::operator=(Result &&other) noexcept {
  4097. if (this != &other) {
  4098. handle_ = std::move(other.handle_);
  4099. buffer_ = std::move(other.buffer_);
  4100. current_size_ = other.current_size_;
  4101. chunk_size_ = other.chunk_size_;
  4102. finished_ = other.finished_;
  4103. other.current_size_ = 0;
  4104. other.finished_ = true;
  4105. }
  4106. return *this;
  4107. }
  4108. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4109. inline Result::operator bool() const { return is_valid(); }
  4110. inline int Result::status() const {
  4111. return handle_.response ? handle_.response->status : -1;
  4112. }
  4113. inline const Headers &Result::headers() const {
  4114. static const Headers empty_headers;
  4115. return handle_.response ? handle_.response->headers : empty_headers;
  4116. }
  4117. inline std::string Result::get_header_value(const std::string &key,
  4118. const char *def) const {
  4119. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4120. }
  4121. inline bool Result::has_header(const std::string &key) const {
  4122. return handle_.response ? handle_.response->has_header(key) : false;
  4123. }
  4124. inline Error Result::error() const { return handle_.error; }
  4125. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4126. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4127. inline bool Result::next() {
  4128. if (!handle_.is_valid() || finished_) { return false; }
  4129. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4130. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4131. if (n > 0) {
  4132. current_size_ = static_cast<size_t>(n);
  4133. return true;
  4134. }
  4135. current_size_ = 0;
  4136. finished_ = true;
  4137. return false;
  4138. }
  4139. inline const char *Result::data() const { return buffer_.data(); }
  4140. inline size_t Result::size() const { return current_size_; }
  4141. inline std::string Result::read_all() {
  4142. std::string result;
  4143. while (next()) {
  4144. result.append(data(), size());
  4145. }
  4146. return result;
  4147. }
  4148. } // namespace stream
  4149. namespace sse {
  4150. // SSEMessage implementations
  4151. inline SSEMessage::SSEMessage() : event("message") {}
  4152. inline void SSEMessage::clear() {
  4153. event = "message";
  4154. data.clear();
  4155. id.clear();
  4156. }
  4157. // SSEClient implementations
  4158. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4159. : client_(client), path_(path) {}
  4160. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4161. const Headers &headers)
  4162. : client_(client), path_(path), headers_(headers) {}
  4163. inline SSEClient::~SSEClient() { stop(); }
  4164. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4165. on_message_ = std::move(handler);
  4166. return *this;
  4167. }
  4168. inline SSEClient &SSEClient::on_event(const std::string &type,
  4169. MessageHandler handler) {
  4170. event_handlers_[type] = std::move(handler);
  4171. return *this;
  4172. }
  4173. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4174. on_open_ = std::move(handler);
  4175. return *this;
  4176. }
  4177. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4178. on_error_ = std::move(handler);
  4179. return *this;
  4180. }
  4181. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4182. reconnect_interval_ms_ = ms;
  4183. return *this;
  4184. }
  4185. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4186. max_reconnect_attempts_ = n;
  4187. return *this;
  4188. }
  4189. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4190. std::lock_guard<std::mutex> lock(headers_mutex_);
  4191. headers_ = headers;
  4192. return *this;
  4193. }
  4194. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4195. inline std::string SSEClient::last_event_id() const {
  4196. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4197. return last_event_id_;
  4198. }
  4199. inline void SSEClient::start() {
  4200. running_.store(true);
  4201. run_event_loop();
  4202. }
  4203. inline void SSEClient::start_async() {
  4204. running_.store(true);
  4205. async_thread_ = std::thread([this]() { run_event_loop(); });
  4206. }
  4207. inline void SSEClient::stop() {
  4208. running_.store(false);
  4209. client_.stop(); // Cancel any pending operations
  4210. if (async_thread_.joinable()) { async_thread_.join(); }
  4211. }
  4212. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4213. int &retry_ms, bool &has_data,
  4214. bool &has_id) {
  4215. // Blank line signals end of event
  4216. if (line.empty()) { return true; }
  4217. // Lines starting with ':' are comments (ignored)
  4218. if (line[0] == ':') { return false; }
  4219. // Find the colon separator
  4220. auto colon_pos = line.find(':');
  4221. auto field = line.substr(0, colon_pos);
  4222. std::string value;
  4223. // Value starts after colon, skip optional single space
  4224. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4225. auto value_start = colon_pos + 1;
  4226. if (line[value_start] == ' ') { value_start++; }
  4227. value = line.substr(value_start);
  4228. }
  4229. // Handle known fields
  4230. if (field == "event") {
  4231. // An empty event type is dispatched as "message" per the SSE spec
  4232. msg.event = value.empty() ? std::string("message") : std::move(value);
  4233. } else if (field == "data") {
  4234. // Multiple data lines are concatenated with newlines
  4235. if (has_data) { msg.data += "\n"; }
  4236. msg.data += value;
  4237. has_data = true;
  4238. } else if (field == "id") {
  4239. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4240. // valid (clears the last event ID)
  4241. if (detail::fields::is_field_value(value)) {
  4242. msg.id = value;
  4243. has_id = true;
  4244. }
  4245. } else if (field == "retry") {
  4246. // Parse retry interval in milliseconds
  4247. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4248. if (detail::is_numeric(value)) {
  4249. int v = 0;
  4250. auto res =
  4251. detail::from_chars(value.data(), value.data() + value.size(), v);
  4252. if (res.ec == std::errc{}) { retry_ms = v; }
  4253. }
  4254. }
  4255. // Unknown fields are ignored per SSE spec
  4256. return false;
  4257. }
  4258. inline void SSEClient::run_event_loop() {
  4259. auto reconnect_count = 0;
  4260. while (running_.load()) {
  4261. // Build headers, including Last-Event-ID if we have one
  4262. Headers request_headers;
  4263. {
  4264. std::lock_guard<std::mutex> lock(headers_mutex_);
  4265. request_headers = headers_;
  4266. }
  4267. if (!last_event_id_.empty()) {
  4268. request_headers.emplace("Last-Event-ID", last_event_id_);
  4269. }
  4270. // Open streaming connection. An event stream has no end, so each event is
  4271. // bounded instead of the whole body.
  4272. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4273. handle.body_reader_.payload_max_length = 0;
  4274. // stop() ends a read that is waiting for the next event
  4275. if (handle.stream_) {
  4276. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4277. }
  4278. stream::Result result{std::move(handle)};
  4279. // Connection error handling
  4280. if (!result) {
  4281. connected_.store(false);
  4282. if (on_error_) { on_error_(result.error()); }
  4283. if (!should_reconnect(reconnect_count)) { break; }
  4284. wait_for_reconnect();
  4285. reconnect_count++;
  4286. continue;
  4287. }
  4288. if (result.status() != StatusCode::OK_200) {
  4289. connected_.store(false);
  4290. if (on_error_) { on_error_(Error::Connection); }
  4291. // For certain errors, don't reconnect.
  4292. // Note: 401 is intentionally absent so that handlers can refresh
  4293. // credentials via set_headers() and let the client reconnect.
  4294. if (result.status() == StatusCode::NoContent_204 ||
  4295. result.status() == StatusCode::NotFound_404 ||
  4296. result.status() == StatusCode::Forbidden_403) {
  4297. break;
  4298. }
  4299. if (!should_reconnect(reconnect_count)) { break; }
  4300. wait_for_reconnect();
  4301. reconnect_count++;
  4302. continue;
  4303. }
  4304. // Connection successful
  4305. connected_.store(true);
  4306. reconnect_count = 0;
  4307. if (on_open_) { on_open_(); }
  4308. // Event receiving loop
  4309. std::string buffer;
  4310. SSEMessage current_msg;
  4311. auto has_data = false;
  4312. auto has_id = false;
  4313. auto first_line = true;
  4314. auto after_cr = false;
  4315. auto event_too_long = false;
  4316. while (running_.load() && result.next()) {
  4317. // What is left in the buffer has no line ending
  4318. auto search_pos = buffer.size();
  4319. buffer.append(result.data(), result.size());
  4320. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4321. // per the SSE spec
  4322. size_t line_start = 0;
  4323. size_t eol_pos;
  4324. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4325. std::string::npos) {
  4326. auto line = buffer.substr(line_start, eol_pos - line_start);
  4327. line_start = eol_pos + 1;
  4328. search_pos = line_start;
  4329. // The \n of a \r\n may arrive in a later chunk than its \r
  4330. auto is_lf_of_crlf =
  4331. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4332. after_cr = buffer[eol_pos] == '\r';
  4333. if (is_lf_of_crlf) { continue; }
  4334. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4335. if (first_line) {
  4336. first_line = false;
  4337. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4338. }
  4339. // Parse the line and check if event is complete
  4340. auto event_complete = parse_sse_line(
  4341. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4342. if (event_complete) {
  4343. // Update last_event_id for reconnection, even for an event that
  4344. // has no data. An empty id clears it.
  4345. if (has_id) {
  4346. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4347. last_event_id_ = current_msg.id;
  4348. }
  4349. // An event without a data field is not dispatched
  4350. if (has_data) { dispatch_event(current_msg); }
  4351. // Reset the message for the next event either way
  4352. current_msg.clear();
  4353. has_data = false;
  4354. has_id = false;
  4355. }
  4356. }
  4357. // Keep unprocessed data in buffer
  4358. buffer.erase(0, line_start);
  4359. // Neither an event nor a line still waiting for its end may grow
  4360. // without bound. 0 means no limit.
  4361. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4362. buffer.size() + current_msg.data.size() >
  4363. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4364. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4365. event_too_long = true;
  4366. break;
  4367. }
  4368. }
  4369. // Connection ended
  4370. connected_.store(false);
  4371. // Reconnecting would only get the same event again
  4372. if (!running_.load() || event_too_long) { break; }
  4373. // Check for read errors
  4374. if (result.has_read_error()) {
  4375. if (on_error_) { on_error_(result.read_error()); }
  4376. }
  4377. if (!should_reconnect(reconnect_count)) { break; }
  4378. wait_for_reconnect();
  4379. reconnect_count++;
  4380. }
  4381. connected_.store(false);
  4382. }
  4383. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4384. // Check for specific event type handler first
  4385. auto it = event_handlers_.find(msg.event);
  4386. if (it != event_handlers_.end()) {
  4387. it->second(msg);
  4388. return;
  4389. }
  4390. // Fall back to generic message handler
  4391. if (on_message_) { on_message_(msg); }
  4392. }
  4393. inline bool SSEClient::should_reconnect(int count) const {
  4394. if (!running_.load()) { return false; }
  4395. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4396. return count < max_reconnect_attempts_;
  4397. }
  4398. inline void SSEClient::wait_for_reconnect() {
  4399. // Use small increments to check running_ flag frequently.
  4400. // Always wait at least one increment, so that a zero interval (e.g.
  4401. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4402. const auto step_ms = 100;
  4403. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4404. auto waited = 0;
  4405. while (running_.load() && waited < interval_ms) {
  4406. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4407. waited += step_ms;
  4408. }
  4409. }
  4410. } // namespace sse
  4411. #ifdef CPPHTTPLIB_SSL_ENABLED
  4412. /*
  4413. * TLS abstraction layer - internal function declarations
  4414. * These are implementation details and not part of the public API.
  4415. */
  4416. namespace tls {
  4417. // Client context
  4418. ctx_t create_client_context();
  4419. void free_context(ctx_t ctx);
  4420. bool set_min_version(ctx_t ctx, Version version);
  4421. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4422. bool load_ca_file(ctx_t ctx, const char *file_path);
  4423. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4424. bool load_system_certs(ctx_t ctx);
  4425. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4426. const char *password);
  4427. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4428. const char *key_path, const char *password);
  4429. // Server context
  4430. ctx_t create_server_context();
  4431. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4432. const char *password);
  4433. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4434. const char *key_path, const char *password);
  4435. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4436. void set_verify_client(ctx_t ctx, bool require);
  4437. // Session management
  4438. session_t create_session(ctx_t ctx, socket_t sock);
  4439. void free_session(session_t session);
  4440. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4441. // Handshake (non-blocking capable)
  4442. TlsError connect(session_t session);
  4443. TlsError accept(session_t session);
  4444. // Handshake with timeout (blocking until timeout)
  4445. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4446. time_t timeout_usec, TlsError *err);
  4447. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4448. time_t timeout_usec, TlsError *err);
  4449. // I/O (non-blocking capable)
  4450. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4451. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4452. int pending(const_session_t session);
  4453. void shutdown(session_t session, bool graceful);
  4454. // Connection state
  4455. bool is_peer_closed(session_t session, socket_t sock);
  4456. // Certificate verification
  4457. cert_t get_peer_cert(const_session_t session);
  4458. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4459. // do not use them after free_session(), as with get_peer_cert().
  4460. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4461. void free_cert(cert_t cert);
  4462. // Matches the host against the subjectAltName entries only, never the Common
  4463. // Name (RFC 9525).
  4464. bool verify_hostname(cert_t cert, const char *hostname);
  4465. uint64_t hostname_mismatch_code();
  4466. long get_verify_result(const_session_t session);
  4467. // Certificate introspection
  4468. std::string get_cert_subject_cn(cert_t cert);
  4469. std::string get_cert_issuer_name(cert_t cert);
  4470. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4471. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4472. std::string get_cert_serial(cert_t cert);
  4473. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4474. const char *get_sni(const_session_t session);
  4475. // CA store management
  4476. ca_store_t create_ca_store(const char *pem, size_t len);
  4477. void free_ca_store(ca_store_t store);
  4478. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4479. // Free each with free_cert(), and do not use them once the context's CA
  4480. // certificates change.
  4481. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4482. std::vector<std::string> get_ca_names(ctx_t ctx);
  4483. // Dynamic certificate update (for servers)
  4484. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4485. const char *password);
  4486. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4487. // Certificate verification callback
  4488. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4489. long get_verify_error(const_session_t session);
  4490. std::string verify_error_string(long error_code);
  4491. // TlsError information
  4492. uint64_t peek_error();
  4493. uint64_t get_error();
  4494. std::string error_string(uint64_t code);
  4495. } // namespace tls
  4496. #endif // CPPHTTPLIB_SSL_ENABLED
  4497. /*
  4498. * Group 1: detail namespace - Non-SSL utilities
  4499. */
  4500. namespace detail {
  4501. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4502. const void *optval, socklen_t optlen) {
  4503. return setsockopt(sock, level, optname,
  4504. #ifdef _WIN32
  4505. reinterpret_cast<const char *>(optval),
  4506. #else
  4507. optval,
  4508. #endif
  4509. optlen) == 0;
  4510. }
  4511. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4512. time_t sec, time_t usec) {
  4513. #ifdef _WIN32
  4514. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4515. #else
  4516. timeval timeout;
  4517. timeout.tv_sec = static_cast<long>(sec);
  4518. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4519. #endif
  4520. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4521. }
  4522. inline bool is_hex(char c, int &v) {
  4523. if (is_ascii_digit(c)) {
  4524. v = c - '0';
  4525. return true;
  4526. } else if ('A' <= c && c <= 'F') {
  4527. v = c - 'A' + 10;
  4528. return true;
  4529. } else if ('a' <= c && c <= 'f') {
  4530. v = c - 'a' + 10;
  4531. return true;
  4532. }
  4533. return false;
  4534. }
  4535. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4536. int &val) {
  4537. if (i >= s.size()) { return false; }
  4538. val = 0;
  4539. for (; cnt; i++, cnt--) {
  4540. if (!s[i]) { return false; }
  4541. auto v = 0;
  4542. if (is_hex(s[i], v)) {
  4543. val = val * 16 + v;
  4544. } else {
  4545. return false;
  4546. }
  4547. }
  4548. return true;
  4549. }
  4550. inline std::string from_i_to_hex(size_t n) {
  4551. static const auto charset = "0123456789abcdef";
  4552. std::string ret;
  4553. do {
  4554. ret = charset[n & 15] + ret;
  4555. n >>= 4;
  4556. } while (n > 0);
  4557. return ret;
  4558. }
  4559. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4560. // builds and trips -Wtautological-type-limit-compare.
  4561. inline bool fits_in_size_t(uint64_t n) {
  4562. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4563. }
  4564. inline std::string compute_etag(const FileStat &fs,
  4565. const std::string &suffix = std::string()) {
  4566. if (!fs.is_file()) { return std::string(); }
  4567. // If mtime cannot be determined (negative value indicates an error
  4568. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4569. // value like 0 could collide with a real file that legitimately has
  4570. // mtime == 0 (epoch) and lead to misleading validators.
  4571. auto mtime_raw = fs.mtime();
  4572. if (mtime_raw < 0) { return std::string(); }
  4573. auto mtime = static_cast<size_t>(mtime_raw);
  4574. auto size = fs.size();
  4575. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4576. from_i_to_hex(size) + suffix + "\"";
  4577. }
  4578. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4579. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4580. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4581. inline std::string file_mtime_to_http_date(time_t mtime) {
  4582. if (mtime < 0) { return std::string(); }
  4583. struct tm tm_buf;
  4584. #ifdef _WIN32
  4585. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4586. #else
  4587. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4588. #endif
  4589. char buf[64];
  4590. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4591. return std::string();
  4592. }
  4593. return std::string(buf);
  4594. }
  4595. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4596. inline time_t parse_http_date(const std::string &date_str) {
  4597. struct tm tm_buf;
  4598. // Create a classic locale object once for all parsing attempts
  4599. const std::locale classic_locale = std::locale::classic();
  4600. // Try to parse using std::get_time (C++11, cross-platform)
  4601. auto try_parse = [&](const char *fmt) -> bool {
  4602. std::istringstream ss(date_str);
  4603. ss.imbue(classic_locale);
  4604. memset(&tm_buf, 0, sizeof(tm_buf));
  4605. ss >> std::get_time(&tm_buf, fmt);
  4606. return !ss.fail();
  4607. };
  4608. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4609. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4610. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4611. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4612. // asctime format: "Sun Nov 6 08:49:37 1994"
  4613. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4614. return static_cast<time_t>(-1);
  4615. }
  4616. }
  4617. }
  4618. #ifdef _WIN32
  4619. return _mkgmtime(&tm_buf);
  4620. #elif defined _AIX
  4621. return mktime(&tm_buf);
  4622. #else
  4623. return timegm(&tm_buf);
  4624. #endif
  4625. }
  4626. inline bool is_weak_etag(const std::string &s) {
  4627. // Check if the string is a weak ETag (starts with 'W/"')
  4628. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4629. }
  4630. inline bool is_strong_etag(const std::string &s) {
  4631. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4632. // chars)
  4633. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4634. }
  4635. inline size_t to_utf8(int code, char *buff) {
  4636. if (code < 0x0080) {
  4637. buff[0] = static_cast<char>(code & 0x7F);
  4638. return 1;
  4639. } else if (code < 0x0800) {
  4640. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4641. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4642. return 2;
  4643. } else if (code < 0xD800) {
  4644. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4645. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4646. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4647. return 3;
  4648. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4649. return 0;
  4650. } else if (code < 0x10000) {
  4651. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4652. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4653. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4654. return 3;
  4655. } else if (code < 0x110000) {
  4656. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4657. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4658. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4659. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4660. return 4;
  4661. }
  4662. // NOTREACHED
  4663. return 0;
  4664. }
  4665. } // namespace detail
  4666. namespace ws {
  4667. namespace impl {
  4668. inline bool is_valid_utf8(const std::string &s) {
  4669. size_t i = 0;
  4670. auto n = s.size();
  4671. while (i < n) {
  4672. auto c = static_cast<unsigned char>(s[i]);
  4673. size_t len;
  4674. uint32_t cp;
  4675. if (c < 0x80) {
  4676. i++;
  4677. continue;
  4678. } else if ((c & 0xE0) == 0xC0) {
  4679. len = 2;
  4680. cp = c & 0x1F;
  4681. } else if ((c & 0xF0) == 0xE0) {
  4682. len = 3;
  4683. cp = c & 0x0F;
  4684. } else if ((c & 0xF8) == 0xF0) {
  4685. len = 4;
  4686. cp = c & 0x07;
  4687. } else {
  4688. return false;
  4689. }
  4690. if (i + len > n) { return false; }
  4691. for (size_t j = 1; j < len; j++) {
  4692. auto b = static_cast<unsigned char>(s[i + j]);
  4693. if ((b & 0xC0) != 0x80) { return false; }
  4694. cp = (cp << 6) | (b & 0x3F);
  4695. }
  4696. // Overlong encoding check
  4697. if (len == 2 && cp < 0x80) { return false; }
  4698. if (len == 3 && cp < 0x800) { return false; }
  4699. if (len == 4 && cp < 0x10000) { return false; }
  4700. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4701. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4702. if (cp > 0x10FFFF) { return false; }
  4703. i += len;
  4704. }
  4705. return true;
  4706. }
  4707. } // namespace impl
  4708. } // namespace ws
  4709. namespace detail {
  4710. // NOTE: This code came up with the following stackoverflow post:
  4711. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4712. inline std::string base64_encode(const std::string &in) {
  4713. static const auto lookup =
  4714. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4715. std::string out;
  4716. out.reserve(in.size());
  4717. // Unsigned: the accumulator is never masked, so with a signed int the
  4718. // `val << 8` below overflows once enough bytes are folded in (undefined
  4719. // behaviour before C++20). Only the low bits are ever emitted, so the
  4720. // wrap-around of an unsigned accumulator does not affect the output.
  4721. uint32_t val = 0;
  4722. auto valb = -6;
  4723. for (auto c : in) {
  4724. val = (val << 8) + static_cast<uint8_t>(c);
  4725. valb += 8;
  4726. while (valb >= 0) {
  4727. out.push_back(lookup[(val >> valb) & 0x3F]);
  4728. valb -= 6;
  4729. }
  4730. }
  4731. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4732. while (out.size() % 4) {
  4733. out.push_back('=');
  4734. }
  4735. return out;
  4736. }
  4737. inline std::string sha1(const std::string &input) {
  4738. // RFC 3174 SHA-1 implementation
  4739. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4740. return (x << n) | (x >> (32 - n));
  4741. };
  4742. uint32_t h0 = 0x67452301;
  4743. uint32_t h1 = 0xEFCDAB89;
  4744. uint32_t h2 = 0x98BADCFE;
  4745. uint32_t h3 = 0x10325476;
  4746. uint32_t h4 = 0xC3D2E1F0;
  4747. // Pre-processing: adding padding bits
  4748. std::string msg = input;
  4749. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4750. msg.push_back(static_cast<char>(0x80u));
  4751. while (msg.size() % 64 != 56) {
  4752. msg.push_back(0);
  4753. }
  4754. // Append original length in bits as 64-bit big-endian
  4755. for (int i = 56; i >= 0; i -= 8) {
  4756. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4757. }
  4758. // Process each 512-bit chunk
  4759. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4760. uint32_t w[80];
  4761. for (size_t i = 0; i < 16; i++) {
  4762. w[i] =
  4763. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4764. << 24) |
  4765. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4766. << 16) |
  4767. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4768. << 8) |
  4769. (static_cast<uint32_t>(
  4770. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4771. }
  4772. for (int i = 16; i < 80; i++) {
  4773. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4774. }
  4775. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4776. for (int i = 0; i < 80; i++) {
  4777. uint32_t f, k;
  4778. if (i < 20) {
  4779. f = (b & c) | ((~b) & d);
  4780. k = 0x5A827999;
  4781. } else if (i < 40) {
  4782. f = b ^ c ^ d;
  4783. k = 0x6ED9EBA1;
  4784. } else if (i < 60) {
  4785. f = (b & c) | (b & d) | (c & d);
  4786. k = 0x8F1BBCDC;
  4787. } else {
  4788. f = b ^ c ^ d;
  4789. k = 0xCA62C1D6;
  4790. }
  4791. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4792. e = d;
  4793. d = c;
  4794. c = left_rotate(b, 30);
  4795. b = a;
  4796. a = temp;
  4797. }
  4798. h0 += a;
  4799. h1 += b;
  4800. h2 += c;
  4801. h3 += d;
  4802. h4 += e;
  4803. }
  4804. // Produce the final hash as a 20-byte binary string
  4805. std::string hash(20, '\0');
  4806. for (size_t i = 0; i < 4; i++) {
  4807. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4808. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4809. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4810. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4811. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4812. }
  4813. return hash;
  4814. }
  4815. inline std::string websocket_accept_key(const std::string &client_key) {
  4816. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4817. return base64_encode(sha1(client_key + magic));
  4818. }
  4819. inline bool is_websocket_upgrade(const Request &req) {
  4820. if (req.method != "GET") { return false; }
  4821. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4822. // list of protocols and asks recipients to match each name
  4823. // case-insensitively, so look for the token rather than compare the whole
  4824. // field value.
  4825. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4826. // Check Connection: Upgrade
  4827. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4828. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4829. // RFC 6455 Section 4.2.1
  4830. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4831. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4832. return false;
  4833. }
  4834. static const std::string b64chars =
  4835. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4836. for (size_t i = 0; i < 22; i++) {
  4837. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4838. }
  4839. // Check Sec-WebSocket-Version: 13
  4840. auto version = req.get_header_value("Sec-WebSocket-Version");
  4841. if (version != "13") { return false; }
  4842. return true;
  4843. }
  4844. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4845. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4846. thread_local std::random_device rd;
  4847. size_t filled = 0;
  4848. while (filled < n) {
  4849. auto v = rd();
  4850. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4851. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4852. }
  4853. }
  4854. }
  4855. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4856. const char *data, size_t len, bool fin,
  4857. bool mask) {
  4858. // First byte: FIN + opcode
  4859. uint8_t header[2];
  4860. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4861. (static_cast<uint8_t>(opcode) & 0x0F));
  4862. // Second byte: MASK + payload length
  4863. if (len < 126) {
  4864. header[1] = static_cast<uint8_t>(len);
  4865. if (mask) { header[1] |= 0x80; }
  4866. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4867. return false;
  4868. }
  4869. } else if (len <= 0xFFFF) {
  4870. header[1] = 126;
  4871. if (mask) { header[1] |= 0x80; }
  4872. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4873. return false;
  4874. }
  4875. uint8_t ext[2];
  4876. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4877. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4878. if (!write_data(strm, reinterpret_cast<char *>(ext), 2)) { return false; }
  4879. } else {
  4880. header[1] = 127;
  4881. if (mask) { header[1] |= 0x80; }
  4882. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4883. return false;
  4884. }
  4885. uint8_t ext[8];
  4886. for (int i = 7; i >= 0; i--) {
  4887. ext[7 - i] =
  4888. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4889. }
  4890. if (!write_data(strm, reinterpret_cast<char *>(ext), 8)) { return false; }
  4891. }
  4892. if (mask) {
  4893. // Generate random mask key
  4894. uint8_t mask_key[4];
  4895. fill_random_bytes(mask_key, sizeof(mask_key));
  4896. if (!write_data(strm, reinterpret_cast<char *>(mask_key), 4)) {
  4897. return false;
  4898. }
  4899. // Write masked payload in chunks
  4900. const size_t chunk_size = 4096;
  4901. std::vector<char> buf((std::min)(len, chunk_size));
  4902. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4903. size_t n = (std::min)(chunk_size, len - offset);
  4904. for (size_t i = 0; i < n; i++) {
  4905. buf[i] =
  4906. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4907. }
  4908. if (!write_data(strm, buf.data(), n)) { return false; }
  4909. }
  4910. } else {
  4911. if (len > 0) {
  4912. if (!write_data(strm, data, len)) { return false; }
  4913. }
  4914. }
  4915. return true;
  4916. }
  4917. } // namespace detail
  4918. namespace ws {
  4919. namespace impl {
  4920. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4921. // hands back whatever its buffer already holds -- so every multi-byte field has
  4922. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4923. // header straddles the read buffer's boundary.
  4924. //
  4925. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4926. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4927. // there is a failure like any other. (When read() fails it always records why,
  4928. // so the error belongs to this call and not to an earlier one.)
  4929. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4930. auto p = static_cast<char *>(buf);
  4931. size_t total = 0;
  4932. while (total < size) {
  4933. auto n = strm.read(p + total, size - total);
  4934. if (n <= 0) {
  4935. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4936. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4937. }
  4938. total += static_cast<size_t>(n);
  4939. }
  4940. return FrameRead::Ok;
  4941. }
  4942. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4943. std::string &payload, bool &fin,
  4944. bool expect_masked, size_t max_len) {
  4945. // Read first 2 bytes. This is the only read that may report a timeout: it
  4946. // sits on a frame boundary, where nothing has been consumed yet.
  4947. uint8_t header[2];
  4948. FrameRead first = read_exact(strm, header, 2);
  4949. if (first != FrameRead::Ok) { return first; }
  4950. fin = (header[0] & 0x80) != 0;
  4951. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4952. if (header[0] & 0x70) { return FrameRead::Fail; }
  4953. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4954. bool masked = (header[1] & 0x80) != 0;
  4955. uint64_t payload_len = header[1] & 0x7F;
  4956. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4957. // MUST have a payload length of 125 bytes or less
  4958. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4959. if (is_control) {
  4960. if (!fin) { return FrameRead::Fail; }
  4961. if (payload_len > 125) { return FrameRead::Fail; }
  4962. }
  4963. if (masked != expect_masked) { return FrameRead::Fail; }
  4964. // Extended payload length
  4965. if (payload_len == 126) {
  4966. uint8_t ext[2];
  4967. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4968. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4969. } else if (payload_len == 127) {
  4970. uint8_t ext[8];
  4971. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4972. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4973. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4974. payload_len = 0;
  4975. for (int i = 0; i < 8; i++) {
  4976. payload_len = (payload_len << 8) | ext[i];
  4977. }
  4978. }
  4979. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4980. // size_t cannot hold (32-bit builds) is refused either way.
  4981. if ((max_len > 0 && payload_len > max_len) ||
  4982. !detail::fits_in_size_t(payload_len)) {
  4983. return FrameRead::Fail;
  4984. }
  4985. // Read mask key if present
  4986. uint8_t mask_key[4] = {0};
  4987. if (masked) {
  4988. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4989. return FrameRead::Fail;
  4990. }
  4991. }
  4992. // Grow the payload only as it arrives, since a header alone can announce
  4993. // max_len bytes that never come.
  4994. payload.clear();
  4995. auto len = static_cast<size_t>(payload_len);
  4996. while (payload.size() < len) {
  4997. auto offset = payload.size();
  4998. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4999. payload.resize(offset + n);
  5000. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  5001. return FrameRead::Fail;
  5002. }
  5003. }
  5004. // Unmask if needed
  5005. if (masked) {
  5006. for (size_t i = 0; i < payload.size(); i++) {
  5007. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  5008. }
  5009. }
  5010. return FrameRead::Ok;
  5011. }
  5012. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  5013. // be sent followed by a UTF-8 reason.
  5014. inline bool is_valid_close_payload(const std::string &payload) {
  5015. if (payload.empty()) { return true; }
  5016. if (payload.size() < 2) { return false; }
  5017. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  5018. static_cast<uint8_t>(payload[1]);
  5019. auto may_be_sent = (1000 <= code && code <= 1003) ||
  5020. (1007 <= code && code <= 1014) ||
  5021. (3000 <= code && code <= 4999);
  5022. return may_be_sent && is_valid_utf8(payload.substr(2));
  5023. }
  5024. } // namespace impl
  5025. } // namespace ws
  5026. namespace detail {
  5027. // A path a mount point serves: absolute, with no empty segment except a
  5028. // trailing '/', no segment ending in '.' or a space (which covers "." and
  5029. // ".." and names Windows trims into another file's name) and, on Windows, no
  5030. // ':' (which names an NTFS stream, so "a.txt::$DATA" is a.txt), so the file
  5031. // served is the one that req.path names to the handlers that ran before it.
  5032. inline bool is_valid_path(const std::string &path) {
  5033. if (path.empty() || path[0] != '/') { return false; }
  5034. auto beg = size_t{1};
  5035. for (auto i = beg; i <= path.size(); i++) {
  5036. if (i < path.size() && path[i] != '/') {
  5037. if (path[i] == '\0' || path[i] == '\\') { return false; }
  5038. #ifdef _WIN32
  5039. if (path[i] == ':') { return false; }
  5040. #endif
  5041. continue;
  5042. }
  5043. auto len = i - beg;
  5044. if ((len == 0 && i < path.size()) ||
  5045. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5046. return false;
  5047. }
  5048. beg = i + 1;
  5049. }
  5050. return true;
  5051. }
  5052. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5053. #if defined(_WIN32)
  5054. char buf[_MAX_PATH];
  5055. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  5056. resolved = buf;
  5057. #elif defined(PATH_MAX)
  5058. char buf[PATH_MAX];
  5059. if (realpath(path, buf) == nullptr) { return false; }
  5060. resolved = buf;
  5061. #else
  5062. auto buf = realpath(path, nullptr);
  5063. auto guard = scope_exit([&]() { std::free(buf); });
  5064. if (buf == nullptr) { return false; }
  5065. resolved = buf;
  5066. #endif
  5067. return true;
  5068. }
  5069. inline bool is_path_within_base(const std::string &resolved_path,
  5070. const std::string &resolved_base) {
  5071. #if defined(_WIN32)
  5072. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5073. resolved_base.size()) == 0;
  5074. #else
  5075. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5076. resolved_base.size()) == 0;
  5077. #endif
  5078. }
  5079. inline FileStat::FileStat(const std::string &path) {
  5080. #if defined(_WIN32)
  5081. auto wpath = u8string_to_wstring(path.c_str());
  5082. ret_ = _wstat(wpath.c_str(), &st_);
  5083. #else
  5084. ret_ = stat(path.c_str(), &st_);
  5085. #endif
  5086. }
  5087. inline bool FileStat::is_file() const {
  5088. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5089. }
  5090. inline bool FileStat::is_dir() const {
  5091. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5092. }
  5093. inline time_t FileStat::mtime() const {
  5094. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5095. : static_cast<time_t>(-1);
  5096. }
  5097. inline size_t FileStat::size() const {
  5098. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5099. }
  5100. inline std::string encode_path(const std::string &s) {
  5101. std::string result;
  5102. result.reserve(s.size());
  5103. for (size_t i = 0; s[i]; i++) {
  5104. switch (s[i]) {
  5105. case ' ': result += "%20"; break;
  5106. case '+': result += "%2B"; break;
  5107. case '\'': result += "%27"; break;
  5108. case ',': result += "%2C"; break;
  5109. // case ':': result += "%3A"; break; // ok? probably...
  5110. case ';': result += "%3B"; break;
  5111. default:
  5112. auto c = static_cast<uint8_t>(s[i]);
  5113. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5114. // in a request-target as-is.
  5115. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5116. result += '%';
  5117. char hex[4];
  5118. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5119. assert(len == 2);
  5120. result.append(hex, static_cast<size_t>(len));
  5121. } else {
  5122. result += s[i];
  5123. }
  5124. break;
  5125. }
  5126. }
  5127. return result;
  5128. }
  5129. inline std::string file_extension(const std::string &path) {
  5130. auto i = path.size();
  5131. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5132. i--;
  5133. }
  5134. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5135. return std::string();
  5136. }
  5137. return path.substr(i);
  5138. }
  5139. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5140. template <typename T>
  5141. inline bool parse_header(const char *beg, const char *end, T fn);
  5142. template <typename T>
  5143. inline bool parse_header(const char *beg, const char *end, T fn) {
  5144. // Skip trailing spaces and tabs.
  5145. while (beg < end && is_space_or_tab(end[-1])) {
  5146. end--;
  5147. }
  5148. auto p = beg;
  5149. while (p < end && *p != ':') {
  5150. p++;
  5151. }
  5152. auto name = std::string(beg, p);
  5153. if (!detail::fields::is_field_name(name)) { return false; }
  5154. if (p == end) { return false; }
  5155. auto key_end = p;
  5156. if (*p++ != ':') { return false; }
  5157. while (p < end && is_space_or_tab(*p)) {
  5158. p++;
  5159. }
  5160. if (p <= end) {
  5161. auto key_len = key_end - beg;
  5162. if (!key_len) { return false; }
  5163. auto key = std::string(beg, key_end);
  5164. auto val = std::string(p, end);
  5165. if (!detail::fields::is_field_value(val)) { return false; }
  5166. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5167. // percent-decoded by the recipient. Applications that need to interpret a
  5168. // value as a URI component should call httplib::decode_uri_component()
  5169. // (or decode_path_component()) explicitly.
  5170. fn(key, val);
  5171. return true;
  5172. }
  5173. return false;
  5174. }
  5175. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5176. const Headers &src_headers) {
  5177. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5178. // transfer coding is complete when a chunk with a chunk-size of zero is
  5179. // received, possibly followed by a trailer section, and finally terminated by
  5180. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5181. //
  5182. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5183. // doesn't care for the existence of the final CRLF. In other words, it seems
  5184. // to be ok whether the final CRLF exists or not in the chunked data.
  5185. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5186. //
  5187. // According to the reference code in RFC 9112, cpp-httplib now allows
  5188. // chunked transfer coding data without the final CRLF.
  5189. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5190. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5191. "transfer-encoding",
  5192. "content-length",
  5193. "host",
  5194. "authorization",
  5195. "www-authenticate",
  5196. "proxy-authenticate",
  5197. "proxy-authorization",
  5198. "cookie",
  5199. "set-cookie",
  5200. "cache-control",
  5201. "expect",
  5202. "max-forwards",
  5203. "pragma",
  5204. "range",
  5205. "te",
  5206. "age",
  5207. "expires",
  5208. "date",
  5209. "location",
  5210. "retry-after",
  5211. "vary",
  5212. "warning",
  5213. "content-encoding",
  5214. "content-type",
  5215. "content-range",
  5216. "trailer"};
  5217. case_ignore::unordered_set<std::string> declared_trailers;
  5218. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5219. if (!trailer_header.empty()) {
  5220. // split() trims each token and skips empty ones, so the name arrives ready
  5221. // to look up.
  5222. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5223. ',', [&](const char *b, const char *e) {
  5224. // A legitimate message declares only a handful of trailers. Cap the
  5225. // set so a peer cannot grow it without bound: an oversized set only
  5226. // arises from an attempt to force many colliding names into
  5227. // quadratic lookups (case_ignore::hash is unkeyed).
  5228. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5229. return;
  5230. }
  5231. std::string key(b, e);
  5232. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5233. declared_trailers.insert(key);
  5234. }
  5235. });
  5236. }
  5237. size_t trailer_header_count = 0;
  5238. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5239. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5240. // Count every received trailer field, not only the declared ones stored in
  5241. // dest, so undeclared fields cannot keep this loop running past the limit.
  5242. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5243. constexpr auto line_terminator_len = 2;
  5244. auto line_beg = line_reader.ptr();
  5245. auto line_end =
  5246. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5247. if (!parse_header(line_beg, line_end,
  5248. [&](const std::string &key, const std::string &val) {
  5249. if (declared_trailers.find(key) !=
  5250. declared_trailers.end()) {
  5251. dest.emplace(key, val);
  5252. }
  5253. })) {
  5254. return false;
  5255. }
  5256. trailer_header_count++;
  5257. if (!line_reader.getline()) { return false; }
  5258. }
  5259. return true;
  5260. }
  5261. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5262. size_t right) {
  5263. while (b + left < e && is_space_or_tab(b[left])) {
  5264. left++;
  5265. }
  5266. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5267. right--;
  5268. }
  5269. return std::make_pair(left, right);
  5270. }
  5271. inline std::string trim_copy(const std::string &s) {
  5272. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5273. return s.substr(r.first, r.second - r.first);
  5274. }
  5275. inline std::string trim_double_quotes_copy(const std::string &s) {
  5276. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5277. return s.substr(1, s.size() - 2);
  5278. }
  5279. return s;
  5280. }
  5281. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5282. // here, as browsers send any other backslash, such as one in a Windows path,
  5283. // as it is.
  5284. inline std::string unquote_param(const std::string &s) {
  5285. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5286. std::string out;
  5287. for (size_t i = 1; i + 1 < s.size(); i++) {
  5288. if (s[i] == '\\' && i + 2 < s.size() &&
  5289. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5290. i++;
  5291. }
  5292. out += s[i];
  5293. }
  5294. return out;
  5295. }
  5296. inline void
  5297. divide(const char *data, std::size_t size, char d,
  5298. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5299. fn) {
  5300. const auto it = std::find(data, data + size, d);
  5301. const auto found = static_cast<std::size_t>(it != data + size);
  5302. const auto lhs_data = data;
  5303. const auto lhs_size = static_cast<std::size_t>(it - data);
  5304. const auto rhs_data = it + found;
  5305. const auto rhs_size = size - lhs_size - found;
  5306. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5307. }
  5308. inline void
  5309. divide(const std::string &str, char d,
  5310. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5311. fn) {
  5312. divide(str.data(), str.size(), d, std::move(fn));
  5313. }
  5314. inline void split(const char *b, const char *e, char d,
  5315. std::function<void(const char *, const char *)> fn) {
  5316. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5317. }
  5318. inline void split(const char *b, const char *e, char d, size_t m,
  5319. std::function<void(const char *, const char *)> fn) {
  5320. size_t i = 0;
  5321. size_t beg = 0;
  5322. size_t count = 1;
  5323. while (e ? (b + i < e) : (b[i] != '\0')) {
  5324. if (b[i] == d && count < m) {
  5325. auto r = trim(b, e, beg, i);
  5326. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5327. beg = i + 1;
  5328. count++;
  5329. }
  5330. i++;
  5331. }
  5332. if (i) {
  5333. auto r = trim(b, e, beg, i);
  5334. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5335. }
  5336. }
  5337. // Same contract as split(), except that a delimiter inside a quoted-string is
  5338. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5339. // quoted-string, and ';' and '=' are legal characters inside one.
  5340. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5341. std::function<void(const char *, const char *)> fn) {
  5342. size_t i = 0;
  5343. size_t beg = 0;
  5344. size_t count = 1;
  5345. auto in_quotes = false;
  5346. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5347. while (has(i)) {
  5348. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5349. // A quoted-pair, whose second character does not end the string.
  5350. i++;
  5351. } else if (b[i] == '"') {
  5352. in_quotes = !in_quotes;
  5353. } else if (b[i] == d && !in_quotes && count < m) {
  5354. auto r = trim(b, e, beg, i);
  5355. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5356. beg = i + 1;
  5357. count++;
  5358. }
  5359. i++;
  5360. }
  5361. if (i) {
  5362. auto r = trim(b, e, beg, i);
  5363. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5364. }
  5365. }
  5366. inline void split_unquoted(const char *b, const char *e, char d,
  5367. std::function<void(const char *, const char *)> fn) {
  5368. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5369. std::move(fn));
  5370. }
  5371. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5372. // key a token, so the first '=' is the separator even when the value is a
  5373. // quoted-string carrying more of them.
  5374. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5375. std::string &val) {
  5376. divide(
  5377. b, static_cast<std::size_t>(e - b), '=',
  5378. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5379. const auto kr = trim(kb, kb + klen, 0, klen);
  5380. key.assign(kb + kr.first, kb + kr.second);
  5381. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5382. val.assign(vb + vr.first, vb + vr.second);
  5383. });
  5384. }
  5385. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5386. std::function<bool(const char *, const char *)> fn) {
  5387. size_t i = 0;
  5388. size_t beg = 0;
  5389. size_t count = 1;
  5390. while (e ? (b + i < e) : (b[i] != '\0')) {
  5391. if (b[i] == d && count < m) {
  5392. auto r = trim(b, e, beg, i);
  5393. if (r.first < r.second) {
  5394. auto found = fn(&b[r.first], &b[r.second]);
  5395. if (found) { return true; }
  5396. }
  5397. beg = i + 1;
  5398. count++;
  5399. }
  5400. i++;
  5401. }
  5402. if (i) {
  5403. auto r = trim(b, e, beg, i);
  5404. if (r.first < r.second) {
  5405. auto found = fn(&b[r.first], &b[r.second]);
  5406. if (found) { return true; }
  5407. }
  5408. }
  5409. return false;
  5410. }
  5411. inline bool split_find(const char *b, const char *e, char d,
  5412. std::function<bool(const char *, const char *)> fn) {
  5413. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5414. std::move(fn));
  5415. }
  5416. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5417. size_t fixed_buffer_size)
  5418. : strm_(strm), fixed_buffer_(fixed_buffer),
  5419. fixed_buffer_size_(fixed_buffer_size) {}
  5420. inline const char *stream_line_reader::ptr() const {
  5421. if (growable_buffer_.empty()) {
  5422. return fixed_buffer_;
  5423. } else {
  5424. return growable_buffer_.data();
  5425. }
  5426. }
  5427. inline size_t stream_line_reader::size() const {
  5428. if (growable_buffer_.empty()) {
  5429. return fixed_buffer_used_size_;
  5430. } else {
  5431. return growable_buffer_.size();
  5432. }
  5433. }
  5434. inline bool stream_line_reader::end_with_crlf() const {
  5435. auto end = ptr() + size();
  5436. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5437. }
  5438. inline bool stream_line_reader::getline() {
  5439. fixed_buffer_used_size_ = 0;
  5440. growable_buffer_.clear();
  5441. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5442. char prev_byte = 0;
  5443. #endif
  5444. for (size_t i = 0;; i++) {
  5445. // Fast path: whatever the stream has already buffered can be scanned for
  5446. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5447. // call, a bounds check and a one-byte copy per character of the request.
  5448. size_t buffered_size = 0;
  5449. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5450. auto take = buffered_size;
  5451. auto terminated = false;
  5452. for (size_t at = 0; at < buffered_size;) {
  5453. auto nl = static_cast<const char *>(
  5454. memchr(buffered + at, '\n', buffered_size - at));
  5455. if (!nl) { break; }
  5456. auto pos = static_cast<size_t>(nl - buffered);
  5457. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5458. take = pos + 1;
  5459. terminated = true;
  5460. break;
  5461. #else
  5462. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5463. // be the last byte of an earlier chunk, hence prev_byte.
  5464. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5465. take = pos + 1;
  5466. terminated = true;
  5467. break;
  5468. }
  5469. at = pos + 1;
  5470. #endif
  5471. }
  5472. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5473. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5474. prev_byte = buffered[take - 1];
  5475. #endif
  5476. append(buffered, take);
  5477. strm_.consume_buffered(take);
  5478. i += take;
  5479. if (terminated) { return true; }
  5480. continue;
  5481. }
  5482. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5483. // Treat exceptionally long lines as an error to
  5484. // prevent infinite loops/memory exhaustion
  5485. return false;
  5486. }
  5487. char byte;
  5488. auto n = strm_.read(&byte, 1);
  5489. if (n < 0) {
  5490. return false;
  5491. } else if (n == 0) {
  5492. if (i == 0) {
  5493. return false;
  5494. } else {
  5495. break;
  5496. }
  5497. }
  5498. append(byte);
  5499. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5500. if (byte == '\n') { break; }
  5501. #else
  5502. if (prev_byte == '\r' && byte == '\n') { break; }
  5503. prev_byte = byte;
  5504. #endif
  5505. }
  5506. return true;
  5507. }
  5508. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5509. inline void stream_line_reader::append(const char *data, size_t size) {
  5510. // Once the line has outgrown the fixed buffer everything must keep going to
  5511. // the growable one, even if a later chunk would have fit. Without the
  5512. // emptiness check a short append after a long one would land in the fixed
  5513. // buffer, which ptr() and size() no longer look at, and be lost.
  5514. if (growable_buffer_.empty() &&
  5515. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5516. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5517. fixed_buffer_used_size_ += size;
  5518. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5519. } else {
  5520. // Unlike the per-character overload, this can be the very first append of
  5521. // the line, so the fixed buffer may hold nothing and carry no terminator
  5522. // yet. assign() takes an explicit length and does not need one.
  5523. if (growable_buffer_.empty()) {
  5524. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5525. }
  5526. growable_buffer_.append(data, size);
  5527. }
  5528. }
  5529. inline mmap::mmap(const char *path) { open(path); }
  5530. inline mmap::~mmap() { close(); }
  5531. inline bool mmap::open(const char *path) {
  5532. close();
  5533. #if defined(_WIN32)
  5534. auto wpath = u8string_to_wstring(path);
  5535. if (wpath.empty()) { return false; }
  5536. hFile_ =
  5537. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5538. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5539. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5540. LARGE_INTEGER size{};
  5541. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5542. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5543. // See:
  5544. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5545. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5546. size_ = static_cast<size_t>(size.QuadPart);
  5547. hMapping_ =
  5548. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5549. // Special treatment for an empty file...
  5550. if (hMapping_ == NULL && size_ == 0) {
  5551. close();
  5552. is_open_empty_file = true;
  5553. return true;
  5554. }
  5555. if (hMapping_ == NULL) {
  5556. close();
  5557. return false;
  5558. }
  5559. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5560. if (addr_ == nullptr) {
  5561. close();
  5562. return false;
  5563. }
  5564. #else
  5565. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5566. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5567. if (fd_ == -1) { return false; }
  5568. // Only a regular file has a size to serve, unlike a directory or a device.
  5569. struct stat sb;
  5570. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5571. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5572. close();
  5573. return false;
  5574. }
  5575. size_ = static_cast<size_t>(sb.st_size);
  5576. #endif
  5577. return true;
  5578. }
  5579. inline bool mmap::is_open() const {
  5580. #if defined(_WIN32)
  5581. return is_open_empty_file ? true : addr_ != nullptr;
  5582. #else
  5583. return fd_ != -1;
  5584. #endif
  5585. }
  5586. inline size_t mmap::size() const { return size_; }
  5587. inline void mmap::close() {
  5588. #if defined(_WIN32)
  5589. if (addr_) {
  5590. ::UnmapViewOfFile(addr_);
  5591. addr_ = nullptr;
  5592. }
  5593. if (hMapping_) {
  5594. ::CloseHandle(hMapping_);
  5595. hMapping_ = NULL;
  5596. }
  5597. if (hFile_ != INVALID_HANDLE_VALUE) {
  5598. ::CloseHandle(hFile_);
  5599. hFile_ = INVALID_HANDLE_VALUE;
  5600. }
  5601. is_open_empty_file = false;
  5602. #else
  5603. if (fd_ != -1) {
  5604. ::close(fd_);
  5605. fd_ = -1;
  5606. }
  5607. #endif
  5608. size_ = 0;
  5609. }
  5610. inline int close_socket(socket_t sock) noexcept {
  5611. #ifdef _WIN32
  5612. return closesocket(sock);
  5613. #else
  5614. return close(sock);
  5615. #endif
  5616. }
  5617. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5618. ssize_t res = 0;
  5619. while (true) {
  5620. res = fn();
  5621. if (res < 0 && errno == EINTR) {
  5622. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5623. continue;
  5624. }
  5625. break;
  5626. }
  5627. return res;
  5628. }
  5629. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5630. if (offset >= size_) { return 0; }
  5631. len = (std::min)(len, size_ - offset);
  5632. #if defined(_WIN32)
  5633. // Windows does not let a mapped file be truncated.
  5634. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5635. return len;
  5636. #else
  5637. auto n = handle_EINTR(
  5638. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5639. return n > 0 ? static_cast<size_t>(n) : 0;
  5640. #endif
  5641. }
  5642. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5643. return handle_EINTR([&]() {
  5644. return recv(sock,
  5645. #ifdef _WIN32
  5646. static_cast<char *>(ptr), static_cast<int>(size),
  5647. #else
  5648. ptr, size,
  5649. #endif
  5650. flags);
  5651. });
  5652. }
  5653. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5654. int flags) {
  5655. return handle_EINTR([&]() {
  5656. return send(sock,
  5657. #ifdef _WIN32
  5658. static_cast<const char *>(ptr), static_cast<int>(size),
  5659. #else
  5660. ptr, size,
  5661. #endif
  5662. flags);
  5663. });
  5664. }
  5665. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5666. #ifdef _WIN32
  5667. return ::WSAPoll(fds, nfds, timeout);
  5668. #else
  5669. return ::poll(fds, nfds, timeout);
  5670. #endif
  5671. }
  5672. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5673. time_t usec) {
  5674. struct pollfd pfd;
  5675. pfd.fd = sock;
  5676. pfd.events = events;
  5677. pfd.revents = 0;
  5678. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5679. // "return immediately", which callers here rely on to probe a socket.
  5680. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5681. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5682. }
  5683. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5684. return select_impl(sock, POLLIN, sec, usec);
  5685. }
  5686. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5687. return select_impl(sock, POLLOUT, sec, usec);
  5688. }
  5689. // The point sec and usec from now, for select_until(). A negative sec never
  5690. // comes, as a negative timeout waits forever in select_impl().
  5691. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5692. time_t usec) {
  5693. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5694. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5695. std::chrono::microseconds(usec);
  5696. }
  5697. // Waits only for the time left until deadline, so that all the waits of one
  5698. // TLS handshake come out of a single timeout.
  5699. inline ssize_t select_until(socket_t sock, short events,
  5700. std::chrono::steady_clock::time_point deadline) {
  5701. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5702. return select_impl(sock, events, -1, 0);
  5703. }
  5704. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5705. deadline - std::chrono::steady_clock::now())
  5706. .count();
  5707. if (left <= 0) { return 0; }
  5708. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5709. static_cast<time_t>(left % 1000000));
  5710. }
  5711. // select_read(), but waits in slices and gives up once interrupted() returns
  5712. // true. A local shutdown() would not wake the wait on Windows.
  5713. inline ssize_t
  5714. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5715. const std::function<bool()> &interrupted) {
  5716. if (!interrupted) { return select_read(sock, sec, usec); }
  5717. const auto slice = std::chrono::microseconds(100000);
  5718. auto deadline = deadline_after(sec, usec);
  5719. while (!interrupted()) {
  5720. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5721. deadline - std::chrono::steady_clock::now());
  5722. auto last = left < slice;
  5723. // poll() takes whole milliseconds, so round the last wait up to keep it
  5724. // from ending before the deadline.
  5725. auto wait_usec = last ? (std::max)((left.count() + 999) / 1000 * 1000,
  5726. static_cast<decltype(left.count())>(0))
  5727. : slice.count();
  5728. auto ret = select_impl(sock, POLLIN, 0, static_cast<time_t>(wait_usec));
  5729. if (ret != 0 || last) { return ret; }
  5730. }
  5731. return 0;
  5732. }
  5733. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5734. time_t usec) {
  5735. struct pollfd pfd_read;
  5736. pfd_read.fd = sock;
  5737. pfd_read.events = POLLIN | POLLOUT;
  5738. pfd_read.revents = 0;
  5739. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5740. auto poll_res =
  5741. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5742. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5743. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5744. auto error = 0;
  5745. socklen_t len = sizeof(error);
  5746. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5747. reinterpret_cast<char *>(&error), &len);
  5748. auto successful = res >= 0 && !error;
  5749. return successful ? Error::Success : Error::Connection;
  5750. }
  5751. return Error::Connection;
  5752. }
  5753. inline bool is_socket_alive(socket_t sock) {
  5754. const auto val = detail::select_read(sock, 0, 0);
  5755. if (val == 0) {
  5756. return true;
  5757. } else if (val < 0 && errno == EBADF) {
  5758. return false;
  5759. }
  5760. char buf[1];
  5761. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5762. }
  5763. class SocketStream final : public Stream {
  5764. public:
  5765. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5766. time_t write_timeout_sec, time_t write_timeout_usec,
  5767. time_t max_timeout_msec = 0,
  5768. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5769. (std::chrono::steady_clock::time_point::min)());
  5770. ~SocketStream() override;
  5771. bool is_readable() const override;
  5772. bool wait_readable() const override;
  5773. bool wait_writable() const override;
  5774. bool is_peer_alive() const override;
  5775. ssize_t read(char *ptr, size_t size) override;
  5776. ssize_t write(const char *ptr, size_t size) override;
  5777. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5778. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5779. socket_t socket() const override;
  5780. time_t duration() const override;
  5781. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5782. void set_max_timeout(time_t msec) override;
  5783. void set_read_interrupt(std::function<bool()> interrupted) override;
  5784. const char *buffered_data(size_t &size) const override;
  5785. void consume_buffered(size_t size) override;
  5786. // The caller has just seen this socket become readable. Lets the next read
  5787. // skip its own readiness wait, which would otherwise ask the kernel a
  5788. // question that was answered a moment ago. Consumed by that read.
  5789. void set_readable_hint() { readable_hint_ = true; }
  5790. private:
  5791. bool ensure_readable();
  5792. socket_t sock_;
  5793. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5794. // thread while a read is in flight -- that is the point of it, for a caller
  5795. // holding one connection and wanting control back to send on it.
  5796. std::atomic<time_t> read_timeout_sec_;
  5797. std::atomic<time_t> read_timeout_usec_;
  5798. time_t write_timeout_sec_;
  5799. time_t write_timeout_usec_;
  5800. time_t max_timeout_msec_;
  5801. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5802. std::function<bool()> read_interrupted_;
  5803. std::vector<char> read_buff_;
  5804. size_t read_buff_off_ = 0;
  5805. size_t read_buff_content_size_ = 0;
  5806. bool readable_hint_ = false;
  5807. static const size_t read_buff_size_ = 1024l * 4;
  5808. };
  5809. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5810. time_t keep_alive_timeout_sec) {
  5811. using namespace std::chrono;
  5812. const auto interval_usec =
  5813. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5814. // Avoid expensive `steady_clock::now()` call for the first time
  5815. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5816. const auto start = steady_clock::now() - microseconds{interval_usec};
  5817. const auto timeout = seconds{keep_alive_timeout_sec};
  5818. while (true) {
  5819. if (svr_sock == INVALID_SOCKET) {
  5820. break; // Server socket is closed
  5821. }
  5822. auto val = select_read(sock, 0, interval_usec);
  5823. if (val < 0) {
  5824. break; // Ssocket error
  5825. } else if (val == 0) {
  5826. if (steady_clock::now() - start > timeout) {
  5827. break; // Timeout
  5828. }
  5829. } else {
  5830. return true; // Ready for read
  5831. }
  5832. }
  5833. return false;
  5834. }
  5835. // `has_buffered_request` reports whether the connection's stream already holds
  5836. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5837. // 9.3.2), so reading one request can pull the start of the next one into the
  5838. // stream's buffer; that request must be served without waiting for the socket
  5839. // to become readable again, since its bytes are no longer on the socket.
  5840. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5841. template <typename P, typename T>
  5842. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5843. socket_t sock,
  5844. size_t keep_alive_max_count,
  5845. time_t keep_alive_timeout_sec,
  5846. P has_buffered_request, T callback) {
  5847. auto ret = false;
  5848. // A keep_alive_max_count of 0 sets no limit.
  5849. for (size_t served = 0;
  5850. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5851. auto socket_readable = false;
  5852. if (!has_buffered_request()) {
  5853. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5854. socket_readable = true;
  5855. }
  5856. auto close_connection = served + 1 == keep_alive_max_count;
  5857. auto connection_closed = false;
  5858. ret = callback(socket_readable, close_connection, connection_closed);
  5859. if (!ret || connection_closed) { break; }
  5860. }
  5861. return ret;
  5862. }
  5863. template <typename T>
  5864. inline bool
  5865. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5866. size_t keep_alive_max_count,
  5867. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5868. time_t read_timeout_usec, time_t write_timeout_sec,
  5869. time_t write_timeout_usec, T callback) {
  5870. // One stream per connection: its read buffer can already hold the start of
  5871. // the next, pipelined request.
  5872. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5873. write_timeout_sec, write_timeout_usec);
  5874. return process_server_socket_core(
  5875. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5876. [&]() { return strm.is_readable(); },
  5877. [&](bool socket_readable, bool close_connection,
  5878. bool &connection_closed) {
  5879. if (socket_readable) { strm.set_readable_hint(); }
  5880. return callback(strm, close_connection, connection_closed);
  5881. });
  5882. }
  5883. inline bool process_client_socket(
  5884. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5885. time_t write_timeout_sec, time_t write_timeout_usec,
  5886. time_t max_timeout_msec,
  5887. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5888. std::function<bool(Stream &)> callback) {
  5889. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5890. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5891. start_time);
  5892. return callback(strm);
  5893. }
  5894. inline int shutdown_socket(socket_t sock) noexcept {
  5895. #ifdef _WIN32
  5896. return shutdown(sock, SD_BOTH);
  5897. #else
  5898. return shutdown(sock, SHUT_RDWR);
  5899. #endif
  5900. }
  5901. // Half-closes the write side and drains any in-flight/queued bytes before
  5902. // the final shutdown+close. Closing with unread data in the receive queue
  5903. // (or bytes arriving after the receive side is closed) makes the stack send
  5904. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5905. // response as a failed read even though it was fully written.
  5906. inline void drain_and_close_socket(socket_t sock) noexcept {
  5907. #ifdef _WIN32
  5908. shutdown(sock, SD_SEND);
  5909. #else
  5910. shutdown(sock, SHUT_WR);
  5911. #endif
  5912. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5913. size_t total = 0;
  5914. const auto deadline = std::chrono::steady_clock::now() +
  5915. std::chrono::milliseconds(100); // bound #1
  5916. while (total < size_t(1024u * 1024u)) { // bound #2
  5917. const auto remaining =
  5918. std::chrono::duration_cast<std::chrono::microseconds>(
  5919. deadline - std::chrono::steady_clock::now())
  5920. .count();
  5921. if (remaining <= 0) { break; }
  5922. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5923. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5924. if (n <= 0) { break; }
  5925. total += static_cast<size_t>(n);
  5926. }
  5927. shutdown_socket(sock);
  5928. close_socket(sock);
  5929. }
  5930. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5931. if (s.size() > 1 && s[0] == '\0') {
  5932. auto ret = s;
  5933. ret[0] = '@';
  5934. return ret;
  5935. }
  5936. return s;
  5937. }
  5938. inline std::string
  5939. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5940. if (s.size() > 1 && s[0] == '@') {
  5941. auto ret = s;
  5942. ret[0] = '\0';
  5943. return ret;
  5944. }
  5945. return s;
  5946. }
  5947. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5948. const struct addrinfo *hints,
  5949. struct addrinfo **res, time_t timeout_sec) {
  5950. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5951. if (timeout_sec <= 0) {
  5952. // No timeout specified, use standard getaddrinfo
  5953. return getaddrinfo(node, service, hints, res);
  5954. }
  5955. #ifdef _WIN32
  5956. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5957. OVERLAPPED overlapped = {};
  5958. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5959. if (!event) { return EAI_FAIL; }
  5960. overlapped.hEvent = event;
  5961. PADDRINFOEXW result_addrinfo = nullptr;
  5962. HANDLE cancel_handle = nullptr;
  5963. ADDRINFOEXW hints_ex = {};
  5964. if (hints) {
  5965. hints_ex.ai_flags = hints->ai_flags;
  5966. hints_ex.ai_family = hints->ai_family;
  5967. hints_ex.ai_socktype = hints->ai_socktype;
  5968. hints_ex.ai_protocol = hints->ai_protocol;
  5969. }
  5970. auto wnode = u8string_to_wstring(node);
  5971. auto wservice = u8string_to_wstring(service);
  5972. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5973. hints ? &hints_ex : nullptr, &result_addrinfo,
  5974. nullptr, &overlapped, nullptr, &cancel_handle);
  5975. if (ret == WSA_IO_PENDING) {
  5976. auto wait_result =
  5977. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5978. if (wait_result == WAIT_TIMEOUT) {
  5979. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5980. ::CloseHandle(event);
  5981. return EAI_AGAIN;
  5982. }
  5983. DWORD bytes_returned;
  5984. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5985. &bytes_returned, FALSE)) {
  5986. ::CloseHandle(event);
  5987. return ::WSAGetLastError();
  5988. }
  5989. }
  5990. ::CloseHandle(event);
  5991. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5992. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5993. return 0;
  5994. }
  5995. return ret;
  5996. #elif TARGET_OS_MAC && defined(__clang__)
  5997. if (!node) { return EAI_NONAME; }
  5998. // macOS implementation using CFHost API for asynchronous DNS resolution
  5999. CFStringRef hostname_ref = CFStringCreateWithCString(
  6000. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  6001. if (!hostname_ref) { return EAI_MEMORY; }
  6002. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  6003. CFRelease(hostname_ref);
  6004. if (!host_ref) { return EAI_MEMORY; }
  6005. // Set up context for callback
  6006. struct CFHostContext {
  6007. bool completed = false;
  6008. bool success = false;
  6009. CFArrayRef addresses = nullptr;
  6010. std::mutex mutex;
  6011. std::condition_variable cv;
  6012. } context;
  6013. CFHostClientContext client_context;
  6014. memset(&client_context, 0, sizeof(client_context));
  6015. client_context.info = &context;
  6016. // Set callback
  6017. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  6018. const CFStreamError *error, void *info) {
  6019. auto ctx = static_cast<CFHostContext *>(info);
  6020. std::lock_guard<std::mutex> lock(ctx->mutex);
  6021. if (error && error->error != 0) {
  6022. ctx->success = false;
  6023. } else {
  6024. Boolean hasBeenResolved;
  6025. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6026. if (ctx->addresses && hasBeenResolved) {
  6027. CFRetain(ctx->addresses);
  6028. ctx->success = true;
  6029. } else {
  6030. ctx->success = false;
  6031. }
  6032. }
  6033. ctx->completed = true;
  6034. ctx->cv.notify_one();
  6035. };
  6036. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6037. CFRelease(host_ref);
  6038. return EAI_SYSTEM;
  6039. }
  6040. // Schedule on run loop
  6041. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6042. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6043. // Start resolution
  6044. CFStreamError stream_error;
  6045. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6046. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6047. CFRelease(host_ref);
  6048. return EAI_FAIL;
  6049. }
  6050. // Wait for completion with timeout
  6051. auto timeout_time =
  6052. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6053. bool timed_out = false;
  6054. {
  6055. std::unique_lock<std::mutex> lock(context.mutex);
  6056. while (!context.completed) {
  6057. auto now = std::chrono::steady_clock::now();
  6058. if (now >= timeout_time) {
  6059. timed_out = true;
  6060. break;
  6061. }
  6062. // Run the runloop for a short time
  6063. lock.unlock();
  6064. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6065. lock.lock();
  6066. }
  6067. }
  6068. // Clean up
  6069. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6070. CFHostSetClient(host_ref, nullptr, nullptr);
  6071. if (timed_out || !context.completed) {
  6072. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6073. CFRelease(host_ref);
  6074. return EAI_AGAIN;
  6075. }
  6076. if (!context.success || !context.addresses) {
  6077. CFRelease(host_ref);
  6078. return EAI_NODATA;
  6079. }
  6080. // Convert CFArray to addrinfo
  6081. CFIndex count = CFArrayGetCount(context.addresses);
  6082. if (count == 0) {
  6083. CFRelease(context.addresses);
  6084. CFRelease(host_ref);
  6085. return EAI_NODATA;
  6086. }
  6087. struct addrinfo *result_addrinfo = nullptr;
  6088. struct addrinfo **current = &result_addrinfo;
  6089. for (CFIndex i = 0; i < count; i++) {
  6090. CFDataRef addr_data =
  6091. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6092. if (!addr_data) continue;
  6093. const struct sockaddr *sockaddr_ptr =
  6094. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6095. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6096. // Allocate addrinfo structure
  6097. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6098. if (!*current) {
  6099. freeaddrinfo(result_addrinfo);
  6100. CFRelease(context.addresses);
  6101. CFRelease(host_ref);
  6102. return EAI_MEMORY;
  6103. }
  6104. memset(*current, 0, sizeof(struct addrinfo));
  6105. // Set up addrinfo fields
  6106. (*current)->ai_family = sockaddr_ptr->sa_family;
  6107. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6108. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6109. (*current)->ai_addrlen = sockaddr_len;
  6110. // Copy sockaddr
  6111. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6112. if (!(*current)->ai_addr) {
  6113. freeaddrinfo(result_addrinfo);
  6114. CFRelease(context.addresses);
  6115. CFRelease(host_ref);
  6116. return EAI_MEMORY;
  6117. }
  6118. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6119. // Set port if service is specified
  6120. if (service && *service) {
  6121. int port = 0;
  6122. if (parse_port(service, strlen(service), port)) {
  6123. if (sockaddr_ptr->sa_family == AF_INET) {
  6124. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6125. ->sin_port = htons(static_cast<uint16_t>(port));
  6126. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6127. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6128. ->sin6_port = htons(static_cast<uint16_t>(port));
  6129. }
  6130. }
  6131. }
  6132. current = &((*current)->ai_next);
  6133. }
  6134. CFRelease(context.addresses);
  6135. CFRelease(host_ref);
  6136. *res = result_addrinfo;
  6137. return 0;
  6138. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6139. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6140. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6141. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6142. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6143. // the resolver worker still references the stack-local gaicb. The cancel
  6144. // path therefore waits (gai_suspend with no timeout) for the worker to
  6145. // actually finish before letting the stack frame go. The trade-off is that
  6146. // a wedged DNS server can hold this thread for the system resolver timeout
  6147. // (~30s by default) past the caller's connection timeout.
  6148. struct gaicb request{};
  6149. struct gaicb *requests[1] = {&request};
  6150. struct sigevent sevp{};
  6151. struct timespec timeout{timeout_sec, 0};
  6152. request.ar_name = node;
  6153. request.ar_service = service;
  6154. request.ar_request = hints;
  6155. sevp.sigev_notify = SIGEV_NONE;
  6156. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6157. if (rc != 0) { return rc; }
  6158. auto cleanup = scope_exit([&] {
  6159. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6160. });
  6161. int wait_result = gai_suspend(requests, 1, &timeout);
  6162. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6163. int gai_result = gai_error(&request);
  6164. if (gai_result == 0) {
  6165. *res = request.ar_result;
  6166. request.ar_result = nullptr;
  6167. return 0;
  6168. }
  6169. return gai_result;
  6170. }
  6171. gai_cancel(&request);
  6172. while (gai_error(&request) == EAI_INPROGRESS) {
  6173. gai_suspend(requests, 1, nullptr);
  6174. }
  6175. return wait_result;
  6176. #else
  6177. // Fallback implementation using thread-based timeout for other Unix systems.
  6178. struct GetAddrInfoState {
  6179. ~GetAddrInfoState() {
  6180. if (info) { freeaddrinfo(info); }
  6181. }
  6182. std::mutex mutex;
  6183. std::condition_variable result_cv;
  6184. bool completed = false;
  6185. int result = EAI_SYSTEM;
  6186. std::string node;
  6187. std::string service;
  6188. struct addrinfo hints;
  6189. struct addrinfo *info = nullptr;
  6190. };
  6191. // Allocate on the heap, so the resolver thread can keep using the data.
  6192. auto state = std::make_shared<GetAddrInfoState>();
  6193. if (node) { state->node = node; }
  6194. state->service = service;
  6195. state->hints = *hints;
  6196. std::thread resolve_thread([state]() {
  6197. auto thread_result =
  6198. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6199. &state->info);
  6200. std::lock_guard<std::mutex> lock(state->mutex);
  6201. state->result = thread_result;
  6202. state->completed = true;
  6203. state->result_cv.notify_one();
  6204. });
  6205. // Wait for completion or timeout
  6206. std::unique_lock<std::mutex> lock(state->mutex);
  6207. auto finished =
  6208. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6209. [&] { return state->completed; });
  6210. if (finished) {
  6211. // Operation completed within timeout
  6212. resolve_thread.join();
  6213. *res = state->info;
  6214. state->info = nullptr; // Pass ownership to caller
  6215. return state->result;
  6216. } else {
  6217. // Timeout occurred
  6218. resolve_thread.detach(); // Let the thread finish in background
  6219. return EAI_AGAIN; // Return timeout error
  6220. }
  6221. #endif
  6222. #else
  6223. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6224. return getaddrinfo(node, service, hints, res);
  6225. #endif
  6226. }
  6227. template <typename BindOrConnect>
  6228. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6229. int address_family, int socket_flags, bool tcp_nodelay,
  6230. bool ipv6_v6only, SocketOptions socket_options,
  6231. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6232. // Get address info
  6233. const char *node = nullptr;
  6234. struct addrinfo hints;
  6235. struct addrinfo *result;
  6236. memset(&hints, 0, sizeof(struct addrinfo));
  6237. hints.ai_socktype = SOCK_STREAM;
  6238. hints.ai_protocol = IPPROTO_IP;
  6239. if (!ip.empty()) {
  6240. node = ip.c_str();
  6241. // Ask getaddrinfo to convert IP in c-string to address
  6242. hints.ai_family = AF_UNSPEC;
  6243. hints.ai_flags = AI_NUMERICHOST;
  6244. } else {
  6245. if (!host.empty()) { node = host.c_str(); }
  6246. hints.ai_family = address_family;
  6247. hints.ai_flags = socket_flags;
  6248. }
  6249. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6250. if (hints.ai_family == AF_UNIX) {
  6251. const auto addrlen = host.length();
  6252. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6253. #ifdef SOCK_CLOEXEC
  6254. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6255. hints.ai_protocol);
  6256. #else
  6257. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6258. #endif
  6259. if (sock != INVALID_SOCKET) {
  6260. sockaddr_un addr{};
  6261. addr.sun_family = AF_UNIX;
  6262. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6263. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6264. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6265. hints.ai_addrlen = static_cast<socklen_t>(
  6266. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6267. #ifndef SOCK_CLOEXEC
  6268. #ifndef _WIN32
  6269. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6270. #endif
  6271. #endif
  6272. if (socket_options) { socket_options(sock); }
  6273. #ifdef _WIN32
  6274. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6275. // remove the option.
  6276. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6277. #endif
  6278. bool dummy;
  6279. if (!bind_or_connect(sock, hints, dummy)) {
  6280. close_socket(sock);
  6281. sock = INVALID_SOCKET;
  6282. }
  6283. }
  6284. return sock;
  6285. }
  6286. #endif
  6287. auto service = std::to_string(port);
  6288. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6289. timeout_sec)) {
  6290. #if defined __linux__ && !defined __ANDROID__
  6291. res_init();
  6292. #endif
  6293. return INVALID_SOCKET;
  6294. }
  6295. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6296. for (auto rp = result; rp; rp = rp->ai_next) {
  6297. // Create a socket
  6298. #ifdef _WIN32
  6299. auto sock =
  6300. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6301. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6302. /**
  6303. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6304. * and above the socket creation fails on older Windows Systems.
  6305. *
  6306. * Let's try to create a socket the old way in this case.
  6307. *
  6308. * Reference:
  6309. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6310. *
  6311. * WSA_FLAG_NO_HANDLE_INHERIT:
  6312. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6313. * SP1, and later
  6314. *
  6315. */
  6316. if (sock == INVALID_SOCKET) {
  6317. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6318. }
  6319. #else
  6320. #ifdef SOCK_CLOEXEC
  6321. auto sock =
  6322. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6323. #else
  6324. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6325. #endif
  6326. #endif
  6327. if (sock == INVALID_SOCKET) { continue; }
  6328. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6329. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6330. close_socket(sock);
  6331. continue;
  6332. }
  6333. #endif
  6334. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6335. if (rp->ai_family == AF_INET6) {
  6336. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6337. }
  6338. if (socket_options) { socket_options(sock); }
  6339. // bind or connect
  6340. auto quit = false;
  6341. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6342. close_socket(sock);
  6343. if (quit) { break; }
  6344. }
  6345. return INVALID_SOCKET;
  6346. }
  6347. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6348. #ifdef _WIN32
  6349. auto flags = nonblocking ? 1UL : 0UL;
  6350. ioctlsocket(sock, FIONBIO, &flags);
  6351. #else
  6352. auto flags = fcntl(sock, F_GETFL, 0);
  6353. fcntl(sock, F_SETFL,
  6354. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6355. #endif
  6356. }
  6357. inline bool is_connection_error() {
  6358. #ifdef _WIN32
  6359. return WSAGetLastError() != WSAEWOULDBLOCK;
  6360. #else
  6361. return errno != EINPROGRESS;
  6362. #endif
  6363. }
  6364. // accept() failed because the process or the network stack is temporarily out
  6365. // of resources. The listening socket is still usable, so back off briefly and
  6366. // try again.
  6367. inline bool is_accept_resource_error() {
  6368. #ifdef _WIN32
  6369. auto err = WSAGetLastError();
  6370. return err == WSAEMFILE || err == WSAENOBUFS;
  6371. #else
  6372. auto err = errno;
  6373. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6374. #endif
  6375. }
  6376. // accept() failed for a reason that says nothing about the listening socket:
  6377. // the pending connection went away before it could be accepted, or the call
  6378. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6379. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6380. // connection that way.
  6381. inline bool is_accept_transient_error() {
  6382. #ifdef _WIN32
  6383. auto err = WSAGetLastError();
  6384. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6385. err == WSAECONNABORTED;
  6386. #else
  6387. auto err = errno;
  6388. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6389. err == ECONNABORTED;
  6390. #endif
  6391. }
  6392. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6393. struct addrinfo hints;
  6394. struct addrinfo *result;
  6395. memset(&hints, 0, sizeof(struct addrinfo));
  6396. hints.ai_family = AF_UNSPEC;
  6397. hints.ai_socktype = SOCK_STREAM;
  6398. hints.ai_protocol = 0;
  6399. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6400. return false;
  6401. }
  6402. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6403. auto ret = false;
  6404. for (auto rp = result; rp; rp = rp->ai_next) {
  6405. const auto &ai = *rp;
  6406. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6407. ret = true;
  6408. break;
  6409. }
  6410. }
  6411. return ret;
  6412. }
  6413. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6414. #define USE_IF2IP
  6415. #endif
  6416. #ifdef USE_IF2IP
  6417. inline std::string if2ip(int address_family, const std::string &ifn) {
  6418. struct ifaddrs *ifap;
  6419. getifaddrs(&ifap);
  6420. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6421. std::string addr_candidate;
  6422. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6423. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6424. (AF_UNSPEC == address_family ||
  6425. ifa->ifa_addr->sa_family == address_family)) {
  6426. if (ifa->ifa_addr->sa_family == AF_INET) {
  6427. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6428. char buf[INET_ADDRSTRLEN];
  6429. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6430. return std::string(buf, INET_ADDRSTRLEN);
  6431. }
  6432. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6433. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6434. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6435. char buf[INET6_ADDRSTRLEN] = {};
  6436. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6437. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6438. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6439. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6440. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6441. } else {
  6442. return std::string(buf, INET6_ADDRSTRLEN);
  6443. }
  6444. }
  6445. }
  6446. }
  6447. }
  6448. }
  6449. return addr_candidate;
  6450. }
  6451. #endif
  6452. inline socket_t create_client_socket(
  6453. const std::string &host, const std::string &ip, int port,
  6454. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6455. SocketOptions socket_options, time_t connection_timeout_sec,
  6456. time_t connection_timeout_usec, time_t read_timeout_sec,
  6457. time_t read_timeout_usec, time_t write_timeout_sec,
  6458. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6459. auto sock = create_socket(
  6460. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6461. std::move(socket_options),
  6462. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6463. if (!intf.empty()) {
  6464. #ifdef USE_IF2IP
  6465. auto ip_from_if = if2ip(address_family, intf);
  6466. if (ip_from_if.empty()) { ip_from_if = intf; }
  6467. if (!bind_ip_address(sock2, ip_from_if)) {
  6468. error = Error::BindIPAddress;
  6469. return false;
  6470. }
  6471. #endif
  6472. }
  6473. set_nonblocking(sock2, true);
  6474. auto ret =
  6475. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6476. if (ret < 0) {
  6477. if (is_connection_error()) {
  6478. error = Error::Connection;
  6479. return false;
  6480. }
  6481. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6482. connection_timeout_usec);
  6483. if (error != Error::Success) {
  6484. if (error == Error::ConnectionTimeout) { quit = true; }
  6485. return false;
  6486. }
  6487. }
  6488. set_nonblocking(sock2, false);
  6489. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6490. read_timeout_usec);
  6491. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6492. write_timeout_usec);
  6493. error = Error::Success;
  6494. return true;
  6495. },
  6496. connection_timeout_sec); // Pass DNS timeout
  6497. if (sock != INVALID_SOCKET) {
  6498. error = Error::Success;
  6499. } else {
  6500. if (error == Error::Success) { error = Error::Connection; }
  6501. }
  6502. return sock;
  6503. }
  6504. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6505. socklen_t addr_len, std::string &ip, int &port) {
  6506. if (addr.ss_family == AF_INET) {
  6507. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6508. } else if (addr.ss_family == AF_INET6) {
  6509. port =
  6510. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6511. } else {
  6512. return false;
  6513. }
  6514. std::array<char, NI_MAXHOST> ipstr{};
  6515. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6516. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6517. 0, NI_NUMERICHOST)) {
  6518. return false;
  6519. }
  6520. ip = ipstr.data();
  6521. return true;
  6522. }
  6523. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6524. struct sockaddr_storage addr;
  6525. socklen_t addr_len = sizeof(addr);
  6526. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6527. &addr_len)) {
  6528. get_ip_and_port(addr, addr_len, ip, port);
  6529. }
  6530. }
  6531. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6532. struct sockaddr_storage addr;
  6533. socklen_t addr_len = sizeof(addr);
  6534. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6535. &addr_len)) {
  6536. #ifndef _WIN32
  6537. if (addr.ss_family == AF_UNIX) {
  6538. #if defined(__linux__)
  6539. struct ucred ucred;
  6540. socklen_t len = sizeof(ucred);
  6541. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6542. port = ucred.pid;
  6543. }
  6544. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6545. pid_t pid;
  6546. socklen_t len = sizeof(pid);
  6547. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6548. port = pid;
  6549. }
  6550. #endif
  6551. return;
  6552. }
  6553. #endif
  6554. get_ip_and_port(addr, addr_len, ip, port);
  6555. }
  6556. }
  6557. inline std::string
  6558. find_content_type(const std::string &path,
  6559. const std::map<std::string, std::string> &user_data,
  6560. const std::string &default_content_type) {
  6561. // Extensions are matched regardless of case, as web servers do
  6562. auto ext = case_ignore::to_lower(file_extension(path));
  6563. auto it = user_data.find(ext);
  6564. if (it != user_data.end()) { return it->second; }
  6565. static const struct {
  6566. const char *ext;
  6567. const char *type;
  6568. } types[] = {
  6569. {"css", "text/css"},
  6570. {"csv", "text/csv"},
  6571. {"htm", "text/html"},
  6572. {"html", "text/html"},
  6573. {"js", "text/javascript"},
  6574. {"mjs", "text/javascript"},
  6575. {"txt", "text/plain"},
  6576. {"vtt", "text/vtt"},
  6577. {"apng", "image/apng"},
  6578. {"avif", "image/avif"},
  6579. {"bmp", "image/bmp"},
  6580. {"gif", "image/gif"},
  6581. {"png", "image/png"},
  6582. {"svg", "image/svg+xml"},
  6583. {"webp", "image/webp"},
  6584. {"ico", "image/x-icon"},
  6585. {"tif", "image/tiff"},
  6586. {"tiff", "image/tiff"},
  6587. {"jpg", "image/jpeg"},
  6588. {"jpeg", "image/jpeg"},
  6589. {"mp4", "video/mp4"},
  6590. {"mpeg", "video/mpeg"},
  6591. {"webm", "video/webm"},
  6592. {"mp3", "audio/mp3"},
  6593. {"mpga", "audio/mpeg"},
  6594. {"weba", "audio/webm"},
  6595. {"wav", "audio/wave"},
  6596. {"otf", "font/otf"},
  6597. {"ttf", "font/ttf"},
  6598. {"woff", "font/woff"},
  6599. {"woff2", "font/woff2"},
  6600. {"7z", "application/x-7z-compressed"},
  6601. {"atom", "application/atom+xml"},
  6602. {"pdf", "application/pdf"},
  6603. {"json", "application/json"},
  6604. {"rss", "application/rss+xml"},
  6605. {"tar", "application/x-tar"},
  6606. {"xht", "application/xhtml+xml"},
  6607. {"xhtml", "application/xhtml+xml"},
  6608. {"xslt", "application/xslt+xml"},
  6609. {"xml", "application/xml"},
  6610. {"gz", "application/gzip"},
  6611. {"zip", "application/zip"},
  6612. {"wasm", "application/wasm"},
  6613. };
  6614. for (const auto &t : types) {
  6615. if (ext == t.ext) { return t.type; }
  6616. }
  6617. return default_content_type;
  6618. }
  6619. inline std::string
  6620. extract_media_type(const std::string &content_type,
  6621. std::map<std::string, std::string> *params = nullptr) {
  6622. // Extract type/subtype from Content-Type value (RFC 2045)
  6623. // e.g. "application/json; charset=utf-8" -> "application/json"
  6624. auto media_type = content_type;
  6625. auto semicolon_pos = media_type.find(';');
  6626. if (semicolon_pos != std::string::npos) {
  6627. auto param_str = media_type.substr(semicolon_pos + 1);
  6628. media_type = media_type.substr(0, semicolon_pos);
  6629. if (params) {
  6630. // Parse parameters: key=value pairs separated by ';'
  6631. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6632. [&](const char *b, const char *e) {
  6633. std::string key;
  6634. std::string val;
  6635. divide_param_pair(b, e, key, val);
  6636. // Parameter names are case-insensitive (RFC 9110
  6637. // §5.6.6)
  6638. if (!key.empty()) {
  6639. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6640. unquote_param(val));
  6641. }
  6642. });
  6643. }
  6644. }
  6645. // Trim whitespace from media type
  6646. return trim_copy(media_type);
  6647. }
  6648. inline bool can_compress_content_type(const std::string &content_type) {
  6649. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6650. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6651. static const char *const compressible[] = {
  6652. "image/svg+xml",
  6653. "application/javascript",
  6654. "application/x-javascript",
  6655. "application/json",
  6656. "application/ld+json",
  6657. "application/xml",
  6658. "application/xhtml+xml",
  6659. "application/rss+xml",
  6660. "application/atom+xml",
  6661. "application/xslt+xml",
  6662. "application/protobuf",
  6663. };
  6664. for (auto type : compressible) {
  6665. if (mime_type == type) { return true; }
  6666. }
  6667. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6668. }
  6669. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6670. double &quality) {
  6671. quality = 1.0;
  6672. token.clear();
  6673. // Split on first ';': left = token name, right = parameters
  6674. const char *params_b = nullptr;
  6675. std::size_t params_len = 0;
  6676. divide(
  6677. b, static_cast<std::size_t>(e - b), ';',
  6678. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6679. auto r = trim(lb, lb + llen, 0, llen);
  6680. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6681. params_b = rb;
  6682. params_len = rlen;
  6683. });
  6684. if (token.empty()) { return false; }
  6685. if (params_len == 0) { return true; }
  6686. // Scan parameters for q= (stops on first match)
  6687. bool invalid = false;
  6688. split_find(params_b, params_b + params_len, ';',
  6689. (std::numeric_limits<size_t>::max)(),
  6690. [&](const char *pb, const char *pe) -> bool {
  6691. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6692. auto len = static_cast<size_t>(pe - pb);
  6693. if (len < 2) { return false; }
  6694. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6695. return false;
  6696. }
  6697. // Trim the value portion
  6698. auto r = trim(pb, pe, 2, len);
  6699. if (r.first >= r.second) {
  6700. invalid = true;
  6701. return true;
  6702. }
  6703. double v = 0.0;
  6704. auto res = from_chars(pb + r.first, pb + r.second, v);
  6705. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6706. v < 0.0 || v > 1.0) {
  6707. invalid = true;
  6708. return true;
  6709. }
  6710. quality = v;
  6711. return true;
  6712. });
  6713. return !invalid;
  6714. }
  6715. inline EncodingType encoding_type(const Request &req,
  6716. const std::string &content_type) {
  6717. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6718. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6719. if (s.empty()) { return EncodingType::None; }
  6720. // Single-pass: iterate tokens and track the best supported encoding.
  6721. // Server preference breaks ties (br > gzip > zstd).
  6722. EncodingType best = EncodingType::None;
  6723. double best_q = 0.0; // q=0 means "not acceptable"
  6724. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6725. auto priority = [](EncodingType t) -> int {
  6726. switch (t) {
  6727. case EncodingType::Brotli: return 0;
  6728. case EncodingType::Gzip: return 1;
  6729. case EncodingType::Zstd: return 2;
  6730. default: return 3;
  6731. }
  6732. };
  6733. std::string name;
  6734. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6735. double quality = 1.0;
  6736. if (!parse_quality(b, e, name, quality)) { return; }
  6737. if (quality <= 0.0) { return; }
  6738. EncodingType type = EncodingType::None;
  6739. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6740. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6741. #endif
  6742. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6743. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6744. type = EncodingType::Gzip;
  6745. }
  6746. #endif
  6747. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6748. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6749. type = EncodingType::Zstd;
  6750. }
  6751. #endif
  6752. if (type == EncodingType::None) { return; }
  6753. // Higher q-value wins; for equal q, server preference breaks ties
  6754. if (quality > best_q ||
  6755. (quality == best_q && priority(type) < priority(best))) {
  6756. best_q = quality;
  6757. best = type;
  6758. }
  6759. });
  6760. return best;
  6761. }
  6762. // `content_type` is taken separately because a file-backed response has not
  6763. // been given one yet when its coding has to be decided.
  6764. inline EncodingType encoding_type(const Request &req, const Response &res,
  6765. const std::string &content_type) {
  6766. // The response already names a content coding of its own: a handler serving
  6767. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6768. // point whose headers name the coding its files are stored in. Applying one
  6769. // on top of that would double-encode the body and append a second
  6770. // `Content-Encoding` field line.
  6771. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6772. return encoding_type(req, content_type);
  6773. }
  6774. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6775. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6776. }
  6777. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6778. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6779. if (type == EncodingType::Gzip) {
  6780. return detail::make_unique<gzip_compressor>();
  6781. }
  6782. #endif
  6783. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6784. if (type == EncodingType::Brotli) {
  6785. return detail::make_unique<brotli_compressor>();
  6786. }
  6787. #endif
  6788. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6789. if (type == EncodingType::Zstd) {
  6790. return detail::make_unique<zstd_compressor>();
  6791. }
  6792. #endif
  6793. (void)type;
  6794. return nullptr;
  6795. }
  6796. inline const char *encoding_name(EncodingType type) {
  6797. switch (type) {
  6798. case EncodingType::Gzip: return "gzip";
  6799. case EncodingType::Brotli: return "br";
  6800. case EncodingType::Zstd: return "zstd";
  6801. default: return "";
  6802. }
  6803. }
  6804. inline bool nocompressor::compress(const char *data, size_t data_length,
  6805. bool /*last*/, Callback callback) {
  6806. if (!data_length) { return true; }
  6807. return callback(data, data_length);
  6808. }
  6809. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6810. inline gzip_compressor::gzip_compressor() {
  6811. std::memset(&strm_, 0, sizeof(strm_));
  6812. strm_.zalloc = Z_NULL;
  6813. strm_.zfree = Z_NULL;
  6814. strm_.opaque = Z_NULL;
  6815. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6816. Z_DEFAULT_STRATEGY) == Z_OK;
  6817. }
  6818. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6819. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6820. bool last, Callback callback) {
  6821. assert(is_valid_);
  6822. do {
  6823. constexpr size_t max_avail_in =
  6824. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6825. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6826. (std::min)(data_length, max_avail_in));
  6827. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6828. data_length -= strm_.avail_in;
  6829. data += strm_.avail_in;
  6830. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6831. auto ret = Z_OK;
  6832. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6833. do {
  6834. strm_.avail_out = static_cast<uInt>(buff.size());
  6835. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6836. ret = deflate(&strm_, flush);
  6837. if (ret == Z_STREAM_ERROR) { return false; }
  6838. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6839. return false;
  6840. }
  6841. } while (strm_.avail_out == 0);
  6842. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6843. (flush == Z_NO_FLUSH && ret == Z_OK));
  6844. assert(strm_.avail_in == 0);
  6845. } while (data_length > 0);
  6846. return true;
  6847. }
  6848. inline gzip_decompressor::gzip_decompressor() {
  6849. std::memset(&strm_, 0, sizeof(strm_));
  6850. strm_.zalloc = Z_NULL;
  6851. strm_.zfree = Z_NULL;
  6852. strm_.opaque = Z_NULL;
  6853. // 15 is the value of wbits, which should be at the maximum possible value
  6854. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6855. // that the stream type should be automatically detected either gzip or
  6856. // deflate.
  6857. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6858. }
  6859. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6860. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6861. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6862. Callback callback) {
  6863. assert(is_valid_);
  6864. auto ret = Z_OK;
  6865. do {
  6866. constexpr size_t max_avail_in =
  6867. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6868. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6869. (std::min)(data_length, max_avail_in));
  6870. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6871. data_length -= strm_.avail_in;
  6872. data += strm_.avail_in;
  6873. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6874. while (strm_.avail_in > 0 && ret == Z_OK) {
  6875. strm_.avail_out = static_cast<uInt>(buff.size());
  6876. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6877. ret = inflate(&strm_, Z_NO_FLUSH);
  6878. assert(ret != Z_STREAM_ERROR);
  6879. switch (ret) {
  6880. case Z_NEED_DICT:
  6881. case Z_DATA_ERROR:
  6882. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6883. }
  6884. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6885. return false;
  6886. }
  6887. }
  6888. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6889. } while (data_length > 0);
  6890. return true;
  6891. }
  6892. #endif
  6893. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6894. inline brotli_compressor::brotli_compressor() {
  6895. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6896. }
  6897. inline brotli_compressor::~brotli_compressor() {
  6898. BrotliEncoderDestroyInstance(state_);
  6899. }
  6900. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6901. bool last, Callback callback) {
  6902. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6903. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6904. auto available_in = data_length;
  6905. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6906. for (;;) {
  6907. if (last) {
  6908. if (BrotliEncoderIsFinished(state_)) { break; }
  6909. } else {
  6910. if (!available_in) { break; }
  6911. }
  6912. auto available_out = buff.size();
  6913. auto next_out = buff.data();
  6914. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6915. &available_out, &next_out, nullptr)) {
  6916. return false;
  6917. }
  6918. auto output_bytes = buff.size() - available_out;
  6919. if (output_bytes) {
  6920. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6921. }
  6922. }
  6923. return true;
  6924. }
  6925. inline brotli_decompressor::brotli_decompressor() {
  6926. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6927. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6928. : BROTLI_DECODER_RESULT_ERROR;
  6929. }
  6930. inline brotli_decompressor::~brotli_decompressor() {
  6931. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6932. }
  6933. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6934. inline bool brotli_decompressor::decompress(const char *data,
  6935. size_t data_length,
  6936. Callback callback) {
  6937. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6938. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6939. return 0;
  6940. }
  6941. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6942. size_t avail_in = data_length;
  6943. size_t total_out;
  6944. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6945. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6946. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6947. char *next_out = buff.data();
  6948. size_t avail_out = buff.size();
  6949. decoder_r = BrotliDecoderDecompressStream(
  6950. decoder_s, &avail_in, &next_in, &avail_out,
  6951. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6952. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6953. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6954. }
  6955. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6956. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6957. }
  6958. #endif
  6959. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6960. inline zstd_compressor::zstd_compressor() {
  6961. ctx_ = ZSTD_createCCtx();
  6962. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6963. }
  6964. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6965. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6966. bool last, Callback callback) {
  6967. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6968. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6969. ZSTD_inBuffer input = {data, data_length, 0};
  6970. bool finished;
  6971. do {
  6972. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6973. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6974. if (ZSTD_isError(remaining)) { return false; }
  6975. if (!callback(buff.data(), output.pos)) { return false; }
  6976. finished = last ? (remaining == 0) : (input.pos == input.size);
  6977. } while (!finished);
  6978. return true;
  6979. }
  6980. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6981. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6982. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6983. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6984. Callback callback) {
  6985. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6986. ZSTD_inBuffer input = {data, data_length, 0};
  6987. while (input.pos < input.size) {
  6988. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6989. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6990. if (ZSTD_isError(remaining)) { return false; }
  6991. if (!callback(buff.data(), output.pos)) { return false; }
  6992. }
  6993. return true;
  6994. }
  6995. #endif
  6996. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6997. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6998. // unknown coding, and its payload would be handed back still compressed.
  6999. inline bool is_zlib_encoding(const std::string &encoding) {
  7000. return case_ignore::equal(encoding, "gzip") ||
  7001. case_ignore::equal(encoding, "deflate");
  7002. }
  7003. inline bool is_brotli_encoding(const std::string &encoding) {
  7004. return case_ignore::equal(encoding, "br");
  7005. }
  7006. inline bool is_zstd_encoding(const std::string &encoding) {
  7007. return case_ignore::equal(encoding, "zstd");
  7008. }
  7009. // Returns true if the content coding is one cpp-httplib is able to decompress
  7010. // when the corresponding support is compiled in.
  7011. inline bool is_known_content_encoding(const std::string &encoding) {
  7012. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  7013. is_zstd_encoding(encoding);
  7014. }
  7015. inline std::unique_ptr<decompressor>
  7016. create_decompressor(const std::string &encoding) {
  7017. std::unique_ptr<decompressor> decompressor;
  7018. if (is_zlib_encoding(encoding)) {
  7019. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7020. decompressor = detail::make_unique<gzip_decompressor>();
  7021. #endif
  7022. } else if (is_brotli_encoding(encoding)) {
  7023. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7024. decompressor = detail::make_unique<brotli_decompressor>();
  7025. #endif
  7026. } else if (is_zstd_encoding(encoding)) {
  7027. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7028. decompressor = detail::make_unique<zstd_decompressor>();
  7029. #endif
  7030. }
  7031. return decompressor;
  7032. }
  7033. // Returns the best available compressor and its Content-Encoding name.
  7034. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7035. inline std::pair<std::unique_ptr<compressor>, const char *>
  7036. create_compressor() {
  7037. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7038. return {detail::make_unique<brotli_compressor>(), "br"};
  7039. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7040. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7041. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7042. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7043. #else
  7044. return {nullptr, nullptr};
  7045. #endif
  7046. }
  7047. inline bool is_prohibited_header_name(const std::string &name) {
  7048. // Field names are case-insensitive (RFC 9110 §5.1)
  7049. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7050. case_ignore::equal(name, "REMOTE_PORT") ||
  7051. case_ignore::equal(name, "LOCAL_ADDR") ||
  7052. case_ignore::equal(name, "LOCAL_PORT");
  7053. }
  7054. inline bool has_header(const Headers &headers, const std::string &key) {
  7055. if (is_prohibited_header_name(key)) { return false; }
  7056. return headers.find(key) != headers.end();
  7057. }
  7058. inline const char *get_header_value(const Headers &headers,
  7059. const std::string &key, const char *def,
  7060. size_t id) {
  7061. if (is_prohibited_header_name(key)) {
  7062. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7063. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7064. throw std::invalid_argument(msg);
  7065. #else
  7066. return "";
  7067. #endif
  7068. }
  7069. auto rng = headers.equal_range(key);
  7070. auto it = bounded_next(rng.first, id, rng.second);
  7071. if (it != rng.second) { return it->second.c_str(); }
  7072. return def;
  7073. }
  7074. inline size_t get_header_value_count(const Headers &headers,
  7075. const std::string &key) {
  7076. return headers.count(key);
  7077. }
  7078. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7079. // list may be sent as several field lines, and the combined field value is
  7080. // those values joined by commas in the order they were received. Callers that
  7081. // parse such a list must work on the combined value; reading only the first
  7082. // occurrence silently drops whatever the later field lines carry.
  7083. inline std::string get_combined_header_value(const Headers &headers,
  7084. const std::string &key) {
  7085. std::string combined;
  7086. auto rng = headers.equal_range(key);
  7087. for (auto it = rng.first; it != rng.second; ++it) {
  7088. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7089. // elements, so an empty field line must not contribute a bare comma to the
  7090. // combined value.
  7091. if (it->second.empty()) { continue; }
  7092. if (!combined.empty()) { combined += ", "; }
  7093. combined += it->second;
  7094. }
  7095. return combined;
  7096. }
  7097. inline bool has_header_token(const Headers &headers, const std::string &key,
  7098. const std::string &token) {
  7099. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7100. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7101. // several lines. Match complete tokens rather than searching the raw value,
  7102. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7103. auto rng = headers.equal_range(key);
  7104. for (auto it = rng.first; it != rng.second; ++it) {
  7105. const auto &value = it->second;
  7106. if (split_find(value.data(), value.data() + value.size(), ',',
  7107. [&](const char *b, const char *e) {
  7108. return case_ignore::equal(std::string(b, e), token);
  7109. })) {
  7110. return true;
  7111. }
  7112. }
  7113. return false;
  7114. }
  7115. template <typename Map>
  7116. inline typename Map::mapped_type
  7117. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7118. auto rng = m.equal_range(key);
  7119. auto it = bounded_next(rng.first, id, rng.second);
  7120. if (it != rng.second) { return it->second; }
  7121. return typename Map::mapped_type();
  7122. }
  7123. inline void set_header(Headers &headers, const std::string &key,
  7124. const std::string &val) {
  7125. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7126. }
  7127. // Drops the fields set_header() would refuse, from headers an application can
  7128. // fill directly: CR/LF in one would split the message.
  7129. inline void erase_invalid_fields(Headers &headers) {
  7130. for (auto it = headers.begin(); it != headers.end();) {
  7131. if (fields::is_field_valid(it->first, it->second)) {
  7132. ++it;
  7133. } else {
  7134. it = headers.erase(it);
  7135. }
  7136. }
  7137. }
  7138. inline bool read_headers(Stream &strm, Headers &headers) {
  7139. const auto bufsiz = 2048;
  7140. char buf[bufsiz];
  7141. stream_line_reader line_reader(strm, buf, bufsiz);
  7142. size_t header_count = 0;
  7143. for (;;) {
  7144. if (!line_reader.getline()) { return false; }
  7145. // Check if the line ends with CRLF.
  7146. auto line_terminator_len = 2;
  7147. if (line_reader.end_with_crlf()) {
  7148. // Blank line indicates end of headers.
  7149. if (line_reader.size() == 2) { break; }
  7150. } else {
  7151. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7152. // Blank line indicates end of headers.
  7153. if (line_reader.size() == 1) { break; }
  7154. line_terminator_len = 1;
  7155. #else
  7156. continue; // Skip invalid line.
  7157. #endif
  7158. }
  7159. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7160. // Check header count limit
  7161. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7162. // Exclude line terminator
  7163. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7164. if (!parse_header(line_reader.ptr(), end,
  7165. [&](const std::string &key, const std::string &val) {
  7166. headers.emplace(key, val);
  7167. })) {
  7168. return false;
  7169. }
  7170. header_count++;
  7171. }
  7172. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7173. // headers that have different values to prevent request smuggling.
  7174. auto cl_range = headers.equal_range("Content-Length");
  7175. if (cl_range.first != cl_range.second) {
  7176. const auto &first_val = cl_range.first->second;
  7177. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7178. if (it->second != first_val) { return false; }
  7179. }
  7180. }
  7181. return true;
  7182. }
  7183. // Parsed by hand: std::regex_match recurses once per character of the reason
  7184. // phrase, which a server can make as long as a whole line.
  7185. inline bool parse_status_line(const char *line, std::string &version,
  7186. int &status, std::string &reason) {
  7187. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7188. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7189. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7190. !is_ascii_digit(line[11])) {
  7191. return false;
  7192. }
  7193. auto p = line + 12;
  7194. auto reason_begin = p;
  7195. if (*p == ' ') {
  7196. reason_begin = ++p;
  7197. p += std::strcspn(p, "\r\n");
  7198. }
  7199. auto reason_end = p;
  7200. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7201. if (*p == '\r') { p++; }
  7202. #else
  7203. if (*p++ != '\r') { return false; }
  7204. #endif
  7205. if (*p++ != '\n' || *p != '\0') { return false; }
  7206. version.assign(line, 8);
  7207. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7208. reason.assign(reason_begin, reason_end);
  7209. return true;
  7210. }
  7211. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7212. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7213. struct WebSocketUpgradeResponse {
  7214. Error error = Error::Success;
  7215. int status = -1;
  7216. Headers headers;
  7217. std::string selected_subprotocol;
  7218. };
  7219. // Reads a response's status line and headers, leaving any body unread. An
  7220. // unparsable status line is no stream error; it just leaves `status` as is.
  7221. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7222. const auto bufsiz = 2048;
  7223. char buf[bufsiz];
  7224. stream_line_reader line_reader(strm, buf, bufsiz);
  7225. if (!line_reader.getline()) { return false; }
  7226. std::string version;
  7227. std::string reason;
  7228. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7229. return true;
  7230. }
  7231. return read_headers(strm, headers);
  7232. }
  7233. inline bool
  7234. read_websocket_upgrade_response(Stream &strm,
  7235. const std::string &expected_accept,
  7236. const std::string &offered_subprotocols,
  7237. WebSocketUpgradeResponse &upgrade) {
  7238. // The headers of a rejection are kept so the caller can see why the server
  7239. // refused the upgrade.
  7240. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7241. upgrade.error = Error::Read;
  7242. return false;
  7243. }
  7244. const auto &headers = upgrade.headers;
  7245. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7246. upgrade.error = Error::WebSocketHandshake;
  7247. return false;
  7248. }
  7249. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7250. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7251. upgrade.error = Error::WebSocketHandshake;
  7252. return false;
  7253. }
  7254. // Verify Connection: Upgrade
  7255. if (!has_header_token(headers, "Connection", "upgrade")) {
  7256. upgrade.error = Error::WebSocketHandshake;
  7257. return false;
  7258. }
  7259. // Verify Sec-WebSocket-Accept header value
  7260. auto it = headers.find("Sec-WebSocket-Accept");
  7261. if (it == headers.end() || it->second != expected_accept) {
  7262. upgrade.error = Error::WebSocketHandshake;
  7263. return false;
  7264. }
  7265. // Extract negotiated subprotocol
  7266. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7267. if (proto_it != headers.end()) {
  7268. upgrade.selected_subprotocol = proto_it->second;
  7269. }
  7270. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7271. if (!upgrade.selected_subprotocol.empty()) {
  7272. auto was_offered = false;
  7273. split(offered_subprotocols.data(),
  7274. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7275. [&](const char *b, const char *e) {
  7276. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7277. was_offered = true;
  7278. }
  7279. });
  7280. if (!was_offered) {
  7281. upgrade.error = Error::WebSocketHandshake;
  7282. return false;
  7283. }
  7284. }
  7285. return true;
  7286. }
  7287. enum class ReadContentResult {
  7288. Success, // Successfully read the content
  7289. PayloadTooLarge, // The content exceeds the specified payload limit
  7290. Error // An error occurred while reading the content
  7291. };
  7292. inline ReadContentResult read_content_with_length(
  7293. Stream &strm, size_t len, DownloadProgress progress,
  7294. ContentReceiverWithProgress out,
  7295. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7296. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7297. detail::BodyReader br;
  7298. br.stream = &strm;
  7299. br.has_content_length = true;
  7300. br.content_length = len;
  7301. br.payload_max_length = payload_max_length;
  7302. br.chunked = false;
  7303. br.bytes_read = 0;
  7304. br.last_error = Error::Success;
  7305. size_t r = 0;
  7306. while (r < len) {
  7307. auto read_len = static_cast<size_t>(len - r);
  7308. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7309. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7310. if (n <= 0) {
  7311. // Check if it was a payload size error
  7312. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7313. return ReadContentResult::PayloadTooLarge;
  7314. }
  7315. return ReadContentResult::Error;
  7316. }
  7317. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7318. return ReadContentResult::Error;
  7319. }
  7320. r += static_cast<size_t>(n);
  7321. if (progress) {
  7322. if (!progress(r, len)) { return ReadContentResult::Error; }
  7323. }
  7324. }
  7325. return ReadContentResult::Success;
  7326. }
  7327. inline ReadContentResult
  7328. read_content_without_length(Stream &strm, size_t payload_max_length,
  7329. ContentReceiverWithProgress out) {
  7330. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7331. size_t r = 0;
  7332. for (;;) {
  7333. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7334. if (n == 0) { return ReadContentResult::Success; }
  7335. if (n < 0) { return ReadContentResult::Error; }
  7336. // Check if adding this data would exceed the payload limit
  7337. if (payload_max_length > 0 &&
  7338. (r > payload_max_length ||
  7339. payload_max_length - r < static_cast<size_t>(n))) {
  7340. return ReadContentResult::PayloadTooLarge;
  7341. }
  7342. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7343. return ReadContentResult::Error;
  7344. }
  7345. r += static_cast<size_t>(n);
  7346. }
  7347. return ReadContentResult::Success;
  7348. }
  7349. template <typename T>
  7350. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7351. size_t payload_max_length,
  7352. ContentReceiverWithProgress out) {
  7353. detail::ChunkedDecoder dec(strm);
  7354. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7355. size_t total_len = 0;
  7356. for (;;) {
  7357. size_t chunk_offset = 0;
  7358. size_t chunk_total = 0;
  7359. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7360. if (n < 0) { return ReadContentResult::Error; }
  7361. if (n == 0) {
  7362. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7363. return ReadContentResult::Error;
  7364. }
  7365. return ReadContentResult::Success;
  7366. }
  7367. if (payload_max_length > 0 &&
  7368. (total_len > payload_max_length ||
  7369. payload_max_length - total_len < static_cast<size_t>(n))) {
  7370. return ReadContentResult::PayloadTooLarge;
  7371. }
  7372. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7373. return ReadContentResult::Error;
  7374. }
  7375. total_len += static_cast<size_t>(n);
  7376. }
  7377. }
  7378. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7379. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7380. // is the final transfer coding. A single field value may list several
  7381. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7382. // several Transfer-Encoding lines, which combine into one comma-separated
  7383. // list in the order the lines were received. Headers preserves that order,
  7384. // so the final coding is the last token of the last line. Match it
  7385. // case-insensitively rather than comparing the whole value against
  7386. // "chunked".
  7387. //
  7388. // Security: reading a chunked message as unframed leaves its body in the
  7389. // socket, where a keep-alive connection parses it as a smuggled request.
  7390. // Server::process_request() answers 400 and closes when the final coding is
  7391. // not chunked, so a request whose framing cannot be determined never
  7392. // reaches the "no body" path.
  7393. auto rng = headers.equal_range("Transfer-Encoding");
  7394. if (rng.first == rng.second) { return false; }
  7395. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7396. // combined list ending in nothing rather than inheriting the line before it.
  7397. std::string last_coding;
  7398. for (auto it = rng.first; it != rng.second; ++it) {
  7399. const auto &value = it->second;
  7400. last_coding.clear();
  7401. split(value.data(), value.data() + value.size(), ',',
  7402. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7403. }
  7404. return case_ignore::equal(last_coding, "chunked");
  7405. }
  7406. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7407. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7408. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7409. return msg.has_header("Transfer-Encoding") &&
  7410. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7411. }
  7412. inline bool has_conflicting_content_length(const Headers &headers) {
  7413. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7414. // Content-Length is framed ambiguously. The body readers here delimit it by
  7415. // the transfer coding and drop Content-Length, while an intermediary may do
  7416. // the reverse, so the two disagree on where the body ends and a reused
  7417. // connection is desynchronised (request/response smuggling). Content-Length:
  7418. // 0 is tolerated for compatibility with existing peers.
  7419. return has_header(headers, "Transfer-Encoding") &&
  7420. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7421. }
  7422. template <typename T, typename U>
  7423. bool prepare_content_receiver(T &x, int &status,
  7424. ContentReceiverWithProgress receiver,
  7425. bool decompress, size_t payload_max_length,
  7426. bool &exceed_payload_max_length, U callback) {
  7427. if (decompress) {
  7428. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7429. std::unique_ptr<decompressor> decompressor;
  7430. if (!encoding.empty()) {
  7431. // A coding we know about but were not built with is an error. An
  7432. // unrecognized coding (including "identity") is left alone and the
  7433. // payload is passed through as-is, since some servers misuse the header,
  7434. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7435. decompressor = detail::create_decompressor(encoding);
  7436. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7437. status = StatusCode::UnsupportedMediaType_415;
  7438. return false;
  7439. }
  7440. }
  7441. if (decompressor) {
  7442. if (decompressor->is_valid()) {
  7443. size_t decompressed_size = 0;
  7444. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7445. size_t off, size_t len) {
  7446. return decompressor->decompress(
  7447. buf, n, [&](const char *buf2, size_t n2) {
  7448. // Guard against zip-bomb: check
  7449. // decompressed size against limit.
  7450. if (payload_max_length > 0 &&
  7451. (decompressed_size >= payload_max_length ||
  7452. n2 > payload_max_length - decompressed_size)) {
  7453. exceed_payload_max_length = true;
  7454. return false;
  7455. }
  7456. decompressed_size += n2;
  7457. return receiver(buf2, n2, off, len);
  7458. });
  7459. };
  7460. return callback(std::move(out));
  7461. } else {
  7462. status = StatusCode::InternalServerError_500;
  7463. return false;
  7464. }
  7465. }
  7466. }
  7467. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7468. size_t len) {
  7469. return receiver(buf, n, off, len);
  7470. };
  7471. return callback(std::move(out));
  7472. }
  7473. template <typename T>
  7474. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7475. DownloadProgress progress,
  7476. ContentReceiverWithProgress receiver, bool decompress) {
  7477. bool exceed_payload_max_length = false;
  7478. return prepare_content_receiver(
  7479. x, status, std::move(receiver), decompress, payload_max_length,
  7480. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7481. auto ret = true;
  7482. // Note: exceed_payload_max_length may also be set by the decompressor
  7483. // wrapper in prepare_content_receiver when the decompressed payload
  7484. // size exceeds the limit.
  7485. if (is_chunked_transfer_encoding(x.headers)) {
  7486. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7487. if (result == ReadContentResult::Success) {
  7488. ret = true;
  7489. } else if (result == ReadContentResult::PayloadTooLarge) {
  7490. exceed_payload_max_length = true;
  7491. ret = false;
  7492. } else {
  7493. ret = false;
  7494. }
  7495. } else if (!has_header(x.headers, "Content-Length")) {
  7496. auto result =
  7497. read_content_without_length(strm, payload_max_length, out);
  7498. if (result == ReadContentResult::Success) {
  7499. ret = true;
  7500. } else if (result == ReadContentResult::PayloadTooLarge) {
  7501. exceed_payload_max_length = true;
  7502. ret = false;
  7503. } else {
  7504. ret = false;
  7505. }
  7506. } else {
  7507. auto is_invalid_value = false;
  7508. auto len = get_header_value_u64(x.headers, "Content-Length",
  7509. (std::numeric_limits<size_t>::max)(),
  7510. 0, is_invalid_value);
  7511. if (is_invalid_value) {
  7512. ret = false;
  7513. } else if (len > 0) {
  7514. auto result = read_content_with_length(
  7515. strm, len, std::move(progress), out, payload_max_length);
  7516. ret = (result == ReadContentResult::Success);
  7517. if (result == ReadContentResult::PayloadTooLarge) {
  7518. exceed_payload_max_length = true;
  7519. }
  7520. }
  7521. }
  7522. if (!ret) {
  7523. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7524. : StatusCode::BadRequest_400;
  7525. }
  7526. return ret;
  7527. });
  7528. }
  7529. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7530. const std::string &path) {
  7531. // Neither the method nor the request target may carry CR/LF, SP or other
  7532. // control octets; otherwise a value smuggled into either splits the request
  7533. // line and injects headers or a whole request.
  7534. if (!fields::is_token(method)) { return -1; }
  7535. if (!fields::is_request_target(path)) { return -1; }
  7536. std::string s = method;
  7537. s += ' ';
  7538. s += path;
  7539. s += " HTTP/1.1\r\n";
  7540. return strm.write(s.data(), s.size());
  7541. }
  7542. inline ssize_t write_response_line(Stream &strm, int status) {
  7543. std::string s = "HTTP/1.1 ";
  7544. s += std::to_string(status);
  7545. s += ' ';
  7546. s += httplib::status_message(status);
  7547. s += "\r\n";
  7548. return strm.write(s.data(), s.size());
  7549. }
  7550. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7551. ssize_t write_len = 0;
  7552. for (const auto &x : headers) {
  7553. std::string s;
  7554. s = x.first;
  7555. s += ": ";
  7556. s += x.second;
  7557. s += "\r\n";
  7558. auto len = strm.write(s.data(), s.size());
  7559. if (len < 0) { return len; }
  7560. write_len += len;
  7561. }
  7562. auto len = strm.write("\r\n");
  7563. if (len < 0) { return len; }
  7564. write_len += len;
  7565. return write_len;
  7566. }
  7567. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7568. size_t offset = 0;
  7569. while (offset < l) {
  7570. auto length = strm.write(d + offset, l - offset);
  7571. if (length < 0) { return false; }
  7572. offset += static_cast<size_t>(length);
  7573. }
  7574. return true;
  7575. }
  7576. template <typename T>
  7577. inline bool write_content_with_progress(Stream &strm,
  7578. const ContentProvider &content_provider,
  7579. size_t offset, size_t length,
  7580. T is_shutting_down,
  7581. const UploadProgress &upload_progress,
  7582. Error &error) {
  7583. size_t end_offset = offset + length;
  7584. size_t start_offset = offset;
  7585. auto ok = true;
  7586. auto finished = false;
  7587. DataSink data_sink;
  7588. data_sink.write = [&](const char *d, size_t l) -> bool {
  7589. if (ok) {
  7590. // Bytes past `length` would follow the framed body, where the peer reads
  7591. // them as the next message. Write only what fits and fail the rest.
  7592. if (l > end_offset - offset) {
  7593. l = end_offset - offset;
  7594. ok = false;
  7595. }
  7596. if (write_data(strm, d, l)) {
  7597. offset += l;
  7598. if (upload_progress && length > 0) {
  7599. size_t current_written = offset - start_offset;
  7600. if (!upload_progress(current_written, length)) {
  7601. ok = false;
  7602. return false;
  7603. }
  7604. }
  7605. } else {
  7606. ok = false;
  7607. }
  7608. }
  7609. return ok;
  7610. };
  7611. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7612. // The body is framed by `length`, so a provider that reports itself done
  7613. // early has truncated it. Record that and let the short-body check below
  7614. // fail the write, rather than calling the provider again forever.
  7615. data_sink.done = [&]() { finished = true; };
  7616. while (offset < end_offset && !finished && !is_shutting_down()) {
  7617. auto last_offset = offset;
  7618. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7619. error = Error::Write;
  7620. return false;
  7621. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7622. error = Error::Canceled;
  7623. return false;
  7624. } else if (!ok) {
  7625. error = Error::Write;
  7626. return false;
  7627. }
  7628. // A provider that reports success without writing anything and without
  7629. // reporting itself done gets handed the same offset and length again on
  7630. // the next pass, so it would spin here for as long as the peer stays
  7631. // connected. Treat making no progress as a short body, like done() early.
  7632. if (!finished && offset == last_offset) {
  7633. error = Error::Write;
  7634. return false;
  7635. }
  7636. }
  7637. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7638. error = Error::Write;
  7639. return false;
  7640. }
  7641. error = Error::Success;
  7642. return true;
  7643. }
  7644. template <typename T>
  7645. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7646. size_t offset, size_t length, T is_shutting_down,
  7647. Error &error) {
  7648. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7649. is_shutting_down, nullptr, error);
  7650. }
  7651. template <typename T>
  7652. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7653. size_t offset, size_t length,
  7654. const T &is_shutting_down) {
  7655. auto error = Error::Success;
  7656. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7657. error);
  7658. }
  7659. template <typename T>
  7660. inline bool
  7661. write_content_without_length(Stream &strm,
  7662. const ContentProvider &content_provider,
  7663. const T &is_shutting_down) {
  7664. size_t offset = 0;
  7665. auto data_available = true;
  7666. auto ok = true;
  7667. DataSink data_sink;
  7668. data_sink.write = [&](const char *d, size_t l) -> bool {
  7669. if (ok) {
  7670. offset += l;
  7671. if (!write_data(strm, d, l)) { ok = false; }
  7672. }
  7673. return ok;
  7674. };
  7675. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7676. data_sink.done = [&](void) { data_available = false; };
  7677. while (data_available && !is_shutting_down()) {
  7678. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7679. return false;
  7680. } else if (!content_provider(offset, 0, data_sink)) {
  7681. return false;
  7682. } else if (!ok) {
  7683. return false;
  7684. }
  7685. }
  7686. return !data_available; // true only if done() was called, false if shutting
  7687. // down
  7688. }
  7689. // Runs a known-length content provider to completion and compresses what it
  7690. // writes into `out`, chunk by chunk, without holding the identity form.
  7691. inline bool compress_content_provider(const ContentProvider &content_provider,
  7692. size_t length, compressor &cmp,
  7693. std::string &out) {
  7694. size_t offset = 0;
  7695. auto ok = true;
  7696. auto finished = false;
  7697. DataSink data_sink;
  7698. auto append = [&](const char *data, size_t data_len) {
  7699. out.append(data, data_len);
  7700. return true;
  7701. };
  7702. data_sink.write = [&](const char *d, size_t l) -> bool {
  7703. if (!ok) { return false; }
  7704. offset += l;
  7705. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7706. return ok;
  7707. };
  7708. // The body is framed by `length`, so a provider that reports itself done
  7709. // early has truncated it; the short-body check below turns that into a
  7710. // failure rather than calling the provider again forever.
  7711. data_sink.done = [&]() { finished = true; };
  7712. while (offset < length && !finished) {
  7713. auto prev_offset = offset;
  7714. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7715. return false;
  7716. }
  7717. // No Stream to block on here, so a provider that keeps returning true
  7718. // without writing would spin. Treat a pass that made no progress as a
  7719. // failure.
  7720. if (offset == prev_offset) { return false; }
  7721. }
  7722. if (offset != length) { return false; }
  7723. return cmp.compress(nullptr, 0, true, append);
  7724. }
  7725. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7726. // and the file flag, so recording them has to come after; keeping all of it
  7727. // here means a third file-serving path cannot get that order wrong.
  7728. inline void set_file_content_provider(Response &res,
  7729. const std::shared_ptr<mmap> &m,
  7730. const std::string &content_type,
  7731. EncodingType encoding) {
  7732. // One read and one write move up to this much of the file at a time.
  7733. auto buf = std::make_shared<std::vector<char>>(
  7734. (std::min)(m->size(), size_t(256 * 1024)));
  7735. res.set_content_provider(
  7736. m->size(), content_type,
  7737. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7738. // Never read past the file, which ends the response early if it has
  7739. // shrunk since it was opened.
  7740. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7741. if (n == 0) { return false; }
  7742. sink.write(buf->data(), n);
  7743. return true;
  7744. });
  7745. res.is_file_content_provider_ = true;
  7746. res.content_coding_ = encoding;
  7747. }
  7748. template <typename T, typename U>
  7749. inline bool
  7750. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7751. const T &is_shutting_down, U &compressor, Error &error) {
  7752. size_t offset = 0;
  7753. auto data_available = true;
  7754. auto ok = true;
  7755. DataSink data_sink;
  7756. data_sink.write = [&](const char *d, size_t l) -> bool {
  7757. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7758. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7759. // zero-length chunk is the terminator, so it must not be emitted here.
  7760. if (ok && l > 0) {
  7761. offset += l;
  7762. std::string payload;
  7763. if (compressor.compress(d, l, false,
  7764. [&](const char *data, size_t data_len) {
  7765. payload.append(data, data_len);
  7766. return true;
  7767. })) {
  7768. if (!payload.empty()) {
  7769. // Emit chunked response header and footer for each chunk
  7770. auto chunk =
  7771. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7772. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7773. }
  7774. } else {
  7775. ok = false;
  7776. }
  7777. }
  7778. return ok;
  7779. };
  7780. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7781. auto done_with_trailer = [&](const Headers *trailer) {
  7782. if (!ok) { return; }
  7783. data_available = false;
  7784. std::string payload;
  7785. if (!compressor.compress(nullptr, 0, true,
  7786. [&](const char *data, size_t data_len) {
  7787. payload.append(data, data_len);
  7788. return true;
  7789. })) {
  7790. ok = false;
  7791. return;
  7792. }
  7793. if (!payload.empty()) {
  7794. // Emit chunked response header and footer for each chunk
  7795. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7796. if (!write_data(strm, chunk.data(), chunk.size())) {
  7797. ok = false;
  7798. return;
  7799. }
  7800. }
  7801. constexpr const char done_marker[] = "0\r\n";
  7802. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7803. // Trailer
  7804. if (trailer) {
  7805. for (const auto &kv : *trailer) {
  7806. // Skip fields with invalid names or values to prevent response
  7807. // splitting via CR/LF injection, matching set_header().
  7808. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7809. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7810. if (!write_data(strm, field_line.data(), field_line.size())) {
  7811. ok = false;
  7812. }
  7813. }
  7814. }
  7815. constexpr const char crlf[] = "\r\n";
  7816. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7817. };
  7818. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7819. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7820. done_with_trailer(&trailer);
  7821. };
  7822. while (data_available && !is_shutting_down()) {
  7823. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7824. error = Error::Write;
  7825. return false;
  7826. } else if (!content_provider(offset, 0, data_sink)) {
  7827. error = Error::Canceled;
  7828. return false;
  7829. } else if (!ok) {
  7830. error = Error::Write;
  7831. return false;
  7832. }
  7833. }
  7834. if (data_available) { // exited due to is_shutting_down(), not done()
  7835. error = Error::Write;
  7836. return false;
  7837. }
  7838. error = Error::Success;
  7839. return true;
  7840. }
  7841. template <typename T, typename U>
  7842. inline bool write_content_chunked(Stream &strm,
  7843. const ContentProvider &content_provider,
  7844. const T &is_shutting_down, U &compressor) {
  7845. auto error = Error::Success;
  7846. return write_content_chunked(strm, content_provider, is_shutting_down,
  7847. compressor, error);
  7848. }
  7849. template <typename T>
  7850. inline bool redirect(T &cli, Request &req, Response &res,
  7851. const std::string &path, const std::string &location,
  7852. Error &error) {
  7853. Request new_req = req;
  7854. new_req.path = path;
  7855. new_req.redirect_count_ -= 1;
  7856. if (res.status == StatusCode::SeeOther_303 &&
  7857. (req.method != "GET" && req.method != "HEAD")) {
  7858. new_req.method = "GET";
  7859. new_req.body.clear();
  7860. new_req.headers.clear();
  7861. new_req.content_length_ = 0;
  7862. new_req.content_provider_ = nullptr;
  7863. new_req.is_chunked_content_provider_ = false;
  7864. }
  7865. Response new_res;
  7866. auto ret = cli.send(new_req, new_res, error);
  7867. if (ret) {
  7868. req = std::move(new_req);
  7869. res = std::move(new_res);
  7870. if (res.location.empty()) { res.location = location; }
  7871. }
  7872. return ret;
  7873. }
  7874. inline std::string params_to_query_str(const Params &params) {
  7875. std::string query;
  7876. for (auto it = params.begin(); it != params.end(); ++it) {
  7877. if (it != params.begin()) { query += '&'; }
  7878. query += encode_query_component(it->first);
  7879. query += '=';
  7880. query += encode_query_component(it->second);
  7881. }
  7882. return query;
  7883. }
  7884. // Splits one "key=value" span of a query string at its first '='. A span with
  7885. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7886. // "?flag" keeps its name.
  7887. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7888. std::string &val) {
  7889. divide(b, static_cast<std::size_t>(e - b), '=',
  7890. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7891. std::size_t rhs_size) {
  7892. key.assign(lhs_data, lhs_size);
  7893. val.assign(rhs_data, rhs_size);
  7894. });
  7895. }
  7896. inline void parse_query_text(const char *data, std::size_t size,
  7897. Params &params) {
  7898. std::set<std::string> cache;
  7899. split(data, data + size, '&', [&](const char *b, const char *e) {
  7900. std::string kv(b, e);
  7901. if (cache.find(kv) != cache.end()) { return; }
  7902. cache.insert(std::move(kv));
  7903. std::string key;
  7904. std::string val;
  7905. divide_query_pair(b, e, key, val);
  7906. if (!key.empty()) {
  7907. params.emplace(decode_query_component(key), decode_query_component(val));
  7908. }
  7909. });
  7910. }
  7911. inline void parse_query_text(const std::string &s, Params &params) {
  7912. parse_query_text(s.data(), s.size(), params);
  7913. }
  7914. // Normalize a query string by decoding and re-encoding each key/value pair
  7915. // while preserving the original parameter order. This avoids double-encoding
  7916. // and ensures consistent encoding. It works on the raw string rather than
  7917. // parsing into Params and re-serializing, because that round trip cannot
  7918. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7919. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7920. // duplicated pairs.
  7921. inline std::string normalize_query_string(const std::string &query) {
  7922. std::string result;
  7923. split(query.data(), query.data() + query.size(), '&',
  7924. [&](const char *b, const char *e) {
  7925. std::string key;
  7926. std::string val;
  7927. divide_query_pair(b, e, key, val);
  7928. if (!key.empty()) {
  7929. auto dec_key = decode_query_component(key);
  7930. auto dec_val = decode_query_component(val);
  7931. if (!result.empty()) { result += '&'; }
  7932. result += encode_query_component(dec_key);
  7933. if (!val.empty() || std::find(b, e, '=') != e) {
  7934. result += '=';
  7935. result += encode_query_component(dec_val);
  7936. }
  7937. }
  7938. });
  7939. return result;
  7940. }
  7941. // The query of a client's path: what follows '?', up to the fragment.
  7942. inline std::string query_of(const std::string &path) {
  7943. auto fragment_pos = path.find('#');
  7944. auto query_pos = path.find('?');
  7945. return query_pos < fragment_pos
  7946. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7947. : std::string();
  7948. }
  7949. // Build the request target that goes on the wire from a caller-supplied path.
  7950. // Shared by the buffered send path and the streaming API so that both put the
  7951. // same bytes in the request line for the same input.
  7952. inline std::string encode_request_target(const std::string &uri,
  7953. bool path_encode) {
  7954. // The fragment stays with the client (RFC 9110 §7.1).
  7955. auto target = uri.substr(0, uri.find('#'));
  7956. // `substr(0, npos)` yields the whole string, which is what the no-query
  7957. // case needs.
  7958. auto query_pos = target.find('?');
  7959. auto path_part = target.substr(0, query_pos);
  7960. std::string query_part;
  7961. if (query_pos != std::string::npos) {
  7962. query_part = target.substr(query_pos + 1);
  7963. }
  7964. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7965. if (!query_part.empty()) {
  7966. // When path encoding is disabled the caller has supplied an already-encoded
  7967. // target and expects the exact bytes to be sent on the wire, so skip
  7968. // normalization for the query too. Normalizing would decode-then-re-encode
  7969. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7970. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7971. if (path_encode) {
  7972. auto normalized = normalize_query_string(query_part);
  7973. if (!normalized.empty()) {
  7974. result += '?';
  7975. result += normalized;
  7976. }
  7977. } else {
  7978. result += '?';
  7979. result += query_part;
  7980. }
  7981. }
  7982. return result;
  7983. }
  7984. inline bool parse_multipart_boundary(const std::string &content_type,
  7985. std::string &boundary) {
  7986. std::map<std::string, std::string> params;
  7987. extract_media_type(content_type, &params);
  7988. auto it = params.find("boundary");
  7989. if (it == params.end()) { return false; }
  7990. boundary = it->second;
  7991. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7992. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7993. // bytes costs a nearly full comparison at nearly every position: the
  7994. // boundary's length multiplies the worst-case cost of scanning a body.
  7995. return !boundary.empty() && boundary.size() <= 70;
  7996. }
  7997. inline void parse_disposition_params(const std::string &s, Params &params) {
  7998. std::set<std::string> cache;
  7999. split_unquoted(
  8000. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  8001. std::string kv(b, e);
  8002. if (cache.find(kv) != cache.end()) { return; }
  8003. cache.insert(kv);
  8004. std::string key;
  8005. std::string val;
  8006. divide_param_pair(b, e, key, val);
  8007. if (!key.empty()) {
  8008. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  8009. }
  8010. });
  8011. }
  8012. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8013. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  8014. #else
  8015. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  8016. #endif
  8017. auto is_valid = [](const std::string &str) {
  8018. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  8019. };
  8020. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8021. const auto pos = static_cast<size_t>(6);
  8022. const auto len = static_cast<size_t>(s.size() - 6);
  8023. auto all_valid_ranges = true;
  8024. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8025. if (!all_valid_ranges) { return; }
  8026. const auto it = std::find(b, e, '-');
  8027. if (it == e) {
  8028. all_valid_ranges = false;
  8029. return;
  8030. }
  8031. const auto lhs = std::string(b, it);
  8032. const auto rhs = std::string(it + 1, e);
  8033. if (!is_valid(lhs) || !is_valid(rhs)) {
  8034. all_valid_ranges = false;
  8035. return;
  8036. }
  8037. ssize_t first = -1;
  8038. if (!lhs.empty()) {
  8039. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8040. // would turn the range into a suffix range.
  8041. auto res =
  8042. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8043. if (res.ec != std::errc{}) {
  8044. all_valid_ranges = false;
  8045. return;
  8046. }
  8047. }
  8048. ssize_t last = -1;
  8049. if (!rhs.empty()) {
  8050. // An overflowing last-byte-pos is past any content length, so keeping
  8051. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8052. ssize_t v;
  8053. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8054. if (res.ec == std::errc{}) { last = v; }
  8055. }
  8056. if ((first == -1 && last == -1) ||
  8057. (first != -1 && last != -1 && first > last)) {
  8058. all_valid_ranges = false;
  8059. return;
  8060. }
  8061. ranges.emplace_back(first, last);
  8062. });
  8063. return all_valid_ranges && !ranges.empty();
  8064. }
  8065. return false;
  8066. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8067. }
  8068. #else
  8069. } catch (...) { return false; }
  8070. #endif
  8071. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8072. inline std::string remove_quoted_strings(const std::string &s) {
  8073. std::string out;
  8074. auto in_quotes = false;
  8075. for (size_t i = 0; i < s.size(); i++) {
  8076. if (s[i] == '"') {
  8077. in_quotes = !in_quotes;
  8078. } else if (!in_quotes) {
  8079. out += s[i];
  8080. } else if (s[i] == '\\') {
  8081. i++;
  8082. }
  8083. }
  8084. return out;
  8085. }
  8086. inline bool parse_accept_header(const std::string &s,
  8087. std::vector<std::string> &content_types) {
  8088. // Parameter values are not used here, so a quoted-string is dropped rather
  8089. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8090. if (s.find('"') != std::string::npos) {
  8091. return parse_accept_header(remove_quoted_strings(s), content_types);
  8092. }
  8093. content_types.clear();
  8094. // Empty string is considered valid (no preference)
  8095. if (s.empty()) { return true; }
  8096. struct AcceptEntry {
  8097. std::string media_type;
  8098. double quality;
  8099. int order;
  8100. };
  8101. std::vector<AcceptEntry> entries;
  8102. int order = 0;
  8103. bool has_invalid_entry = false;
  8104. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8105. // has to parse and ignore empty list elements, so a leading, trailing or
  8106. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8107. // split() skips them, and the header length limit bounds how many a sender
  8108. // can send, so ignoring all of them cannot be used as a denial-of-service
  8109. // vector.
  8110. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8111. std::string entry(b, e);
  8112. entry = trim_copy(entry);
  8113. AcceptEntry accept_entry;
  8114. accept_entry.order = order++;
  8115. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8116. accept_entry.media_type, accept_entry.quality)) {
  8117. has_invalid_entry = true;
  8118. return;
  8119. }
  8120. // Remove additional parameters from media type
  8121. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8122. // Basic validation of media type format
  8123. if (accept_entry.media_type.empty()) {
  8124. has_invalid_entry = true;
  8125. return;
  8126. }
  8127. // Check for basic media type format (should contain '/' or be '*')
  8128. if (accept_entry.media_type != "*" &&
  8129. accept_entry.media_type.find('/') == std::string::npos) {
  8130. has_invalid_entry = true;
  8131. return;
  8132. }
  8133. entries.push_back(std::move(accept_entry));
  8134. });
  8135. // Return false if any invalid entry was found
  8136. if (has_invalid_entry) { return false; }
  8137. // Sort by quality (descending), then by original order (ascending)
  8138. std::sort(entries.begin(), entries.end(),
  8139. [](const AcceptEntry &a, const AcceptEntry &b) {
  8140. if (a.quality != b.quality) {
  8141. return a.quality > b.quality; // Higher quality first
  8142. }
  8143. return a.order < b.order; // Earlier order first for same quality
  8144. });
  8145. // Extract sorted media types
  8146. content_types.reserve(entries.size());
  8147. for (auto &entry : entries) {
  8148. content_types.push_back(std::move(entry.media_type));
  8149. }
  8150. return true;
  8151. }
  8152. class FormDataParser {
  8153. public:
  8154. FormDataParser() = default;
  8155. void set_boundary(std::string &&boundary) {
  8156. boundary_ = std::move(boundary);
  8157. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8158. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8159. }
  8160. bool is_valid() const { return is_valid_; }
  8161. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8162. const ContentReceiver &content_callback) {
  8163. // Once the close delimiter has been seen the rest of the body is epilogue
  8164. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8165. // spread across reads is not copied in only to be erased right away.
  8166. if (state_ == 5) { return true; }
  8167. buf_append(buf, n);
  8168. while (buf_size() > 0) {
  8169. switch (state_) {
  8170. case 0: { // Initial boundary
  8171. auto pos = buf_find(dash_boundary_crlf_);
  8172. if (pos == buf_size()) {
  8173. // Not found yet: keep only a possible partial boundary at the tail so
  8174. // that a body which never contains the boundary cannot grow the
  8175. // buffer (and get rescanned from the start) without bound.
  8176. auto keep = dash_boundary_crlf_.size() - 1;
  8177. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8178. return true;
  8179. }
  8180. buf_erase(pos + dash_boundary_crlf_.size());
  8181. state_ = 1;
  8182. break;
  8183. }
  8184. case 1: { // New entry
  8185. clear_file_info();
  8186. header_searched_ = 0;
  8187. state_ = 2;
  8188. break;
  8189. }
  8190. case 2: { // Headers
  8191. // Resume where the last call stopped looking, so that a line arriving
  8192. // a few bytes at a time is not searched from its start each time.
  8193. auto pos = buf_find(crlf_, header_searched_);
  8194. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8195. while (pos < buf_size()) {
  8196. // Empty line
  8197. if (pos == 0) {
  8198. if (!header_callback(file_)) {
  8199. is_valid_ = false;
  8200. return false;
  8201. }
  8202. buf_erase(crlf_.size());
  8203. state_ = 3;
  8204. break;
  8205. }
  8206. // Check header count limit
  8207. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8208. is_valid_ = false;
  8209. return false;
  8210. }
  8211. header_count_++;
  8212. const auto header = buf_head(pos);
  8213. if (!parse_header(header.data(), header.data() + header.size(),
  8214. [&](const std::string &, const std::string &) {})) {
  8215. is_valid_ = false;
  8216. return false;
  8217. }
  8218. // Parse and emplace space trimmed headers into a map
  8219. if (!parse_header(
  8220. header.data(), header.data() + header.size(),
  8221. [&](const std::string &key, const std::string &val) {
  8222. file_.headers.emplace(key, val);
  8223. })) {
  8224. is_valid_ = false;
  8225. return false;
  8226. }
  8227. constexpr const char header_content_type[] = "Content-Type:";
  8228. if (start_with_case_ignore(header, header_content_type)) {
  8229. file_.content_type =
  8230. trim_copy(header.substr(str_len(header_content_type)));
  8231. } else {
  8232. std::string disposition_params;
  8233. if (parse_content_disposition(header, disposition_params)) {
  8234. Params params;
  8235. parse_disposition_params(disposition_params, params);
  8236. auto it = params.find("name");
  8237. if (it != params.end()) {
  8238. file_.name = it->second;
  8239. } else {
  8240. is_valid_ = false;
  8241. return false;
  8242. }
  8243. it = params.find("filename");
  8244. if (it != params.end()) { file_.filename = it->second; }
  8245. it = params.find("filename*");
  8246. if (it != params.end()) {
  8247. // RFC 5987: only UTF-8 encoding is allowed
  8248. const auto &val = it->second;
  8249. constexpr const char utf8_prefix[] = "UTF-8''";
  8250. constexpr size_t prefix_len = str_len(utf8_prefix);
  8251. if (val.size() > prefix_len &&
  8252. start_with_case_ignore(val, utf8_prefix)) {
  8253. file_.filename = decode_path_component(
  8254. val.substr(prefix_len)); // override...
  8255. } else {
  8256. is_valid_ = false;
  8257. return false;
  8258. }
  8259. }
  8260. }
  8261. }
  8262. buf_erase(pos + crlf_.size());
  8263. pos = buf_find(crlf_);
  8264. }
  8265. if (state_ != 3) {
  8266. // The CR of the CRLF may be the last byte so far.
  8267. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8268. return true;
  8269. }
  8270. break;
  8271. }
  8272. case 3: { // Body
  8273. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8274. auto pos = buf_find(crlf_dash_boundary_);
  8275. if (pos < buf_size()) {
  8276. if (!content_callback(buf_data(), pos)) {
  8277. is_valid_ = false;
  8278. return false;
  8279. }
  8280. buf_erase(pos + crlf_dash_boundary_.size());
  8281. state_ = 4;
  8282. } else {
  8283. auto len = buf_size() - crlf_dash_boundary_.size();
  8284. if (len > 0) {
  8285. if (!content_callback(buf_data(), len)) {
  8286. is_valid_ = false;
  8287. return false;
  8288. }
  8289. buf_erase(len);
  8290. }
  8291. return true;
  8292. }
  8293. break;
  8294. }
  8295. case 4: { // Boundary
  8296. if (crlf_.size() > buf_size()) { return true; }
  8297. if (buf_start_with(crlf_)) {
  8298. buf_erase(crlf_.size());
  8299. state_ = 1;
  8300. } else if (buf_start_with(dash_)) {
  8301. buf_erase(dash_.size());
  8302. is_valid_ = true;
  8303. state_ = 5;
  8304. } else {
  8305. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8306. // accepted after a boundary; RFC 2046 allows transport-padding in
  8307. // between, but this parser has never supported it. Either way the
  8308. // body is already destined to be rejected, so fail now instead of
  8309. // buffering the rest of it. Both are two bytes, so the check above
  8310. // already guarantees enough buffered data to decide.
  8311. is_valid_ = false;
  8312. return false;
  8313. }
  8314. break;
  8315. }
  8316. case 5: { // Epilogue
  8317. buf_erase(buf_size());
  8318. break;
  8319. }
  8320. }
  8321. }
  8322. return true;
  8323. }
  8324. private:
  8325. void clear_file_info() {
  8326. file_.name.clear();
  8327. file_.filename.clear();
  8328. file_.content_type.clear();
  8329. file_.headers.clear();
  8330. header_count_ = 0;
  8331. }
  8332. bool start_with_case_ignore(const std::string &a, const char *b,
  8333. size_t offset = 0) const {
  8334. const auto b_len = strlen(b);
  8335. if (a.size() < offset + b_len) { return false; }
  8336. for (size_t i = 0; i < b_len; i++) {
  8337. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8338. return false;
  8339. }
  8340. }
  8341. return true;
  8342. }
  8343. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8344. // Returns true if header matches, with the params portion in `params_out`.
  8345. bool parse_content_disposition(const std::string &header,
  8346. std::string &params_out) const {
  8347. constexpr const char prefix[] = "Content-Disposition:";
  8348. constexpr size_t prefix_len = str_len(prefix);
  8349. if (!start_with_case_ignore(header, prefix)) { return false; }
  8350. // Skip whitespace after "Content-Disposition:"
  8351. auto pos = prefix_len;
  8352. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8353. pos++;
  8354. }
  8355. // Match "form-data;" (case-insensitive)
  8356. constexpr const char form_data[] = "form-data;";
  8357. constexpr size_t form_data_len = str_len(form_data);
  8358. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8359. pos += form_data_len;
  8360. // Skip whitespace after "form-data;"
  8361. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8362. pos++;
  8363. }
  8364. params_out = header.substr(pos);
  8365. return true;
  8366. }
  8367. const std::string dash_ = "--";
  8368. const std::string crlf_ = "\r\n";
  8369. std::string boundary_;
  8370. std::string dash_boundary_crlf_;
  8371. std::string crlf_dash_boundary_;
  8372. size_t state_ = 0;
  8373. bool is_valid_ = false;
  8374. FormData file_;
  8375. size_t header_count_ = 0;
  8376. size_t header_searched_ = 0;
  8377. // Buffer
  8378. bool start_with(const std::string &a, size_t spos, size_t epos,
  8379. const std::string &b) const {
  8380. if (epos - spos < b.size()) { return false; }
  8381. for (size_t i = 0; i < b.size(); i++) {
  8382. if (a[i + spos] != b[i]) { return false; }
  8383. }
  8384. return true;
  8385. }
  8386. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8387. const char *buf_data() const { return &buf_[buf_spos_]; }
  8388. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8389. bool buf_start_with(const std::string &s) const {
  8390. return start_with(buf_, buf_spos_, buf_epos_, s);
  8391. }
  8392. size_t buf_find(const std::string &s, size_t from = 0) const {
  8393. auto c = s.front();
  8394. size_t off = buf_spos_ + from;
  8395. while (off < buf_epos_) {
  8396. auto pos = off;
  8397. while (true) {
  8398. if (pos == buf_epos_) { return buf_size(); }
  8399. if (buf_[pos] == c) { break; }
  8400. pos++;
  8401. }
  8402. auto remaining_size = buf_epos_ - pos;
  8403. if (s.size() > remaining_size) { return buf_size(); }
  8404. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8405. off = pos + 1;
  8406. }
  8407. return buf_size();
  8408. }
  8409. void buf_append(const char *data, size_t n) {
  8410. auto remaining_size = buf_size();
  8411. if (remaining_size > 0 && buf_spos_ > 0) {
  8412. for (size_t i = 0; i < remaining_size; i++) {
  8413. buf_[i] = buf_[buf_spos_ + i];
  8414. }
  8415. }
  8416. buf_spos_ = 0;
  8417. buf_epos_ = remaining_size;
  8418. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8419. for (size_t i = 0; i < n; i++) {
  8420. buf_[buf_epos_ + i] = data[i];
  8421. }
  8422. buf_epos_ += n;
  8423. }
  8424. void buf_erase(size_t size) { buf_spos_ += size; }
  8425. std::string buf_;
  8426. size_t buf_spos_ = 0;
  8427. size_t buf_epos_ = 0;
  8428. };
  8429. inline std::string random_string(size_t length) {
  8430. constexpr const char data[] =
  8431. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8432. std::string result(length, '\0');
  8433. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8434. for (auto &c : result) {
  8435. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8436. }
  8437. return result;
  8438. }
  8439. inline std::string make_multipart_data_boundary() {
  8440. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8441. }
  8442. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8443. auto valid = true;
  8444. for (size_t i = 0; i < boundary.size(); i++) {
  8445. auto c = boundary[i];
  8446. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8447. valid = false;
  8448. break;
  8449. }
  8450. }
  8451. return valid;
  8452. }
  8453. // Escape a multipart field name/filename following the WHATWG HTML standard
  8454. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8455. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8456. // With quoted = false, only CR and LF are escaped; this is for header values
  8457. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8458. inline std::string escape_multipart_field(const std::string &s,
  8459. bool quoted = true) {
  8460. std::string result;
  8461. result.reserve(s.size());
  8462. for (auto c : s) {
  8463. switch (c) {
  8464. case '"':
  8465. if (quoted) {
  8466. result += "%22";
  8467. } else {
  8468. result += c;
  8469. }
  8470. break;
  8471. case '\\':
  8472. // A lone backslash would escape the character after it (RFC 9110
  8473. // 5.6.4).
  8474. if (quoted) { result += '\\'; }
  8475. result += c;
  8476. break;
  8477. case '\r': result += "%0D"; break;
  8478. case '\n': result += "%0A"; break;
  8479. default: result += c; break;
  8480. }
  8481. }
  8482. return result;
  8483. }
  8484. template <typename T>
  8485. inline std::string
  8486. serialize_multipart_formdata_item_begin(const T &item,
  8487. const std::string &boundary) {
  8488. std::string body = "--" + boundary + "\r\n";
  8489. body += "Content-Disposition: form-data; name=\"" +
  8490. escape_multipart_field(item.name) + "\"";
  8491. if (!item.filename.empty()) {
  8492. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8493. }
  8494. body += "\r\n";
  8495. if (!item.content_type.empty()) {
  8496. body +=
  8497. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8498. "\r\n";
  8499. }
  8500. body += "\r\n";
  8501. return body;
  8502. }
  8503. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8504. inline std::string
  8505. serialize_multipart_formdata_finish(const std::string &boundary) {
  8506. return "--" + boundary + "--\r\n";
  8507. }
  8508. inline std::string
  8509. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8510. return "multipart/form-data; boundary=" + boundary;
  8511. }
  8512. inline std::string
  8513. serialize_multipart_formdata(const UploadFormDataItems &items,
  8514. const std::string &boundary, bool finish = true) {
  8515. std::string body;
  8516. for (const auto &item : items) {
  8517. body += serialize_multipart_formdata_item_begin(item, boundary);
  8518. body += item.content + serialize_multipart_formdata_item_end();
  8519. }
  8520. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8521. return body;
  8522. }
  8523. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8524. const std::string &boundary) {
  8525. size_t total = 0;
  8526. for (const auto &item : items) {
  8527. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8528. total += item.content.size();
  8529. total += serialize_multipart_formdata_item_end().size();
  8530. }
  8531. total += serialize_multipart_formdata_finish(boundary).size();
  8532. return total;
  8533. }
  8534. struct MultipartSegment {
  8535. const char *data;
  8536. size_t size;
  8537. };
  8538. // NOTE: items must outlive the returned ContentProvider
  8539. // (safe for synchronous use inside Post/Put/Patch)
  8540. inline ContentProvider
  8541. make_multipart_content_provider(const UploadFormDataItems &items,
  8542. const std::string &boundary) {
  8543. // Own the per-item header strings and the finish string
  8544. std::vector<std::string> owned;
  8545. owned.reserve(items.size() + 1);
  8546. for (const auto &item : items)
  8547. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8548. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8549. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8550. std::vector<MultipartSegment> segs;
  8551. segs.reserve(items.size() * 3 + 1);
  8552. static const char crlf[] = "\r\n";
  8553. for (size_t i = 0; i < items.size(); i++) {
  8554. segs.push_back({owned[i].data(), owned[i].size()});
  8555. segs.push_back({items[i].content.data(), items[i].content.size()});
  8556. segs.push_back({crlf, 2});
  8557. }
  8558. segs.push_back({owned.back().data(), owned.back().size()});
  8559. struct MultipartState {
  8560. std::vector<std::string> owned;
  8561. std::vector<MultipartSegment> segs;
  8562. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8563. };
  8564. auto state = std::make_shared<MultipartState>();
  8565. state->owned = std::move(owned);
  8566. // `segs` holds raw pointers into owned strings; std::string move preserves
  8567. // the data pointer, so these pointers remain valid after the move above.
  8568. state->segs = std::move(segs);
  8569. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8570. // Buffer multiple small segments into fewer, larger writes to avoid
  8571. // excessive TCP packets when there are many form data items (#2410)
  8572. auto &buf = state->buf;
  8573. auto buf_size = buf.size();
  8574. size_t buf_len = 0;
  8575. size_t remaining = length;
  8576. // Find the first segment containing 'offset'
  8577. size_t pos = 0;
  8578. size_t seg_idx = 0;
  8579. for (; seg_idx < state->segs.size(); seg_idx++) {
  8580. const auto &seg = state->segs[seg_idx];
  8581. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8582. pos += seg.size;
  8583. }
  8584. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8585. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8586. const auto &seg = state->segs[seg_idx];
  8587. size_t available = seg.size - seg_offset;
  8588. size_t to_copy = (std::min)(available, remaining);
  8589. const char *src = seg.data + seg_offset;
  8590. seg_offset = 0; // only the first segment has a non-zero offset
  8591. while (to_copy > 0) {
  8592. size_t space = buf_size - buf_len;
  8593. size_t chunk = (std::min)(to_copy, space);
  8594. std::memcpy(buf.data() + buf_len, src, chunk);
  8595. buf_len += chunk;
  8596. src += chunk;
  8597. to_copy -= chunk;
  8598. remaining -= chunk;
  8599. if (buf_len == buf_size) {
  8600. if (!sink.write(buf.data(), buf_len)) { return false; }
  8601. buf_len = 0;
  8602. }
  8603. }
  8604. }
  8605. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8606. return true;
  8607. };
  8608. }
  8609. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8610. if (ranges.size() <= 1) return;
  8611. // Sort ranges by start position
  8612. std::sort(ranges.begin(), ranges.end(),
  8613. [](const Range &a, const Range &b) { return a.first < b.first; });
  8614. Ranges coalesced;
  8615. coalesced.reserve(ranges.size());
  8616. for (auto &r : ranges) {
  8617. auto first_pos = r.first;
  8618. auto last_pos = r.second;
  8619. // Handle special cases like in range_error
  8620. if (first_pos == -1 && last_pos == -1) {
  8621. first_pos = 0;
  8622. last_pos = static_cast<ssize_t>(content_length);
  8623. }
  8624. if (first_pos == -1) {
  8625. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8626. last_pos = static_cast<ssize_t>(content_length) - 1;
  8627. }
  8628. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8629. last_pos = static_cast<ssize_t>(content_length) - 1;
  8630. }
  8631. // Skip invalid ranges
  8632. if (!(0 <= first_pos && first_pos <= last_pos &&
  8633. last_pos < static_cast<ssize_t>(content_length))) {
  8634. continue;
  8635. }
  8636. // Coalesce with previous range if overlapping or adjacent (but not
  8637. // identical)
  8638. if (!coalesced.empty()) {
  8639. auto &prev = coalesced.back();
  8640. // Check if current range overlaps or is adjacent to previous range
  8641. // but don't coalesce identical ranges (allow duplicates)
  8642. if (first_pos <= prev.second + 1 &&
  8643. !(first_pos == prev.first && last_pos == prev.second)) {
  8644. // Extend the previous range
  8645. prev.second = (std::max)(prev.second, last_pos);
  8646. continue;
  8647. }
  8648. }
  8649. // Add new range
  8650. coalesced.emplace_back(first_pos, last_pos);
  8651. }
  8652. ranges = std::move(coalesced);
  8653. }
  8654. inline bool range_error(Request &req, Response &res) {
  8655. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8656. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8657. req.ranges.clear();
  8658. if (res.status == StatusCode::PartialContent_206) {
  8659. res.status = StatusCode::OK_200;
  8660. }
  8661. return false;
  8662. }
  8663. ssize_t content_len = static_cast<ssize_t>(
  8664. res.content_length_ ? res.content_length_ : res.body.size());
  8665. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8666. size_t overwrapping_count = 0;
  8667. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8668. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8669. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8670. // Too many ranges
  8671. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8672. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8673. return true;
  8674. }
  8675. for (auto &r : req.ranges) {
  8676. auto &first_pos = r.first;
  8677. auto &last_pos = r.second;
  8678. if (first_pos == -1 && last_pos == -1) {
  8679. first_pos = 0;
  8680. last_pos = content_len;
  8681. }
  8682. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8683. // selects the entire representation.
  8684. if (first_pos == -1) {
  8685. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8686. last_pos = content_len - 1;
  8687. }
  8688. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8689. // A client can limit the number of bytes requested without knowing the
  8690. // size of the selected representation. If the last-pos value is absent,
  8691. // or if the value is greater than or equal to the current length of the
  8692. // representation data, the byte range is interpreted as the remainder of
  8693. // the representation (i.e., the server replaces the value of last-pos
  8694. // with a value that is one less than the current length of the selected
  8695. // representation).
  8696. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8697. if (last_pos == -1 || last_pos >= content_len) {
  8698. last_pos = content_len - 1;
  8699. }
  8700. // Range must be within content length
  8701. if (!(0 <= first_pos && first_pos <= last_pos &&
  8702. last_pos <= content_len - 1)) {
  8703. return true;
  8704. }
  8705. // Request must not have more than two overlapping ranges
  8706. for (const auto &processed_range : processed_ranges) {
  8707. if (!(last_pos < processed_range.first ||
  8708. first_pos > processed_range.second)) {
  8709. overwrapping_count++;
  8710. if (overwrapping_count > 2) { return true; }
  8711. break; // Only count once per range
  8712. }
  8713. }
  8714. processed_ranges.emplace_back(first_pos, last_pos);
  8715. }
  8716. // After validation, coalesce overlapping ranges as per RFC 9110
  8717. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8718. }
  8719. return false;
  8720. }
  8721. inline std::pair<size_t, size_t>
  8722. get_range_offset_and_length(Range r, size_t content_length) {
  8723. assert(r.first != -1 && r.second != -1);
  8724. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8725. assert(r.first <= r.second &&
  8726. r.second < static_cast<ssize_t>(content_length));
  8727. (void)(content_length);
  8728. return std::make_pair(static_cast<size_t>(r.first),
  8729. static_cast<size_t>(r.second - r.first) + 1);
  8730. }
  8731. inline std::string make_content_range_header_field(
  8732. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8733. auto st = offset_and_length.first;
  8734. auto ed = st + offset_and_length.second - 1;
  8735. std::string field = "bytes ";
  8736. field += std::to_string(st);
  8737. field += '-';
  8738. field += std::to_string(ed);
  8739. field += '/';
  8740. field += std::to_string(content_length);
  8741. return field;
  8742. }
  8743. template <typename SToken, typename CToken, typename Content>
  8744. bool process_multipart_ranges_data(const Request &req,
  8745. const std::string &boundary,
  8746. const std::string &content_type,
  8747. size_t content_length, SToken stoken,
  8748. CToken ctoken, Content content) {
  8749. for (size_t i = 0; i < req.ranges.size(); i++) {
  8750. ctoken("--");
  8751. stoken(boundary);
  8752. ctoken("\r\n");
  8753. if (!content_type.empty()) {
  8754. ctoken("Content-Type: ");
  8755. stoken(content_type);
  8756. ctoken("\r\n");
  8757. }
  8758. auto offset_and_length =
  8759. get_range_offset_and_length(req.ranges[i], content_length);
  8760. ctoken("Content-Range: ");
  8761. stoken(make_content_range_header_field(offset_and_length, content_length));
  8762. ctoken("\r\n");
  8763. ctoken("\r\n");
  8764. if (!content(offset_and_length.first, offset_and_length.second)) {
  8765. return false;
  8766. }
  8767. ctoken("\r\n");
  8768. }
  8769. ctoken("--");
  8770. stoken(boundary);
  8771. ctoken("--");
  8772. return true;
  8773. }
  8774. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8775. const std::string &boundary,
  8776. const std::string &content_type,
  8777. size_t content_length,
  8778. std::string &data) {
  8779. process_multipart_ranges_data(
  8780. req, boundary, content_type, content_length,
  8781. [&](const std::string &token) { data += token; },
  8782. [&](const std::string &token) { data += token; },
  8783. [&](size_t offset, size_t length) {
  8784. assert(offset + length <= content_length);
  8785. data += res.body.substr(offset, length);
  8786. return true;
  8787. });
  8788. }
  8789. inline size_t get_multipart_ranges_data_length(const Request &req,
  8790. const std::string &boundary,
  8791. const std::string &content_type,
  8792. size_t content_length) {
  8793. size_t data_length = 0;
  8794. process_multipart_ranges_data(
  8795. req, boundary, content_type, content_length,
  8796. [&](const std::string &token) { data_length += token.size(); },
  8797. [&](const std::string &token) { data_length += token.size(); },
  8798. [&](size_t /*offset*/, size_t length) {
  8799. data_length += length;
  8800. return true;
  8801. });
  8802. return data_length;
  8803. }
  8804. template <typename T>
  8805. inline bool
  8806. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8807. const std::string &boundary,
  8808. const std::string &content_type,
  8809. size_t content_length, const T &is_shutting_down) {
  8810. return process_multipart_ranges_data(
  8811. req, boundary, content_type, content_length,
  8812. [&](const std::string &token) { strm.write(token); },
  8813. [&](const std::string &token) { strm.write(token); },
  8814. [&](size_t offset, size_t length) {
  8815. return write_content(strm, res.content_provider_, offset, length,
  8816. is_shutting_down);
  8817. });
  8818. }
  8819. inline bool has_framed_body(const Request &req) {
  8820. return is_chunked_transfer_encoding(req.headers) ||
  8821. req.get_header_value_u64("Content-Length") > 0;
  8822. }
  8823. inline bool expect_content(const Request &req) {
  8824. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8825. req.method == "DELETE") {
  8826. return true;
  8827. }
  8828. return has_framed_body(req);
  8829. }
  8830. #ifdef _WIN32
  8831. class WSInit {
  8832. public:
  8833. WSInit() {
  8834. WSADATA wsaData;
  8835. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8836. }
  8837. ~WSInit() {
  8838. if (is_valid_) WSACleanup();
  8839. }
  8840. bool is_valid_ = false;
  8841. };
  8842. static WSInit wsinit_;
  8843. #endif
  8844. inline std::string unescape_quoted_pairs(const std::string &s) {
  8845. std::string out;
  8846. out.reserve(s.size());
  8847. for (size_t i = 0; i < s.size(); i++) {
  8848. if (s[i] == '\\' && i + 1 < s.size()) {
  8849. out += s[++i];
  8850. } else {
  8851. out += s[i];
  8852. }
  8853. }
  8854. return out;
  8855. }
  8856. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8857. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8858. // quoted-pair, so the recipient recovers the original value.
  8859. inline std::string escape_quoted_pairs(const std::string &s) {
  8860. std::string out;
  8861. out.reserve(s.size());
  8862. for (auto c : s) {
  8863. if (c == '\\' || c == '"') { out += '\\'; }
  8864. out += c;
  8865. }
  8866. return out;
  8867. }
  8868. // RFC 9110 Section 11.6.1 defines a challenge list as
  8869. // WWW-Authenticate = #challenge
  8870. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8871. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8872. // so a server may offer several schemes, each with its own comma-separated
  8873. // auth-param list, in either order and either as separate field lines or
  8874. // packed into one. Splitting on every comma would break apart a challenge's
  8875. // own param list; splitting only on the first space would miss a Digest
  8876. // challenge that isn't first. Split on commas that aren't inside a
  8877. // quoted-string instead (split_unquoted), then track which scheme each
  8878. // resulting segment belongs to: a segment whose text before "=" contains
  8879. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8880. // leading token.
  8881. inline bool parse_www_authenticate(const Response &res,
  8882. std::map<std::string, std::string> &auth,
  8883. bool is_proxy) {
  8884. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8885. auto combined = get_combined_header_value(res.headers, auth_key);
  8886. if (combined.empty()) { return false; }
  8887. auto found_digest = false;
  8888. auto in_digest_challenge = false;
  8889. split_unquoted(
  8890. combined.data(), combined.data() + combined.size(), ',',
  8891. [&](const char *b, const char *e) {
  8892. std::string segment(b, e);
  8893. auto eq_pos = segment.find('=');
  8894. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8895. // for the first segment of a challenge, "<scheme> <key>") must be
  8896. // trimmed before its boundaries are inspected.
  8897. auto key_part = trim_copy(
  8898. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8899. auto space_pos = key_part.find_last_of(" \t");
  8900. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8901. // "<scheme>[ <key>]" starts a new challenge.
  8902. auto scheme_end =
  8903. space_pos == std::string::npos ? key_part.size() : space_pos;
  8904. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8905. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8906. // from one challenge is never paired with another's algorithm.
  8907. in_digest_challenge =
  8908. !found_digest &&
  8909. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8910. if (in_digest_challenge) { found_digest = true; }
  8911. if (space_pos == std::string::npos) {
  8912. // Bare scheme (or a token68), no auth-param on this segment.
  8913. return;
  8914. }
  8915. key_part = key_part.substr(space_pos + 1);
  8916. }
  8917. if (!in_digest_challenge) { return; }
  8918. auto val = trim_copy(segment.substr(eq_pos + 1));
  8919. auto unquoted = trim_double_quotes_copy(val);
  8920. if (unquoted.size() != val.size()) {
  8921. unquoted = unescape_quoted_pairs(unquoted);
  8922. }
  8923. auth[std::move(key_part)] = std::move(unquoted);
  8924. });
  8925. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8926. // make_digest_authentication_header() dereferences both unconditionally, so
  8927. // a challenge missing either can't produce a usable Authorization header.
  8928. // Treat it the same as no Digest challenge at all.
  8929. return found_digest && auth.find("realm") != auth.end() &&
  8930. auth.find("nonce") != auth.end();
  8931. }
  8932. class ContentProviderAdapter {
  8933. public:
  8934. explicit ContentProviderAdapter(
  8935. ContentProviderWithoutLength &&content_provider)
  8936. : content_provider_(std::move(content_provider)) {}
  8937. bool operator()(size_t offset, size_t, DataSink &sink) {
  8938. return content_provider_(offset, sink);
  8939. }
  8940. private:
  8941. ContentProviderWithoutLength content_provider_;
  8942. };
  8943. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8944. namespace fields {
  8945. inline bool is_token_char(char c) {
  8946. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8947. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8948. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8949. }
  8950. inline bool is_token(const std::string &s) {
  8951. if (s.empty()) { return false; }
  8952. for (auto c : s) {
  8953. if (!is_token_char(c)) { return false; }
  8954. }
  8955. return true;
  8956. }
  8957. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8958. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8959. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8960. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8961. inline bool is_field_content(const std::string &s) {
  8962. if (s.empty()) { return true; }
  8963. if (s.size() == 1) {
  8964. return is_field_vchar(s[0]);
  8965. } else if (s.size() == 2) {
  8966. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8967. } else {
  8968. size_t i = 0;
  8969. if (!is_field_vchar(s[i])) { return false; }
  8970. i++;
  8971. while (i < s.size() - 1) {
  8972. auto c = s[i++];
  8973. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8974. } else {
  8975. return false;
  8976. }
  8977. }
  8978. return is_field_vchar(s[i]);
  8979. }
  8980. }
  8981. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8982. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8983. return is_field_name(name) && is_field_value(value);
  8984. }
  8985. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8986. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8987. inline bool is_request_target(const std::string &s) {
  8988. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8989. }
  8990. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8991. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8992. inline bool is_host(const std::string &s) {
  8993. return std::all_of(s.begin(), s.end(), [](char c) {
  8994. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8995. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8996. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8997. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8998. });
  8999. }
  9000. } // namespace fields
  9001. // Built in memory first, like ClientImpl::write_request, so a rejected header
  9002. // never leaves a partial request on the wire.
  9003. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  9004. BufferStream bstrm;
  9005. if (write_request_line(bstrm, req.method, req.path) < 0) {
  9006. error = Error::Write;
  9007. return false;
  9008. }
  9009. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  9010. return false;
  9011. }
  9012. const auto &data = bstrm.get_buffer();
  9013. if (!write_data(strm, data.data(), data.size())) {
  9014. error = Error::Write;
  9015. return false;
  9016. }
  9017. return true;
  9018. }
  9019. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9020. WebSocketUpgradeResponse &upgrade) {
  9021. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9022. std::string key_bytes(16, '\0');
  9023. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9024. key_bytes.size());
  9025. auto client_key = base64_encode(key_bytes);
  9026. req.headers.erase("Upgrade");
  9027. req.headers.erase("Connection");
  9028. req.headers.erase("Sec-WebSocket-Key");
  9029. req.headers.erase("Sec-WebSocket-Version");
  9030. req.headers.emplace("Upgrade", "websocket");
  9031. req.headers.emplace("Connection", "Upgrade");
  9032. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9033. req.headers.emplace("Sec-WebSocket-Version", "13");
  9034. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9035. // Verify 101 response and Sec-WebSocket-Accept header
  9036. auto expected_accept = websocket_accept_key(client_key);
  9037. auto offered_subprotocols =
  9038. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9039. return read_websocket_upgrade_response(strm, expected_accept,
  9040. offered_subprotocols, upgrade);
  9041. }
  9042. inline bool is_ip_address(const std::string &host) {
  9043. struct in_addr addr4;
  9044. struct in6_addr addr6;
  9045. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9046. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9047. }
  9048. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9049. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9050. // else, including an address with a zone ID, is returned as it is.
  9051. inline std::string canonical_ip(const std::string &addr) {
  9052. struct in6_addr addr6;
  9053. if (addr.find('%') != std::string::npos ||
  9054. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9055. return addr;
  9056. }
  9057. char buf[INET6_ADDRSTRLEN];
  9058. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9059. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9060. : addr;
  9061. }
  9062. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9063. }
  9064. // `trusted_proxies` holds canonical_ip() spellings.
  9065. inline bool is_trusted_proxy(const std::string &addr,
  9066. const std::vector<std::string> &trusted_proxies) {
  9067. if (trusted_proxies.empty()) { return false; }
  9068. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9069. canonical_ip(addr)) != trusted_proxies.end();
  9070. }
  9071. // Resolve where a client should connect for `host`, honoring a user-supplied
  9072. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9073. // supplying the Host header and SNI; only the connection target changes.
  9074. //
  9075. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9076. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9077. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9078. // absent or empty mapping leaves `host` as the connection target; without the
  9079. // empty check the value would reach getaddrinfo as a null node and silently
  9080. // resolve to loopback.
  9081. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9082. const std::string &host, std::string &connect_host,
  9083. std::string &ip) {
  9084. connect_host = host;
  9085. ip.clear();
  9086. auto it = addr_map.find(host);
  9087. if (it == addr_map.end() || it->second.empty()) { return; }
  9088. if (is_ip_address(it->second)) {
  9089. ip = it->second;
  9090. } else {
  9091. connect_host = it->second;
  9092. }
  9093. }
  9094. } // namespace detail
  9095. /*
  9096. * Group 2: detail namespace - SSL common utilities
  9097. */
  9098. #ifdef CPPHTTPLIB_SSL_ENABLED
  9099. namespace detail {
  9100. class SSLSocketStream final : public Stream {
  9101. public:
  9102. SSLSocketStream(
  9103. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9104. time_t read_timeout_usec, time_t write_timeout_sec,
  9105. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9106. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9107. (std::chrono::steady_clock::time_point::min)());
  9108. ~SSLSocketStream() override;
  9109. bool is_readable() const override;
  9110. bool wait_readable() const override;
  9111. bool wait_writable() const override;
  9112. bool is_peer_alive() const override;
  9113. ssize_t read(char *ptr, size_t size) override;
  9114. ssize_t write(const char *ptr, size_t size) override;
  9115. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9116. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9117. socket_t socket() const override;
  9118. time_t duration() const override;
  9119. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9120. void set_max_timeout(time_t msec) override;
  9121. void set_read_interrupt(std::function<bool()> interrupted) override;
  9122. // See SocketStream::set_readable_hint().
  9123. void set_readable_hint() { readable_hint_ = true; }
  9124. // The error from the last read() or write() that failed in the TLS layer,
  9125. // with code Success if none did
  9126. const tls::TlsError &tls_error() const { return tls_error_; }
  9127. private:
  9128. bool ensure_readable();
  9129. socket_t sock_;
  9130. tls::session_t session_;
  9131. time_t read_timeout_sec_;
  9132. time_t read_timeout_usec_;
  9133. time_t write_timeout_sec_;
  9134. time_t write_timeout_usec_;
  9135. time_t max_timeout_msec_;
  9136. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9137. std::function<bool()> read_interrupted_;
  9138. bool readable_hint_ = false;
  9139. tls::TlsError tls_error_;
  9140. };
  9141. // A TLS stream for WebSocket connections, where the receive path and the
  9142. // send path (application send() plus the heartbeat ping thread) run on
  9143. // different threads. A single TLS session must never be entered
  9144. // concurrently, so every call into the session is serialized by one mutex.
  9145. //
  9146. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9147. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9148. // call under the lock, then waits for readiness with select() outside the
  9149. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9150. // blocked waiting for data never stalls a concurrent sender.
  9151. //
  9152. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9153. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9154. class WebSocketSSLStream final : public Stream {
  9155. public:
  9156. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9157. time_t read_timeout_sec, time_t read_timeout_usec,
  9158. time_t write_timeout_sec, time_t write_timeout_usec);
  9159. ~WebSocketSSLStream() override;
  9160. bool is_readable() const override;
  9161. bool wait_readable() const override;
  9162. bool wait_writable() const override;
  9163. ssize_t read(char *ptr, size_t size) override;
  9164. ssize_t write(const char *ptr, size_t size) override;
  9165. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9166. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9167. socket_t socket() const override;
  9168. time_t duration() const override;
  9169. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9170. void set_read_interrupt(std::function<bool()> interrupted) override;
  9171. private:
  9172. mutable std::mutex session_mutex_;
  9173. socket_t sock_;
  9174. tls::session_t session_;
  9175. // WebSocket::close() shortens the read timeout from the closing thread
  9176. // while the receive thread is inside wait_readable(), so these two are read
  9177. // and written concurrently. The write timeouts are never mutated.
  9178. std::atomic<time_t> read_timeout_sec_;
  9179. std::atomic<time_t> read_timeout_usec_;
  9180. time_t write_timeout_sec_;
  9181. time_t write_timeout_usec_;
  9182. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9183. std::function<bool()> read_interrupted_;
  9184. };
  9185. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9186. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9187. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9188. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9189. unsigned int hash_length = 0;
  9190. unsigned char hash[EVP_MAX_MD_SIZE];
  9191. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9192. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9193. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9194. std::stringstream ss;
  9195. for (auto i = 0u; i < hash_length; ++i) {
  9196. ss << std::hex << std::setw(2) << std::setfill('0')
  9197. << static_cast<unsigned int>(hash[i]);
  9198. }
  9199. return ss.str();
  9200. }
  9201. inline std::string MD5(const std::string &s) {
  9202. return message_digest(s, EVP_md5());
  9203. }
  9204. inline std::string SHA_256(const std::string &s) {
  9205. return message_digest(s, EVP_sha256());
  9206. }
  9207. inline std::string SHA_512(const std::string &s) {
  9208. return message_digest(s, EVP_sha512());
  9209. }
  9210. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9211. namespace {
  9212. template <size_t N>
  9213. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9214. std::stringstream ss;
  9215. for (size_t i = 0; i < N; ++i) {
  9216. ss << std::hex << std::setw(2) << std::setfill('0')
  9217. << static_cast<unsigned int>(hash[i]);
  9218. }
  9219. return ss.str();
  9220. }
  9221. } // namespace
  9222. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9223. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9224. // initialized once. PSA state is process-global; do not free it.
  9225. inline bool ensure_mbedtls_psa_crypto() {
  9226. static std::once_flag once;
  9227. static bool ok = false;
  9228. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9229. return ok;
  9230. }
  9231. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9232. unsigned char *out, size_t out_size) {
  9233. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9234. size_t olen = 0;
  9235. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9236. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9237. olen == out_size;
  9238. }
  9239. #endif
  9240. inline std::string MD5(const std::string &s) {
  9241. unsigned char hash[16];
  9242. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9243. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9244. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9245. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9246. hash);
  9247. #else
  9248. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9249. hash);
  9250. #endif
  9251. return hash_to_hex(hash);
  9252. }
  9253. inline std::string SHA_256(const std::string &s) {
  9254. unsigned char hash[32];
  9255. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9256. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9257. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9258. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9259. hash, 0);
  9260. #else
  9261. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9262. s.size(), hash, 0);
  9263. #endif
  9264. return hash_to_hex(hash);
  9265. }
  9266. inline std::string SHA_512(const std::string &s) {
  9267. unsigned char hash[64];
  9268. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9269. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9270. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9271. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9272. hash, 0);
  9273. #else
  9274. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9275. s.size(), hash, 0);
  9276. #endif
  9277. return hash_to_hex(hash);
  9278. }
  9279. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9280. namespace {
  9281. template <size_t N>
  9282. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9283. std::stringstream ss;
  9284. for (size_t i = 0; i < N; ++i) {
  9285. ss << std::hex << std::setw(2) << std::setfill('0')
  9286. << static_cast<unsigned int>(hash[i]);
  9287. }
  9288. return ss.str();
  9289. }
  9290. } // namespace
  9291. inline std::string MD5(const std::string &s) {
  9292. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9293. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9294. static_cast<word32>(s.size()), hash);
  9295. return hash_to_hex(hash);
  9296. }
  9297. inline std::string SHA_256(const std::string &s) {
  9298. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9299. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9300. static_cast<word32>(s.size()), hash);
  9301. return hash_to_hex(hash);
  9302. }
  9303. inline std::string SHA_512(const std::string &s) {
  9304. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9305. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9306. static_cast<word32>(s.size()), hash);
  9307. return hash_to_hex(hash);
  9308. }
  9309. #endif
  9310. template <typename T>
  9311. inline bool process_server_socket_ssl(
  9312. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9313. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9314. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9315. time_t write_timeout_usec, T callback) {
  9316. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9317. // of a pipelined request, which keep_alive() cannot see on the socket.
  9318. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9319. write_timeout_sec, write_timeout_usec);
  9320. return process_server_socket_core(
  9321. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9322. [&]() { return strm.is_readable(); },
  9323. [&](bool socket_readable, bool close_connection,
  9324. bool &connection_closed) {
  9325. if (socket_readable) { strm.set_readable_hint(); }
  9326. return callback(strm, close_connection, connection_closed);
  9327. });
  9328. }
  9329. template <typename T>
  9330. inline bool process_client_socket_ssl(
  9331. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9332. time_t read_timeout_usec, time_t write_timeout_sec,
  9333. time_t write_timeout_usec, time_t max_timeout_msec,
  9334. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9335. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9336. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9337. start_time);
  9338. return callback(strm);
  9339. }
  9340. // `uri` is req's request-target in origin form, as curl sends it, also when
  9341. // the request line carries the absolute form for a proxy.
  9342. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9343. const Request &req, const std::string &uri,
  9344. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9345. const std::string &cnonce, const std::string &username,
  9346. const std::string &password, bool is_proxy = false) {
  9347. std::string nc;
  9348. {
  9349. std::stringstream ss;
  9350. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9351. nc = ss.str();
  9352. }
  9353. std::string qop;
  9354. if (auth.find("qop") != auth.end()) {
  9355. qop = auth.at("qop");
  9356. if (qop.find("auth-int") != std::string::npos) {
  9357. qop = "auth-int";
  9358. } else if (qop.find("auth") != std::string::npos) {
  9359. qop = "auth";
  9360. } else {
  9361. qop.clear();
  9362. }
  9363. }
  9364. std::string algo = "MD5";
  9365. if (auth.find("algorithm") != auth.end()) {
  9366. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9367. // not a token would otherwise be emitted verbatim and could carry commas
  9368. // or quotes that inject further auth-params into the header below.
  9369. const auto &a = auth.at("algorithm");
  9370. if (fields::is_token(a)) { algo = a; }
  9371. }
  9372. std::string response;
  9373. {
  9374. auto H = algo == "SHA-256" ? detail::SHA_256
  9375. : algo == "SHA-512" ? detail::SHA_512
  9376. : detail::MD5;
  9377. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9378. auto A2 = req.method + ":" + uri;
  9379. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9380. if (qop.empty()) {
  9381. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9382. } else {
  9383. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9384. ":" + qop + ":" + H(A2));
  9385. }
  9386. }
  9387. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9388. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9389. // close the string early. realm, nonce and opaque come straight from the
  9390. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9391. // without this a crafted challenge injects extra auth-params into the header.
  9392. auto field =
  9393. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9394. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9395. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9396. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9397. "\", algorithm=" + algo +
  9398. (qop.empty() ? ", response=\""
  9399. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9400. "\", response=\"") +
  9401. response + "\"" +
  9402. (opaque.empty()
  9403. ? ""
  9404. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9405. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9406. return std::make_pair(key, field);
  9407. }
  9408. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9409. // backend accepts the same names.
  9410. inline bool match_hostname(const std::string &pattern,
  9411. const std::string &hostname) {
  9412. // A trailing dot on the host is ignored
  9413. auto host = hostname;
  9414. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9415. // Exact match (case-insensitive)
  9416. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9417. // Split both pattern and hostname into components by '.', keeping any empty
  9418. // one, which no name may have
  9419. auto labels = [](const std::string &s) {
  9420. std::vector<std::string> v;
  9421. size_t b = 0;
  9422. while (true) {
  9423. auto e = s.find('.', b);
  9424. v.push_back(s.substr(b, e - b));
  9425. if (e == std::string::npos) { return v; }
  9426. b = e + 1;
  9427. }
  9428. };
  9429. auto pattern_components = labels(pattern);
  9430. auto host_components = labels(host);
  9431. auto has_empty_label = [](const std::vector<std::string> &v) {
  9432. return std::any_of(v.begin(), v.end(),
  9433. [](const std::string &l) { return l.empty(); });
  9434. };
  9435. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9436. return false;
  9437. }
  9438. // Component count must match
  9439. if (host_components.size() != pattern_components.size()) { return false; }
  9440. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9441. // and an IDNA label may not have one
  9442. const auto &leftmost = pattern_components.front();
  9443. if (leftmost.find('*') != std::string::npos &&
  9444. (pattern_components.size() < 3 ||
  9445. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9446. return false;
  9447. }
  9448. // Compare each component with wildcard support
  9449. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9450. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9451. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9452. auto itr = pattern_components.begin();
  9453. for (const auto &h : host_components) {
  9454. auto &p = *itr;
  9455. auto is_leftmost = itr == pattern_components.begin();
  9456. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9457. bool partial_match = false;
  9458. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9459. const auto prefix_length = p.size() - 1;
  9460. if (prefix_length == 0) {
  9461. partial_match = true;
  9462. } else if (h.size() >= prefix_length) {
  9463. partial_match =
  9464. std::equal(p.begin(),
  9465. p.begin() + static_cast<std::string::difference_type>(
  9466. prefix_length),
  9467. h.begin(), [](const char ca, const char cb) {
  9468. return detail::case_ignore::to_lower(ca) ==
  9469. detail::case_ignore::to_lower(cb);
  9470. });
  9471. }
  9472. }
  9473. if (!partial_match) { return false; }
  9474. }
  9475. ++itr;
  9476. }
  9477. return true;
  9478. }
  9479. #ifdef _WIN32
  9480. // Verify certificate using Windows CertGetCertificateChain API.
  9481. // This provides real-time certificate validation with Windows Update
  9482. // integration, independent of the TLS backend.
  9483. inline bool verify_cert_with_windows_schannel(
  9484. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9485. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9486. if (der_cert.empty()) { return false; }
  9487. out_error = 0;
  9488. // Create Windows certificate context from DER data
  9489. auto cert_context = CertCreateCertificateContext(
  9490. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9491. static_cast<DWORD>(der_cert.size()));
  9492. if (!cert_context) {
  9493. out_error = GetLastError();
  9494. return false;
  9495. }
  9496. auto cert_guard =
  9497. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9498. // Give CryptoAPI the certificates the server sent. Without them it follows
  9499. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9500. std::vector<tls::cert_t> peer_certs;
  9501. tls::get_peer_certs(session, peer_certs);
  9502. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9503. auto store_guard = scope_exit([&] {
  9504. for (auto cert : peer_certs) {
  9505. tls::free_cert(cert);
  9506. }
  9507. if (store) { CertCloseStore(store, 0); }
  9508. });
  9509. for (auto cert : peer_certs) {
  9510. std::vector<unsigned char> der;
  9511. if (store && tls::get_cert_der(cert, der)) {
  9512. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9513. static_cast<DWORD>(der.size()),
  9514. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9515. }
  9516. }
  9517. // Setup chain parameters
  9518. CERT_CHAIN_PARA chain_para = {};
  9519. chain_para.cbSize = sizeof(chain_para);
  9520. // Require the server authentication usage along the chain, which also
  9521. // rejects roots that Windows trusts only for other purposes.
  9522. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9523. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9524. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9525. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9526. // Build certificate chain with revocation checking
  9527. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9528. auto chain_result = CertGetCertificateChain(
  9529. nullptr, cert_context, nullptr, store, &chain_para,
  9530. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9531. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9532. nullptr, &chain_context);
  9533. if (!chain_result || !chain_context) {
  9534. out_error = GetLastError();
  9535. return false;
  9536. }
  9537. auto chain_guard =
  9538. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9539. // Verify SSL policy
  9540. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9541. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9542. #ifdef AUTHTYPE_SERVER
  9543. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9544. #endif
  9545. std::wstring whost;
  9546. if (verify_hostname) {
  9547. whost = u8string_to_wstring(hostname.c_str());
  9548. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9549. }
  9550. CERT_CHAIN_POLICY_PARA policy_para = {};
  9551. policy_para.cbSize = sizeof(policy_para);
  9552. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9553. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9554. #else
  9555. policy_para.dwFlags = 0;
  9556. #endif
  9557. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9558. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9559. policy_status.cbSize = sizeof(policy_status);
  9560. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9561. &policy_para, &policy_status)) {
  9562. out_error = GetLastError();
  9563. return false;
  9564. }
  9565. if (policy_status.dwError != 0) {
  9566. out_error = policy_status.dwError;
  9567. return false;
  9568. }
  9569. return true;
  9570. }
  9571. #endif // _WIN32
  9572. // Loads CA file/dir configuration and applies the system CA policy to a
  9573. // client TLS context. PEM data and native stores are applied to the context
  9574. // directly at set time; has_custom_store reflects them for the Auto policy
  9575. // decision.
  9576. inline bool load_client_ca_config(tls::ctx_t ctx,
  9577. const std::string &ca_cert_file_path,
  9578. const std::string &ca_cert_dir_path,
  9579. bool has_custom_store, SystemCAMode mode,
  9580. uint64_t &backend_error) {
  9581. auto ret = true;
  9582. if (!ca_cert_file_path.empty()) {
  9583. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9584. backend_error = tls::get_error();
  9585. ret = false;
  9586. }
  9587. } else if (!ca_cert_dir_path.empty()) {
  9588. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9589. backend_error = tls::get_error();
  9590. ret = false;
  9591. }
  9592. }
  9593. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9594. !ca_cert_dir_path.empty() || has_custom_store;
  9595. if (mode == SystemCAMode::Enabled ||
  9596. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9597. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9598. }
  9599. return ret;
  9600. }
  9601. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9602. // loaded into another context.
  9603. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9604. std::string pem;
  9605. std::vector<tls::cert_t> certs;
  9606. tls::get_ca_certs(ctx, certs);
  9607. for (auto cert : certs) {
  9608. std::vector<unsigned char> der;
  9609. if (tls::get_cert_der(cert, der)) {
  9610. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9611. pem += "-----BEGIN CERTIFICATE-----\n";
  9612. for (size_t i = 0; i < b64.size(); i += 64) {
  9613. pem += b64.substr(i, 64);
  9614. pem += '\n';
  9615. }
  9616. pem += "-----END CERTIFICATE-----\n";
  9617. }
  9618. tls::free_cert(cert);
  9619. }
  9620. return pem;
  9621. }
  9622. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9623. // copied to buf, or pem itself when len is 0.
  9624. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9625. if (!pem || len == 0) { return pem; }
  9626. buf.assign(pem, len);
  9627. return buf.c_str();
  9628. }
  9629. // The parts of session setup that only SSLClient needs, plus the handful
  9630. // WebSocketClient also exposes; everything else takes the defaults, which is
  9631. // what keeps the two clients on one implementation.
  9632. struct ClientTlsSessionOptions {
  9633. // Both SSLClient and WebSocketClient expose this independently of
  9634. // certificate verification.
  9635. bool server_hostname_verification = true;
  9636. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9637. // When non-null, guards session creation against concurrent use of the
  9638. // context. A WebSocketClient is not safe to use from several threads to
  9639. // begin with, so it passes nothing.
  9640. std::mutex *ctx_mutex = nullptr;
  9641. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9642. // The caller decides whether Schannel has anything to say about this
  9643. // connection; see SSLClient::initialize_ssl().
  9644. bool windows_cert_verification = false;
  9645. // A server certificate verifier works on the backend's chain verification,
  9646. // so the backend keeps deciding and Schannel only adds its own check.
  9647. bool server_certificate_verifier_set = false;
  9648. #endif
  9649. };
  9650. // Filled in on failure for callers that report error details.
  9651. struct ClientTlsSessionError {
  9652. Error error = Error::Success;
  9653. int ssl_error = 0;
  9654. uint64_t backend_error = 0;
  9655. };
  9656. // Establishes a client TLS session on an already connected socket. On failure
  9657. // the session is left for the caller to free: SSLClient frees it right away,
  9658. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9659. inline bool setup_client_tls_session(
  9660. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9661. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9662. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9663. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9664. using namespace tls;
  9665. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9666. if (out_error) {
  9667. out_error->error = error;
  9668. out_error->ssl_error = ssl_error;
  9669. out_error->backend_error = backend_error;
  9670. }
  9671. return false;
  9672. };
  9673. // A TLS failure, whose verification codes name the Error too
  9674. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9675. auto error = Error::SSLConnection;
  9676. if (code == ErrorCode::CertVerifyFailed) {
  9677. error = Error::SSLServerVerification;
  9678. } else if (code == ErrorCode::HostnameMismatch) {
  9679. error = Error::SSLServerHostnameVerification;
  9680. }
  9681. return fail(error, static_cast<int>(code), backend_error);
  9682. };
  9683. if (!ctx) {
  9684. session = nullptr;
  9685. return fail(Error::SSLConnection, 0, 0);
  9686. }
  9687. // With Windows verification on and no server certificate verifier set,
  9688. // Schannel is the only chain verifier. The backend's trust store is a
  9689. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9690. // demand, so the backend's verdict is not used.
  9691. auto windows_verifies_chain = false;
  9692. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9693. windows_verifies_chain = options.windows_cert_verification &&
  9694. !options.server_certificate_verifier_set;
  9695. #endif
  9696. // The chain, and a host name, are verified during the handshake, so that a
  9697. // server failing them never gets to see a client certificate. Unless
  9698. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9699. // identity is checked after the handshake by verify_hostname().
  9700. auto verify_in_handshake =
  9701. server_certificate_verification && !windows_verifies_chain;
  9702. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9703. // A session verifier may accept a certificate the built-in check rejects,
  9704. // and runs only after the handshake
  9705. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9706. #endif
  9707. {
  9708. std::unique_lock<std::mutex> guard;
  9709. if (options.ctx_mutex) {
  9710. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9711. }
  9712. // The mode is set on the context, so under the same lock
  9713. set_verify_client(ctx, verify_in_handshake);
  9714. session = create_session(ctx, sock);
  9715. }
  9716. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9717. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9718. // their identity is checked post-handshake below instead.
  9719. if (!is_ip_address(host)) {
  9720. if (!set_sni(session, host.c_str(),
  9721. verify_in_handshake && options.server_hostname_verification)) {
  9722. return fail(Error::SSLConnection, 0, get_error());
  9723. }
  9724. }
  9725. TlsError tls_err;
  9726. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9727. &tls_err)) {
  9728. return fail_tls(tls_err.code, tls_err.backend_code);
  9729. }
  9730. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9731. if (options.session_verifier) {
  9732. verification_status = options.session_verifier(session);
  9733. }
  9734. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9735. return fail(Error::SSLServerVerification, 0, get_error());
  9736. }
  9737. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9738. server_certificate_verification) {
  9739. if (!windows_verifies_chain) {
  9740. auto verify_result = get_verify_result(session);
  9741. if (verify_result != 0) {
  9742. return fail_tls(ErrorCode::CertVerifyFailed,
  9743. static_cast<uint64_t>(verify_result));
  9744. }
  9745. }
  9746. auto server_cert = get_peer_cert(session);
  9747. if (!server_cert) {
  9748. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9749. }
  9750. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9751. // Identity check against the peer certificate, post-handshake for all
  9752. // backends. For IP hosts this is the only identity verification, since no
  9753. // hostname is bound during the handshake.
  9754. if (options.server_hostname_verification) {
  9755. if (!verify_hostname(server_cert, host.c_str())) {
  9756. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9757. }
  9758. }
  9759. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9760. // Windows Schannel verification, which lets Windows fetch missing roots
  9761. // and intermediates on demand. It must not be skipped: unless a server
  9762. // certificate verifier is set, it is the only chain check.
  9763. if (options.windows_cert_verification) {
  9764. std::vector<unsigned char> der;
  9765. uint64_t wincrypt_error = 0;
  9766. if (!get_cert_der(server_cert, der) ||
  9767. !verify_cert_with_windows_schannel(
  9768. der, host, options.server_hostname_verification, wincrypt_error,
  9769. session)) {
  9770. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9771. }
  9772. }
  9773. #endif
  9774. }
  9775. return true;
  9776. }
  9777. } // namespace detail
  9778. #endif // CPPHTTPLIB_SSL_ENABLED
  9779. /*
  9780. * Group 3: httplib namespace - Non-SSL public API implementations
  9781. */
  9782. inline void default_socket_options(socket_t sock) {
  9783. set_socket_opt(sock, SOL_SOCKET,
  9784. #ifdef SO_REUSEPORT
  9785. SO_REUSEPORT,
  9786. #else
  9787. SO_REUSEADDR,
  9788. #endif
  9789. 1);
  9790. }
  9791. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9792. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9793. sizeof(optval));
  9794. }
  9795. inline std::string get_bearer_token_auth(const Request &req) {
  9796. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9797. // than the prefix carries no token.
  9798. constexpr const char bearer_prefix[] = "Bearer ";
  9799. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9800. auto value = req.get_header_value("Authorization");
  9801. if (value.size() >= bearer_prefix_len &&
  9802. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9803. bearer_prefix)) {
  9804. return value.substr(bearer_prefix_len);
  9805. }
  9806. return "";
  9807. }
  9808. inline const char *status_message(int status) {
  9809. switch (status) {
  9810. case StatusCode::Continue_100: return "Continue";
  9811. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9812. case StatusCode::Processing_102: return "Processing";
  9813. case StatusCode::EarlyHints_103: return "Early Hints";
  9814. case StatusCode::OK_200: return "OK";
  9815. case StatusCode::Created_201: return "Created";
  9816. case StatusCode::Accepted_202: return "Accepted";
  9817. case StatusCode::NonAuthoritativeInformation_203:
  9818. return "Non-Authoritative Information";
  9819. case StatusCode::NoContent_204: return "No Content";
  9820. case StatusCode::ResetContent_205: return "Reset Content";
  9821. case StatusCode::PartialContent_206: return "Partial Content";
  9822. case StatusCode::MultiStatus_207: return "Multi-Status";
  9823. case StatusCode::AlreadyReported_208: return "Already Reported";
  9824. case StatusCode::IMUsed_226: return "IM Used";
  9825. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9826. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9827. case StatusCode::Found_302: return "Found";
  9828. case StatusCode::SeeOther_303: return "See Other";
  9829. case StatusCode::NotModified_304: return "Not Modified";
  9830. case StatusCode::UseProxy_305: return "Use Proxy";
  9831. case StatusCode::unused_306: return "unused";
  9832. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9833. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9834. case StatusCode::BadRequest_400: return "Bad Request";
  9835. case StatusCode::Unauthorized_401: return "Unauthorized";
  9836. case StatusCode::PaymentRequired_402: return "Payment Required";
  9837. case StatusCode::Forbidden_403: return "Forbidden";
  9838. case StatusCode::NotFound_404: return "Not Found";
  9839. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9840. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9841. case StatusCode::ProxyAuthenticationRequired_407:
  9842. return "Proxy Authentication Required";
  9843. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9844. case StatusCode::Conflict_409: return "Conflict";
  9845. case StatusCode::Gone_410: return "Gone";
  9846. case StatusCode::LengthRequired_411: return "Length Required";
  9847. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9848. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9849. case StatusCode::UriTooLong_414: return "URI Too Long";
  9850. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9851. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9852. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9853. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9854. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9855. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9856. case StatusCode::Locked_423: return "Locked";
  9857. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9858. case StatusCode::TooEarly_425: return "Too Early";
  9859. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9860. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9861. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9862. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9863. return "Request Header Fields Too Large";
  9864. case StatusCode::UnavailableForLegalReasons_451:
  9865. return "Unavailable For Legal Reasons";
  9866. case StatusCode::NotImplemented_501: return "Not Implemented";
  9867. case StatusCode::BadGateway_502: return "Bad Gateway";
  9868. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9869. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9870. case StatusCode::HttpVersionNotSupported_505:
  9871. return "HTTP Version Not Supported";
  9872. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9873. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9874. case StatusCode::LoopDetected_508: return "Loop Detected";
  9875. case StatusCode::NotExtended_510: return "Not Extended";
  9876. case StatusCode::NetworkAuthenticationRequired_511:
  9877. return "Network Authentication Required";
  9878. default:
  9879. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9880. }
  9881. }
  9882. inline std::string to_string(const Error error) {
  9883. switch (error) {
  9884. case Error::Success: return "Success (no error)";
  9885. case Error::Unknown: return "Unknown";
  9886. case Error::Connection: return "Could not establish connection";
  9887. case Error::BindIPAddress: return "Failed to bind IP address";
  9888. case Error::Read: return "Failed to read connection";
  9889. case Error::Write: return "Failed to write connection";
  9890. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9891. case Error::Canceled: return "Connection handling canceled";
  9892. case Error::SSLConnection: return "SSL connection failed";
  9893. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9894. case Error::SSLServerVerification: return "SSL server verification failed";
  9895. case Error::SSLServerHostnameVerification:
  9896. return "SSL server hostname verification failed";
  9897. case Error::UnsupportedMultipartBoundaryChars:
  9898. return "Unsupported HTTP multipart boundary characters";
  9899. case Error::Compression: return "Compression failed";
  9900. case Error::ConnectionTimeout: return "Connection timed out";
  9901. case Error::ProxyConnection: return "Proxy connection failed";
  9902. case Error::ConnectionClosed: return "Connection closed by server";
  9903. case Error::Timeout: return "Read timeout";
  9904. case Error::ResourceExhaustion: return "Resource exhaustion";
  9905. case Error::TooManyFormDataFiles: return "Too many form data files";
  9906. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9907. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9908. case Error::ExceedMaxSocketDescriptorCount:
  9909. return "Exceeded maximum socket descriptor count";
  9910. case Error::InvalidRequestLine: return "Invalid request line";
  9911. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9912. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9913. case Error::InvalidHeaders: return "Invalid headers";
  9914. case Error::MultipartParsing: return "Multipart parsing failed";
  9915. case Error::OpenFile: return "Failed to open file";
  9916. case Error::Listen: return "Failed to listen on socket";
  9917. case Error::GetSockName: return "Failed to get socket name";
  9918. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9919. case Error::HTTPParsing: return "HTTP parsing failed";
  9920. case Error::InvalidRangeHeader: return "Invalid Range header";
  9921. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9922. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9923. case Error::UserCallbackException: return "User callback threw an exception";
  9924. default: break;
  9925. }
  9926. return "Invalid";
  9927. }
  9928. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9929. os << to_string(obj);
  9930. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9931. return os;
  9932. }
  9933. inline std::string hosted_at(const std::string &hostname) {
  9934. std::vector<std::string> addrs;
  9935. hosted_at(hostname, addrs);
  9936. if (addrs.empty()) { return std::string(); }
  9937. return addrs[0];
  9938. }
  9939. inline void hosted_at(const std::string &hostname,
  9940. std::vector<std::string> &addrs) {
  9941. struct addrinfo hints;
  9942. struct addrinfo *result;
  9943. memset(&hints, 0, sizeof(struct addrinfo));
  9944. hints.ai_family = AF_UNSPEC;
  9945. hints.ai_socktype = SOCK_STREAM;
  9946. hints.ai_protocol = 0;
  9947. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9948. &result, 0)) {
  9949. #if defined __linux__ && !defined __ANDROID__
  9950. res_init();
  9951. #endif
  9952. return;
  9953. }
  9954. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9955. for (auto rp = result; rp; rp = rp->ai_next) {
  9956. const auto &addr =
  9957. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9958. std::string ip;
  9959. auto dummy = -1;
  9960. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9961. dummy)) {
  9962. addrs.emplace_back(std::move(ip));
  9963. }
  9964. }
  9965. }
  9966. inline std::string encode_uri_component(const std::string &value) {
  9967. std::ostringstream escaped;
  9968. escaped.fill('0');
  9969. escaped << std::hex;
  9970. for (auto c : value) {
  9971. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9972. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9973. escaped << c;
  9974. } else {
  9975. escaped << std::uppercase;
  9976. escaped << '%' << std::setw(2)
  9977. << static_cast<int>(static_cast<unsigned char>(c));
  9978. escaped << std::nouppercase;
  9979. }
  9980. }
  9981. return escaped.str();
  9982. }
  9983. inline std::string encode_uri(const std::string &value) {
  9984. std::ostringstream escaped;
  9985. escaped.fill('0');
  9986. escaped << std::hex;
  9987. for (auto c : value) {
  9988. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9989. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9990. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9991. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9992. escaped << c;
  9993. } else {
  9994. escaped << std::uppercase;
  9995. escaped << '%' << std::setw(2)
  9996. << static_cast<int>(static_cast<unsigned char>(c));
  9997. escaped << std::nouppercase;
  9998. }
  9999. }
  10000. return escaped.str();
  10001. }
  10002. inline std::string decode_uri_component(const std::string &value) {
  10003. std::string result;
  10004. for (size_t i = 0; i < value.size(); i++) {
  10005. if (value[i] == '%' && i + 2 < value.size()) {
  10006. auto val = 0;
  10007. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10008. result += static_cast<char>(val);
  10009. i += 2;
  10010. } else {
  10011. result += value[i];
  10012. }
  10013. } else {
  10014. result += value[i];
  10015. }
  10016. }
  10017. return result;
  10018. }
  10019. inline std::string decode_uri(const std::string &value) {
  10020. std::string result;
  10021. for (size_t i = 0; i < value.size(); i++) {
  10022. if (value[i] == '%' && i + 2 < value.size()) {
  10023. auto val = 0;
  10024. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10025. auto c = static_cast<char>(val);
  10026. // Keep escapes of the reserved characters that encode_uri leaves
  10027. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10028. // delimiter is not promoted into a real one (as with JS decodeURI).
  10029. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10030. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10031. c == '#') {
  10032. result += value[i];
  10033. result += value[i + 1];
  10034. result += value[i + 2];
  10035. } else {
  10036. result += c;
  10037. }
  10038. i += 2;
  10039. } else {
  10040. result += value[i];
  10041. }
  10042. } else {
  10043. result += value[i];
  10044. }
  10045. }
  10046. return result;
  10047. }
  10048. inline std::string encode_path_component(const std::string &component) {
  10049. std::string result;
  10050. result.reserve(component.size() * 3);
  10051. for (size_t i = 0; i < component.size(); i++) {
  10052. auto c = static_cast<unsigned char>(component[i]);
  10053. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10054. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10055. c == '_' || c == '~') {
  10056. result += static_cast<char>(c);
  10057. }
  10058. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10059. // "," / ";" / "="
  10060. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10061. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10062. c == '=') {
  10063. result += static_cast<char>(c);
  10064. }
  10065. // Colon is allowed in path segments except first segment
  10066. else if (c == ':') {
  10067. result += static_cast<char>(c);
  10068. }
  10069. // @ is allowed in path
  10070. else if (c == '@') {
  10071. result += static_cast<char>(c);
  10072. } else {
  10073. result += '%';
  10074. char hex[3];
  10075. snprintf(hex, sizeof(hex), "%02X", c);
  10076. result.append(hex, 2);
  10077. }
  10078. }
  10079. return result;
  10080. }
  10081. inline std::string decode_path_component(const std::string &component) {
  10082. std::string result;
  10083. result.reserve(component.size());
  10084. for (size_t i = 0; i < component.size(); i++) {
  10085. if (component[i] == '%' && i + 1 < component.size()) {
  10086. if (component[i + 1] == 'u') {
  10087. // Unicode %uXXXX encoding
  10088. auto val = 0;
  10089. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10090. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10091. char buff[4];
  10092. size_t len = 0;
  10093. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10094. (len = detail::to_utf8(val, buff)) > 0) {
  10095. result.append(buff, len);
  10096. i += 5; // 'u0000'
  10097. } else {
  10098. // Not 4 hex digits, or a surrogate, which is no character: the
  10099. // escape is kept as it is rather than joining its neighbours
  10100. result += component[i];
  10101. }
  10102. } else {
  10103. // Standard %XX encoding
  10104. auto val = 0;
  10105. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10106. // 2 digits hex codes
  10107. result += static_cast<char>(val);
  10108. i += 2; // 'XX'
  10109. } else {
  10110. result += component[i];
  10111. }
  10112. }
  10113. } else {
  10114. result += component[i];
  10115. }
  10116. }
  10117. return result;
  10118. }
  10119. inline std::string encode_query_component(const std::string &component,
  10120. bool space_as_plus) {
  10121. std::string result;
  10122. result.reserve(component.size() * 3);
  10123. for (size_t i = 0; i < component.size(); i++) {
  10124. auto c = static_cast<unsigned char>(component[i]);
  10125. // Unreserved characters per RFC 3986
  10126. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10127. c == '_' || c == '~') {
  10128. result += static_cast<char>(c);
  10129. }
  10130. // Space handling
  10131. else if (c == ' ') {
  10132. if (space_as_plus) {
  10133. result += '+';
  10134. } else {
  10135. result += "%20";
  10136. }
  10137. }
  10138. // Plus sign handling
  10139. else if (c == '+') {
  10140. if (space_as_plus) {
  10141. result += "%2B";
  10142. } else {
  10143. result += static_cast<char>(c);
  10144. }
  10145. }
  10146. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10147. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10148. c == '*' || c == ',' || c == ';') {
  10149. result += static_cast<char>(c);
  10150. }
  10151. // Colon and @ are allowed in query
  10152. else if (c == ':' || c == '@') {
  10153. result += static_cast<char>(c);
  10154. }
  10155. // Forward slash is allowed in query values
  10156. else if (c == '/') {
  10157. result += static_cast<char>(c);
  10158. }
  10159. // Question mark is allowed in query values (after first ?)
  10160. else if (c == '?') {
  10161. result += static_cast<char>(c);
  10162. } else {
  10163. result += '%';
  10164. char hex[3];
  10165. snprintf(hex, sizeof(hex), "%02X", c);
  10166. result.append(hex, 2);
  10167. }
  10168. }
  10169. return result;
  10170. }
  10171. inline std::string decode_query_component(const std::string &component,
  10172. bool plus_as_space) {
  10173. std::string result;
  10174. result.reserve(component.size());
  10175. for (size_t i = 0; i < component.size(); i++) {
  10176. if (component[i] == '%' && i + 2 < component.size()) {
  10177. auto val = 0;
  10178. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10179. result += static_cast<char>(val);
  10180. i += 2;
  10181. } else {
  10182. result += component[i];
  10183. }
  10184. } else if (component[i] == '+' && plus_as_space) {
  10185. result += ' '; // + becomes space in form-urlencoded
  10186. } else {
  10187. result += component[i];
  10188. }
  10189. }
  10190. return result;
  10191. }
  10192. inline std::string sanitize_filename(const std::string &filename) {
  10193. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10194. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10195. #ifdef _WIN32
  10196. auto pos = filename.find_last_of("/\\:");
  10197. #else
  10198. auto pos = filename.find_last_of("/\\");
  10199. #endif
  10200. auto result =
  10201. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10202. // Strip null bytes
  10203. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10204. // Trim whitespace
  10205. {
  10206. auto start = result.find_first_not_of(" \t");
  10207. auto end = result.find_last_not_of(" \t");
  10208. result = (start == std::string::npos)
  10209. ? ""
  10210. : result.substr(start, end - start + 1);
  10211. }
  10212. // Reject . and ..
  10213. if (result == "." || result == "..") { return ""; }
  10214. return result;
  10215. }
  10216. inline std::string append_query_params(const std::string &path,
  10217. const Params &params) {
  10218. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10219. auto fragment_pos = path.find('#');
  10220. auto path_with_query = path.substr(0, fragment_pos);
  10221. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10222. path_with_query += detail::params_to_query_str(params);
  10223. if (fragment_pos != std::string::npos) {
  10224. path_with_query.append(path, fragment_pos, std::string::npos);
  10225. }
  10226. return path_with_query;
  10227. }
  10228. // Header utilities
  10229. inline std::pair<std::string, std::string>
  10230. make_range_header(const Ranges &ranges) {
  10231. std::string field = "bytes=";
  10232. auto i = 0;
  10233. for (const auto &r : ranges) {
  10234. if (i != 0) { field += ", "; }
  10235. if (r.first != -1) { field += std::to_string(r.first); }
  10236. field += '-';
  10237. if (r.second != -1) { field += std::to_string(r.second); }
  10238. i++;
  10239. }
  10240. return std::make_pair("Range", std::move(field));
  10241. }
  10242. inline std::pair<std::string, std::string>
  10243. make_basic_authentication_header(const std::string &username,
  10244. const std::string &password, bool is_proxy) {
  10245. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10246. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10247. return std::make_pair(key, std::move(field));
  10248. }
  10249. inline std::pair<std::string, std::string>
  10250. make_bearer_token_authentication_header(const std::string &token,
  10251. bool is_proxy = false) {
  10252. auto field = "Bearer " + token;
  10253. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10254. return std::make_pair(key, std::move(field));
  10255. }
  10256. namespace detail {
  10257. // Basic auth when a username or password is set, otherwise a bearer token,
  10258. // unless the request already carries the header.
  10259. inline void add_authorization_header(Request &req, const std::string &username,
  10260. const std::string &password,
  10261. const std::string &token, bool is_proxy) {
  10262. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10263. return;
  10264. }
  10265. if (!username.empty() || !password.empty()) {
  10266. req.headers.insert(
  10267. make_basic_authentication_header(username, password, is_proxy));
  10268. } else if (!token.empty()) {
  10269. req.headers.insert(
  10270. make_bearer_token_authentication_header(token, is_proxy));
  10271. }
  10272. }
  10273. } // namespace detail
  10274. // Request implementation
  10275. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10276. size_t id) const {
  10277. return detail::get_header_value_u64(headers, key, def, id);
  10278. }
  10279. inline bool Request::has_header(const std::string &key) const {
  10280. return detail::has_header(headers, key);
  10281. }
  10282. inline std::string Request::get_header_value(const std::string &key,
  10283. const char *def, size_t id) const {
  10284. return detail::get_header_value(headers, key, def, id);
  10285. }
  10286. inline size_t Request::get_header_value_count(const std::string &key) const {
  10287. return detail::get_header_value_count(headers, key);
  10288. }
  10289. inline void Request::set_header(const std::string &key,
  10290. const std::string &val) {
  10291. detail::set_header(headers, key, val);
  10292. }
  10293. inline bool Request::has_trailer(const std::string &key) const {
  10294. return trailers.find(key) != trailers.end();
  10295. }
  10296. inline std::string Request::get_trailer_value(const std::string &key,
  10297. size_t id) const {
  10298. return detail::get_multimap_value(trailers, key, id);
  10299. }
  10300. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10301. return trailers.count(key);
  10302. }
  10303. inline bool Request::has_param(const std::string &key) const {
  10304. return params.find(key) != params.end();
  10305. }
  10306. inline std::string Request::get_param_value(const std::string &key,
  10307. size_t id) const {
  10308. return detail::get_multimap_value(params, key, id);
  10309. }
  10310. inline std::vector<std::string>
  10311. Request::get_param_values(const std::string &key) const {
  10312. auto rng = params.equal_range(key);
  10313. std::vector<std::string> values;
  10314. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10315. for (auto it = rng.first; it != rng.second; ++it) {
  10316. values.push_back(it->second);
  10317. }
  10318. return values;
  10319. }
  10320. inline size_t Request::get_param_value_count(const std::string &key) const {
  10321. return params.count(key);
  10322. }
  10323. inline bool Request::is_multipart_form_data() const {
  10324. const auto &content_type = get_header_value("Content-Type");
  10325. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10326. "multipart/form-data");
  10327. }
  10328. // Multipart FormData implementation
  10329. inline std::string MultipartFormData::get_field(const std::string &key,
  10330. size_t id) const {
  10331. auto rng = fields.equal_range(key);
  10332. auto it = detail::bounded_next(rng.first, id, rng.second);
  10333. if (it != rng.second) { return it->second.content; }
  10334. return std::string();
  10335. }
  10336. inline std::vector<std::string>
  10337. MultipartFormData::get_fields(const std::string &key) const {
  10338. std::vector<std::string> values;
  10339. auto rng = fields.equal_range(key);
  10340. for (auto it = rng.first; it != rng.second; it++) {
  10341. values.push_back(it->second.content);
  10342. }
  10343. return values;
  10344. }
  10345. inline bool MultipartFormData::has_field(const std::string &key) const {
  10346. return fields.find(key) != fields.end();
  10347. }
  10348. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10349. return fields.count(key);
  10350. }
  10351. inline FormData MultipartFormData::get_file(const std::string &key,
  10352. size_t id) const {
  10353. return detail::get_multimap_value(files, key, id);
  10354. }
  10355. inline std::vector<FormData>
  10356. MultipartFormData::get_files(const std::string &key) const {
  10357. std::vector<FormData> values;
  10358. auto rng = files.equal_range(key);
  10359. for (auto it = rng.first; it != rng.second; it++) {
  10360. values.push_back(it->second);
  10361. }
  10362. return values;
  10363. }
  10364. inline bool MultipartFormData::has_file(const std::string &key) const {
  10365. return files.find(key) != files.end();
  10366. }
  10367. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10368. return files.count(key);
  10369. }
  10370. // Multipart FormData writer implementation
  10371. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10372. return detail::is_multipart_boundary_chars_valid(boundary);
  10373. }
  10374. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10375. : boundary_(detail::make_multipart_data_boundary()) {}
  10376. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10377. : boundary_(std::move(boundary)) {}
  10378. inline const std::string &MultipartFormDataWriter::boundary() const {
  10379. return boundary_;
  10380. }
  10381. inline std::string MultipartFormDataWriter::content_type() const {
  10382. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10383. }
  10384. inline std::string
  10385. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10386. return detail::serialize_multipart_formdata(items, boundary_);
  10387. }
  10388. inline size_t MultipartFormDataWriter::content_length(
  10389. const UploadFormDataItems &items) const {
  10390. return detail::get_multipart_content_length(items, boundary_);
  10391. }
  10392. inline std::string
  10393. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10394. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10395. }
  10396. inline std::string MultipartFormDataWriter::item_end() {
  10397. return detail::serialize_multipart_formdata_item_end();
  10398. }
  10399. inline std::string MultipartFormDataWriter::finish() const {
  10400. return detail::serialize_multipart_formdata_finish(boundary_);
  10401. }
  10402. // Response implementation
  10403. namespace detail {
  10404. // A response has one content source: `body`, a content provider, or a file.
  10405. // Each content setter calls this so that the one called last wins.
  10406. inline void clear_content_provider(Response &res) {
  10407. auto releaser = std::move(res.content_provider_resource_releaser_);
  10408. auto success = res.content_provider_success_;
  10409. res.content_length_ = 0;
  10410. res.content_provider_ = nullptr;
  10411. res.content_provider_resource_releaser_ = nullptr;
  10412. res.is_chunked_content_provider_ = false;
  10413. res.is_file_content_provider_ = false;
  10414. res.content_provider_success_ = false;
  10415. res.content_coding_ = EncodingType::None;
  10416. res.file_content_path_.clear();
  10417. res.file_content_content_type_.clear();
  10418. if (releaser) { releaser(success); }
  10419. }
  10420. inline void clear_content(Response &res) {
  10421. res.body.clear();
  10422. clear_content_provider(res);
  10423. }
  10424. // The Content-Type of the old content goes with it.
  10425. inline void set_content_type(Response &res, const std::string &content_type) {
  10426. res.headers.erase("Content-Type");
  10427. res.set_header("Content-Type", content_type);
  10428. }
  10429. // `body` is public, so it can be assigned directly after a provider or a file
  10430. // was set. It came last, so it wins.
  10431. inline void prefer_assigned_body(Response &res) {
  10432. if (!res.body.empty() &&
  10433. (res.content_provider_ || !res.file_content_path_.empty())) {
  10434. clear_content_provider(res);
  10435. }
  10436. }
  10437. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10438. inline bool body_allowed_for_status(int status) {
  10439. return status >= 200 && status != StatusCode::NoContent_204 &&
  10440. status != StatusCode::NotModified_304;
  10441. }
  10442. // Only a 206 response is served as a partial representation. range_error()
  10443. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10444. // status would start from an unchecked offset.
  10445. inline bool is_partial_content(const Request &req, const Response &res) {
  10446. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10447. }
  10448. // Sets the Content-Length or Transfer-Encoding framing the body that
  10449. // Server::write_response_core() writes, or closes the connection after a body
  10450. // that has neither. Only the library sets them: one from a handler would go
  10451. // out next to it, or describe some other body.
  10452. inline void set_framing_headers(const Request &req, Response &res,
  10453. const std::string &boundary,
  10454. const std::string &content_type) {
  10455. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10456. auto head_length = req.method == "HEAD"
  10457. ? res.get_header_value("Content-Length")
  10458. : std::string();
  10459. res.headers.erase("Content-Length");
  10460. res.headers.erase("Transfer-Encoding");
  10461. if (!body_allowed_for_status(res.status)) { return; }
  10462. if (res.content_provider_) {
  10463. if (res.content_length_ == 0) {
  10464. if (res.is_chunked_content_provider_) {
  10465. res.set_header("Transfer-Encoding", "chunked");
  10466. } else if (req.method != "HEAD") {
  10467. // RFC 9112 6.3: a body with neither ends where the connection does.
  10468. res.headers.erase("Keep-Alive");
  10469. if (!has_header_token(res.headers, "Connection", "close")) {
  10470. res.set_header("Connection", "close");
  10471. }
  10472. }
  10473. return;
  10474. }
  10475. // The part Server::write_content_with_provider() writes.
  10476. auto length = res.content_length_;
  10477. if (is_partial_content(req, res)) {
  10478. length = req.ranges.size() == 1
  10479. ? get_range_offset_and_length(req.ranges[0], length).second
  10480. : get_multipart_ranges_data_length(req, boundary,
  10481. content_type, length);
  10482. }
  10483. res.set_header("Content-Length", std::to_string(length));
  10484. } else if (!res.body.empty()) {
  10485. res.set_header("Content-Length", std::to_string(res.body.size()));
  10486. } else {
  10487. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10488. }
  10489. }
  10490. } // namespace detail
  10491. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10492. size_t id) const {
  10493. return detail::get_header_value_u64(headers, key, def, id);
  10494. }
  10495. inline bool Response::has_header(const std::string &key) const {
  10496. return headers.find(key) != headers.end();
  10497. }
  10498. inline std::string Response::get_header_value(const std::string &key,
  10499. const char *def,
  10500. size_t id) const {
  10501. return detail::get_header_value(headers, key, def, id);
  10502. }
  10503. inline size_t Response::get_header_value_count(const std::string &key) const {
  10504. return detail::get_header_value_count(headers, key);
  10505. }
  10506. inline void Response::set_header(const std::string &key,
  10507. const std::string &val) {
  10508. detail::set_header(headers, key, val);
  10509. }
  10510. inline bool Response::has_trailer(const std::string &key) const {
  10511. return trailers.find(key) != trailers.end();
  10512. }
  10513. inline std::string Response::get_trailer_value(const std::string &key,
  10514. size_t id) const {
  10515. return detail::get_multimap_value(trailers, key, id);
  10516. }
  10517. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10518. return trailers.count(key);
  10519. }
  10520. inline void Response::set_redirect(const std::string &url, int stat) {
  10521. if (detail::fields::is_field_value(url)) {
  10522. set_header("Location", url);
  10523. if (300 <= stat && stat < 400) {
  10524. this->status = stat;
  10525. } else {
  10526. this->status = StatusCode::Found_302;
  10527. }
  10528. }
  10529. }
  10530. inline void Response::set_content(const char *s, size_t n,
  10531. const std::string &content_type) {
  10532. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10533. detail::clear_content_provider(*this);
  10534. detail::set_content_type(*this, content_type);
  10535. }
  10536. inline void Response::set_content(const std::string &s,
  10537. const std::string &content_type) {
  10538. set_content(s.data(), s.size(), content_type);
  10539. }
  10540. inline void Response::set_content(std::string &&s,
  10541. const std::string &content_type) {
  10542. body = std::move(s);
  10543. detail::clear_content_provider(*this);
  10544. detail::set_content_type(*this, content_type);
  10545. }
  10546. inline void Response::set_content_provider(
  10547. size_t in_length, const std::string &content_type, ContentProvider provider,
  10548. ContentProviderResourceReleaser resource_releaser) {
  10549. detail::clear_content(*this);
  10550. detail::set_content_type(*this, content_type);
  10551. content_length_ = in_length;
  10552. if (in_length > 0) { content_provider_ = std::move(provider); }
  10553. content_provider_resource_releaser_ = std::move(resource_releaser);
  10554. }
  10555. inline void Response::set_content_provider(
  10556. const std::string &content_type, ContentProviderWithoutLength provider,
  10557. ContentProviderResourceReleaser resource_releaser) {
  10558. detail::clear_content(*this);
  10559. detail::set_content_type(*this, content_type);
  10560. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10561. content_provider_resource_releaser_ = std::move(resource_releaser);
  10562. }
  10563. inline void Response::set_chunked_content_provider(
  10564. const std::string &content_type, ContentProviderWithoutLength provider,
  10565. ContentProviderResourceReleaser resource_releaser) {
  10566. set_content_provider(content_type, std::move(provider),
  10567. std::move(resource_releaser));
  10568. is_chunked_content_provider_ = true;
  10569. }
  10570. inline void Response::set_file_content(const std::string &path,
  10571. const std::string &content_type) {
  10572. detail::clear_content(*this);
  10573. headers.erase("Content-Type");
  10574. file_content_path_ = path;
  10575. file_content_content_type_ = content_type;
  10576. }
  10577. inline void Response::set_file_content(const std::string &path) {
  10578. set_file_content(path, std::string());
  10579. }
  10580. // Result implementation
  10581. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10582. size_t def,
  10583. size_t id) const {
  10584. return detail::get_header_value_u64(request_headers_, key, def, id);
  10585. }
  10586. inline bool Result::has_request_header(const std::string &key) const {
  10587. return request_headers_.find(key) != request_headers_.end();
  10588. }
  10589. inline std::string Result::get_request_header_value(const std::string &key,
  10590. const char *def,
  10591. size_t id) const {
  10592. return detail::get_header_value(request_headers_, key, def, id);
  10593. }
  10594. inline size_t
  10595. Result::get_request_header_value_count(const std::string &key) const {
  10596. return request_headers_.count(key);
  10597. }
  10598. // Stream implementation
  10599. inline ssize_t Stream::write(const char *ptr) {
  10600. return write(ptr, strlen(ptr));
  10601. }
  10602. inline ssize_t Stream::write(const std::string &s) {
  10603. return write(s.data(), s.size());
  10604. }
  10605. // BodyReader implementation
  10606. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10607. if (!stream) {
  10608. last_error = Error::Connection;
  10609. return -1;
  10610. }
  10611. if (eof) { return 0; }
  10612. if (!chunked) {
  10613. // Content-Length based reading
  10614. if (has_content_length && bytes_read >= content_length) {
  10615. eof = true;
  10616. return 0;
  10617. }
  10618. auto to_read = len;
  10619. if (has_content_length) {
  10620. auto remaining = content_length - bytes_read;
  10621. to_read = (std::min)(len, remaining);
  10622. }
  10623. auto n = stream->read(buf, to_read);
  10624. // Without Content-Length the body ends when the connection closes
  10625. // (RFC 9112 §6.3); with one, an EOF here came too early
  10626. if (n < 0 || (n == 0 && has_content_length)) {
  10627. last_error = stream->get_error();
  10628. if (last_error == Error::Success) { last_error = Error::Read; }
  10629. }
  10630. if (n <= 0) {
  10631. eof = true;
  10632. return n;
  10633. }
  10634. bytes_read += static_cast<size_t>(n);
  10635. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10636. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10637. last_error = Error::ExceedMaxPayloadSize;
  10638. eof = true;
  10639. return -1;
  10640. }
  10641. return n;
  10642. }
  10643. // Chunked transfer encoding: delegate to shared decoder instance.
  10644. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10645. size_t chunk_offset = 0;
  10646. size_t chunk_total = 0;
  10647. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10648. if (n < 0) {
  10649. last_error = stream->get_error();
  10650. if (last_error == Error::Success) { last_error = Error::Read; }
  10651. eof = true;
  10652. return n;
  10653. }
  10654. if (n == 0) {
  10655. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10656. eof = true;
  10657. return 0;
  10658. }
  10659. bytes_read += static_cast<size_t>(n);
  10660. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10661. last_error = Error::ExceedMaxPayloadSize;
  10662. eof = true;
  10663. return -1;
  10664. }
  10665. return n;
  10666. }
  10667. // ThreadPool implementation
  10668. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10669. time_t idle_timeout_sec)
  10670. : base_thread_count_(n), max_queued_requests_(mqr),
  10671. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10672. shutdown_(false) {
  10673. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10674. if (max_n != 0 && max_n < n) {
  10675. std::string msg = "max_threads must be >= base_threads";
  10676. throw std::invalid_argument(msg);
  10677. }
  10678. #endif
  10679. max_thread_count_ = max_n == 0 ? n : max_n;
  10680. threads_.reserve(base_thread_count_);
  10681. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10682. try {
  10683. #endif
  10684. for (size_t i = 0; i < base_thread_count_; i++) {
  10685. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10686. }
  10687. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10688. } catch (...) {
  10689. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10690. // signal the workers we already spawned to exit and join them so the
  10691. // vector destructor does not see joinable threads (which would call
  10692. // std::terminate). Then rethrow so the caller learns of the failure.
  10693. {
  10694. std::unique_lock<std::mutex> lock(mutex_);
  10695. shutdown_ = true;
  10696. }
  10697. cond_.notify_all();
  10698. for (auto &t : threads_) {
  10699. if (t.joinable()) { t.join(); }
  10700. }
  10701. throw;
  10702. }
  10703. #endif
  10704. }
  10705. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10706. {
  10707. std::unique_lock<std::mutex> lock(mutex_);
  10708. if (shutdown_) { return false; }
  10709. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10710. return false;
  10711. }
  10712. jobs_.push_back(std::move(fn));
  10713. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10714. if (jobs_.size() > idle_thread_count_ &&
  10715. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10716. cleanup_finished_threads();
  10717. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10718. }
  10719. }
  10720. cond_.notify_one();
  10721. return true;
  10722. }
  10723. inline void ThreadPool::shutdown() {
  10724. {
  10725. std::unique_lock<std::mutex> lock(mutex_);
  10726. shutdown_ = true;
  10727. }
  10728. cond_.notify_all();
  10729. for (auto &t : threads_) {
  10730. if (t.joinable()) { t.join(); }
  10731. }
  10732. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10733. // with worker threads that call move_to_finished() concurrently.
  10734. std::list<std::thread> remaining_dynamic;
  10735. {
  10736. std::unique_lock<std::mutex> lock(mutex_);
  10737. remaining_dynamic = std::move(dynamic_threads_);
  10738. }
  10739. for (auto &t : remaining_dynamic) {
  10740. if (t.joinable()) { t.join(); }
  10741. }
  10742. std::unique_lock<std::mutex> lock(mutex_);
  10743. cleanup_finished_threads();
  10744. }
  10745. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10746. // Must be called with mutex_ held
  10747. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10748. if (it->get_id() == id) {
  10749. finished_threads_.push_back(std::move(*it));
  10750. dynamic_threads_.erase(it);
  10751. return;
  10752. }
  10753. }
  10754. }
  10755. inline void ThreadPool::cleanup_finished_threads() {
  10756. // Must be called with mutex_ held
  10757. for (auto &t : finished_threads_) {
  10758. if (t.joinable()) { t.join(); }
  10759. }
  10760. finished_threads_.clear();
  10761. }
  10762. inline void ThreadPool::worker(bool is_dynamic) {
  10763. for (;;) {
  10764. std::function<void()> fn;
  10765. {
  10766. std::unique_lock<std::mutex> lock(mutex_);
  10767. idle_thread_count_++;
  10768. if (is_dynamic) {
  10769. auto has_work =
  10770. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10771. [&] { return !jobs_.empty() || shutdown_; });
  10772. if (!has_work) {
  10773. // Timed out with no work - exit this dynamic thread
  10774. idle_thread_count_--;
  10775. move_to_finished(std::this_thread::get_id());
  10776. break;
  10777. }
  10778. } else {
  10779. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10780. }
  10781. idle_thread_count_--;
  10782. if (shutdown_ && jobs_.empty()) { break; }
  10783. fn = std::move(jobs_.front());
  10784. jobs_.pop_front();
  10785. }
  10786. assert(true == static_cast<bool>(fn));
  10787. fn();
  10788. }
  10789. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10790. !defined(LIBRESSL_VERSION_NUMBER)
  10791. OPENSSL_thread_stop();
  10792. #endif
  10793. }
  10794. /*
  10795. * Group 1 (continued): detail namespace - Stream implementations
  10796. */
  10797. namespace detail {
  10798. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10799. time_t timeout_sec, time_t timeout_usec,
  10800. time_t &actual_timeout_sec,
  10801. time_t &actual_timeout_usec) {
  10802. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10803. auto actual_timeout_msec =
  10804. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10805. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10806. actual_timeout_sec = actual_timeout_msec / 1000;
  10807. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10808. }
  10809. // Socket stream implementation
  10810. inline SocketStream::SocketStream(
  10811. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10812. time_t write_timeout_sec, time_t write_timeout_usec,
  10813. time_t max_timeout_msec,
  10814. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10815. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10816. read_timeout_usec_(read_timeout_usec),
  10817. write_timeout_sec_(write_timeout_sec),
  10818. write_timeout_usec_(write_timeout_usec),
  10819. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10820. read_buff_(read_buff_size_, 0) {}
  10821. inline SocketStream::~SocketStream() = default;
  10822. inline bool SocketStream::is_readable() const {
  10823. return read_buff_off_ < read_buff_content_size_;
  10824. }
  10825. inline bool SocketStream::wait_readable() const {
  10826. if (max_timeout_msec_ <= 0) {
  10827. return select_read_interruptible(sock_, read_timeout_sec_,
  10828. read_timeout_usec_, read_interrupted_) > 0;
  10829. }
  10830. time_t read_timeout_sec;
  10831. time_t read_timeout_usec;
  10832. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10833. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10834. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10835. read_interrupted_) > 0;
  10836. }
  10837. inline bool SocketStream::wait_writable() const {
  10838. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10839. }
  10840. inline bool SocketStream::ensure_readable() {
  10841. if (readable_hint_) {
  10842. readable_hint_ = false;
  10843. return true;
  10844. }
  10845. return wait_readable();
  10846. }
  10847. inline const char *SocketStream::buffered_data(size_t &size) const {
  10848. size = read_buff_content_size_ - read_buff_off_;
  10849. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10850. }
  10851. inline void SocketStream::consume_buffered(size_t size) {
  10852. assert(size <= read_buff_content_size_ - read_buff_off_);
  10853. read_buff_off_ += size;
  10854. }
  10855. inline bool SocketStream::is_peer_alive() const {
  10856. return detail::is_socket_alive(sock_);
  10857. }
  10858. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10859. #ifdef _WIN32
  10860. size =
  10861. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10862. #else
  10863. size = (std::min)(size,
  10864. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10865. #endif
  10866. if (read_buff_off_ < read_buff_content_size_) {
  10867. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10868. if (size <= remaining_size) {
  10869. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10870. read_buff_off_ += size;
  10871. return static_cast<ssize_t>(size);
  10872. } else {
  10873. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10874. read_buff_off_ += remaining_size;
  10875. return static_cast<ssize_t>(remaining_size);
  10876. }
  10877. }
  10878. if (!ensure_readable()) {
  10879. error_ = Error::Timeout;
  10880. return -1;
  10881. }
  10882. read_buff_off_ = 0;
  10883. read_buff_content_size_ = 0;
  10884. if (size < read_buff_size_) {
  10885. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10886. CPPHTTPLIB_RECV_FLAGS);
  10887. if (n <= 0) {
  10888. if (n == 0) {
  10889. error_ = Error::ConnectionClosed;
  10890. } else {
  10891. error_ = Error::Read;
  10892. }
  10893. return n;
  10894. } else if (n <= static_cast<ssize_t>(size)) {
  10895. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10896. return n;
  10897. } else {
  10898. memcpy(ptr, read_buff_.data(), size);
  10899. read_buff_off_ = size;
  10900. read_buff_content_size_ = static_cast<size_t>(n);
  10901. return static_cast<ssize_t>(size);
  10902. }
  10903. } else {
  10904. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10905. if (n <= 0) {
  10906. if (n == 0) {
  10907. error_ = Error::ConnectionClosed;
  10908. } else {
  10909. error_ = Error::Read;
  10910. }
  10911. }
  10912. return n;
  10913. }
  10914. }
  10915. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10916. if (!wait_writable()) { return -1; }
  10917. #if defined(_WIN32) && !defined(_WIN64)
  10918. size =
  10919. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10920. #endif
  10921. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10922. }
  10923. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10924. int &port) const {
  10925. return detail::get_remote_ip_and_port(sock_, ip, port);
  10926. }
  10927. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10928. int &port) const {
  10929. return detail::get_local_ip_and_port(sock_, ip, port);
  10930. }
  10931. inline socket_t SocketStream::socket() const { return sock_; }
  10932. inline time_t SocketStream::duration() const {
  10933. return static_cast<time_t>(
  10934. std::chrono::duration_cast<std::chrono::milliseconds>(
  10935. std::chrono::steady_clock::now() - start_time_)
  10936. .count());
  10937. }
  10938. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10939. read_timeout_sec_ = sec;
  10940. read_timeout_usec_ = usec;
  10941. }
  10942. inline void SocketStream::set_max_timeout(time_t msec) {
  10943. max_timeout_msec_ = msec;
  10944. start_time_ = std::chrono::steady_clock::now();
  10945. }
  10946. inline void
  10947. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  10948. read_interrupted_ = std::move(interrupted);
  10949. }
  10950. // Buffer stream implementation
  10951. inline bool BufferStream::is_readable() const { return true; }
  10952. inline bool BufferStream::wait_readable() const { return true; }
  10953. inline bool BufferStream::wait_writable() const { return true; }
  10954. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10955. #if defined(_MSC_VER) && _MSC_VER < 1910
  10956. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10957. #else
  10958. auto len_read = buffer.copy(ptr, size, position);
  10959. #endif
  10960. position += static_cast<size_t>(len_read);
  10961. return static_cast<ssize_t>(len_read);
  10962. }
  10963. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10964. buffer.append(ptr, size);
  10965. return static_cast<ssize_t>(size);
  10966. }
  10967. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10968. int & /*port*/) const {}
  10969. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10970. int & /*port*/) const {}
  10971. inline socket_t BufferStream::socket() const { return 0; }
  10972. inline time_t BufferStream::duration() const { return 0; }
  10973. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10974. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10975. : MatcherBase(pattern) {
  10976. constexpr const char marker[] = "/:";
  10977. // One past the last ending position of a path param substring
  10978. std::size_t last_param_end = 0;
  10979. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10980. // Needed to ensure that parameter names are unique during matcher
  10981. // construction
  10982. // If exceptions are disabled, only last duplicate path
  10983. // parameter will be set
  10984. std::unordered_set<std::string> param_name_set;
  10985. #endif
  10986. while (true) {
  10987. const auto marker_pos = pattern.find(
  10988. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10989. if (marker_pos == std::string::npos) { break; }
  10990. static_fragments_.push_back(
  10991. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10992. const auto param_name_start = marker_pos + str_len(marker);
  10993. auto sep_pos = pattern.find(separator, param_name_start);
  10994. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10995. auto param_name =
  10996. pattern.substr(param_name_start, sep_pos - param_name_start);
  10997. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10998. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10999. std::string msg = "Encountered path parameter '" + param_name +
  11000. "' multiple times in route pattern '" + pattern + "'.";
  11001. throw std::invalid_argument(msg);
  11002. }
  11003. #endif
  11004. param_names_.push_back(std::move(param_name));
  11005. last_param_end = sep_pos + 1;
  11006. }
  11007. if (last_param_end < pattern.length()) {
  11008. static_fragments_.push_back(pattern.substr(last_param_end));
  11009. }
  11010. }
  11011. inline bool PathParamsMatcher::match(Request &request) const {
  11012. request.matches = std::smatch();
  11013. request.path_params.clear();
  11014. // A pattern without parameters is just a literal path to compare against
  11015. if (param_names_.empty()) { return request.path == pattern(); }
  11016. request.path_params.reserve(param_names_.size());
  11017. // One past the position at which the path matched the pattern last time
  11018. std::size_t starting_pos = 0;
  11019. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11020. const auto &fragment = static_fragments_[i];
  11021. if (starting_pos + fragment.length() > request.path.length()) {
  11022. return false;
  11023. }
  11024. // Avoid unnecessary allocation by using strncmp instead of substr +
  11025. // comparison
  11026. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11027. fragment.length()) != 0) {
  11028. return false;
  11029. }
  11030. starting_pos += fragment.length();
  11031. // Should only happen when we have a static fragment after a param
  11032. // Example: '/users/:id/subscriptions'
  11033. // The 'subscriptions' fragment here does not have a corresponding param
  11034. if (i >= param_names_.size()) { continue; }
  11035. auto sep_pos = request.path.find(separator, starting_pos);
  11036. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11037. const auto &param_name = param_names_[i];
  11038. request.path_params.emplace(
  11039. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11040. // Mark everything up to '/' as matched
  11041. starting_pos = sep_pos + 1;
  11042. }
  11043. // Returns false if the path is longer than the pattern
  11044. return starting_pos >= request.path.length();
  11045. }
  11046. inline bool RegexMatcher::match(Request &request) const {
  11047. request.path_params.clear();
  11048. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11049. // a non-match rather than risking a stack overflow in std::regex_match.
  11050. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11051. return false;
  11052. }
  11053. return std::regex_match(request.path, request.matches, regex_);
  11054. }
  11055. // Enclose IPv6 address in brackets if needed
  11056. inline std::string prepare_host_string(const std::string &host) {
  11057. // Enclose IPv6 address in brackets (but not if already enclosed)
  11058. if (host.find(':') == std::string::npos ||
  11059. (!host.empty() && host[0] == '[')) {
  11060. // IPv4, hostname, or already bracketed IPv6
  11061. return host;
  11062. } else {
  11063. // IPv6 address without brackets
  11064. return "[" + host + "]";
  11065. }
  11066. }
  11067. inline std::string make_host_and_port_string(const std::string &host, int port,
  11068. bool is_ssl) {
  11069. auto result = prepare_host_string(host);
  11070. // Append port if not default
  11071. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11072. ; // do nothing
  11073. } else {
  11074. result += ":" + std::to_string(port);
  11075. }
  11076. return result;
  11077. }
  11078. // Create "host:port" string always including port number (for CONNECT method)
  11079. inline std::string
  11080. make_host_and_port_string_always_port(const std::string &host, int port) {
  11081. return prepare_host_string(host) + ":" + std::to_string(port);
  11082. }
  11083. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11084. inline std::string
  11085. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11086. const std::string &host, int port) {
  11087. std::string connect_host;
  11088. std::string ip;
  11089. apply_addr_map(addr_map, host, connect_host, ip);
  11090. return make_host_and_port_string_always_port(ip.empty() ? connect_host : ip,
  11091. port);
  11092. }
  11093. // Value for the Host header a client sends when the caller supplied none.
  11094. // Only the value: callers decide where in their header list it goes.
  11095. inline std::string make_default_host_header_value(const std::string &host,
  11096. int port, bool is_ssl,
  11097. int address_family) {
  11098. if (address_family == AF_UNIX) { return "localhost"; }
  11099. return make_host_and_port_string(host, port, is_ssl);
  11100. }
  11101. inline void add_default_user_agent_header(Request &req) {
  11102. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11103. if (!req.has_header("User-Agent")) {
  11104. req.set_header("User-Agent",
  11105. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11106. }
  11107. #else
  11108. (void)req;
  11109. #endif
  11110. }
  11111. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11112. NormalizedTarget normalize_target(const std::string &host);
  11113. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11114. bool host_matches_no_proxy(const NormalizedTarget &target,
  11115. const std::vector<NoProxyEntry> &entries);
  11116. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11117. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11118. if (prefix_bits == 0) { return true; }
  11119. int full_bytes = prefix_bits / 8;
  11120. int rem_bits = prefix_bits % 8;
  11121. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11122. static_cast<size_t>(full_bytes)) != 0) {
  11123. return false;
  11124. }
  11125. if (rem_bits == 0) { return true; }
  11126. auto i = static_cast<size_t>(full_bytes);
  11127. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11128. return (ip[i] & mask) == (net[i] & mask);
  11129. }
  11130. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11131. if (token.empty()) { return false; }
  11132. if (token == "*") {
  11133. out.kind = NoProxyKind::Wildcard;
  11134. return true;
  11135. }
  11136. auto slash = token.find('/');
  11137. std::string addr_part =
  11138. (slash == std::string::npos) ? token : token.substr(0, slash);
  11139. std::string prefix_part =
  11140. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11141. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11142. // don't silently treat it as a /32 (or /128).
  11143. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11144. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11145. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11146. // when brackets are present.
  11147. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11148. addr_part.back() == ']';
  11149. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11150. if (!bracketed) {
  11151. struct in_addr v4;
  11152. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11153. int prefix = 32;
  11154. if (!prefix_part.empty() &&
  11155. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11156. prefix)) {
  11157. return false;
  11158. }
  11159. out.kind = NoProxyKind::IPv4Cidr;
  11160. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11161. out.prefix_bits = prefix;
  11162. return true;
  11163. }
  11164. }
  11165. struct in6_addr v6;
  11166. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11167. int prefix = 128;
  11168. if (!prefix_part.empty() &&
  11169. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11170. prefix)) {
  11171. return false;
  11172. }
  11173. out.kind = NoProxyKind::IPv6Cidr;
  11174. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11175. out.prefix_bits = prefix;
  11176. return true;
  11177. }
  11178. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11179. // the entry is malformed — don't fall through to the hostname branch.
  11180. if (bracketed) { return false; }
  11181. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11182. if (slash != std::string::npos) { return false; }
  11183. // Port-specific entries (host:port) are not supported.
  11184. if (token.find(':') != std::string::npos) { return false; }
  11185. std::string hostname = case_ignore::to_lower(token);
  11186. while (!hostname.empty() && hostname.front() == '.') {
  11187. hostname.erase(hostname.begin());
  11188. }
  11189. while (!hostname.empty() && hostname.back() == '.') {
  11190. hostname.pop_back();
  11191. }
  11192. if (hostname.empty()) { return false; }
  11193. out.kind = NoProxyKind::HostnameSuffix;
  11194. out.hostname_pattern = std::move(hostname);
  11195. return true;
  11196. }
  11197. inline std::vector<NoProxyEntry>
  11198. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11199. std::vector<NoProxyEntry> entries;
  11200. entries.reserve(patterns.size());
  11201. for (const auto &p : patterns) {
  11202. auto trimmed = trim_copy(p);
  11203. if (trimmed.empty()) { continue; }
  11204. NoProxyEntry entry;
  11205. if (parse_no_proxy_entry(trimmed, entry)) {
  11206. entries.push_back(std::move(entry));
  11207. }
  11208. }
  11209. return entries;
  11210. }
  11211. inline NormalizedTarget normalize_target(const std::string &host) {
  11212. NormalizedTarget t;
  11213. std::string h = host;
  11214. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11215. h = h.substr(1, h.size() - 2);
  11216. }
  11217. // Strip a single trailing dot so "example.com." canonicalizes to
  11218. // "example.com".
  11219. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11220. t.hostname = case_ignore::to_lower(h);
  11221. if (!t.hostname.empty()) {
  11222. struct in_addr v4;
  11223. struct in6_addr v6;
  11224. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11225. t.is_ipv4 = true;
  11226. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11227. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11228. t.is_ipv6 = true;
  11229. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11230. }
  11231. }
  11232. return t;
  11233. }
  11234. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11235. const std::vector<NoProxyEntry> &entries) {
  11236. if (target.hostname.empty()) { return false; }
  11237. for (const auto &e : entries) {
  11238. switch (e.kind) {
  11239. case NoProxyKind::Wildcard: return true;
  11240. case NoProxyKind::IPv4Cidr:
  11241. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11242. return true;
  11243. }
  11244. break;
  11245. case NoProxyKind::IPv6Cidr:
  11246. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11247. return true;
  11248. }
  11249. break;
  11250. case NoProxyKind::HostnameSuffix:
  11251. if (target.is_ipv4 || target.is_ipv6) { break; }
  11252. if (target.hostname == e.hostname_pattern) { return true; }
  11253. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11254. // an entry of "example.com".
  11255. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11256. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11257. if (target.hostname[offset - 1] == '.' &&
  11258. target.hostname.compare(offset, e.hostname_pattern.size(),
  11259. e.hostname_pattern) == 0) {
  11260. return true;
  11261. }
  11262. }
  11263. break;
  11264. }
  11265. }
  11266. return false;
  11267. }
  11268. template <typename T>
  11269. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11270. T header_writer, Error &error) {
  11271. for (const auto &h : headers) {
  11272. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11273. error = Error::InvalidHeaders;
  11274. return false;
  11275. }
  11276. }
  11277. if (header_writer(strm, headers) <= 0) {
  11278. error = Error::Write;
  11279. return false;
  11280. }
  11281. return true;
  11282. }
  11283. } // namespace detail
  11284. /*
  11285. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11286. */
  11287. #ifdef CPPHTTPLIB_SSL_ENABLED
  11288. namespace detail {
  11289. // SSL socket stream implementation
  11290. inline SSLSocketStream::SSLSocketStream(
  11291. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11292. time_t read_timeout_usec, time_t write_timeout_sec,
  11293. time_t write_timeout_usec, time_t max_timeout_msec,
  11294. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11295. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11296. read_timeout_usec_(read_timeout_usec),
  11297. write_timeout_sec_(write_timeout_sec),
  11298. write_timeout_usec_(write_timeout_usec),
  11299. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11300. tls_error_.code = tls::ErrorCode::Success;
  11301. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11302. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11303. // Note: create_session() also clears this, but SSLClient currently
  11304. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11305. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11306. // SSL session was created.
  11307. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11308. #endif
  11309. }
  11310. inline SSLSocketStream::~SSLSocketStream() = default;
  11311. inline bool SSLSocketStream::is_readable() const {
  11312. return tls::pending(session_) > 0;
  11313. }
  11314. inline bool SSLSocketStream::wait_readable() const {
  11315. if (max_timeout_msec_ <= 0) {
  11316. return select_read_interruptible(sock_, read_timeout_sec_,
  11317. read_timeout_usec_, read_interrupted_) > 0;
  11318. }
  11319. time_t read_timeout_sec;
  11320. time_t read_timeout_usec;
  11321. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11322. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11323. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11324. read_interrupted_) > 0;
  11325. }
  11326. inline bool SSLSocketStream::wait_writable() const {
  11327. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11328. !tls::is_peer_closed(session_, sock_);
  11329. }
  11330. inline bool SSLSocketStream::ensure_readable() {
  11331. if (readable_hint_) {
  11332. readable_hint_ = false;
  11333. return true;
  11334. }
  11335. return wait_readable();
  11336. }
  11337. inline bool SSLSocketStream::is_peer_alive() const {
  11338. return !tls::is_peer_closed(session_, sock_);
  11339. }
  11340. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11341. if (tls::pending(session_) > 0) {
  11342. tls::TlsError err;
  11343. auto ret = tls::read(session_, ptr, size, err);
  11344. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11345. error_ = Error::ConnectionClosed;
  11346. } else if (ret < 0) {
  11347. tls_error_ = err;
  11348. }
  11349. return ret;
  11350. } else if (ensure_readable()) {
  11351. tls::TlsError err;
  11352. auto ret = tls::read(session_, ptr, size, err);
  11353. if (ret < 0) {
  11354. auto n = 1000;
  11355. #ifdef _WIN32
  11356. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11357. (err.code == tls::ErrorCode::SyscallError &&
  11358. WSAGetLastError() == WSAETIMEDOUT))) {
  11359. #else
  11360. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11361. #endif
  11362. if (tls::pending(session_) > 0) {
  11363. ret = tls::read(session_, ptr, size, err);
  11364. if (ret >= 0) { return ret; }
  11365. break;
  11366. } else if (wait_readable()) {
  11367. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11368. ret = tls::read(session_, ptr, size, err);
  11369. if (ret >= 0) { return ret; }
  11370. } else {
  11371. break;
  11372. }
  11373. }
  11374. assert(ret < 0);
  11375. tls_error_ = err;
  11376. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11377. error_ = Error::ConnectionClosed;
  11378. }
  11379. return ret;
  11380. } else {
  11381. error_ = Error::Timeout;
  11382. return -1;
  11383. }
  11384. }
  11385. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11386. if (wait_writable()) {
  11387. auto handle_size =
  11388. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11389. tls::TlsError err;
  11390. auto ret = tls::write(session_, ptr, handle_size, err);
  11391. if (ret < 0) {
  11392. auto n = 1000;
  11393. #ifdef _WIN32
  11394. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11395. (err.code == tls::ErrorCode::SyscallError &&
  11396. WSAGetLastError() == WSAETIMEDOUT))) {
  11397. #else
  11398. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11399. #endif
  11400. if (wait_writable()) {
  11401. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11402. ret = tls::write(session_, ptr, handle_size, err);
  11403. if (ret >= 0) { return ret; }
  11404. } else {
  11405. break;
  11406. }
  11407. }
  11408. assert(ret < 0);
  11409. tls_error_ = err;
  11410. }
  11411. return ret;
  11412. }
  11413. return -1;
  11414. }
  11415. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11416. int &port) const {
  11417. detail::get_remote_ip_and_port(sock_, ip, port);
  11418. }
  11419. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11420. int &port) const {
  11421. detail::get_local_ip_and_port(sock_, ip, port);
  11422. }
  11423. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11424. inline time_t SSLSocketStream::duration() const {
  11425. return static_cast<time_t>(
  11426. std::chrono::duration_cast<std::chrono::milliseconds>(
  11427. std::chrono::steady_clock::now() - start_time_)
  11428. .count());
  11429. }
  11430. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11431. read_timeout_sec_ = sec;
  11432. read_timeout_usec_ = usec;
  11433. }
  11434. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11435. max_timeout_msec_ = msec;
  11436. start_time_ = std::chrono::steady_clock::now();
  11437. }
  11438. inline void
  11439. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11440. read_interrupted_ = std::move(interrupted);
  11441. }
  11442. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11443. tls::session_t session,
  11444. time_t read_timeout_sec,
  11445. time_t read_timeout_usec,
  11446. time_t write_timeout_sec,
  11447. time_t write_timeout_usec)
  11448. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11449. read_timeout_usec_(read_timeout_usec),
  11450. write_timeout_sec_(write_timeout_sec),
  11451. write_timeout_usec_(write_timeout_usec),
  11452. start_time_(std::chrono::steady_clock::now()) {
  11453. // The receive and send paths run on different threads, so each TLS call is
  11454. // driven in non-blocking mode and readiness is awaited with select()
  11455. // outside the session lock. Set the socket non-blocking once here; it is
  11456. // never flipped back, so no thread races on the flag.
  11457. detail::set_nonblocking(sock_, true);
  11458. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11459. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11460. #endif
  11461. }
  11462. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11463. inline bool WebSocketSSLStream::is_readable() const {
  11464. std::lock_guard<std::mutex> guard(session_mutex_);
  11465. return tls::pending(session_) > 0;
  11466. }
  11467. inline bool WebSocketSSLStream::wait_readable() const {
  11468. return select_read_interruptible(sock_, read_timeout_sec_, read_timeout_usec_,
  11469. read_interrupted_) > 0;
  11470. }
  11471. inline bool WebSocketSSLStream::wait_writable() const {
  11472. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11473. // that probe toggles the socket's blocking flag, which would race with the
  11474. // concurrent reader on a permanently non-blocking socket.
  11475. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11476. }
  11477. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11478. tls::TlsError err;
  11479. auto n = 1000;
  11480. while (--n >= 0) {
  11481. {
  11482. std::lock_guard<std::mutex> guard(session_mutex_);
  11483. auto ret = tls::read(session_, ptr, size, err);
  11484. if (ret > 0) { return ret; }
  11485. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11486. error_ = Error::ConnectionClosed;
  11487. return ret;
  11488. }
  11489. }
  11490. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11491. // direction: the send path shares this session, so output it left pending
  11492. // has to be flushed before more input can be decrypted. Anything else is
  11493. // a hard error.
  11494. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11495. #ifdef _WIN32
  11496. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11497. needs_readable =
  11498. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11499. WSAGetLastError() == WSAETIMEDOUT);
  11500. #endif
  11501. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11502. error_ = Error::Read;
  11503. return -1;
  11504. }
  11505. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11506. error_ = Error::Timeout;
  11507. return -1;
  11508. }
  11509. }
  11510. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11511. // to tell a timeout from a close would otherwise see whatever the previous
  11512. // failure left behind (error_ is never cleared on success).
  11513. error_ = Error::Read;
  11514. return -1;
  11515. }
  11516. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11517. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11518. tls::TlsError err;
  11519. auto n = 1000;
  11520. while (--n >= 0) {
  11521. {
  11522. std::lock_guard<std::mutex> guard(session_mutex_);
  11523. auto ret = tls::write(session_, ptr, handle_size, err);
  11524. if (ret >= 0) { return ret; }
  11525. }
  11526. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11527. // or a post-handshake message must be consumed before the record goes
  11528. // out. Anything else is a hard error.
  11529. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11530. #ifdef _WIN32
  11531. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11532. needs_writable =
  11533. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11534. WSAGetLastError() == WSAETIMEDOUT);
  11535. #endif
  11536. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11537. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11538. }
  11539. return -1;
  11540. }
  11541. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11542. int &port) const {
  11543. detail::get_remote_ip_and_port(sock_, ip, port);
  11544. }
  11545. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11546. int &port) const {
  11547. detail::get_local_ip_and_port(sock_, ip, port);
  11548. }
  11549. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11550. inline time_t WebSocketSSLStream::duration() const {
  11551. return static_cast<time_t>(
  11552. std::chrono::duration_cast<std::chrono::milliseconds>(
  11553. std::chrono::steady_clock::now() - start_time_)
  11554. .count());
  11555. }
  11556. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11557. read_timeout_sec_ = sec;
  11558. read_timeout_usec_ = usec;
  11559. }
  11560. inline void
  11561. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11562. read_interrupted_ = std::move(interrupted);
  11563. }
  11564. } // namespace detail
  11565. #endif // CPPHTTPLIB_SSL_ENABLED
  11566. /*
  11567. * Group 4: Server implementation
  11568. */
  11569. // HTTP server implementation
  11570. inline Server::Server()
  11571. : new_task_queue([] {
  11572. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11573. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11574. }) {
  11575. #ifndef _WIN32
  11576. signal(SIGPIPE, SIG_IGN);
  11577. #endif
  11578. }
  11579. inline Server::~Server() = default;
  11580. inline std::unique_ptr<detail::MatcherBase>
  11581. Server::make_matcher(const std::string &pattern) {
  11582. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11583. // a path params pattern
  11584. if (pattern.find("/:") != std::string::npos) {
  11585. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11586. }
  11587. // A pattern with no regex metacharacter only has to be compared literally,
  11588. // which is what PathParamsMatcher already does when it captures no
  11589. // parameter, so std::regex is only worth building for the patterns that
  11590. // actually need it
  11591. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11592. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11593. }
  11594. return detail::make_unique<detail::RegexMatcher>(pattern);
  11595. }
  11596. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11597. return add_handler(get_handlers_, pattern, std::move(handler));
  11598. }
  11599. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11600. return add_handler(post_handlers_, pattern, std::move(handler));
  11601. }
  11602. inline Server &Server::Post(const std::string &pattern,
  11603. HandlerWithContentReader handler) {
  11604. return add_handler(post_handlers_for_content_reader_, pattern,
  11605. std::move(handler));
  11606. }
  11607. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11608. return add_handler(put_handlers_, pattern, std::move(handler));
  11609. }
  11610. inline Server &Server::Put(const std::string &pattern,
  11611. HandlerWithContentReader handler) {
  11612. return add_handler(put_handlers_for_content_reader_, pattern,
  11613. std::move(handler));
  11614. }
  11615. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11616. return add_handler(patch_handlers_, pattern, std::move(handler));
  11617. }
  11618. inline Server &Server::Patch(const std::string &pattern,
  11619. HandlerWithContentReader handler) {
  11620. return add_handler(patch_handlers_for_content_reader_, pattern,
  11621. std::move(handler));
  11622. }
  11623. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11624. return add_handler(delete_handlers_, pattern, std::move(handler));
  11625. }
  11626. inline Server &Server::Delete(const std::string &pattern,
  11627. HandlerWithContentReader handler) {
  11628. return add_handler(delete_handlers_for_content_reader_, pattern,
  11629. std::move(handler));
  11630. }
  11631. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11632. return add_handler(options_handlers_, pattern, std::move(handler));
  11633. }
  11634. inline const std::set<std::string> &Server::builtin_methods() {
  11635. thread_local const std::set<std::string> methods{
  11636. "GET", "HEAD", "POST", "PUT", "DELETE",
  11637. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11638. return methods;
  11639. }
  11640. inline Server::CustomHandlerEntry *
  11641. Server::custom_entry_for_registration(const std::string &method) {
  11642. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11643. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11644. // routing() before the custom tables are consulted, so a route registered
  11645. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11646. // there and would be reachable, but they carry protocol-level meaning
  11647. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11648. // library does not route.
  11649. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11650. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11651. has_invalid_registration_ = true;
  11652. return nullptr;
  11653. }
  11654. return &custom_handlers_[method];
  11655. }
  11656. inline Server &Server::CustomRoute(const std::string &method,
  11657. const std::string &pattern,
  11658. Handler handler) {
  11659. auto *entry = custom_entry_for_registration(method);
  11660. if (!entry) { return *this; }
  11661. return add_handler(entry->handlers, pattern, std::move(handler));
  11662. }
  11663. inline Server &Server::CustomRoute(const std::string &method,
  11664. const std::string &pattern,
  11665. HandlerWithContentReader handler) {
  11666. auto *entry = custom_entry_for_registration(method);
  11667. if (!entry) { return *this; }
  11668. return add_handler(entry->handlers_for_content_reader, pattern,
  11669. std::move(handler));
  11670. }
  11671. inline const Server::CustomHandlerEntry *
  11672. Server::find_custom_entry(const std::string &method) const {
  11673. // find() alone would be correct here. The empty() check is what keeps the
  11674. // per-request cost off servers that never call CustomRoute(), which is the
  11675. // overwhelmingly common case; keep it rather than walking into the tree.
  11676. if (custom_handlers_.empty()) { return nullptr; }
  11677. auto it = custom_handlers_.find(method);
  11678. return it == custom_handlers_.end() ? nullptr : &it->second;
  11679. }
  11680. inline Server &Server::WebSocket(const std::string &pattern,
  11681. WebSocketHandler handler) {
  11682. websocket_handlers_.push_back(
  11683. {make_matcher(pattern), std::move(handler), nullptr});
  11684. return *this;
  11685. }
  11686. inline Server &Server::WebSocket(const std::string &pattern,
  11687. WebSocketHandler handler,
  11688. SubProtocolSelector sub_protocol_selector) {
  11689. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11690. std::move(sub_protocol_selector)});
  11691. return *this;
  11692. }
  11693. inline bool Server::set_base_dir(const std::string &dir,
  11694. const std::string &mount_point) {
  11695. return set_mount_point(mount_point, dir);
  11696. }
  11697. inline bool Server::set_mount_point(const std::string &mount_point,
  11698. const std::string &dir, Headers headers) {
  11699. detail::FileStat stat(dir);
  11700. if (stat.is_dir()) {
  11701. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11702. if (!mnt.empty() && mnt[0] == '/') {
  11703. // Without the resolved directory, a file could not be checked to be
  11704. // inside it.
  11705. std::string resolved_base;
  11706. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11707. return false;
  11708. }
  11709. #if defined(_WIN32)
  11710. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11711. resolved_base += '\\';
  11712. }
  11713. #else
  11714. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11715. #endif
  11716. base_dirs_.push_back(
  11717. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11718. return true;
  11719. }
  11720. }
  11721. return false;
  11722. }
  11723. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11724. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11725. if (it->mount_point == mount_point) {
  11726. base_dirs_.erase(it);
  11727. return true;
  11728. }
  11729. }
  11730. return false;
  11731. }
  11732. inline Server &
  11733. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11734. const std::string &mime) {
  11735. // Keyed as find_content_type() looks it up
  11736. auto key = detail::case_ignore::to_lower(ext);
  11737. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  11738. file_extension_and_mimetype_map_[key] = mime;
  11739. return *this;
  11740. }
  11741. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11742. default_file_mimetype_ = mime;
  11743. return *this;
  11744. }
  11745. inline Server &Server::set_file_request_handler(Handler handler) {
  11746. file_request_handler_ = std::move(handler);
  11747. return *this;
  11748. }
  11749. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11750. std::true_type) {
  11751. error_handler_ = std::move(handler);
  11752. return *this;
  11753. }
  11754. inline Server &Server::set_error_handler_core(Handler handler,
  11755. std::false_type) {
  11756. error_handler_ = [handler](const Request &req, Response &res) {
  11757. handler(req, res);
  11758. return HandlerResponse::Handled;
  11759. };
  11760. return *this;
  11761. }
  11762. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11763. exception_handler_ = std::move(handler);
  11764. return *this;
  11765. }
  11766. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11767. pre_routing_handler_ = std::move(handler);
  11768. return *this;
  11769. }
  11770. inline Server &Server::set_post_routing_handler(Handler handler) {
  11771. post_routing_handler_ = std::move(handler);
  11772. return *this;
  11773. }
  11774. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11775. pre_request_handler_ = std::move(handler);
  11776. return *this;
  11777. }
  11778. inline Server &Server::set_logger(Logger logger) {
  11779. logger_ = std::move(logger);
  11780. return *this;
  11781. }
  11782. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11783. error_logger_ = std::move(error_logger);
  11784. return *this;
  11785. }
  11786. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11787. pre_compression_logger_ = std::move(logger);
  11788. return *this;
  11789. }
  11790. inline Server &
  11791. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11792. expect_100_continue_handler_ = std::move(handler);
  11793. return *this;
  11794. }
  11795. inline Server &Server::set_start_handler(StartHandler handler) {
  11796. start_handler_ = std::move(handler);
  11797. return *this;
  11798. }
  11799. inline Server &Server::set_address_family(int family) {
  11800. address_family_ = family;
  11801. return *this;
  11802. }
  11803. inline Server &Server::set_tcp_nodelay(bool on) {
  11804. tcp_nodelay_ = on;
  11805. return *this;
  11806. }
  11807. inline Server &Server::set_ipv6_v6only(bool on) {
  11808. ipv6_v6only_ = on;
  11809. return *this;
  11810. }
  11811. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11812. socket_options_ = std::move(socket_options);
  11813. return *this;
  11814. }
  11815. inline Server &Server::set_default_headers(Headers headers) {
  11816. default_headers_ = std::move(headers);
  11817. return *this;
  11818. }
  11819. inline Server &Server::set_header_writer(
  11820. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11821. header_writer_ = writer;
  11822. return *this;
  11823. }
  11824. inline Server &
  11825. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11826. trusted_proxies_.clear();
  11827. trusted_proxies_.reserve(proxies.size());
  11828. for (const auto &proxy : proxies) {
  11829. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  11830. }
  11831. return *this;
  11832. }
  11833. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11834. keep_alive_max_count_ = count;
  11835. return *this;
  11836. }
  11837. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11838. keep_alive_timeout_sec_ = sec;
  11839. return *this;
  11840. }
  11841. template <class Rep, class Period>
  11842. inline Server &Server::set_keep_alive_timeout(
  11843. const std::chrono::duration<Rep, Period> &duration) {
  11844. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11845. set_keep_alive_timeout(sec);
  11846. });
  11847. return *this;
  11848. }
  11849. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11850. read_timeout_sec_ = sec;
  11851. read_timeout_usec_ = usec;
  11852. return *this;
  11853. }
  11854. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11855. write_timeout_sec_ = sec;
  11856. write_timeout_usec_ = usec;
  11857. return *this;
  11858. }
  11859. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11860. idle_interval_sec_ = sec;
  11861. idle_interval_usec_ = usec;
  11862. return *this;
  11863. }
  11864. inline Server &Server::set_payload_max_length(size_t length) {
  11865. payload_max_length_ = length;
  11866. return *this;
  11867. }
  11868. inline Server &Server::set_compress(bool on) {
  11869. compress_ = on;
  11870. return *this;
  11871. }
  11872. inline Server &Server::set_static_file_compression(bool on) {
  11873. static_file_compression_ = on;
  11874. return *this;
  11875. }
  11876. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11877. static_file_compression_min_length_ = length;
  11878. return *this;
  11879. }
  11880. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11881. static_file_compression_max_length_ = length;
  11882. return *this;
  11883. }
  11884. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11885. websocket_max_missed_pongs_ = count;
  11886. return *this;
  11887. }
  11888. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11889. websocket_ping_interval_sec_ = sec;
  11890. return *this;
  11891. }
  11892. template <class Rep, class Period>
  11893. inline Server &Server::set_websocket_ping_interval(
  11894. const std::chrono::duration<Rep, Period> &duration) {
  11895. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11896. set_websocket_ping_interval(sec);
  11897. });
  11898. return *this;
  11899. }
  11900. inline bool Server::bind_to_port(const std::string &host, int port,
  11901. int socket_flags) {
  11902. auto ret = bind_internal(host, port, socket_flags);
  11903. if (ret == -1) { is_decommissioned = true; }
  11904. return ret >= 0;
  11905. }
  11906. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11907. auto ret = bind_internal(host, 0, socket_flags);
  11908. if (ret == -1) { is_decommissioned = true; }
  11909. return ret;
  11910. }
  11911. inline bool Server::listen_after_bind() { return listen_internal(); }
  11912. inline bool Server::listen(const std::string &host, int port,
  11913. int socket_flags) {
  11914. return bind_to_port(host, port, socket_flags) && listen_internal();
  11915. }
  11916. inline bool Server::is_running() const { return is_running_; }
  11917. inline void Server::wait_until_ready() const {
  11918. while (!is_running_ && !is_decommissioned) {
  11919. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11920. }
  11921. }
  11922. inline void Server::stop() noexcept {
  11923. // Release the listening socket whether or not the accept loop is running:
  11924. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11925. // exchange is what makes this safe to call concurrently with the accept loop.
  11926. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11927. if (sock != INVALID_SOCKET) {
  11928. detail::shutdown_socket(sock);
  11929. detail::close_socket(sock);
  11930. }
  11931. is_decommissioned = false;
  11932. }
  11933. inline void Server::decommission() { is_decommissioned = true; }
  11934. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11935. auto len = strlen(s);
  11936. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11937. len -= 2;
  11938. {
  11939. // RFC 9112 §3: exactly one SP between the method, the target and the
  11940. // version. Taking other whitespace as a separator too lets recipients
  11941. // that parse more strictly see a different request.
  11942. auto end = s + len;
  11943. if (std::count(s, end, ' ') != 2) { return false; }
  11944. auto sp1 = std::find(s, end, ' ');
  11945. auto sp2 = std::find(sp1 + 1, end, ' ');
  11946. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11947. req.method.assign(s, sp1);
  11948. req.target.assign(sp1 + 1, sp2);
  11949. req.version.assign(sp2 + 1, end);
  11950. }
  11951. // A method outside the built-in set is accepted only when a handler has been
  11952. // registered for it with CustomRoute().
  11953. const auto &methods = builtin_methods();
  11954. if (methods.find(req.method) == methods.end() &&
  11955. !find_custom_entry(req.method)) {
  11956. output_error_log(Error::InvalidHTTPMethod, &req);
  11957. return false;
  11958. }
  11959. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11960. output_error_log(Error::InvalidHTTPVersion, &req);
  11961. return false;
  11962. }
  11963. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11964. // would leave this server routing a different path than a cache or a
  11965. // filter in front of it sees.
  11966. if (!detail::fields::is_request_target(req.target) ||
  11967. req.target.find('#') != std::string::npos) {
  11968. return false;
  11969. }
  11970. {
  11971. detail::divide(req.target, '?',
  11972. [&](const char *lhs_data, std::size_t lhs_size,
  11973. const char *rhs_data, std::size_t rhs_size) {
  11974. req.path =
  11975. decode_path_component(std::string(lhs_data, lhs_size));
  11976. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11977. });
  11978. }
  11979. return true;
  11980. }
  11981. inline bool Server::write_response(Stream &strm, bool close_connection,
  11982. Request &req, Response &res) {
  11983. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11984. // incorrectly to the error content.
  11985. req.ranges.clear();
  11986. return write_response_core(strm, close_connection, req, res, false);
  11987. }
  11988. inline bool Server::write_response_with_content(Stream &strm,
  11989. bool close_connection,
  11990. const Request &req,
  11991. Response &res) {
  11992. return write_response_core(strm, close_connection, req, res, true);
  11993. }
  11994. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11995. const Request &req, Response &res,
  11996. bool need_apply_ranges) {
  11997. assert(res.status != -1);
  11998. if (400 <= res.status && error_handler_ &&
  11999. error_handler_(req, res) == HandlerResponse::Handled) {
  12000. need_apply_ranges = true;
  12001. }
  12002. // Before anything below reads res.headers, which the handlers may have
  12003. // filled directly
  12004. detail::erase_invalid_fields(res.headers);
  12005. if (!detail::body_allowed_for_status(res.status)) {
  12006. detail::clear_content(res);
  12007. }
  12008. detail::prefer_assigned_body(res);
  12009. std::string content_type;
  12010. std::string boundary;
  12011. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  12012. // Prepare additional headers
  12013. if (close_connection ||
  12014. detail::has_header_token(req.headers, "Connection", "close") ||
  12015. 400 <= res.status || // Don't leave connections open after errors
  12016. // The client withholds the body until `100 Continue`, which was never
  12017. // sent, so whether and when the body follows is unknown.
  12018. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  12019. // The body was left partway, e.g. by a content receiver that returned
  12020. // false, so the rest of it cannot be told from the next request.
  12021. (req.body_read_started_ && !req.body_consumed_)) {
  12022. res.set_header("Connection", "close");
  12023. } else {
  12024. std::string s = "timeout=";
  12025. s += std::to_string(keep_alive_timeout_sec_);
  12026. if (keep_alive_max_count_ > 0) {
  12027. s += ", max=";
  12028. s += std::to_string(keep_alive_max_count_);
  12029. }
  12030. res.set_header("Keep-Alive", s);
  12031. }
  12032. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12033. !res.has_header("Content-Type")) {
  12034. res.set_header("Content-Type", "text/plain");
  12035. }
  12036. detail::set_framing_headers(req, res, boundary, content_type);
  12037. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12038. res.set_header("Accept-Ranges", "bytes");
  12039. }
  12040. if (post_routing_handler_) {
  12041. post_routing_handler_(req, res);
  12042. detail::erase_invalid_fields(res.headers);
  12043. // Again, for a body or framing headers the handler changed.
  12044. detail::set_framing_headers(req, res, boundary, content_type);
  12045. }
  12046. // Response line and headers
  12047. detail::BufferStream bstrm;
  12048. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12049. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12050. // Combine a small body with the headers so the whole response leaves in a
  12051. // single write. A large body is written on its own instead: a copy of it
  12052. // costs more than the extra write saves.
  12053. auto send_body =
  12054. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12055. auto body_is_separate = false;
  12056. auto provider_done = false;
  12057. if (send_body && !res.body.empty() && !res.content_provider_) {
  12058. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12059. bstrm.write(res.body.data(), res.body.size());
  12060. } else {
  12061. body_is_separate = true;
  12062. }
  12063. } else if (send_body && res.content_provider_ &&
  12064. res.is_file_content_provider_ &&
  12065. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12066. // A small file is read into the same buffer. Other providers may produce
  12067. // their data over time, so they are never held back.
  12068. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12069. return false;
  12070. }
  12071. provider_done = true;
  12072. }
  12073. // Log before writing to avoid race condition with client-side code that
  12074. // accesses logger-captured data immediately after receiving the response.
  12075. output_log(req, res);
  12076. // Flush buffer
  12077. auto &data = bstrm.get_buffer();
  12078. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12079. if (body_is_separate) {
  12080. return detail::write_data(strm, res.body.data(), res.body.size());
  12081. }
  12082. // Streaming body
  12083. if (send_body && res.content_provider_) {
  12084. if (!provider_done &&
  12085. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12086. return false;
  12087. }
  12088. res.content_provider_success_ = true;
  12089. }
  12090. return true;
  12091. }
  12092. inline bool
  12093. Server::write_content_with_provider(Stream &strm, const Request &req,
  12094. Response &res, const std::string &boundary,
  12095. const std::string &content_type) {
  12096. auto is_shutting_down = [this]() {
  12097. return this->svr_sock_ == INVALID_SOCKET;
  12098. };
  12099. if (res.content_length_ > 0) {
  12100. if (!detail::is_partial_content(req, res)) {
  12101. return detail::write_content(strm, res.content_provider_, 0,
  12102. res.content_length_, is_shutting_down);
  12103. } else if (req.ranges.size() == 1) {
  12104. auto offset_and_length = detail::get_range_offset_and_length(
  12105. req.ranges[0], res.content_length_);
  12106. return detail::write_content(strm, res.content_provider_,
  12107. offset_and_length.first,
  12108. offset_and_length.second, is_shutting_down);
  12109. } else {
  12110. return detail::write_multipart_ranges_data(
  12111. strm, req, res, boundary, content_type, res.content_length_,
  12112. is_shutting_down);
  12113. }
  12114. } else {
  12115. if (res.is_chunked_content_provider_) {
  12116. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12117. // re-negotiating here would disagree with them, e.g. once a handler's
  12118. // own Content-Encoding header suppresses the negotiation.
  12119. auto compressor = detail::make_compressor(res.content_coding_);
  12120. if (!compressor) {
  12121. compressor = detail::make_unique<detail::nocompressor>();
  12122. }
  12123. return detail::write_content_chunked(strm, res.content_provider_,
  12124. is_shutting_down, *compressor);
  12125. } else {
  12126. return detail::write_content_without_length(strm, res.content_provider_,
  12127. is_shutting_down);
  12128. }
  12129. }
  12130. }
  12131. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12132. FormFields::iterator cur_field;
  12133. FormFiles::iterator cur_file;
  12134. auto is_text_field = false;
  12135. size_t count = 0;
  12136. if (read_content_core(
  12137. strm, req, res,
  12138. // Regular
  12139. [&](const char *buf, size_t n) {
  12140. // Prevent arithmetic overflow when checking sizes.
  12141. // Avoid computing (req.body.size() + n) directly because
  12142. // adding two unsigned `size_t` values can wrap around and
  12143. // produce a small result instead of indicating overflow.
  12144. // Instead, check using subtraction: ensure `n` does not
  12145. // exceed the remaining capacity `max_size() - size()`.
  12146. if (req.body.size() >= req.body.max_size() ||
  12147. n > req.body.max_size() - req.body.size()) {
  12148. return false;
  12149. }
  12150. // Limit decompressed body size to payload_max_length_ to protect
  12151. // against "zip bomb" attacks where a small compressed payload
  12152. // decompresses to a massive size.
  12153. if (payload_max_length_ > 0 &&
  12154. (req.body.size() >= payload_max_length_ ||
  12155. n > payload_max_length_ - req.body.size())) {
  12156. return false;
  12157. }
  12158. req.body.append(buf, n);
  12159. return true;
  12160. },
  12161. // Multipart FormData
  12162. [&](const FormData &file) {
  12163. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12164. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12165. output_error_log(Error::TooManyFormDataFiles, &req);
  12166. return false;
  12167. }
  12168. if (file.filename.empty()) {
  12169. cur_field = req.form.fields.emplace(
  12170. file.name, FormField{file.name, file.content, file.headers});
  12171. is_text_field = true;
  12172. } else {
  12173. cur_file = req.form.files.emplace(file.name, file);
  12174. is_text_field = false;
  12175. }
  12176. return true;
  12177. },
  12178. [&](const char *buf, size_t n) {
  12179. if (is_text_field) {
  12180. auto &content = cur_field->second.content;
  12181. if (content.size() + n > content.max_size()) { return false; }
  12182. content.append(buf, n);
  12183. } else {
  12184. auto &content = cur_file->second.content;
  12185. if (content.size() + n > content.max_size()) { return false; }
  12186. content.append(buf, n);
  12187. }
  12188. return true;
  12189. })) {
  12190. const auto &content_type = req.get_header_value("Content-Type");
  12191. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12192. "application/x-www-form-urlencoded")) {
  12193. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12194. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12195. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12196. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12197. return false;
  12198. }
  12199. detail::parse_query_text(req.body, req.params);
  12200. }
  12201. return true;
  12202. }
  12203. return false;
  12204. }
  12205. inline bool Server::read_content_with_content_receiver(
  12206. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12207. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12208. return read_content_core(strm, req, res, std::move(receiver),
  12209. std::move(multipart_header),
  12210. std::move(multipart_receiver));
  12211. }
  12212. inline bool Server::read_content_core(
  12213. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12214. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12215. detail::FormDataParser multipart_form_data_parser;
  12216. ContentReceiverWithProgress out;
  12217. if (req.is_multipart_form_data()) {
  12218. const auto &content_type = req.get_header_value("Content-Type");
  12219. std::string boundary;
  12220. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12221. res.status = StatusCode::BadRequest_400;
  12222. output_error_log(Error::MultipartParsing, &req);
  12223. return false;
  12224. }
  12225. multipart_form_data_parser.set_boundary(std::move(boundary));
  12226. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12227. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12228. multipart_receiver);
  12229. };
  12230. } else {
  12231. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12232. size_t /*len*/) { return receiver(buf, n); };
  12233. }
  12234. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12235. if (!req.has_header("Content-Length") &&
  12236. !detail::is_chunked_transfer_encoding(req.headers)) {
  12237. return true;
  12238. }
  12239. // A second read would start where the first one stopped, or in the next
  12240. // request.
  12241. if (req.body_read_started_) { return false; }
  12242. // The client is waiting for this before it sends the body.
  12243. if (req.expect_100_continue_pending_) {
  12244. req.expect_100_continue_pending_ = false;
  12245. detail::write_response_line(strm, StatusCode::Continue_100);
  12246. strm.write("\r\n");
  12247. }
  12248. // Set before reading, since a receiver may also stop by throwing.
  12249. req.body_read_started_ = true;
  12250. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12251. out, true)) {
  12252. return false;
  12253. }
  12254. req.body_consumed_ = true;
  12255. if (req.is_multipart_form_data()) {
  12256. if (!multipart_form_data_parser.is_valid()) {
  12257. res.status = StatusCode::BadRequest_400;
  12258. output_error_log(Error::MultipartParsing, &req);
  12259. return false;
  12260. }
  12261. }
  12262. return true;
  12263. }
  12264. inline bool Server::handle_file_request(Request &req, Response &res) {
  12265. if (!detail::is_valid_path(req.path)) { return false; }
  12266. for (const auto &entry : base_dirs_) {
  12267. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12268. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12269. // One that already ends in '/' (the root mount among them) carries its own
  12270. // boundary; set_mount_point() guarantees the mount point is not empty.
  12271. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12272. (entry.mount_point.back() == '/' ||
  12273. req.path.size() == entry.mount_point.size() ||
  12274. req.path[entry.mount_point.size()] == '/')) {
  12275. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12276. auto path = entry.base_dir + sub_path;
  12277. if (path.back() == '/') { path += "index.html"; }
  12278. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12279. // but symlinks/junctions can still escape the base directory. A path
  12280. // that cannot be resolved, which includes one that does not exist, is
  12281. // not served from here.
  12282. std::string resolved_path;
  12283. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12284. if (!detail::is_path_within_base(resolved_path,
  12285. entry.resolved_base_dir)) {
  12286. res.status = StatusCode::Forbidden_403;
  12287. return true;
  12288. }
  12289. detail::FileStat stat(path);
  12290. if (stat.is_dir()) {
  12291. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12292. // in the name from reading as a scheme.
  12293. auto name = req.path.substr(req.path.rfind('/') + 1);
  12294. res.set_redirect("./" + encode_path_component(name) + "/",
  12295. StatusCode::MovedPermanently_301);
  12296. return true;
  12297. }
  12298. if (stat.is_file()) {
  12299. for (const auto &kv : entry.headers) {
  12300. res.set_header(kv.first, kv.second);
  12301. }
  12302. auto content_type = detail::find_content_type(
  12303. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12304. auto encoding = detail::EncodingType::None;
  12305. if (static_file_compression_) {
  12306. encoding = static_file_encoding(req, res, content_type, stat.size());
  12307. }
  12308. // The ETag names the representation actually sent, so a client that
  12309. // cached the compressed form revalidates against the compressed ETag
  12310. // and still gets a 304, while one that took identity keeps the plain
  12311. // ETag.
  12312. auto etag = detail::compute_etag(
  12313. stat, encoding == detail::EncodingType::None
  12314. ? std::string()
  12315. : std::string("-") + detail::encoding_name(encoding));
  12316. if (!etag.empty()) { res.set_header("ETag", etag); }
  12317. auto mtime = stat.mtime();
  12318. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12319. if (!last_modified.empty()) {
  12320. res.set_header("Last-Modified", last_modified);
  12321. }
  12322. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12323. check_if_range(req, etag, mtime);
  12324. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12325. if (!mm->is_open()) {
  12326. output_error_log(Error::OpenFile, &req);
  12327. return false;
  12328. }
  12329. detail::set_file_content_provider(res, mm, content_type, encoding);
  12330. if (req.method != "HEAD" && file_request_handler_) {
  12331. file_request_handler_(req, res);
  12332. }
  12333. return true;
  12334. } else {
  12335. output_error_log(Error::OpenFile, &req);
  12336. }
  12337. }
  12338. }
  12339. return false;
  12340. }
  12341. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12342. const std::string &etag,
  12343. time_t mtime) const {
  12344. // Handle conditional GET:
  12345. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12346. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12347. if (req.has_header("If-None-Match")) {
  12348. if (!etag.empty()) {
  12349. auto val =
  12350. detail::get_combined_header_value(req.headers, "If-None-Match");
  12351. // NOTE: We use exact string matching here. This works correctly
  12352. // because our server always generates weak ETags (W/"..."), and
  12353. // clients typically send back the same ETag they received.
  12354. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12355. // If-None-Match, where W/"x" and "x" would match, but this
  12356. // simplified implementation requires exact matches.
  12357. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12358. [&](const char *b, const char *e) {
  12359. auto seg_len = static_cast<size_t>(e - b);
  12360. return (seg_len == 1 && *b == '*') ||
  12361. (seg_len == etag.size() &&
  12362. std::equal(b, e, etag.begin()));
  12363. });
  12364. if (ret) {
  12365. res.status = StatusCode::NotModified_304;
  12366. return true;
  12367. }
  12368. }
  12369. } else if (req.has_header("If-Modified-Since")) {
  12370. auto val = req.get_header_value("If-Modified-Since");
  12371. auto t = detail::parse_http_date(val);
  12372. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12373. res.status = StatusCode::NotModified_304;
  12374. return true;
  12375. }
  12376. }
  12377. return false;
  12378. }
  12379. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12380. time_t mtime) const {
  12381. // Handle If-Range for partial content requests (RFC 9110
  12382. // Section 13.1.5). If-Range is only evaluated when Range header is
  12383. // present. If the validator matches, serve partial content; otherwise
  12384. // serve full content.
  12385. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12386. auto val = req.get_header_value("If-Range");
  12387. auto is_valid_range = [&]() {
  12388. if (detail::is_strong_etag(val)) {
  12389. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12390. // comparison.
  12391. return (!etag.empty() && val == etag);
  12392. } else if (detail::is_weak_etag(val)) {
  12393. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12394. return false;
  12395. } else {
  12396. // HTTP-date comparison
  12397. auto t = detail::parse_http_date(val);
  12398. return (t != static_cast<time_t>(-1) && mtime <= t);
  12399. }
  12400. };
  12401. if (!is_valid_range()) {
  12402. // Validator doesn't match: ignore Range and serve full content
  12403. req.ranges.clear();
  12404. return false;
  12405. }
  12406. }
  12407. return true;
  12408. }
  12409. inline socket_t
  12410. Server::create_server_socket(const std::string &host, int port,
  12411. int socket_flags,
  12412. SocketOptions socket_options) const {
  12413. return detail::create_socket(
  12414. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12415. ipv6_v6only_, std::move(socket_options),
  12416. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12417. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12418. output_error_log(Error::BindIPAddress, nullptr);
  12419. return false;
  12420. }
  12421. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12422. output_error_log(Error::Listen, nullptr);
  12423. return false;
  12424. }
  12425. return true;
  12426. });
  12427. }
  12428. inline int Server::bind_internal(const std::string &host, int port,
  12429. int socket_flags) {
  12430. if (is_decommissioned) { return -1; }
  12431. if (!is_valid()) { return -1; }
  12432. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12433. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12434. if (port == 0) {
  12435. struct sockaddr_storage addr;
  12436. socklen_t addr_len = sizeof(addr);
  12437. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12438. &addr_len) == -1) {
  12439. output_error_log(Error::GetSockName, nullptr);
  12440. return -1;
  12441. }
  12442. if (addr.ss_family == AF_INET) {
  12443. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12444. } else if (addr.ss_family == AF_INET6) {
  12445. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12446. } else {
  12447. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12448. return -1;
  12449. }
  12450. } else {
  12451. return port;
  12452. }
  12453. }
  12454. inline bool Server::listen_internal() {
  12455. // A stop() between bind and listen leaves nothing to accept on. Report
  12456. // failure instead of returning success without ever serving, and mark the
  12457. // server decommissioned the way any failed listen does so that a concurrent
  12458. // wait_until_ready() wakes up instead of spinning forever.
  12459. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12460. is_decommissioned = true;
  12461. return false;
  12462. }
  12463. auto ret = true;
  12464. is_running_ = true;
  12465. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12466. if (start_handler_) { start_handler_(); }
  12467. {
  12468. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12469. while (svr_sock_ != INVALID_SOCKET) {
  12470. #ifndef _WIN32
  12471. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12472. #endif
  12473. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12474. idle_interval_usec_);
  12475. if (val == 0) { // Timeout
  12476. task_queue->on_idle();
  12477. continue;
  12478. }
  12479. #ifndef _WIN32
  12480. }
  12481. #endif
  12482. #if defined _WIN32
  12483. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12484. // OVERLAPPED
  12485. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12486. #elif defined SOCK_CLOEXEC
  12487. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12488. #else
  12489. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12490. #endif
  12491. if (sock == INVALID_SOCKET) {
  12492. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12493. // touches the CRT errno, so the two have to be asked platform by
  12494. // platform rather than by testing errno here.
  12495. if (detail::is_accept_resource_error()) {
  12496. // The per-process descriptor limit or the network stack's buffer
  12497. // space has been reached. Try to accept new connections after a
  12498. // short sleep.
  12499. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12500. continue;
  12501. } else if (detail::is_accept_transient_error()) {
  12502. continue;
  12503. }
  12504. // Take the descriptor out of svr_sock_ before closing it: a later
  12505. // stop() would otherwise shutdown()/close() a value the OS may have
  12506. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12507. // gone. The exchange also settles the race with a concurrent stop(),
  12508. // since whichever side takes the descriptor closes it exactly once.
  12509. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12510. if (listen_sock != INVALID_SOCKET) {
  12511. detail::close_socket(listen_sock);
  12512. ret = false;
  12513. output_error_log(Error::Connection, nullptr);
  12514. } else {
  12515. ; // The server socket was closed by user.
  12516. }
  12517. break;
  12518. }
  12519. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12520. read_timeout_sec_, read_timeout_usec_);
  12521. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12522. write_timeout_sec_, write_timeout_usec_);
  12523. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12524. if (!task_queue->enqueue(
  12525. [this, sock]() { process_and_close_socket(sock); })) {
  12526. output_error_log(Error::ResourceExhaustion, nullptr);
  12527. detail::shutdown_socket(sock);
  12528. detail::close_socket(sock);
  12529. }
  12530. }
  12531. task_queue->shutdown();
  12532. }
  12533. is_decommissioned = !ret;
  12534. return ret;
  12535. }
  12536. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  12537. // Call from a catch block. The response is a 500 unless the exception handler
  12538. // sets another status. Returns whether the exception handler ran.
  12539. inline bool Server::handle_exception(Request &req, Response &res) {
  12540. res.status = StatusCode::InternalServerError_500;
  12541. if (!exception_handler_) { return false; }
  12542. exception_handler_(req, res, std::current_exception());
  12543. return true;
  12544. }
  12545. #endif
  12546. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12547. bool skip_pre_routing) {
  12548. if (!skip_pre_routing && pre_routing_handler_ &&
  12549. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12550. return true;
  12551. }
  12552. // File handler
  12553. if ((req.method == "GET" || req.method == "HEAD") &&
  12554. handle_file_request(req, res)) {
  12555. return true;
  12556. }
  12557. const auto *custom = find_custom_entry(req.method);
  12558. // The second clause mirrors what expect_content() does unconditionally for
  12559. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12560. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12561. // `allprop`) would skip its handler and fall through to 404.
  12562. if (detail::expect_content(req) ||
  12563. (custom && !custom->handlers_for_content_reader.empty())) {
  12564. // Content reader handler
  12565. {
  12566. // Track whether the ContentReader was aborted due to the decompressed
  12567. // payload exceeding `payload_max_length_`.
  12568. // The user handler runs after the lambda returns, so we must restore the
  12569. // 413 status if the handler overwrites it.
  12570. bool content_reader_payload_too_large = false;
  12571. ContentReader reader(
  12572. [&](ContentReceiver receiver) {
  12573. auto result = read_content_with_content_receiver(
  12574. strm, req, res, std::move(receiver), nullptr, nullptr);
  12575. if (!result) {
  12576. output_error_log(Error::Read, &req);
  12577. if (res.status == StatusCode::PayloadTooLarge_413) {
  12578. content_reader_payload_too_large = true;
  12579. }
  12580. }
  12581. return result;
  12582. },
  12583. [&](FormDataHeader header, ContentReceiver receiver) {
  12584. auto result = read_content_with_content_receiver(
  12585. strm, req, res, nullptr, std::move(header),
  12586. std::move(receiver));
  12587. if (!result) {
  12588. output_error_log(Error::Read, &req);
  12589. if (res.status == StatusCode::PayloadTooLarge_413) {
  12590. content_reader_payload_too_large = true;
  12591. }
  12592. }
  12593. return result;
  12594. });
  12595. bool dispatched = false;
  12596. if (req.method == "POST") {
  12597. dispatched = dispatch_request_for_content_reader(
  12598. req, res, std::move(reader), post_handlers_for_content_reader_);
  12599. } else if (req.method == "PUT") {
  12600. dispatched = dispatch_request_for_content_reader(
  12601. req, res, std::move(reader), put_handlers_for_content_reader_);
  12602. } else if (req.method == "PATCH") {
  12603. dispatched = dispatch_request_for_content_reader(
  12604. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12605. } else if (req.method == "DELETE") {
  12606. dispatched = dispatch_request_for_content_reader(
  12607. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12608. } else if (custom) {
  12609. dispatched = dispatch_request_for_content_reader(
  12610. req, res, std::move(reader), custom->handlers_for_content_reader);
  12611. }
  12612. if (dispatched) {
  12613. if (content_reader_payload_too_large) {
  12614. // Enforce the limit: override any status the handler may have set
  12615. // and return false so the error path sends a plain 413 response.
  12616. res.status = StatusCode::PayloadTooLarge_413;
  12617. detail::clear_content(res);
  12618. return false;
  12619. }
  12620. return true;
  12621. }
  12622. }
  12623. // NOTE: `req.body` is not read here. For a regular handler the body is
  12624. // read inside dispatch_request(), after the route has matched and the
  12625. // pre-request handler has approved the request, so that a rejected
  12626. // request (e.g. failed authentication) never forces us to buffer a
  12627. // potentially large body.
  12628. }
  12629. // Regular handler
  12630. if (req.method == "GET" || req.method == "HEAD") {
  12631. return dispatch_request(req, res, get_handlers_, strm);
  12632. } else if (req.method == "POST") {
  12633. return dispatch_request(req, res, post_handlers_, strm);
  12634. } else if (req.method == "PUT") {
  12635. return dispatch_request(req, res, put_handlers_, strm);
  12636. } else if (req.method == "DELETE") {
  12637. return dispatch_request(req, res, delete_handlers_, strm);
  12638. } else if (req.method == "OPTIONS") {
  12639. return dispatch_request(req, res, options_handlers_, strm);
  12640. } else if (req.method == "PATCH") {
  12641. return dispatch_request(req, res, patch_handlers_, strm);
  12642. } else if (custom) {
  12643. return dispatch_request(req, res, custom->handlers, strm);
  12644. }
  12645. res.status = StatusCode::BadRequest_400;
  12646. return false;
  12647. }
  12648. inline bool Server::dispatch_request(Request &req, Response &res,
  12649. const Handlers &handlers, Stream &strm) {
  12650. for (const auto &x : handlers) {
  12651. const auto &matcher = x.first;
  12652. const auto &handler = x.second;
  12653. if (matcher->match(req)) {
  12654. req.matched_route = matcher->pattern();
  12655. // Run the pre-request handler before reading the body so a rejected
  12656. // request (e.g. failed authentication) never forces us to buffer a
  12657. // potentially large body. `req.matched_route` is available here.
  12658. if (pre_request_handler_ &&
  12659. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12660. return true;
  12661. }
  12662. // The route matched and the request was approved; read the body now.
  12663. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12664. output_error_log(Error::Read, &req);
  12665. return false;
  12666. }
  12667. handler(req, res);
  12668. return true;
  12669. }
  12670. }
  12671. return false;
  12672. }
  12673. // Decides the content coding for a response served straight from a file. Both
  12674. // the ETag, which has to name the representation actually sent, and
  12675. // `apply_static_file_compression()` go through this, so the two cannot drift
  12676. // apart.
  12677. inline detail::EncodingType
  12678. Server::static_file_encoding(const Request &req, const Response &res,
  12679. const std::string &content_type,
  12680. size_t length) const {
  12681. if (!static_file_compression_) { return detail::EncodingType::None; }
  12682. // Nothing to compress, and an empty file already answers with
  12683. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12684. // turn an empty body into a 20-byte gzip stream.
  12685. if (length == 0) { return detail::EncodingType::None; }
  12686. // A file that already fits in a single packet gains nothing from being made
  12687. // smaller, since it still travels in that one segment, and a file of a few
  12688. // bytes comes out larger than it went in.
  12689. if (length < static_file_compression_min_length_) {
  12690. return detail::EncodingType::None;
  12691. }
  12692. // RFC 9110 applies Range to the representation after content coding, so a
  12693. // compressed 206 would mean compressing the whole file and then slicing it.
  12694. // Serve ranges from the identity representation instead.
  12695. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12696. if (static_file_compression_max_length_ > 0 &&
  12697. length > static_file_compression_max_length_) {
  12698. return detail::EncodingType::None;
  12699. }
  12700. return detail::encoding_type(req, res, content_type);
  12701. }
  12702. // Compresses a file-backed content provider into `res.body`. Returns false when
  12703. // the response is left untouched.
  12704. inline bool Server::apply_static_file_compression(const Request &req,
  12705. Response &res) const {
  12706. auto type = res.content_coding_;
  12707. if (type == detail::EncodingType::None || !res.content_provider_) {
  12708. return false;
  12709. }
  12710. auto compressor = detail::make_compressor(type);
  12711. if (!compressor) { return false; }
  12712. output_pre_compression_log(req, res);
  12713. std::string compressed;
  12714. if (!detail::compress_content_provider(res.content_provider_,
  12715. res.content_length_, *compressor,
  12716. compressed)) {
  12717. return false;
  12718. }
  12719. res.body.swap(compressed);
  12720. // The provider was consumed in full, so its releaser hears about a success.
  12721. res.content_provider_success_ = true;
  12722. detail::clear_content_provider(res);
  12723. res.set_header("Content-Encoding", detail::encoding_name(type));
  12724. res.set_header("Vary", "Accept-Encoding");
  12725. return true;
  12726. }
  12727. inline void Server::apply_ranges(const Request &req, Response &res,
  12728. std::string &content_type,
  12729. std::string &boundary) const {
  12730. // A known-length content provider leaves `res.body` empty, so the compressor
  12731. // at the end of this function never runs for one (issue #2545). A file-backed
  12732. // provider is fully readable right here, so compress it and answer with an
  12733. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12734. // takes the same path as `set_content()` from here on. Range requests never
  12735. // get a content coding, so `Content-Range` still names identity bytes and
  12736. // none of the range handling below applies.
  12737. if (apply_static_file_compression(req, res)) { return; }
  12738. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12739. auto it = res.headers.find("Content-Type");
  12740. if (it != res.headers.end()) {
  12741. content_type = it->second;
  12742. res.headers.erase(it);
  12743. }
  12744. boundary = detail::make_multipart_data_boundary();
  12745. res.set_header("Content-Type",
  12746. "multipart/byteranges; boundary=" + boundary);
  12747. }
  12748. auto type =
  12749. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  12750. if (res.body.empty()) {
  12751. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12752. res.status == StatusCode::PartialContent_206) {
  12753. auto offset_and_length = detail::get_range_offset_and_length(
  12754. req.ranges[0], res.content_length_);
  12755. auto content_range = detail::make_content_range_header_field(
  12756. offset_and_length, res.content_length_);
  12757. res.set_header("Content-Range", content_range);
  12758. } else if (res.is_chunked_content_provider_) {
  12759. res.content_coding_ = type;
  12760. if (type != detail::EncodingType::None) {
  12761. res.set_header("Content-Encoding", detail::encoding_name(type));
  12762. res.set_header("Vary", "Accept-Encoding");
  12763. }
  12764. }
  12765. } else {
  12766. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12767. ;
  12768. } else if (req.ranges.size() == 1) {
  12769. auto offset_and_length =
  12770. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12771. auto offset = offset_and_length.first;
  12772. auto length = offset_and_length.second;
  12773. auto content_range = detail::make_content_range_header_field(
  12774. offset_and_length, res.body.size());
  12775. res.set_header("Content-Range", content_range);
  12776. assert(offset + length <= res.body.size());
  12777. res.body = res.body.substr(offset, length);
  12778. } else {
  12779. std::string data;
  12780. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12781. res.body.size(), data);
  12782. res.body.swap(data);
  12783. }
  12784. if (type != detail::EncodingType::None) {
  12785. output_pre_compression_log(req, res);
  12786. if (auto compressor = detail::make_compressor(type)) {
  12787. std::string compressed;
  12788. if (compressor->compress(res.body.data(), res.body.size(), true,
  12789. [&](const char *data, size_t data_len) {
  12790. compressed.append(data, data_len);
  12791. return true;
  12792. })) {
  12793. res.body.swap(compressed);
  12794. res.set_header("Content-Encoding", detail::encoding_name(type));
  12795. res.set_header("Vary", "Accept-Encoding");
  12796. }
  12797. }
  12798. }
  12799. res.content_length_ = res.body.size();
  12800. }
  12801. }
  12802. inline bool Server::dispatch_request_for_content_reader(
  12803. Request &req, Response &res, ContentReader content_reader,
  12804. const HandlersForContentReader &handlers) const {
  12805. for (const auto &x : handlers) {
  12806. const auto &matcher = x.first;
  12807. const auto &handler = x.second;
  12808. if (matcher->match(req)) {
  12809. req.matched_route = matcher->pattern();
  12810. if (!pre_request_handler_ ||
  12811. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12812. handler(req, res, content_reader);
  12813. }
  12814. return true;
  12815. }
  12816. }
  12817. return false;
  12818. }
  12819. inline std::string
  12820. get_client_ip(const std::string &x_forwarded_for,
  12821. const std::vector<std::string> &trusted_proxies) {
  12822. // X-Forwarded-For is a comma-separated list per RFC 7239
  12823. std::vector<std::string> ip_list;
  12824. detail::split(x_forwarded_for.data(),
  12825. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12826. [&](const char *b, const char *e) {
  12827. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12828. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12829. });
  12830. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12831. // no segments. Signal "no client IP derived" with an empty string so the
  12832. // caller can fall back to the connection-level remote address.
  12833. if (ip_list.empty()) { return std::string(); }
  12834. // Each hop appends the address it received the request from, so the rightmost
  12835. // entries are the ones written by our own infrastructure while the leftmost
  12836. // are whatever the original client chose to send. Walk from the right and
  12837. // skip trusted proxies; the first address that is not a trusted proxy is the
  12838. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12839. // from the left instead lets a client forge an arbitrary address by following
  12840. // it with a trusted proxy's address, which the left-to-right scan then
  12841. // returned as the client.
  12842. for (size_t i = ip_list.size(); i-- > 0;) {
  12843. const auto &ip = ip_list[i];
  12844. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  12845. }
  12846. // Every hop was a trusted proxy; fall back to the first entry.
  12847. return ip_list.front();
  12848. }
  12849. inline bool
  12850. Server::process_request(Stream &strm, const std::string &remote_addr,
  12851. int remote_port, const std::string &local_addr,
  12852. int local_port, bool close_connection,
  12853. bool &connection_closed,
  12854. const std::function<void(Request &)> &setup_request,
  12855. bool *websocket_upgraded) {
  12856. std::array<char, 2048> buf{};
  12857. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12858. // The read timeout bounds the request line and headers as a whole, so a
  12859. // client sending them a byte at a time cannot hold the worker any longer.
  12860. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  12861. strm.set_max_timeout(read_timeout_msec);
  12862. // Connection has been closed on client
  12863. if (!line_reader.getline()) { return false; }
  12864. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12865. // clients send an extra CRLF after a request body, which would otherwise be
  12866. // parsed as the next request on a persistent connection.
  12867. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12868. return false;
  12869. }
  12870. Request req;
  12871. req.start_time_ = std::chrono::steady_clock::now();
  12872. req.remote_addr = remote_addr;
  12873. req.remote_port = remote_port;
  12874. req.local_addr = local_addr;
  12875. req.local_port = local_port;
  12876. Response res;
  12877. res.version = "HTTP/1.1";
  12878. res.headers = default_headers_;
  12879. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12880. // close the connection after that response, whichever path wrote it (an
  12881. // error status, a handler, or a rejected request). Reading on would also
  12882. // parse whatever the client sent next on a connection it considers done.
  12883. auto honor_connection_close = detail::scope_exit([&] {
  12884. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12885. connection_closed = true;
  12886. }
  12887. });
  12888. // Request line and headers. A rejected message leaves the rest of it (and
  12889. // any body) unread, so the connection cannot be reused: the leftover bytes
  12890. // would be parsed as the next request.
  12891. if (!parse_request_line(line_reader.ptr(), req)) {
  12892. connection_closed = true;
  12893. res.status = StatusCode::BadRequest_400;
  12894. output_error_log(Error::InvalidRequestLine, &req);
  12895. return write_response(strm, close_connection, req, res);
  12896. }
  12897. // Request headers
  12898. if (!detail::read_headers(strm, req.headers)) {
  12899. connection_closed = true;
  12900. res.status = StatusCode::BadRequest_400;
  12901. output_error_log(Error::InvalidHeaders, &req);
  12902. return write_response(strm, close_connection, req, res);
  12903. }
  12904. strm.set_max_timeout(0);
  12905. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12906. // which would otherwise let an intermediary and this parser disagree on
  12907. // where the body ends and enable request smuggling. Three cases: a
  12908. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12909. // or empty), which would otherwise be read as "no body"; a non-zero
  12910. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12911. // tolerated for compatibility with existing clients); and a
  12912. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12913. // length undeterminable. None of them may fall through to the "no body"
  12914. // path, or the body bytes are parsed as the next request on a persistent
  12915. // connection.
  12916. auto is_invalid_content_length = false;
  12917. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12918. is_invalid_content_length);
  12919. if (is_invalid_content_length ||
  12920. detail::has_conflicting_content_length(req.headers) ||
  12921. (req.has_header("Transfer-Encoding") &&
  12922. !detail::is_chunked_transfer_encoding(req.headers))) {
  12923. connection_closed = true;
  12924. res.status = StatusCode::BadRequest_400;
  12925. return write_response(strm, close_connection, req, res);
  12926. }
  12927. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  12928. if (req.has_header("Transfer-Encoding") &&
  12929. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  12930. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  12931. "chunked"))) {
  12932. connection_closed = true;
  12933. res.status = StatusCode::NotImplemented_501;
  12934. return write_response(strm, close_connection, req, res);
  12935. }
  12936. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12937. // HTTP/1.0 request, is honoured, but the connection closes after the
  12938. // response.
  12939. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12940. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12941. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12942. // the same authority.
  12943. auto host_count = req.get_header_value_count("Host");
  12944. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12945. !detail::fields::is_host(req.get_header_value("Host"))) {
  12946. connection_closed = true;
  12947. res.status = StatusCode::BadRequest_400;
  12948. output_error_log(Error::InvalidHeaders, &req);
  12949. return write_response(strm, close_connection, req, res);
  12950. }
  12951. // Check if the request URI doesn't exceed the limit
  12952. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12953. connection_closed = true;
  12954. res.status = StatusCode::UriTooLong_414;
  12955. output_error_log(Error::ExceedUriMaxLength, &req);
  12956. return write_response(strm, close_connection, req, res);
  12957. }
  12958. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12959. connection_closed = true;
  12960. }
  12961. if (req.version == "HTTP/1.0" &&
  12962. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12963. connection_closed = true;
  12964. }
  12965. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12966. // itself a trusted proxy. Otherwise any direct client could spoof
  12967. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12968. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  12969. req.has_header("X-Forwarded-For")) {
  12970. // Some proxies append the address they observed as a separate
  12971. // X-Forwarded-For field line instead of extending the one the client sent
  12972. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12973. // be scanned. Reading only the first occurrence would hand back the
  12974. // client-supplied, and therefore forgeable, value.
  12975. auto x_forwarded_for =
  12976. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12977. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12978. req.remote_addr = derived.empty() ? remote_addr : derived;
  12979. } else {
  12980. req.remote_addr = remote_addr;
  12981. }
  12982. req.remote_port = remote_port;
  12983. req.local_addr = local_addr;
  12984. req.local_port = local_port;
  12985. if (req.has_header("Accept")) {
  12986. auto accept_header =
  12987. detail::get_combined_header_value(req.headers, "Accept");
  12988. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12989. connection_closed = true;
  12990. res.status = StatusCode::BadRequest_400;
  12991. output_error_log(Error::HTTPParsing, &req);
  12992. return write_response(strm, close_connection, req, res);
  12993. }
  12994. }
  12995. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  12996. if ((req.method == "GET" || req.method == "HEAD") &&
  12997. req.has_header("Range")) {
  12998. const auto &range_header_value = req.get_header_value("Range");
  12999. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  13000. connection_closed = true;
  13001. res.status = StatusCode::RangeNotSatisfiable_416;
  13002. output_error_log(Error::InvalidRangeHeader, &req);
  13003. return write_response(strm, close_connection, req, res);
  13004. }
  13005. }
  13006. if (setup_request) { setup_request(req); }
  13007. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  13008. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  13009. // must be ignored. An expectation we do not recognize is left alone; the
  13010. // 417 the section allows for one is a MAY, not a requirement.
  13011. //
  13012. // `100 Continue` itself is deferred until the body is actually read (see
  13013. // read_content_core), so a request rejected by a later handler never
  13014. // invites the client to send a body nobody will read.
  13015. if (req.version != "HTTP/1.0" &&
  13016. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  13017. int status = StatusCode::Continue_100;
  13018. if (expect_100_continue_handler_) {
  13019. status = expect_100_continue_handler_(req, res);
  13020. }
  13021. if (status == StatusCode::Continue_100) {
  13022. req.expect_100_continue_pending_ = true;
  13023. } else {
  13024. if (res.status == -1) { res.status = status; }
  13025. connection_closed = true;
  13026. return write_response(strm, true, req, res);
  13027. }
  13028. }
  13029. // Setup `is_connection_closed` method
  13030. auto sock = strm.socket();
  13031. req.is_connection_closed = [sock]() {
  13032. return !detail::is_socket_alive(sock);
  13033. };
  13034. // WebSocket upgrade
  13035. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13036. // that authentication and other middleware can reject the request with an
  13037. // HTTP response (e.g., 401) before the protocol switches.
  13038. // The response says so when this connection closes after it.
  13039. auto close_after_response = close_connection || connection_closed;
  13040. // An upgrade request has been through pre-routing before it reaches routing()
  13041. auto is_upgrade = detail::is_websocket_upgrade(req);
  13042. if (is_upgrade) {
  13043. // A response given here leaves the body unread, and it would be parsed as
  13044. // the next request.
  13045. auto close_if_answered =
  13046. close_after_response || detail::has_framed_body(req);
  13047. const WebSocketHandlerEntry *ws_route = nullptr;
  13048. std::string selected_subprotocol;
  13049. auto answer_before_upgrade = [&]() -> bool {
  13050. if (pre_routing_handler_ &&
  13051. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13052. return true;
  13053. }
  13054. for (const auto &entry : websocket_handlers_) {
  13055. if (!entry.matcher->match(req)) { continue; }
  13056. req.matched_route = entry.matcher->pattern();
  13057. if (pre_request_handler_ &&
  13058. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13059. return true;
  13060. }
  13061. ws_route = &entry;
  13062. if (entry.sub_protocol_selector) {
  13063. auto protocol_header = detail::get_combined_header_value(
  13064. req.headers, "Sec-WebSocket-Protocol");
  13065. if (!protocol_header.empty()) {
  13066. std::vector<std::string> protocols;
  13067. detail::split(protocol_header.data(),
  13068. protocol_header.data() + protocol_header.size(), ',',
  13069. [&](const char *b, const char *e) {
  13070. protocols.emplace_back(b, e);
  13071. });
  13072. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13073. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13074. if (std::find(protocols.begin(), protocols.end(),
  13075. selected_subprotocol) == protocols.end()) {
  13076. selected_subprotocol.clear();
  13077. }
  13078. }
  13079. }
  13080. return false;
  13081. }
  13082. return false;
  13083. };
  13084. auto answered = false;
  13085. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13086. answered = answer_before_upgrade();
  13087. #else
  13088. try {
  13089. answered = answer_before_upgrade();
  13090. } catch (...) {
  13091. if (!handle_exception(req, res)) {
  13092. return write_response(strm, close_if_answered, req, res);
  13093. }
  13094. answered = true;
  13095. }
  13096. #endif
  13097. if (answered) {
  13098. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13099. return write_response_with_content(strm, close_if_answered, req, res);
  13100. }
  13101. if (ws_route) {
  13102. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13103. auto accept_key = detail::websocket_accept_key(client_key);
  13104. // Send 101 Switching Protocols
  13105. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13106. "Upgrade: websocket\r\n"
  13107. "Connection: Upgrade\r\n"
  13108. "Sec-WebSocket-Accept: " +
  13109. accept_key + "\r\n";
  13110. if (!selected_subprotocol.empty()) {
  13111. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13112. return false;
  13113. }
  13114. handshake_response +=
  13115. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13116. }
  13117. handshake_response += "\r\n";
  13118. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13119. 0) {
  13120. return false;
  13121. }
  13122. connection_closed = true;
  13123. if (websocket_upgraded) { *websocket_upgraded = true; }
  13124. #ifdef CPPHTTPLIB_SSL_ENABLED
  13125. if (req.ssl) {
  13126. // wss: the heartbeat ping thread and the read path enter the same
  13127. // TLS session from different threads. Hand the WebSocket a stream
  13128. // that serializes every TLS call, so the shared SSLSocketStream on
  13129. // the plain HTTP/HTTPS paths stays untouched.
  13130. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13131. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13132. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13133. write_timeout_sec_, write_timeout_usec_));
  13134. ws::WebSocket ws(std::move(ws_strm), req, true,
  13135. websocket_ping_interval_sec_,
  13136. websocket_max_missed_pongs_);
  13137. ws_route->handler(req, ws);
  13138. return true;
  13139. }
  13140. #endif
  13141. // Use WebSocket-specific read timeout instead of HTTP timeout
  13142. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13143. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13144. websocket_max_missed_pongs_);
  13145. ws_route->handler(req, ws);
  13146. return true;
  13147. }
  13148. // No WebSocket route: route it as a plain HTTP request
  13149. }
  13150. // Routing
  13151. auto routed = false;
  13152. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13153. routed = routing(req, res, strm, is_upgrade);
  13154. #else
  13155. try {
  13156. routed = routing(req, res, strm, is_upgrade);
  13157. } catch (...) { routed = handle_exception(req, res); }
  13158. #endif
  13159. auto ret = false;
  13160. if (routed) {
  13161. if (res.status == -1) {
  13162. res.status = req.ranges.empty() ? StatusCode::OK_200
  13163. : StatusCode::PartialContent_206;
  13164. }
  13165. // Before the Range checks below, so they see the body's own length.
  13166. detail::prefer_assigned_body(res);
  13167. // Serve file content by using a content provider
  13168. auto file_open_error = false;
  13169. if (!res.file_content_path_.empty()) {
  13170. const auto &path = res.file_content_path_;
  13171. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13172. if (!mm->is_open()) {
  13173. res.status = StatusCode::NotFound_404;
  13174. output_error_log(Error::OpenFile, &req);
  13175. file_open_error = true;
  13176. } else {
  13177. auto content_type = res.file_content_content_type_;
  13178. if (content_type.empty()) {
  13179. // One the handler set after set_file_content()
  13180. content_type = res.get_header_value("Content-Type");
  13181. }
  13182. if (content_type.empty()) {
  13183. content_type = detail::find_content_type(
  13184. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13185. }
  13186. detail::set_file_content_provider(
  13187. res, mm, content_type,
  13188. static_file_encoding(req, res, content_type, mm->size()));
  13189. }
  13190. }
  13191. if (file_open_error) {
  13192. ret = write_response(strm, close_after_response, req, res);
  13193. } else if (detail::range_error(req, res)) {
  13194. detail::clear_content(res);
  13195. res.status = StatusCode::RangeNotSatisfiable_416;
  13196. ret = write_response(strm, close_after_response, req, res);
  13197. } else {
  13198. ret = write_response_with_content(strm, close_after_response, req, res);
  13199. }
  13200. } else {
  13201. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13202. ret = write_response(strm, close_after_response, req, res);
  13203. }
  13204. // Drain any unconsumed framed body to prevent request smuggling on
  13205. // keep-alive. Without framing there is no body to drain — reading would
  13206. // consume the next request (issue #2450). If the response has committed the
  13207. // connection to close, there is no next request to protect. A body read in
  13208. // part cannot be drained from where it stopped, so the connection closes,
  13209. // as it does when the body is longer than the drain limit or does not
  13210. // arrive within the read timeout.
  13211. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13212. !detail::has_header_token(res.headers, "Connection", "close")) {
  13213. strm.set_max_timeout(read_timeout_msec);
  13214. int dummy_status;
  13215. if (req.body_read_started_ ||
  13216. !detail::read_content(
  13217. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13218. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13219. false)) {
  13220. connection_closed = true;
  13221. }
  13222. }
  13223. return ret;
  13224. }
  13225. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13226. inline bool Server::process_and_close_socket(socket_t sock) {
  13227. std::string remote_addr;
  13228. int remote_port = 0;
  13229. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13230. std::string local_addr;
  13231. int local_port = 0;
  13232. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13233. bool websocket_upgraded = false;
  13234. auto ret = serve_guarded([&]() {
  13235. return detail::process_server_socket(
  13236. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13237. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13238. write_timeout_usec_,
  13239. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13240. return process_request(strm, remote_addr, remote_port, local_addr,
  13241. local_port, close_connection,
  13242. connection_closed, nullptr,
  13243. &websocket_upgraded);
  13244. });
  13245. });
  13246. detail::drain_and_close_socket(sock);
  13247. return ret;
  13248. }
  13249. inline void Server::output_log(const Request &req, const Response &res) const {
  13250. if (logger_) {
  13251. std::lock_guard<std::mutex> guard(logger_mutex_);
  13252. logger_(req, res);
  13253. }
  13254. }
  13255. inline void Server::output_pre_compression_log(const Request &req,
  13256. const Response &res) const {
  13257. if (pre_compression_logger_) {
  13258. std::lock_guard<std::mutex> guard(logger_mutex_);
  13259. pre_compression_logger_(req, res);
  13260. }
  13261. }
  13262. inline void Server::output_error_log(const Error &err,
  13263. const Request *req) const {
  13264. if (error_logger_) {
  13265. std::lock_guard<std::mutex> guard(logger_mutex_);
  13266. error_logger_(err, req);
  13267. }
  13268. }
  13269. /*
  13270. * Group 5: ClientImpl and Client (Universal) implementation
  13271. */
  13272. // HTTP client implementation
  13273. inline ClientImpl::ClientImpl(const std::string &host)
  13274. : ClientImpl(host, 80, std::string(), std::string()) {}
  13275. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13276. : ClientImpl(host, port, std::string(), std::string()) {}
  13277. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13278. const std::string &client_cert_path,
  13279. const std::string &client_key_path)
  13280. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13281. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13282. inline ClientImpl::~ClientImpl() {
  13283. // Wait until all the requests in flight are handled.
  13284. size_t retry_count = 10;
  13285. while (retry_count-- > 0) {
  13286. {
  13287. std::lock_guard<std::mutex> guard(socket_mutex_);
  13288. if (socket_requests_in_flight_ == 0) { break; }
  13289. }
  13290. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13291. }
  13292. std::lock_guard<std::mutex> guard(socket_mutex_);
  13293. shutdown_socket(socket_);
  13294. close_socket(socket_);
  13295. }
  13296. inline bool ClientImpl::is_valid() const { return true; }
  13297. inline bool
  13298. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13299. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13300. if (no_proxy_entries_.empty()) { return true; }
  13301. // host_ is const so its normalized form is invariant; cache it. The
  13302. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13303. if (host == host_) {
  13304. if (!host_normalized_valid_) {
  13305. host_normalized_ = detail::normalize_target(host_);
  13306. host_normalized_valid_ = true;
  13307. }
  13308. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13309. }
  13310. auto target = detail::normalize_target(host);
  13311. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13312. }
  13313. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13314. if (is_proxy_enabled_for_host(host_)) {
  13315. return detail::create_client_socket(
  13316. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13317. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13318. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13319. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13320. }
  13321. // Check is custom IP or hostname specified for host_
  13322. std::string connect_host;
  13323. std::string ip;
  13324. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13325. return detail::create_client_socket(
  13326. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13327. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13328. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13329. write_timeout_usec_, interface_, error);
  13330. }
  13331. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13332. Error &error) {
  13333. auto sock = create_client_socket(error);
  13334. if (sock == INVALID_SOCKET) { return false; }
  13335. socket.sock = sock;
  13336. return true;
  13337. }
  13338. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13339. socket_tls_settings_version_ = tls_settings_version_;
  13340. return create_and_connect_socket(socket, error);
  13341. }
  13342. inline bool ClientImpl::setup_proxy_connection(
  13343. Socket & /*socket*/,
  13344. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13345. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13346. return true;
  13347. }
  13348. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13349. bool /*shutdown_gracefully*/) {
  13350. // If there are any requests in flight from threads other than us, then it's
  13351. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13352. assert(socket_requests_in_flight_ == 0 ||
  13353. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13354. }
  13355. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13356. if (socket.sock == INVALID_SOCKET) { return; }
  13357. detail::shutdown_socket(socket.sock);
  13358. }
  13359. inline void ClientImpl::close_socket(Socket &socket) {
  13360. // If there are requests in flight in another thread, usually closing
  13361. // the socket will be fine and they will simply receive an error when
  13362. // using the closed socket, but it is still a bug since rarely the OS
  13363. // may reassign the socket id to be used for a new socket, and then
  13364. // suddenly they will be operating on a live socket that is different
  13365. // than the one they intended!
  13366. assert(socket_requests_in_flight_ == 0 ||
  13367. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13368. // It is also a bug if this happens while SSL is still active
  13369. #ifdef CPPHTTPLIB_SSL_ENABLED
  13370. assert(socket.ssl == nullptr);
  13371. #endif
  13372. if (socket.sock == INVALID_SOCKET) { return; }
  13373. detail::close_socket(socket.sock);
  13374. socket.sock = INVALID_SOCKET;
  13375. }
  13376. inline void ClientImpl::disconnect(bool gracefully) {
  13377. shutdown_ssl(socket_, gracefully);
  13378. shutdown_socket(socket_);
  13379. close_socket(socket_);
  13380. }
  13381. inline bool ClientImpl::socket_reusable() {
  13382. if (!socket_.is_open()) { return false; }
  13383. auto is_alive = detail::is_socket_alive(socket_.sock);
  13384. #ifdef CPPHTTPLIB_SSL_ENABLED
  13385. if (is_alive && is_ssl() && tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13386. is_alive = false;
  13387. }
  13388. #endif
  13389. if (!is_alive) {
  13390. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13391. disconnect(/*gracefully=*/false);
  13392. return false;
  13393. }
  13394. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13395. disconnect(/*gracefully=*/true);
  13396. return false;
  13397. }
  13398. return true;
  13399. }
  13400. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13401. Response &res,
  13402. bool skip_100_continue) const {
  13403. std::array<char, 2048> buf{};
  13404. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13405. if (!line_reader.getline()) { return false; }
  13406. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13407. res.reason)) {
  13408. return req.method == "CONNECT";
  13409. }
  13410. // Skip interim (1xx) responses along with their header fields, except a 100
  13411. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13412. // HTTP on the connection, so it is final. A server sending them without end
  13413. // would hold the client, so there may be only so many.
  13414. size_t interim_count = 0;
  13415. while (100 <= res.status && res.status < 200 &&
  13416. res.status != StatusCode::SwitchingProtocol_101 &&
  13417. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13418. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13419. return false;
  13420. }
  13421. Headers interim_headers;
  13422. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13423. if (!line_reader.getline()) { return false; } // next response line
  13424. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13425. res.reason)) {
  13426. return false;
  13427. }
  13428. }
  13429. return true;
  13430. }
  13431. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13432. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13433. // A same-origin redirect and a digest retry send through here again. Only
  13434. // the call the caller made reports a failure, once, with its request.
  13435. auto outermost = send_depth_++ == 0;
  13436. auto se = detail::scope_exit([&] { send_depth_--; });
  13437. if (outermost) { error = Error::Success; }
  13438. auto ret = send_(req, res, error);
  13439. if (error == Error::SSLPeerCouldBeClosed_) {
  13440. assert(!ret);
  13441. ret = send_(req, res, error);
  13442. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13443. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13444. }
  13445. // Also an answer that carries an error, such as a proxy's 407
  13446. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13447. return ret;
  13448. }
  13449. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13450. #ifdef CPPHTTPLIB_SSL_ENABLED
  13451. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13452. // client that failed to set up its TLS context keeps reporting why.
  13453. if (is_valid()) {
  13454. last_ssl_error_ = 0;
  13455. last_backend_error_ = 0;
  13456. }
  13457. #endif
  13458. {
  13459. std::lock_guard<std::mutex> guard(socket_mutex_);
  13460. // Set this to false immediately - if it ever gets set to true by the end
  13461. // of the request, we know another thread instructed us to close the
  13462. // socket.
  13463. socket_should_be_closed_when_request_is_done_ = false;
  13464. // A redirect or a retry sent inside a request keeps its stop()
  13465. if (socket_requests_in_flight_ == 0) { stop_requested_ = false; }
  13466. if (!socket_reusable()) {
  13467. if (!ensure_socket_connection(socket_, error)) { return false; }
  13468. {
  13469. auto success = true;
  13470. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13471. error)) {
  13472. return success;
  13473. }
  13474. }
  13475. }
  13476. // Mark the current socket as being in use so that it cannot be closed by
  13477. // anyone else while this request is ongoing, even though we will be
  13478. // releasing the mutex.
  13479. if (socket_requests_in_flight_ > 1) {
  13480. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13481. }
  13482. socket_requests_in_flight_ += 1;
  13483. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13484. }
  13485. for (const auto &header : default_headers_) {
  13486. if (req.headers.find(header.first) == req.headers.end()) {
  13487. req.headers.insert(header);
  13488. }
  13489. }
  13490. auto ret = false;
  13491. auto close_connection = !keep_alive_;
  13492. auto se = detail::scope_exit([&]() {
  13493. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13494. std::lock_guard<std::mutex> guard(socket_mutex_);
  13495. socket_requests_in_flight_ -= 1;
  13496. if (socket_requests_in_flight_ <= 0) {
  13497. assert(socket_requests_in_flight_ == 0);
  13498. socket_requests_are_from_thread_ = std::thread::id();
  13499. }
  13500. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13501. !ret) {
  13502. disconnect(/*gracefully=*/true);
  13503. }
  13504. });
  13505. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13506. strm.set_read_interrupt([this] { return stop_requested_.load(); });
  13507. return handle_request(strm, req, res, close_connection, error);
  13508. });
  13509. if (!ret) {
  13510. if (error == Error::Success) { error = Error::Unknown; }
  13511. }
  13512. return ret;
  13513. }
  13514. inline Result ClientImpl::send(const Request &req) {
  13515. auto req2 = req;
  13516. return send_(std::move(req2));
  13517. }
  13518. inline Result ClientImpl::send_(Request &&req) {
  13519. auto res = detail::make_unique<Response>();
  13520. auto error = Error::Success;
  13521. #ifdef CPPHTTPLIB_SSL_ENABLED
  13522. // Hold the request lock until the Result has read this request's TLS error
  13523. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13524. #endif
  13525. auto ret = send(req, *res, error);
  13526. #ifdef CPPHTTPLIB_SSL_ENABLED
  13527. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13528. last_ssl_error_, last_backend_error_};
  13529. #else
  13530. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13531. #endif
  13532. }
  13533. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13534. const std::string &ct) {
  13535. (void)for_stream;
  13536. // Default headers are meant for the origin and may carry its credentials, so
  13537. // keep them off the CONNECT request the proxy reads.
  13538. if (r.method != "CONNECT") {
  13539. for (const auto &header : default_headers_) {
  13540. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13541. }
  13542. }
  13543. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13544. // prepend it rather than appending it after the caller's own fields.
  13545. if (!r.has_header("Host")) {
  13546. r.headers.emplace_front(
  13547. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13548. address_family_));
  13549. }
  13550. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13551. if (!r.content_receiver) {
  13552. if (!r.has_header("Accept-Encoding")) {
  13553. std::string accept_encoding;
  13554. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13555. accept_encoding = "br";
  13556. #endif
  13557. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13558. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13559. accept_encoding += "gzip, deflate";
  13560. #endif
  13561. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13562. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13563. accept_encoding += "zstd";
  13564. #endif
  13565. r.set_header("Accept-Encoding", accept_encoding);
  13566. }
  13567. detail::add_default_user_agent_header(r);
  13568. }
  13569. if (!r.body.empty()) {
  13570. if (!ct.empty() && !r.has_header("Content-Type")) {
  13571. r.headers.emplace("Content-Type", ct);
  13572. }
  13573. if (!r.has_header("Content-Length")) {
  13574. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13575. }
  13576. }
  13577. }
  13578. inline ClientImpl::StreamHandle
  13579. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13580. const Params &params, const Headers &headers,
  13581. const std::string &body,
  13582. const std::string &content_type) {
  13583. // Encode the target exactly like the buffered send path does, so that the
  13584. // same `path` produces the same request line through either API.
  13585. auto raw_query_path =
  13586. params.empty() ? path : append_query_params(path, params);
  13587. Request req;
  13588. req.method = method;
  13589. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13590. req.headers = headers;
  13591. req.body = body;
  13592. prepare_default_headers(req, true, content_type);
  13593. auto handle = open_stream_(req);
  13594. // Like a buffered request, a stream that fails to open is reported once
  13595. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13596. return handle;
  13597. }
  13598. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13599. StreamHandle handle;
  13600. handle.response = detail::make_unique<Response>();
  13601. handle.error = Error::Success;
  13602. handle.connection_ = detail::make_unique<ClientConnection>();
  13603. {
  13604. std::lock_guard<std::mutex> guard(socket_mutex_);
  13605. if (!socket_reusable()) {
  13606. if (!ensure_socket_connection(socket_, handle.error)) {
  13607. handle.response.reset();
  13608. return handle;
  13609. }
  13610. {
  13611. auto success = true;
  13612. auto start_time = std::chrono::steady_clock::now();
  13613. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13614. success, handle.error)) {
  13615. if (!success) { handle.response.reset(); }
  13616. return handle;
  13617. }
  13618. }
  13619. }
  13620. transfer_socket_ownership_to_handle(handle);
  13621. }
  13622. #ifdef CPPHTTPLIB_SSL_ENABLED
  13623. if (is_ssl() && handle.connection_->session) {
  13624. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13625. handle.connection_->sock, handle.connection_->session,
  13626. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13627. write_timeout_usec_);
  13628. } else {
  13629. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13630. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13631. write_timeout_sec_, write_timeout_usec_);
  13632. }
  13633. #else
  13634. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13635. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13636. write_timeout_sec_, write_timeout_usec_);
  13637. #endif
  13638. handle.stream_ = handle.socket_stream_.get();
  13639. auto &strm = *handle.stream_;
  13640. // After connecting, as for a buffered request
  13641. add_credential_headers(req);
  13642. // Build the request line and headers in memory first, like write_request()
  13643. // does, so that a rejected header leaves nothing on the wire.
  13644. {
  13645. detail::BufferStream bstrm;
  13646. // The path follows the authority in absolute-form, so one that does not
  13647. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13648. auto prefix = proxy_target_prefix();
  13649. if ((!prefix.empty() && req.path[0] != '/') ||
  13650. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  13651. handle.error = Error::Write;
  13652. handle.response.reset();
  13653. return handle;
  13654. }
  13655. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13656. handle.error)) {
  13657. handle.response.reset();
  13658. return handle;
  13659. }
  13660. const auto &data = bstrm.get_buffer();
  13661. if (!detail::write_data(strm, data.data(), data.size())) {
  13662. handle.error = Error::Write;
  13663. handle.response.reset();
  13664. return handle;
  13665. }
  13666. }
  13667. if (!req.body.empty()) {
  13668. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13669. handle.error = Error::Write;
  13670. handle.response.reset();
  13671. return handle;
  13672. }
  13673. }
  13674. if (!read_response_line(strm, req, *handle.response) ||
  13675. !detail::read_headers(strm, handle.response->headers)) {
  13676. handle.error = Error::Read;
  13677. handle.response.reset();
  13678. return handle;
  13679. }
  13680. handle.body_reader_.stream = handle.stream_;
  13681. handle.body_reader_.payload_max_length = payload_max_length_;
  13682. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13683. // header section, so none of its framing or coding headers apply.
  13684. if (req.method == "HEAD" ||
  13685. handle.response->status == StatusCode::NoContent_204 ||
  13686. handle.response->status == StatusCode::NotModified_304) {
  13687. handle.body_reader_.eof = true;
  13688. return handle;
  13689. }
  13690. // Same framing check as ClientImpl::process_request()
  13691. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13692. handle.error = Error::Read;
  13693. handle.response.reset();
  13694. return handle;
  13695. }
  13696. if (handle.response->has_header("Content-Length")) {
  13697. bool is_invalid = false;
  13698. auto content_length = detail::get_header_value_u64(
  13699. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13700. if (is_invalid) {
  13701. handle.error = Error::Read;
  13702. handle.response.reset();
  13703. return handle;
  13704. }
  13705. handle.body_reader_.has_content_length = true;
  13706. handle.body_reader_.content_length = content_length;
  13707. }
  13708. handle.body_reader_.chunked =
  13709. detail::is_chunked_transfer_encoding(handle.response->headers);
  13710. auto content_encoding = detail::get_combined_header_value(
  13711. handle.response->headers, "Content-Encoding");
  13712. if (decompress_ && !content_encoding.empty()) {
  13713. // Same policy as prepare_content_receiver(): reject a coding we know about
  13714. // but were not built with, pass an unrecognized one through as-is.
  13715. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13716. if (!handle.decompressor_) {
  13717. if (detail::is_known_content_encoding(content_encoding)) {
  13718. handle.error = Error::UnsupportedContentEncoding;
  13719. handle.response.reset();
  13720. return handle;
  13721. }
  13722. } else if (!handle.decompressor_->is_valid()) {
  13723. handle.error = Error::Compression;
  13724. handle.response.reset();
  13725. return handle;
  13726. }
  13727. }
  13728. return handle;
  13729. }
  13730. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13731. if (!is_valid() || !response) { return -1; }
  13732. auto n = decompressor_
  13733. ? read_with_decompression(buf, len)
  13734. : detail::read_body_content(stream_, body_reader_, buf, len);
  13735. if (n == 0) { parse_trailers_if_needed(); }
  13736. return n;
  13737. }
  13738. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13739. size_t len) {
  13740. if (decompress_offset_ < decompress_buffer_.size()) {
  13741. auto available = decompress_buffer_.size() - decompress_offset_;
  13742. auto to_copy = (std::min)(len, available);
  13743. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13744. decompress_offset_ += to_copy;
  13745. decompressed_bytes_read_ += to_copy;
  13746. return static_cast<ssize_t>(to_copy);
  13747. }
  13748. decompress_buffer_.clear();
  13749. decompress_offset_ = 0;
  13750. constexpr size_t kDecompressionBufferSize = 8192;
  13751. char compressed_buf[kDecompressionBufferSize];
  13752. while (true) {
  13753. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13754. sizeof(compressed_buf));
  13755. if (n <= 0) { return n; }
  13756. auto exceeded = false;
  13757. bool decompress_ok = decompressor_->decompress(
  13758. compressed_buf, static_cast<size_t>(n),
  13759. [&](const char *data, size_t data_len) {
  13760. decompress_buffer_.append(data, data_len);
  13761. auto limit = body_reader_.payload_max_length;
  13762. exceeded =
  13763. limit > 0 &&
  13764. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13765. return !exceeded;
  13766. });
  13767. if (!decompress_ok) {
  13768. body_reader_.last_error =
  13769. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13770. return -1;
  13771. }
  13772. if (!decompress_buffer_.empty()) { break; }
  13773. }
  13774. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13775. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13776. decompress_offset_ = to_copy;
  13777. decompressed_bytes_read_ += to_copy;
  13778. return static_cast<ssize_t>(to_copy);
  13779. }
  13780. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13781. // The trailers follow the last chunk, so there are none before it
  13782. auto &decoder = body_reader_.chunked_decoder;
  13783. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13784. return;
  13785. }
  13786. trailers_parsed_ = true;
  13787. decoder->parse_trailers_into(response->trailers, response->headers);
  13788. }
  13789. namespace detail {
  13790. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13791. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13792. size_t &out_chunk_offset,
  13793. size_t &out_chunk_total) {
  13794. if (finished) { return 0; }
  13795. if (chunk_remaining == 0) {
  13796. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13797. if (!lr.getline()) { return -1; }
  13798. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13799. // the line terminator is never mistaken for line content.
  13800. const char *eol = lr.ptr() + lr.size();
  13801. if (lr.end_with_crlf()) {
  13802. eol -= 2;
  13803. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13804. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13805. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13806. // has to come off here or the check below would reject the line.
  13807. eol -= 1;
  13808. }
  13809. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13810. const char *p = lr.ptr();
  13811. int v = 0;
  13812. if (p == eol || !is_hex(*p, v)) { return -1; }
  13813. size_t chunk_len = 0;
  13814. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13815. for (; p < eol && is_hex(*p, v); ++p) {
  13816. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13817. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13818. }
  13819. while (p < eol && is_space_or_tab(*p)) {
  13820. ++p;
  13821. }
  13822. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13823. // terminator, and it is built from tokens and quoted-strings, so it never
  13824. // holds a CR, LF or any other control character. getline() reads up to the
  13825. // CRLF, so a bare LF left in here would be swallowed as extension text
  13826. // while an intermediary that ends the line on it delimits the chunks
  13827. // differently, and the two disagree on where the body ends (request
  13828. // smuggling).
  13829. if (p < eol && *p != ';') { return -1; }
  13830. for (; p < eol; ++p) {
  13831. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13832. }
  13833. // The bytes around the data are no payload, so they are counted on their
  13834. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  13835. // them, which lets a stream send a byte at a time, and what goes past that
  13836. // in padding, leading zeros and extensions builds up to one header field.
  13837. overhead += lr.size() + 2;
  13838. overhead = overhead > 16 ? overhead - 16 : 0;
  13839. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  13840. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  13841. if (chunk_len == 0) {
  13842. chunk_remaining = 0;
  13843. finished = true;
  13844. out_chunk_offset = 0;
  13845. out_chunk_total = 0;
  13846. return 0;
  13847. }
  13848. chunk_remaining = chunk_len;
  13849. last_chunk_total = chunk_remaining;
  13850. last_chunk_offset = 0;
  13851. }
  13852. auto to_read = (std::min)(chunk_remaining, len);
  13853. auto n = strm.read(buf, to_read);
  13854. if (n <= 0) { return -1; }
  13855. auto offset_before = last_chunk_offset;
  13856. last_chunk_offset += static_cast<size_t>(n);
  13857. chunk_remaining -= static_cast<size_t>(n);
  13858. out_chunk_offset = offset_before;
  13859. out_chunk_total = last_chunk_total;
  13860. if (chunk_remaining == 0) {
  13861. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13862. if (!lr.getline()) { return -1; }
  13863. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13864. }
  13865. return n;
  13866. }
  13867. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13868. const Headers &src_headers) {
  13869. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13870. if (!lr.getline()) { return false; }
  13871. return parse_trailers(lr, dest, src_headers);
  13872. }
  13873. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  13874. // a redirect without a Location, is a final response.
  13875. inline bool is_redirect(const Response &res) {
  13876. switch (res.status) {
  13877. case StatusCode::MovedPermanently_301:
  13878. case StatusCode::Found_302:
  13879. case StatusCode::SeeOther_303:
  13880. case StatusCode::TemporaryRedirect_307:
  13881. case StatusCode::PermanentRedirect_308:
  13882. return !res.get_header_value("Location").empty();
  13883. default: return false;
  13884. }
  13885. }
  13886. } // namespace detail
  13887. inline void
  13888. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13889. handle.connection_->sock = socket_.sock;
  13890. #ifdef CPPHTTPLIB_SSL_ENABLED
  13891. handle.connection_->session = socket_.ssl;
  13892. socket_.ssl = nullptr;
  13893. #endif
  13894. socket_.sock = INVALID_SOCKET;
  13895. }
  13896. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  13897. inline std::string ClientImpl::proxy_target_prefix() const {
  13898. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  13899. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  13900. }
  13901. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13902. Response &res, bool close_connection,
  13903. Error &error) {
  13904. if (req.path.empty()) {
  13905. error = Error::Connection;
  13906. return false;
  13907. }
  13908. auto req_save = req;
  13909. bool ret;
  13910. auto prefix = proxy_target_prefix();
  13911. if (!prefix.empty()) {
  13912. // The path follows the authority in absolute-form, so one that does not
  13913. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13914. if (req.path[0] != '/') {
  13915. error = Error::Write;
  13916. return false;
  13917. }
  13918. auto req2 = req;
  13919. req2.path = prefix + req.path;
  13920. ret = process_request(strm, req2, res, close_connection, error);
  13921. req = std::move(req2);
  13922. req.path = req_save.path;
  13923. } else {
  13924. ret = process_request(strm, req, res, close_connection, error);
  13925. }
  13926. if (!ret) { return false; }
  13927. {
  13928. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13929. // for this to be safe.
  13930. // This is safe to call because handle_request is only called by send_
  13931. // which locks the request mutex during the process. It would be a bug
  13932. // to call it from a different thread since it's a thread-safety issue
  13933. // to do these things to the socket if another thread is using the socket.
  13934. std::lock_guard<std::mutex> guard(socket_mutex_);
  13935. // Also when the request asked for it (e.g. a body that was never sent,
  13936. // or "Connection: close"), so that a redirect or an auth retry below does
  13937. // not reuse the socket.
  13938. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13939. detail::has_header_token(res.headers, "Connection", "close") ||
  13940. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13941. disconnect(/*gracefully=*/true);
  13942. }
  13943. }
  13944. if (follow_location_ && detail::is_redirect(res)) {
  13945. req = std::move(req_save);
  13946. // The client that followed the redirect has answered any challenge it
  13947. // could. Retrying below would sign another host's challenge and send it
  13948. // here.
  13949. return redirect(req, res, error);
  13950. }
  13951. #ifdef CPPHTTPLIB_SSL_ENABLED
  13952. if ((res.status == StatusCode::Unauthorized_401 ||
  13953. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13954. req.authorization_count_ < 5) {
  13955. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13956. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13957. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13958. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13959. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13960. return ret;
  13961. }
  13962. const auto &username =
  13963. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13964. const auto &password =
  13965. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13966. if (!username.empty() && !password.empty()) {
  13967. std::map<std::string, std::string> auth;
  13968. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13969. Request new_req = req;
  13970. new_req.authorization_count_ += 1;
  13971. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13972. : "Authorization");
  13973. new_req.headers.insert(detail::make_digest_authentication_header(
  13974. req, make_request_target(req), auth, new_req.authorization_count_,
  13975. detail::random_string(10), username, password, is_proxy));
  13976. Response new_res;
  13977. ret = send(new_req, new_res, error);
  13978. if (ret) { res = std::move(new_res); }
  13979. }
  13980. }
  13981. }
  13982. #endif
  13983. return ret;
  13984. }
  13985. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13986. if (req.redirect_count_ == 0) {
  13987. error = Error::ExceedRedirectCount;
  13988. return false;
  13989. }
  13990. auto location = res.get_header_value("location");
  13991. if (location.empty()) { return false; }
  13992. detail::UrlComponents uc;
  13993. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13994. uc)) {
  13995. return false;
  13996. }
  13997. // Only follow http/https redirects
  13998. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13999. return false;
  14000. }
  14001. auto scheme = is_ssl() ? "https" : "http";
  14002. auto next_scheme = std::move(uc.scheme);
  14003. auto next_host = std::move(uc.host);
  14004. auto port_str = std::move(uc.port);
  14005. auto next_path = std::move(uc.path);
  14006. auto next_query = std::move(uc.query);
  14007. auto next_port = port_;
  14008. if (!port_str.empty()) {
  14009. if (!detail::parse_port(port_str, next_port)) { return false; }
  14010. } else if (!next_scheme.empty()) {
  14011. next_port = next_scheme == "https" ? 443 : 80;
  14012. }
  14013. if (next_scheme.empty()) { next_scheme = scheme; }
  14014. if (next_host.empty()) { next_host = host_; }
  14015. if (next_path.empty()) { next_path = "/"; }
  14016. // An absolute or absolute-path location can have dot segments too.
  14017. if (next_path[0] == '/') {
  14018. next_path = detail::remove_dot_segments(next_path);
  14019. }
  14020. auto path = std::move(next_path) + next_query;
  14021. // Same host redirect - use current client
  14022. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  14023. return detail::redirect(*this, req, res, path, location, error);
  14024. }
  14025. // Cross-host/scheme redirect - create new client with robust setup
  14026. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14027. path, location, error);
  14028. }
  14029. // New method for robust redirect client creation
  14030. inline bool ClientImpl::create_redirect_client(
  14031. const std::string &scheme, const std::string &host, int port, Request &req,
  14032. Response &res, const std::string &path, const std::string &location,
  14033. Error &error) {
  14034. // Determine if we need SSL
  14035. auto need_ssl = (scheme == "https");
  14036. // Clean up request headers that are host/client specific
  14037. // Remove headers that should not be carried over to new host
  14038. auto headers_to_remove = std::vector<std::string>{
  14039. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14040. for (const auto &header_name : headers_to_remove) {
  14041. auto it = req.headers.find(header_name);
  14042. while (it != req.headers.end()) {
  14043. it = req.headers.erase(it);
  14044. it = req.headers.find(header_name);
  14045. }
  14046. }
  14047. // Create appropriate client type and handle redirect
  14048. if (need_ssl) {
  14049. #ifdef CPPHTTPLIB_SSL_ENABLED
  14050. // Create SSL client for HTTPS redirect
  14051. SSLClient redirect_client(host, port);
  14052. // Setup basic client configuration first
  14053. setup_redirect_client(redirect_client);
  14054. redirect_client.enable_server_certificate_verification(
  14055. server_certificate_verification_);
  14056. redirect_client.enable_server_hostname_verification(
  14057. server_hostname_verification_);
  14058. redirect_client.system_ca_mode_ = system_ca_mode_;
  14059. // Transfer CA certificate to redirect client
  14060. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14061. if (is_ssl()) {
  14062. auto &self = static_cast<SSLClient &>(*this);
  14063. // A store given to set_ca_cert_store() lives only in this client's
  14064. // context, which then holds all that is trusted.
  14065. if (self.ca_cert_store_set_) {
  14066. std::string pem;
  14067. {
  14068. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14069. pem = detail::ca_certs_to_pem(self.ctx_);
  14070. }
  14071. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14072. redirect_client.ca_cert_store_set_ = true;
  14073. } else if (self.custom_ca_loaded_) {
  14074. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14075. ca_cert_pem_.size());
  14076. }
  14077. redirect_client.set_session_verifier(self.session_verifier_);
  14078. if (self.server_certificate_verifier_) {
  14079. redirect_client.set_server_certificate_verifier(
  14080. self.server_certificate_verifier_);
  14081. }
  14082. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14083. redirect_client.enable_windows_cert_verification_ =
  14084. self.enable_windows_cert_verification_;
  14085. #endif
  14086. }
  14087. // Client certificates are set through constructor for SSLClient
  14088. // NOTE: SSLClient constructor already takes client_cert_path and
  14089. // client_key_path so we need to create it properly if client certs are
  14090. // needed
  14091. // Execute the redirect
  14092. return detail::redirect(redirect_client, req, res, path, location, error);
  14093. #else
  14094. // SSL not supported - set appropriate error
  14095. error = Error::SSLConnection;
  14096. return false;
  14097. #endif
  14098. } else {
  14099. // HTTP redirect
  14100. ClientImpl redirect_client(host, port);
  14101. // Setup client with robust configuration
  14102. setup_redirect_client(redirect_client);
  14103. // Execute the redirect
  14104. return detail::redirect(redirect_client, req, res, path, location, error);
  14105. }
  14106. }
  14107. // New method for robust client setup (based on basic_manual_redirect.cpp
  14108. // logic)
  14109. template <typename ClientType>
  14110. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14111. // Copy basic settings first
  14112. client.set_connection_timeout(connection_timeout_sec_,
  14113. connection_timeout_usec_);
  14114. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14115. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14116. client.set_max_timeout(max_timeout_msec_);
  14117. if (has_payload_max_length_) {
  14118. client.set_payload_max_length(payload_max_length_);
  14119. }
  14120. client.set_keep_alive(keep_alive_);
  14121. client.set_follow_location(
  14122. true); // Enable redirects to handle multi-step redirects
  14123. client.set_path_encode(path_encode_);
  14124. client.set_compress(compress_);
  14125. client.set_decompress(decompress_);
  14126. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14127. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14128. // 15.4, credentials must not be forwarded when redirecting to a different
  14129. // host. This function is only called for cross-host redirects; same-host
  14130. // redirects are handled directly in ClientImpl::redirect().
  14131. // Copy the proxy configuration unconditionally; the per-target bypass is
  14132. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14133. // still use the proxy.
  14134. client.no_proxy_entries_ = no_proxy_entries_;
  14135. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14136. client.set_proxy(proxy_host_, proxy_port_);
  14137. if (!proxy_basic_auth_username_.empty() ||
  14138. !proxy_basic_auth_password_.empty()) {
  14139. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14140. proxy_basic_auth_password_);
  14141. }
  14142. if (!proxy_bearer_token_auth_token_.empty()) {
  14143. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14144. }
  14145. #ifdef CPPHTTPLIB_SSL_ENABLED
  14146. if (!proxy_digest_auth_username_.empty()) {
  14147. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14148. proxy_digest_auth_password_);
  14149. }
  14150. #endif
  14151. }
  14152. // Copy network and socket settings
  14153. client.addr_map_ = addr_map_;
  14154. client.tunnel_addr_map_ = tunnel_addr_map_;
  14155. client.set_address_family(address_family_);
  14156. client.set_tcp_nodelay(tcp_nodelay_);
  14157. client.set_ipv6_v6only(ipv6_v6only_);
  14158. if (socket_options_) { client.set_socket_options(socket_options_); }
  14159. if (!interface_.empty()) { client.set_interface(interface_); }
  14160. // Copy logging and headers. Not the error logger: a failure comes back to
  14161. // this client's send(), which reports it with the caller's request.
  14162. if (logger_) { client.set_logger(logger_); }
  14163. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14164. // Each new client should generate its own headers based on its target host
  14165. }
  14166. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14167. const Request &req,
  14168. Error &error) const {
  14169. auto is_shutting_down = []() { return false; };
  14170. if (req.is_chunked_content_provider_) {
  14171. auto compressor = compress_ ? detail::create_compressor().first
  14172. : std::unique_ptr<detail::compressor>();
  14173. if (!compressor) {
  14174. compressor = detail::make_unique<detail::nocompressor>();
  14175. }
  14176. return detail::write_content_chunked(strm, req.content_provider_,
  14177. is_shutting_down, *compressor, error);
  14178. } else {
  14179. return detail::write_content_with_progress(
  14180. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14181. req.upload_progress, error);
  14182. }
  14183. }
  14184. // What goes on the request line for req: its path, encoded and without the
  14185. // fragment, with `req.params` as the query when the path has none.
  14186. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14187. auto target = detail::encode_request_target(req.path, path_encode_);
  14188. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14189. target = append_query_params(target, req.params);
  14190. }
  14191. return target;
  14192. }
  14193. inline void ClientImpl::add_credential_headers(Request &req) {
  14194. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14195. // it opens is read by the origin. Each credential goes only to its own hop.
  14196. auto is_connect = req.method == "CONNECT";
  14197. if (!is_connect) {
  14198. detail::add_authorization_header(req, basic_auth_username_,
  14199. basic_auth_password_,
  14200. bearer_token_auth_token_, false);
  14201. }
  14202. // Proxy-Authorization is only sent when the proxy reads this message —
  14203. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14204. // would leak proxy credentials to the destination server.
  14205. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14206. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14207. proxy_basic_auth_password_,
  14208. proxy_bearer_token_auth_token_, true);
  14209. }
  14210. }
  14211. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14212. bool close_connection, Error &error,
  14213. bool skip_body, bool &rejected_locally) {
  14214. rejected_locally = false;
  14215. // Prepare additional headers
  14216. if (close_connection) {
  14217. if (!req.has_header("Connection")) {
  14218. req.set_header("Connection", "close");
  14219. }
  14220. }
  14221. std::string ct_for_defaults;
  14222. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14223. ct_for_defaults = "text/plain";
  14224. }
  14225. prepare_default_headers(req, false, ct_for_defaults);
  14226. if (req.body.empty()) {
  14227. if (req.content_provider_) {
  14228. if (!req.is_chunked_content_provider_) {
  14229. if (!req.has_header("Content-Length")) {
  14230. auto length = std::to_string(req.content_length_);
  14231. req.set_header("Content-Length", length);
  14232. }
  14233. }
  14234. } else {
  14235. if (req.method == "POST" || req.method == "PUT" ||
  14236. req.method == "PATCH") {
  14237. req.set_header("Content-Length", "0");
  14238. }
  14239. }
  14240. }
  14241. add_credential_headers(req);
  14242. // Request line and headers
  14243. {
  14244. detail::BufferStream bstrm;
  14245. auto path_with_query = make_request_target(req);
  14246. // The query already came in through `req.path`; still populate
  14247. // `req.params` for handlers/users who read them.
  14248. auto query_part = detail::query_of(req.path);
  14249. if (!query_part.empty()) {
  14250. detail::parse_query_text(query_part, req.params);
  14251. }
  14252. // Write request line and headers
  14253. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14254. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14255. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14256. // fail the request cleanly instead of emitting a request-line-less,
  14257. // header-injecting request.
  14258. error = Error::Write;
  14259. rejected_locally = true;
  14260. return false;
  14261. }
  14262. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14263. error)) {
  14264. rejected_locally = true;
  14265. return false;
  14266. }
  14267. // Flush buffer
  14268. auto &data = bstrm.get_buffer();
  14269. if (!detail::write_data(strm, data.data(), data.size())) {
  14270. error = Error::Write;
  14271. return false;
  14272. }
  14273. }
  14274. // After sending request line and headers, wait briefly for an early server
  14275. // response (e.g. 4xx) and avoid sending a potentially large request body
  14276. // unnecessarily. This workaround is only enabled on Windows because Unix
  14277. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14278. // buffering can accept large writes even when the peer already responded.
  14279. // Check the stream first (which covers SSL via `is_readable()`), then
  14280. // fall back to select on the socket. Only perform the wait for very large
  14281. // request bodies to avoid interfering with normal small requests and
  14282. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14283. // response. Skip this check when using Expect: 100-continue, as the protocol
  14284. // handles early responses properly.
  14285. #if defined(_WIN32)
  14286. if (!skip_body &&
  14287. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14288. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14289. auto start = std::chrono::high_resolution_clock::now();
  14290. for (;;) {
  14291. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14292. // from SSL internals. If the underlying socket is readable, assume an
  14293. // early response may be present.
  14294. auto sock = strm.socket();
  14295. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14296. return false;
  14297. }
  14298. // Fallback to stream-level check for non-socket streams or when the
  14299. // socket isn't reporting readable. Avoid using `is_readable()` for
  14300. // SSL, since `SSL_pending()` may report buffered records that do not
  14301. // indicate a complete application-level response yet.
  14302. if (!is_ssl() && strm.is_readable()) { return false; }
  14303. auto now = std::chrono::high_resolution_clock::now();
  14304. auto elapsed =
  14305. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14306. .count();
  14307. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14308. break;
  14309. }
  14310. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14311. }
  14312. }
  14313. #endif
  14314. // Body
  14315. if (skip_body) { return true; }
  14316. return write_request_body(strm, req, error);
  14317. }
  14318. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14319. Error &error) {
  14320. if (req.body.empty()) {
  14321. return write_content_with_provider(strm, req, error);
  14322. }
  14323. if (req.upload_progress) {
  14324. auto body_size = req.body.size();
  14325. size_t written = 0;
  14326. auto data = req.body.data();
  14327. while (written < body_size) {
  14328. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14329. if (!detail::write_data(strm, data + written, to_write)) {
  14330. error = Error::Write;
  14331. return false;
  14332. }
  14333. written += to_write;
  14334. if (!req.upload_progress(written, body_size)) {
  14335. error = Error::Canceled;
  14336. return false;
  14337. }
  14338. }
  14339. } else {
  14340. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14341. error = Error::Write;
  14342. return false;
  14343. }
  14344. }
  14345. return true;
  14346. }
  14347. inline std::unique_ptr<Response>
  14348. ClientImpl::send_with_content_provider_and_receiver(
  14349. Request &req, const char *body, size_t content_length,
  14350. ContentProvider content_provider,
  14351. ContentProviderWithoutLength content_provider_without_length,
  14352. const std::string &content_type, ContentReceiver content_receiver,
  14353. Error &error) {
  14354. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14355. auto enc = compress_
  14356. ? detail::create_compressor()
  14357. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14358. nullptr, nullptr);
  14359. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14360. if (enc.first && !content_provider_without_length) {
  14361. auto &compressor = enc.first;
  14362. if (content_provider) {
  14363. auto ok = true;
  14364. auto finished = false;
  14365. size_t offset = 0;
  14366. DataSink data_sink;
  14367. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14368. if (ok) {
  14369. auto last = offset + data_len == content_length;
  14370. auto ret = compressor->compress(
  14371. data, data_len, last,
  14372. [&](const char *compressed_data, size_t compressed_data_len) {
  14373. req.body.append(compressed_data, compressed_data_len);
  14374. return true;
  14375. });
  14376. if (ret) {
  14377. offset += data_len;
  14378. } else {
  14379. ok = false;
  14380. }
  14381. }
  14382. return ok;
  14383. };
  14384. // As in detail::write_content_with_progress(): the body is framed by
  14385. // content_length, so a provider that finishes early has truncated it.
  14386. // Stop and report that instead of calling the provider forever.
  14387. data_sink.done = [&]() { finished = true; };
  14388. while (ok && !finished && offset < content_length) {
  14389. if (!content_provider(offset, content_length - offset, data_sink)) {
  14390. error = Error::Canceled;
  14391. output_error_log(error, &req);
  14392. return nullptr;
  14393. }
  14394. }
  14395. // A short body here means either the provider stopped early or the
  14396. // compressor gave up. The branch below reports a failing compressor as
  14397. // Error::Compression, so keep the two distinguishable.
  14398. if (offset < content_length) {
  14399. error = ok ? Error::Write : Error::Compression;
  14400. output_error_log(error, &req);
  14401. return nullptr;
  14402. }
  14403. } else {
  14404. if (!compressor->compress(body, content_length, true,
  14405. [&](const char *data, size_t data_len) {
  14406. req.body.append(data, data_len);
  14407. return true;
  14408. })) {
  14409. error = Error::Compression;
  14410. output_error_log(error, &req);
  14411. return nullptr;
  14412. }
  14413. }
  14414. } else {
  14415. if (content_provider) {
  14416. req.content_length_ = content_length;
  14417. req.content_provider_ = std::move(content_provider);
  14418. req.is_chunked_content_provider_ = false;
  14419. } else if (content_provider_without_length) {
  14420. req.content_length_ = 0;
  14421. req.content_provider_ = detail::ContentProviderAdapter(
  14422. std::move(content_provider_without_length));
  14423. req.is_chunked_content_provider_ = true;
  14424. req.set_header("Transfer-Encoding", "chunked");
  14425. } else {
  14426. req.body.assign(body, content_length);
  14427. }
  14428. }
  14429. if (content_receiver) {
  14430. req.content_receiver =
  14431. [content_receiver](const char *data, size_t data_length,
  14432. size_t /*offset*/, size_t /*total_length*/) {
  14433. return content_receiver(data, data_length);
  14434. };
  14435. }
  14436. auto res = detail::make_unique<Response>();
  14437. return send(req, *res, error) ? std::move(res) : nullptr;
  14438. }
  14439. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14440. const std::string &method, const std::string &path, const Headers &headers,
  14441. const char *body, size_t content_length, ContentProvider content_provider,
  14442. ContentProviderWithoutLength content_provider_without_length,
  14443. const std::string &content_type, ContentReceiver content_receiver,
  14444. UploadProgress progress) {
  14445. Request req;
  14446. req.method = method;
  14447. req.headers = headers;
  14448. req.path = path;
  14449. req.upload_progress = std::move(progress);
  14450. if (max_timeout_msec_ > 0) {
  14451. req.start_time_ = std::chrono::steady_clock::now();
  14452. }
  14453. auto error = Error::Success;
  14454. #ifdef CPPHTTPLIB_SSL_ENABLED
  14455. // Hold the request lock until the Result has read this request's TLS error
  14456. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14457. #endif
  14458. auto res = send_with_content_provider_and_receiver(
  14459. req, body, content_length, std::move(content_provider),
  14460. std::move(content_provider_without_length), content_type,
  14461. std::move(content_receiver), error);
  14462. #ifdef CPPHTTPLIB_SSL_ENABLED
  14463. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14464. last_backend_error_};
  14465. #else
  14466. return Result{std::move(res), error, std::move(req.headers)};
  14467. #endif
  14468. }
  14469. inline void ClientImpl::output_log(const Request &req,
  14470. const Response &res) const {
  14471. if (logger_) {
  14472. std::lock_guard<std::mutex> guard(logger_mutex_);
  14473. logger_(req, res);
  14474. }
  14475. }
  14476. inline void ClientImpl::output_error_log(const Error &err,
  14477. const Request *req) const {
  14478. if (error_logger_) {
  14479. std::lock_guard<std::mutex> guard(logger_mutex_);
  14480. error_logger_(err, req);
  14481. }
  14482. }
  14483. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14484. Response &res, bool close_connection,
  14485. Error &error) {
  14486. // Auto-add Expect: 100-continue for large bodies
  14487. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14488. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14489. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14490. req.set_header("Expect", "100-continue");
  14491. }
  14492. }
  14493. // Check for Expect: 100-continue
  14494. auto expect_100_continue =
  14495. detail::has_header_token(req.headers, "Expect", "100-continue");
  14496. // Send request (skip body if using Expect: 100-continue)
  14497. auto rejected_locally = false;
  14498. auto write_request_success =
  14499. write_request(strm, req, close_connection, error, expect_100_continue,
  14500. rejected_locally);
  14501. // A failed write normally still reads the response below, since the server
  14502. // may have answered early (e.g. 413/414) and closed while the body was being
  14503. // sent. A request rejected before any byte reached the socket gets no such
  14504. // response, and waiting for one would block until the read timeout.
  14505. if (rejected_locally) { return false; }
  14506. #ifdef CPPHTTPLIB_SSL_ENABLED
  14507. if (is_ssl() && !expect_100_continue) {
  14508. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14509. if (!is_proxy_enabled) {
  14510. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14511. error = Error::SSLPeerCouldBeClosed_;
  14512. return false;
  14513. }
  14514. }
  14515. }
  14516. #endif
  14517. // Handle Expect: 100-continue.
  14518. //
  14519. // Wait for an interim/early response by attempting to read the status line
  14520. // under a short timeout, instead of trusting raw socket readability. Over
  14521. // TLS, post-handshake records (e.g. session tickets) make the socket
  14522. // readable without any HTTP response being available; relying on
  14523. // `select_read` there caused the body to be withheld forever and the
  14524. // request to fail with `Read` (#2458). If no status line arrives within the
  14525. // timeout, send the body anyway (matching curl's behavior).
  14526. auto status_line_read = false;
  14527. if (expect_100_continue && write_request_success) {
  14528. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14529. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14530. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14531. strm.set_read_timeout(sec, usec);
  14532. status_line_read = read_response_line(strm, req, res, false);
  14533. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14534. }
  14535. if (!status_line_read) {
  14536. // No interim response within the timeout: send the body and handle the
  14537. // response as usual.
  14538. if (!write_request_body(strm, req, error)) { return false; }
  14539. expect_100_continue = false; // Switch to normal response handling
  14540. }
  14541. }
  14542. // Receive response and headers
  14543. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14544. if ((!status_line_read &&
  14545. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14546. !detail::read_headers(strm, res.headers)) {
  14547. if (write_request_success) { error = Error::Read; }
  14548. return false;
  14549. }
  14550. if (!write_request_success) { return false; }
  14551. // Handle Expect: 100-continue response
  14552. if (expect_100_continue) {
  14553. if (res.status == StatusCode::Continue_100) {
  14554. // Server accepted, send the body
  14555. if (!write_request_body(strm, req, error)) { return false; }
  14556. // Read the actual response
  14557. res.headers.clear();
  14558. res.body.clear();
  14559. if (!read_response_line(strm, req, res) ||
  14560. !detail::read_headers(strm, res.headers)) {
  14561. error = Error::Read;
  14562. return false;
  14563. }
  14564. } else {
  14565. // A final response came first, so the body this request declared was
  14566. // never sent, and the server may still be waiting for it. The
  14567. // connection cannot carry another request.
  14568. std::lock_guard<std::mutex> guard(socket_mutex_);
  14569. socket_should_be_closed_when_request_is_done_ = true;
  14570. }
  14571. }
  14572. // Body
  14573. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14574. req.method != "CONNECT") {
  14575. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14576. // whose final transfer coding is not chunked is not ambiguous: its body
  14577. // runs until the server closes the connection, so it is not rejected.
  14578. // HEAD/204 are excluded above and a 304 carries no body.
  14579. if (res.status != StatusCode::NotModified_304) {
  14580. if (detail::has_conflicting_content_length(res.headers)) {
  14581. error = Error::Read;
  14582. return false;
  14583. }
  14584. if (detail::has_faulty_transfer_encoding(res)) {
  14585. std::lock_guard<std::mutex> guard(socket_mutex_);
  14586. socket_should_be_closed_when_request_is_done_ = true;
  14587. }
  14588. }
  14589. auto redirect = follow_location_ && detail::is_redirect(res);
  14590. if (req.response_handler && !redirect) {
  14591. if (!req.response_handler(res)) {
  14592. error = Error::Canceled;
  14593. return false;
  14594. }
  14595. }
  14596. auto out =
  14597. req.content_receiver
  14598. ? static_cast<ContentReceiverWithProgress>(
  14599. [&](const char *buf, size_t n, size_t off, size_t len) {
  14600. if (redirect) { return true; }
  14601. auto ret = req.content_receiver(buf, n, off, len);
  14602. if (!ret) { error = Error::Canceled; }
  14603. return ret;
  14604. })
  14605. : static_cast<ContentReceiverWithProgress>(
  14606. [&](const char *buf, size_t n, size_t /*off*/,
  14607. size_t /*len*/) {
  14608. assert(res.body.size() + n <= res.body.max_size());
  14609. if (payload_max_length_ > 0 &&
  14610. (res.body.size() >= payload_max_length_ ||
  14611. n > payload_max_length_ - res.body.size())) {
  14612. return false;
  14613. }
  14614. res.body.append(buf, n);
  14615. return true;
  14616. });
  14617. auto progress = [&](size_t current, size_t total) {
  14618. if (!req.download_progress || redirect) { return true; }
  14619. auto ret = req.download_progress(current, total);
  14620. if (!ret) { error = Error::Canceled; }
  14621. return ret;
  14622. };
  14623. if (res.has_header("Content-Length")) {
  14624. if (!req.content_receiver) {
  14625. auto len = res.get_header_value_u64("Content-Length");
  14626. if (len > res.body.max_size()) {
  14627. error = Error::Read;
  14628. return false;
  14629. }
  14630. // Content-Length is only the server's claim, so reserve no more than
  14631. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14632. // body has arrived. A longer body grows as it is read.
  14633. auto reserve_len =
  14634. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14635. if (payload_max_length_ > 0) {
  14636. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14637. }
  14638. res.body.reserve(reserve_len);
  14639. }
  14640. }
  14641. if (res.status != StatusCode::NotModified_304) {
  14642. auto content_status = 0;
  14643. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14644. ? (std::numeric_limits<size_t>::max)()
  14645. : payload_max_length_;
  14646. if (!detail::read_content(strm, res, max_length, content_status,
  14647. std::move(progress), std::move(out),
  14648. decompress_)) {
  14649. if (error != Error::Canceled) {
  14650. // Tell the caller apart from a plain read failure when the body was
  14651. // over the payload limit or could not be decoded because of its
  14652. // Content-Encoding.
  14653. switch (content_status) {
  14654. case StatusCode::PayloadTooLarge_413:
  14655. error = Error::ExceedMaxPayloadSize;
  14656. break;
  14657. case StatusCode::UnsupportedMediaType_415:
  14658. error = Error::UnsupportedContentEncoding;
  14659. break;
  14660. case StatusCode::InternalServerError_500:
  14661. error = Error::Compression;
  14662. break;
  14663. default: error = Error::Read; break;
  14664. }
  14665. }
  14666. return false;
  14667. }
  14668. }
  14669. }
  14670. // Log
  14671. output_log(req, res);
  14672. return true;
  14673. }
  14674. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14675. const std::string &boundary, const UploadFormDataItems &items,
  14676. const FormDataProviderItems &provider_items) const {
  14677. size_t cur_item = 0;
  14678. size_t cur_start = 0;
  14679. // cur_item and cur_start are copied to within the std::function and
  14680. // maintain state between successive calls
  14681. return [&, cur_item, cur_start](size_t offset,
  14682. DataSink &sink) mutable -> bool {
  14683. if (!offset && !items.empty()) {
  14684. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14685. return true;
  14686. } else if (cur_item < provider_items.size()) {
  14687. if (!cur_start) {
  14688. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14689. provider_items[cur_item], boundary);
  14690. offset += begin.size();
  14691. cur_start = offset;
  14692. sink.os << begin;
  14693. }
  14694. DataSink cur_sink;
  14695. auto has_data = true;
  14696. cur_sink.write = sink.write;
  14697. // Forward is_writable so a provider item asking whether it may keep
  14698. // going gets the outer sink's answer rather than the default `true`.
  14699. cur_sink.is_writable = sink.is_writable;
  14700. cur_sink.done = [&]() { has_data = false; };
  14701. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14702. return false;
  14703. }
  14704. if (!has_data) {
  14705. sink.os << detail::serialize_multipart_formdata_item_end();
  14706. cur_item++;
  14707. cur_start = 0;
  14708. }
  14709. return true;
  14710. } else {
  14711. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14712. sink.done();
  14713. return true;
  14714. }
  14715. };
  14716. }
  14717. inline bool ClientImpl::process_socket(
  14718. const Socket &socket,
  14719. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14720. std::function<bool(Stream &strm)> callback) {
  14721. return detail::process_client_socket(
  14722. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14723. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14724. }
  14725. inline bool ClientImpl::is_ssl() const { return false; }
  14726. inline Result ClientImpl::Get(const std::string &path,
  14727. DownloadProgress progress) {
  14728. return Get(path, Headers(), std::move(progress));
  14729. }
  14730. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14731. DownloadProgress progress) {
  14732. return Get(path, params, Headers(), std::move(progress));
  14733. }
  14734. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14735. const Headers &headers,
  14736. DownloadProgress progress) {
  14737. if (params.empty()) { return Get(path, headers); }
  14738. std::string path_with_query = append_query_params(path, params);
  14739. return Get(path_with_query, headers, std::move(progress));
  14740. }
  14741. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14742. DownloadProgress progress) {
  14743. Request req;
  14744. req.method = "GET";
  14745. req.path = path;
  14746. req.headers = headers;
  14747. req.download_progress = std::move(progress);
  14748. if (max_timeout_msec_ > 0) {
  14749. req.start_time_ = std::chrono::steady_clock::now();
  14750. }
  14751. return send_(std::move(req));
  14752. }
  14753. inline Result ClientImpl::Get(const std::string &path,
  14754. ContentReceiver content_receiver,
  14755. DownloadProgress progress) {
  14756. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14757. std::move(progress));
  14758. }
  14759. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14760. ContentReceiver content_receiver,
  14761. DownloadProgress progress) {
  14762. return Get(path, headers, nullptr, std::move(content_receiver),
  14763. std::move(progress));
  14764. }
  14765. inline Result ClientImpl::Get(const std::string &path,
  14766. ResponseHandler response_handler,
  14767. ContentReceiver content_receiver,
  14768. DownloadProgress progress) {
  14769. return Get(path, Headers(), std::move(response_handler),
  14770. std::move(content_receiver), std::move(progress));
  14771. }
  14772. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14773. ResponseHandler response_handler,
  14774. ContentReceiver content_receiver,
  14775. DownloadProgress progress) {
  14776. Request req;
  14777. req.method = "GET";
  14778. req.path = path;
  14779. req.headers = headers;
  14780. req.response_handler = std::move(response_handler);
  14781. req.content_receiver =
  14782. [content_receiver](const char *data, size_t data_length,
  14783. size_t /*offset*/, size_t /*total_length*/) {
  14784. return content_receiver(data, data_length);
  14785. };
  14786. req.download_progress = std::move(progress);
  14787. if (max_timeout_msec_ > 0) {
  14788. req.start_time_ = std::chrono::steady_clock::now();
  14789. }
  14790. return send_(std::move(req));
  14791. }
  14792. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14793. const Headers &headers,
  14794. ContentReceiver content_receiver,
  14795. DownloadProgress progress) {
  14796. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14797. std::move(progress));
  14798. }
  14799. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14800. const Headers &headers,
  14801. ResponseHandler response_handler,
  14802. ContentReceiver content_receiver,
  14803. DownloadProgress progress) {
  14804. if (params.empty()) {
  14805. return Get(path, headers, std::move(response_handler),
  14806. std::move(content_receiver), std::move(progress));
  14807. }
  14808. std::string path_with_query = append_query_params(path, params);
  14809. return Get(path_with_query, headers, std::move(response_handler),
  14810. std::move(content_receiver), std::move(progress));
  14811. }
  14812. inline Result ClientImpl::Head(const std::string &path) {
  14813. return Head(path, Headers());
  14814. }
  14815. inline Result ClientImpl::Head(const std::string &path,
  14816. const Headers &headers) {
  14817. Request req;
  14818. req.method = "HEAD";
  14819. req.headers = headers;
  14820. req.path = path;
  14821. if (max_timeout_msec_ > 0) {
  14822. req.start_time_ = std::chrono::steady_clock::now();
  14823. }
  14824. return send_(std::move(req));
  14825. }
  14826. inline Result ClientImpl::Post(const std::string &path) {
  14827. return Post(path, std::string(), std::string());
  14828. }
  14829. inline Result ClientImpl::Post(const std::string &path,
  14830. const Headers &headers) {
  14831. return Post(path, headers, nullptr, 0, std::string());
  14832. }
  14833. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14834. size_t content_length,
  14835. const std::string &content_type,
  14836. UploadProgress progress) {
  14837. return Post(path, Headers(), body, content_length, content_type, progress);
  14838. }
  14839. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14840. const std::string &content_type,
  14841. UploadProgress progress) {
  14842. return Post(path, Headers(), body, content_type, progress);
  14843. }
  14844. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14845. return Post(path, Headers(), params);
  14846. }
  14847. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14848. ContentProvider content_provider,
  14849. const std::string &content_type,
  14850. UploadProgress progress) {
  14851. return Post(path, Headers(), content_length, std::move(content_provider),
  14852. content_type, progress);
  14853. }
  14854. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14855. ContentProvider content_provider,
  14856. const std::string &content_type,
  14857. ContentReceiver content_receiver,
  14858. UploadProgress progress) {
  14859. return Post(path, Headers(), content_length, std::move(content_provider),
  14860. content_type, std::move(content_receiver), progress);
  14861. }
  14862. inline Result ClientImpl::Post(const std::string &path,
  14863. ContentProviderWithoutLength content_provider,
  14864. const std::string &content_type,
  14865. UploadProgress progress) {
  14866. return Post(path, Headers(), std::move(content_provider), content_type,
  14867. progress);
  14868. }
  14869. inline Result ClientImpl::Post(const std::string &path,
  14870. ContentProviderWithoutLength content_provider,
  14871. const std::string &content_type,
  14872. ContentReceiver content_receiver,
  14873. UploadProgress progress) {
  14874. return Post(path, Headers(), std::move(content_provider), content_type,
  14875. std::move(content_receiver), progress);
  14876. }
  14877. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14878. const Params &params) {
  14879. auto query = detail::params_to_query_str(params);
  14880. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14881. }
  14882. inline Result ClientImpl::Post(const std::string &path,
  14883. const UploadFormDataItems &items,
  14884. UploadProgress progress) {
  14885. return Post(path, Headers(), items, progress);
  14886. }
  14887. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14888. const UploadFormDataItems &items,
  14889. UploadProgress progress) {
  14890. const auto &boundary = detail::make_multipart_data_boundary();
  14891. const auto &content_type =
  14892. detail::serialize_multipart_formdata_get_content_type(boundary);
  14893. auto content_length = detail::get_multipart_content_length(items, boundary);
  14894. return Post(path, headers, content_length,
  14895. detail::make_multipart_content_provider(items, boundary),
  14896. content_type, progress);
  14897. }
  14898. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14899. const UploadFormDataItems &items,
  14900. const std::string &boundary,
  14901. UploadProgress progress) {
  14902. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14903. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14904. }
  14905. const auto &content_type =
  14906. detail::serialize_multipart_formdata_get_content_type(boundary);
  14907. auto content_length = detail::get_multipart_content_length(items, boundary);
  14908. return Post(path, headers, content_length,
  14909. detail::make_multipart_content_provider(items, boundary),
  14910. content_type, progress);
  14911. }
  14912. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14913. const char *body, size_t content_length,
  14914. const std::string &content_type,
  14915. UploadProgress progress) {
  14916. return send_with_content_provider_and_receiver(
  14917. "POST", path, headers, body, content_length, nullptr, nullptr,
  14918. content_type, nullptr, progress);
  14919. }
  14920. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14921. const std::string &body,
  14922. const std::string &content_type,
  14923. UploadProgress progress) {
  14924. return send_with_content_provider_and_receiver(
  14925. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14926. content_type, nullptr, progress);
  14927. }
  14928. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14929. size_t content_length,
  14930. ContentProvider content_provider,
  14931. const std::string &content_type,
  14932. UploadProgress progress) {
  14933. return send_with_content_provider_and_receiver(
  14934. "POST", path, headers, nullptr, content_length,
  14935. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14936. }
  14937. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14938. size_t content_length,
  14939. ContentProvider content_provider,
  14940. const std::string &content_type,
  14941. ContentReceiver content_receiver,
  14942. DownloadProgress progress) {
  14943. return send_with_content_provider_and_receiver(
  14944. "POST", path, headers, nullptr, content_length,
  14945. std::move(content_provider), nullptr, content_type,
  14946. std::move(content_receiver), std::move(progress));
  14947. }
  14948. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14949. ContentProviderWithoutLength content_provider,
  14950. const std::string &content_type,
  14951. UploadProgress progress) {
  14952. return send_with_content_provider_and_receiver(
  14953. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14954. content_type, nullptr, progress);
  14955. }
  14956. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14957. ContentProviderWithoutLength content_provider,
  14958. const std::string &content_type,
  14959. ContentReceiver content_receiver,
  14960. DownloadProgress progress) {
  14961. return send_with_content_provider_and_receiver(
  14962. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14963. content_type, std::move(content_receiver), std::move(progress));
  14964. }
  14965. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14966. const UploadFormDataItems &items,
  14967. const FormDataProviderItems &provider_items,
  14968. UploadProgress progress) {
  14969. const auto &boundary = detail::make_multipart_data_boundary();
  14970. const auto &content_type =
  14971. detail::serialize_multipart_formdata_get_content_type(boundary);
  14972. return send_with_content_provider_and_receiver(
  14973. "POST", path, headers, nullptr, 0, nullptr,
  14974. get_multipart_content_provider(boundary, items, provider_items),
  14975. content_type, nullptr, progress);
  14976. }
  14977. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14978. const std::string &body,
  14979. const std::string &content_type,
  14980. ContentReceiver content_receiver,
  14981. DownloadProgress progress) {
  14982. Request req;
  14983. req.method = "POST";
  14984. req.path = path;
  14985. req.headers = headers;
  14986. req.body = body;
  14987. req.content_receiver =
  14988. [content_receiver](const char *data, size_t data_length,
  14989. size_t /*offset*/, size_t /*total_length*/) {
  14990. return content_receiver(data, data_length);
  14991. };
  14992. req.download_progress = std::move(progress);
  14993. if (max_timeout_msec_ > 0) {
  14994. req.start_time_ = std::chrono::steady_clock::now();
  14995. }
  14996. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14997. return send_(std::move(req));
  14998. }
  14999. inline Result ClientImpl::Put(const std::string &path) {
  15000. return Put(path, std::string(), std::string());
  15001. }
  15002. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  15003. return Put(path, headers, nullptr, 0, std::string());
  15004. }
  15005. inline Result ClientImpl::Put(const std::string &path, const char *body,
  15006. size_t content_length,
  15007. const std::string &content_type,
  15008. UploadProgress progress) {
  15009. return Put(path, Headers(), body, content_length, content_type, progress);
  15010. }
  15011. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  15012. const std::string &content_type,
  15013. UploadProgress progress) {
  15014. return Put(path, Headers(), body, content_type, progress);
  15015. }
  15016. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  15017. return Put(path, Headers(), params);
  15018. }
  15019. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15020. ContentProvider content_provider,
  15021. const std::string &content_type,
  15022. UploadProgress progress) {
  15023. return Put(path, Headers(), content_length, std::move(content_provider),
  15024. content_type, progress);
  15025. }
  15026. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15027. ContentProvider content_provider,
  15028. const std::string &content_type,
  15029. ContentReceiver content_receiver,
  15030. UploadProgress progress) {
  15031. return Put(path, Headers(), content_length, std::move(content_provider),
  15032. content_type, std::move(content_receiver), progress);
  15033. }
  15034. inline Result ClientImpl::Put(const std::string &path,
  15035. ContentProviderWithoutLength content_provider,
  15036. const std::string &content_type,
  15037. UploadProgress progress) {
  15038. return Put(path, Headers(), std::move(content_provider), content_type,
  15039. progress);
  15040. }
  15041. inline Result ClientImpl::Put(const std::string &path,
  15042. ContentProviderWithoutLength content_provider,
  15043. const std::string &content_type,
  15044. ContentReceiver content_receiver,
  15045. UploadProgress progress) {
  15046. return Put(path, Headers(), std::move(content_provider), content_type,
  15047. std::move(content_receiver), progress);
  15048. }
  15049. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15050. const Params &params) {
  15051. auto query = detail::params_to_query_str(params);
  15052. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15053. }
  15054. inline Result ClientImpl::Put(const std::string &path,
  15055. const UploadFormDataItems &items,
  15056. UploadProgress progress) {
  15057. return Put(path, Headers(), items, progress);
  15058. }
  15059. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15060. const UploadFormDataItems &items,
  15061. UploadProgress progress) {
  15062. const auto &boundary = detail::make_multipart_data_boundary();
  15063. const auto &content_type =
  15064. detail::serialize_multipart_formdata_get_content_type(boundary);
  15065. auto content_length = detail::get_multipart_content_length(items, boundary);
  15066. return Put(path, headers, content_length,
  15067. detail::make_multipart_content_provider(items, boundary),
  15068. content_type, progress);
  15069. }
  15070. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15071. const UploadFormDataItems &items,
  15072. const std::string &boundary,
  15073. UploadProgress progress) {
  15074. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15075. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15076. }
  15077. const auto &content_type =
  15078. detail::serialize_multipart_formdata_get_content_type(boundary);
  15079. auto content_length = detail::get_multipart_content_length(items, boundary);
  15080. return Put(path, headers, content_length,
  15081. detail::make_multipart_content_provider(items, boundary),
  15082. content_type, progress);
  15083. }
  15084. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15085. const char *body, size_t content_length,
  15086. const std::string &content_type,
  15087. UploadProgress progress) {
  15088. return send_with_content_provider_and_receiver(
  15089. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15090. content_type, nullptr, progress);
  15091. }
  15092. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15093. const std::string &body,
  15094. const std::string &content_type,
  15095. UploadProgress progress) {
  15096. return send_with_content_provider_and_receiver(
  15097. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15098. content_type, nullptr, progress);
  15099. }
  15100. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15101. size_t content_length,
  15102. ContentProvider content_provider,
  15103. const std::string &content_type,
  15104. UploadProgress progress) {
  15105. return send_with_content_provider_and_receiver(
  15106. "PUT", path, headers, nullptr, content_length,
  15107. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15108. }
  15109. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15110. size_t content_length,
  15111. ContentProvider content_provider,
  15112. const std::string &content_type,
  15113. ContentReceiver content_receiver,
  15114. UploadProgress progress) {
  15115. return send_with_content_provider_and_receiver(
  15116. "PUT", path, headers, nullptr, content_length,
  15117. std::move(content_provider), nullptr, content_type,
  15118. std::move(content_receiver), progress);
  15119. }
  15120. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15121. ContentProviderWithoutLength content_provider,
  15122. const std::string &content_type,
  15123. UploadProgress progress) {
  15124. return send_with_content_provider_and_receiver(
  15125. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15126. content_type, nullptr, progress);
  15127. }
  15128. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15129. ContentProviderWithoutLength content_provider,
  15130. const std::string &content_type,
  15131. ContentReceiver content_receiver,
  15132. UploadProgress progress) {
  15133. return send_with_content_provider_and_receiver(
  15134. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15135. content_type, std::move(content_receiver), progress);
  15136. }
  15137. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15138. const UploadFormDataItems &items,
  15139. const FormDataProviderItems &provider_items,
  15140. UploadProgress progress) {
  15141. const auto &boundary = detail::make_multipart_data_boundary();
  15142. const auto &content_type =
  15143. detail::serialize_multipart_formdata_get_content_type(boundary);
  15144. return send_with_content_provider_and_receiver(
  15145. "PUT", path, headers, nullptr, 0, nullptr,
  15146. get_multipart_content_provider(boundary, items, provider_items),
  15147. content_type, nullptr, progress);
  15148. }
  15149. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15150. const std::string &body,
  15151. const std::string &content_type,
  15152. ContentReceiver content_receiver,
  15153. DownloadProgress progress) {
  15154. Request req;
  15155. req.method = "PUT";
  15156. req.path = path;
  15157. req.headers = headers;
  15158. req.body = body;
  15159. req.content_receiver =
  15160. [content_receiver](const char *data, size_t data_length,
  15161. size_t /*offset*/, size_t /*total_length*/) {
  15162. return content_receiver(data, data_length);
  15163. };
  15164. req.download_progress = std::move(progress);
  15165. if (max_timeout_msec_ > 0) {
  15166. req.start_time_ = std::chrono::steady_clock::now();
  15167. }
  15168. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15169. return send_(std::move(req));
  15170. }
  15171. inline Result ClientImpl::Patch(const std::string &path) {
  15172. return Patch(path, std::string(), std::string());
  15173. }
  15174. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15175. UploadProgress progress) {
  15176. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15177. }
  15178. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15179. size_t content_length,
  15180. const std::string &content_type,
  15181. UploadProgress progress) {
  15182. return Patch(path, Headers(), body, content_length, content_type, progress);
  15183. }
  15184. inline Result ClientImpl::Patch(const std::string &path,
  15185. const std::string &body,
  15186. const std::string &content_type,
  15187. UploadProgress progress) {
  15188. return Patch(path, Headers(), body, content_type, progress);
  15189. }
  15190. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15191. return Patch(path, Headers(), params);
  15192. }
  15193. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15194. ContentProvider content_provider,
  15195. const std::string &content_type,
  15196. UploadProgress progress) {
  15197. return Patch(path, Headers(), content_length, std::move(content_provider),
  15198. content_type, progress);
  15199. }
  15200. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15201. ContentProvider content_provider,
  15202. const std::string &content_type,
  15203. ContentReceiver content_receiver,
  15204. UploadProgress progress) {
  15205. return Patch(path, Headers(), content_length, std::move(content_provider),
  15206. content_type, std::move(content_receiver), progress);
  15207. }
  15208. inline Result ClientImpl::Patch(const std::string &path,
  15209. ContentProviderWithoutLength content_provider,
  15210. const std::string &content_type,
  15211. UploadProgress progress) {
  15212. return Patch(path, Headers(), std::move(content_provider), content_type,
  15213. progress);
  15214. }
  15215. inline Result ClientImpl::Patch(const std::string &path,
  15216. ContentProviderWithoutLength content_provider,
  15217. const std::string &content_type,
  15218. ContentReceiver content_receiver,
  15219. UploadProgress progress) {
  15220. return Patch(path, Headers(), std::move(content_provider), content_type,
  15221. std::move(content_receiver), progress);
  15222. }
  15223. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15224. const Params &params) {
  15225. auto query = detail::params_to_query_str(params);
  15226. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15227. }
  15228. inline Result ClientImpl::Patch(const std::string &path,
  15229. const UploadFormDataItems &items,
  15230. UploadProgress progress) {
  15231. return Patch(path, Headers(), items, progress);
  15232. }
  15233. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15234. const UploadFormDataItems &items,
  15235. UploadProgress progress) {
  15236. const auto &boundary = detail::make_multipart_data_boundary();
  15237. const auto &content_type =
  15238. detail::serialize_multipart_formdata_get_content_type(boundary);
  15239. auto content_length = detail::get_multipart_content_length(items, boundary);
  15240. return Patch(path, headers, content_length,
  15241. detail::make_multipart_content_provider(items, boundary),
  15242. content_type, progress);
  15243. }
  15244. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15245. const UploadFormDataItems &items,
  15246. const std::string &boundary,
  15247. UploadProgress progress) {
  15248. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15249. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15250. }
  15251. const auto &content_type =
  15252. detail::serialize_multipart_formdata_get_content_type(boundary);
  15253. auto content_length = detail::get_multipart_content_length(items, boundary);
  15254. return Patch(path, headers, content_length,
  15255. detail::make_multipart_content_provider(items, boundary),
  15256. content_type, progress);
  15257. }
  15258. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15259. const char *body, size_t content_length,
  15260. const std::string &content_type,
  15261. UploadProgress progress) {
  15262. return send_with_content_provider_and_receiver(
  15263. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15264. content_type, nullptr, progress);
  15265. }
  15266. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15267. const std::string &body,
  15268. const std::string &content_type,
  15269. UploadProgress progress) {
  15270. return send_with_content_provider_and_receiver(
  15271. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15272. content_type, nullptr, progress);
  15273. }
  15274. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15275. size_t content_length,
  15276. ContentProvider content_provider,
  15277. const std::string &content_type,
  15278. UploadProgress progress) {
  15279. return send_with_content_provider_and_receiver(
  15280. "PATCH", path, headers, nullptr, content_length,
  15281. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15282. }
  15283. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15284. size_t content_length,
  15285. ContentProvider content_provider,
  15286. const std::string &content_type,
  15287. ContentReceiver content_receiver,
  15288. UploadProgress progress) {
  15289. return send_with_content_provider_and_receiver(
  15290. "PATCH", path, headers, nullptr, content_length,
  15291. std::move(content_provider), nullptr, content_type,
  15292. std::move(content_receiver), progress);
  15293. }
  15294. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15295. ContentProviderWithoutLength content_provider,
  15296. const std::string &content_type,
  15297. UploadProgress progress) {
  15298. return send_with_content_provider_and_receiver(
  15299. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15300. content_type, nullptr, progress);
  15301. }
  15302. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15303. ContentProviderWithoutLength content_provider,
  15304. const std::string &content_type,
  15305. ContentReceiver content_receiver,
  15306. UploadProgress progress) {
  15307. return send_with_content_provider_and_receiver(
  15308. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15309. content_type, std::move(content_receiver), progress);
  15310. }
  15311. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15312. const UploadFormDataItems &items,
  15313. const FormDataProviderItems &provider_items,
  15314. UploadProgress progress) {
  15315. const auto &boundary = detail::make_multipart_data_boundary();
  15316. const auto &content_type =
  15317. detail::serialize_multipart_formdata_get_content_type(boundary);
  15318. return send_with_content_provider_and_receiver(
  15319. "PATCH", path, headers, nullptr, 0, nullptr,
  15320. get_multipart_content_provider(boundary, items, provider_items),
  15321. content_type, nullptr, progress);
  15322. }
  15323. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15324. const std::string &body,
  15325. const std::string &content_type,
  15326. ContentReceiver content_receiver,
  15327. DownloadProgress progress) {
  15328. Request req;
  15329. req.method = "PATCH";
  15330. req.path = path;
  15331. req.headers = headers;
  15332. req.body = body;
  15333. req.content_receiver =
  15334. [content_receiver](const char *data, size_t data_length,
  15335. size_t /*offset*/, size_t /*total_length*/) {
  15336. return content_receiver(data, data_length);
  15337. };
  15338. req.download_progress = std::move(progress);
  15339. if (max_timeout_msec_ > 0) {
  15340. req.start_time_ = std::chrono::steady_clock::now();
  15341. }
  15342. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15343. return send_(std::move(req));
  15344. }
  15345. inline Result ClientImpl::Delete(const std::string &path,
  15346. DownloadProgress progress) {
  15347. return Delete(path, Headers(), std::string(), std::string(), progress);
  15348. }
  15349. inline Result ClientImpl::Delete(const std::string &path,
  15350. const Headers &headers,
  15351. DownloadProgress progress) {
  15352. return Delete(path, headers, std::string(), std::string(), progress);
  15353. }
  15354. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15355. size_t content_length,
  15356. const std::string &content_type,
  15357. DownloadProgress progress) {
  15358. return Delete(path, Headers(), body, content_length, content_type, progress);
  15359. }
  15360. inline Result ClientImpl::Delete(const std::string &path,
  15361. const std::string &body,
  15362. const std::string &content_type,
  15363. DownloadProgress progress) {
  15364. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15365. progress);
  15366. }
  15367. inline Result ClientImpl::Delete(const std::string &path,
  15368. const Headers &headers,
  15369. const std::string &body,
  15370. const std::string &content_type,
  15371. DownloadProgress progress) {
  15372. return Delete(path, headers, body.data(), body.size(), content_type,
  15373. progress);
  15374. }
  15375. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15376. DownloadProgress progress) {
  15377. return Delete(path, Headers(), params, progress);
  15378. }
  15379. inline Result ClientImpl::Delete(const std::string &path,
  15380. const Headers &headers, const Params &params,
  15381. DownloadProgress progress) {
  15382. auto query = detail::params_to_query_str(params);
  15383. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15384. progress);
  15385. }
  15386. inline Result ClientImpl::Delete(const std::string &path,
  15387. const Headers &headers, const char *body,
  15388. size_t content_length,
  15389. const std::string &content_type,
  15390. DownloadProgress progress) {
  15391. Request req;
  15392. req.method = "DELETE";
  15393. req.headers = headers;
  15394. req.path = path;
  15395. req.download_progress = std::move(progress);
  15396. if (max_timeout_msec_ > 0) {
  15397. req.start_time_ = std::chrono::steady_clock::now();
  15398. }
  15399. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15400. req.body.assign(body, content_length);
  15401. return send_(std::move(req));
  15402. }
  15403. inline Result ClientImpl::Options(const std::string &path) {
  15404. return Options(path, Headers());
  15405. }
  15406. inline Result ClientImpl::Options(const std::string &path,
  15407. const Headers &headers) {
  15408. Request req;
  15409. req.method = "OPTIONS";
  15410. req.headers = headers;
  15411. req.path = path;
  15412. if (max_timeout_msec_ > 0) {
  15413. req.start_time_ = std::chrono::steady_clock::now();
  15414. }
  15415. return send_(std::move(req));
  15416. }
  15417. inline void ClientImpl::stop() {
  15418. std::lock_guard<std::mutex> guard(socket_mutex_);
  15419. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15420. // do is to shutdown_socket, so that threads using this socket suddenly
  15421. // discover they can't read/write any more and error out. Everything else
  15422. // (closing the socket, shutting ssl down) is unsafe because these actions
  15423. // are not thread-safe.
  15424. if (socket_requests_in_flight_ > 0) {
  15425. shutdown_socket(socket_);
  15426. // shutdown() does not wake a read waiting in WSAPoll on Windows, so the
  15427. // request's reads also give up once they see this flag.
  15428. stop_requested_ = true;
  15429. // Aside from that, we set a flag for the socket to be closed when we're
  15430. // done.
  15431. socket_should_be_closed_when_request_is_done_ = true;
  15432. return;
  15433. }
  15434. disconnect(/*gracefully=*/true);
  15435. }
  15436. inline std::string ClientImpl::host() const { return host_; }
  15437. inline int ClientImpl::port() const { return port_; }
  15438. inline size_t ClientImpl::is_socket_open() const {
  15439. std::lock_guard<std::mutex> guard(socket_mutex_);
  15440. return socket_.is_open();
  15441. }
  15442. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15443. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15444. connection_timeout_sec_ = sec;
  15445. connection_timeout_usec_ = usec;
  15446. }
  15447. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15448. read_timeout_sec_ = sec;
  15449. read_timeout_usec_ = usec;
  15450. }
  15451. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15452. write_timeout_sec_ = sec;
  15453. write_timeout_usec_ = usec;
  15454. }
  15455. inline void ClientImpl::set_max_timeout(time_t msec) {
  15456. max_timeout_msec_ = msec;
  15457. }
  15458. inline void ClientImpl::set_basic_auth(const std::string &username,
  15459. const std::string &password) {
  15460. basic_auth_username_ = username;
  15461. basic_auth_password_ = password;
  15462. }
  15463. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15464. bearer_token_auth_token_ = token;
  15465. }
  15466. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15467. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15468. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15469. inline void
  15470. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15471. set_direct_hostname_addr_map(std::move(addr_map));
  15472. }
  15473. inline void ClientImpl::set_direct_hostname_addr_map(
  15474. std::map<std::string, std::string> addr_map) {
  15475. addr_map_ = std::move(addr_map);
  15476. }
  15477. inline void ClientImpl::set_tunnel_hostname_addr_map(
  15478. std::map<std::string, std::string> addr_map) {
  15479. tunnel_addr_map_ = std::move(addr_map);
  15480. }
  15481. inline void ClientImpl::set_default_headers(Headers headers) {
  15482. default_headers_ = std::move(headers);
  15483. }
  15484. inline void ClientImpl::set_header_writer(
  15485. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15486. header_writer_ = writer;
  15487. }
  15488. inline void ClientImpl::set_address_family(int family) {
  15489. address_family_ = family;
  15490. }
  15491. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15492. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15493. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15494. socket_options_ = std::move(socket_options);
  15495. }
  15496. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15497. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15498. inline void ClientImpl::set_payload_max_length(size_t length) {
  15499. payload_max_length_ = length;
  15500. has_payload_max_length_ = true;
  15501. }
  15502. inline void ClientImpl::set_interface(const std::string &intf) {
  15503. interface_ = intf;
  15504. }
  15505. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15506. proxy_host_ = host;
  15507. proxy_port_ = port;
  15508. std::lock_guard<std::mutex> guard(socket_mutex_);
  15509. disconnect(/*gracefully=*/true);
  15510. }
  15511. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15512. const std::string &password) {
  15513. proxy_basic_auth_username_ = username;
  15514. proxy_basic_auth_password_ = password;
  15515. }
  15516. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15517. proxy_bearer_token_auth_token_ = token;
  15518. }
  15519. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15520. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15521. std::lock_guard<std::mutex> guard(socket_mutex_);
  15522. disconnect(/*gracefully=*/true);
  15523. }
  15524. #ifdef CPPHTTPLIB_SSL_ENABLED
  15525. inline void ClientImpl::set_digest_auth(const std::string &username,
  15526. const std::string &password) {
  15527. digest_auth_username_ = username;
  15528. digest_auth_password_ = password;
  15529. }
  15530. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15531. const std::string &ca_cert_dir_path) {
  15532. ca_cert_file_path_ = ca_cert_file_path;
  15533. ca_cert_dir_path_ = ca_cert_dir_path;
  15534. }
  15535. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15536. const std::string &password) {
  15537. proxy_digest_auth_username_ = username;
  15538. proxy_digest_auth_password_ = password;
  15539. }
  15540. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15541. if (server_certificate_verification_ == enabled) { return; }
  15542. server_certificate_verification_ = enabled;
  15543. tls_settings_changed();
  15544. }
  15545. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15546. if (server_hostname_verification_ == enabled) { return; }
  15547. server_hostname_verification_ = enabled;
  15548. tls_settings_changed();
  15549. }
  15550. inline void ClientImpl::enable_system_ca(bool enabled) {
  15551. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15552. }
  15553. #endif
  15554. inline void ClientImpl::set_logger(Logger logger) {
  15555. logger_ = std::move(logger);
  15556. }
  15557. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15558. error_logger_ = std::move(error_logger);
  15559. }
  15560. /*
  15561. * SSL/TLS Common Implementation
  15562. */
  15563. inline ClientConnection::~ClientConnection() {
  15564. #ifdef CPPHTTPLIB_SSL_ENABLED
  15565. if (session) {
  15566. tls::shutdown(session, true);
  15567. tls::free_session(session);
  15568. session = nullptr;
  15569. }
  15570. #endif
  15571. if (sock != INVALID_SOCKET) {
  15572. detail::close_socket(sock);
  15573. sock = INVALID_SOCKET;
  15574. }
  15575. }
  15576. // Universal client implementation
  15577. inline Client::Client(const std::string &scheme_host_port)
  15578. : Client(scheme_host_port, std::string(), std::string()) {}
  15579. inline Client::Client(const std::string &scheme_host_port,
  15580. const std::string &client_cert_path,
  15581. const std::string &client_key_path) {
  15582. detail::UrlComponents uc;
  15583. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15584. auto &scheme = uc.scheme;
  15585. #ifdef CPPHTTPLIB_SSL_ENABLED
  15586. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15587. #else
  15588. if (!scheme.empty() && scheme != "http") {
  15589. #endif
  15590. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15591. std::string msg = "'" + scheme + "' scheme is not supported.";
  15592. throw std::invalid_argument(msg);
  15593. #endif
  15594. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15595. return;
  15596. }
  15597. auto is_ssl = scheme == "https";
  15598. auto host = std::move(uc.host);
  15599. auto port = is_ssl ? 443 : 80;
  15600. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15601. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15602. return;
  15603. }
  15604. if (is_ssl) {
  15605. #ifdef CPPHTTPLIB_SSL_ENABLED
  15606. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15607. client_key_path);
  15608. is_ssl_ = is_ssl;
  15609. #endif
  15610. } else {
  15611. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15612. client_key_path);
  15613. }
  15614. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15615. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15616. // A URL, but not one this client can use, such as one with userinfo. A
  15617. // Unix socket path may have "//" further on.
  15618. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15619. } else {
  15620. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15621. // if port param below changes.
  15622. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15623. client_cert_path, client_key_path);
  15624. }
  15625. }
  15626. inline Client::Client(const std::string &host, int port)
  15627. : Client(host, port, std::string(), std::string()) {}
  15628. inline Client::Client(const std::string &host, int port,
  15629. const std::string &client_cert_path,
  15630. const std::string &client_key_path)
  15631. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15632. client_key_path)) {}
  15633. inline Client::~Client() = default;
  15634. inline bool Client::is_valid() const {
  15635. return cli_ != nullptr && cli_->is_valid();
  15636. }
  15637. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15638. return cli_->Get(path, std::move(progress));
  15639. }
  15640. inline Result Client::Get(const std::string &path, const Headers &headers,
  15641. DownloadProgress progress) {
  15642. return cli_->Get(path, headers, std::move(progress));
  15643. }
  15644. inline Result Client::Get(const std::string &path,
  15645. ContentReceiver content_receiver,
  15646. DownloadProgress progress) {
  15647. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15648. }
  15649. inline Result Client::Get(const std::string &path, const Headers &headers,
  15650. ContentReceiver content_receiver,
  15651. DownloadProgress progress) {
  15652. return cli_->Get(path, headers, std::move(content_receiver),
  15653. std::move(progress));
  15654. }
  15655. inline Result Client::Get(const std::string &path,
  15656. ResponseHandler response_handler,
  15657. ContentReceiver content_receiver,
  15658. DownloadProgress progress) {
  15659. return cli_->Get(path, std::move(response_handler),
  15660. std::move(content_receiver), std::move(progress));
  15661. }
  15662. inline Result Client::Get(const std::string &path, const Headers &headers,
  15663. ResponseHandler response_handler,
  15664. ContentReceiver content_receiver,
  15665. DownloadProgress progress) {
  15666. return cli_->Get(path, headers, std::move(response_handler),
  15667. std::move(content_receiver), std::move(progress));
  15668. }
  15669. inline Result Client::Get(const std::string &path, const Params &params,
  15670. DownloadProgress progress) {
  15671. return cli_->Get(path, params, std::move(progress));
  15672. }
  15673. inline Result Client::Get(const std::string &path, const Params &params,
  15674. const Headers &headers, DownloadProgress progress) {
  15675. return cli_->Get(path, params, headers, std::move(progress));
  15676. }
  15677. inline Result Client::Get(const std::string &path, const Params &params,
  15678. const Headers &headers,
  15679. ContentReceiver content_receiver,
  15680. DownloadProgress progress) {
  15681. return cli_->Get(path, params, headers, std::move(content_receiver),
  15682. std::move(progress));
  15683. }
  15684. inline Result Client::Get(const std::string &path, const Params &params,
  15685. const Headers &headers,
  15686. ResponseHandler response_handler,
  15687. ContentReceiver content_receiver,
  15688. DownloadProgress progress) {
  15689. return cli_->Get(path, params, headers, std::move(response_handler),
  15690. std::move(content_receiver), std::move(progress));
  15691. }
  15692. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15693. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15694. return cli_->Head(path, headers);
  15695. }
  15696. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15697. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15698. return cli_->Post(path, headers);
  15699. }
  15700. inline Result Client::Post(const std::string &path, const char *body,
  15701. size_t content_length,
  15702. const std::string &content_type,
  15703. UploadProgress progress) {
  15704. return cli_->Post(path, body, content_length, content_type, progress);
  15705. }
  15706. inline Result Client::Post(const std::string &path, const Headers &headers,
  15707. const char *body, size_t content_length,
  15708. const std::string &content_type,
  15709. UploadProgress progress) {
  15710. return cli_->Post(path, headers, body, content_length, content_type,
  15711. progress);
  15712. }
  15713. inline Result Client::Post(const std::string &path, const std::string &body,
  15714. const std::string &content_type,
  15715. UploadProgress progress) {
  15716. return cli_->Post(path, body, content_type, progress);
  15717. }
  15718. inline Result Client::Post(const std::string &path, const Headers &headers,
  15719. const std::string &body,
  15720. const std::string &content_type,
  15721. UploadProgress progress) {
  15722. return cli_->Post(path, headers, body, content_type, progress);
  15723. }
  15724. inline Result Client::Post(const std::string &path, size_t content_length,
  15725. ContentProvider content_provider,
  15726. const std::string &content_type,
  15727. UploadProgress progress) {
  15728. return cli_->Post(path, content_length, std::move(content_provider),
  15729. content_type, progress);
  15730. }
  15731. inline Result Client::Post(const std::string &path, size_t content_length,
  15732. ContentProvider content_provider,
  15733. const std::string &content_type,
  15734. ContentReceiver content_receiver,
  15735. UploadProgress progress) {
  15736. return cli_->Post(path, content_length, std::move(content_provider),
  15737. content_type, std::move(content_receiver), progress);
  15738. }
  15739. inline Result Client::Post(const std::string &path,
  15740. ContentProviderWithoutLength content_provider,
  15741. const std::string &content_type,
  15742. UploadProgress progress) {
  15743. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15744. }
  15745. inline Result Client::Post(const std::string &path,
  15746. ContentProviderWithoutLength content_provider,
  15747. const std::string &content_type,
  15748. ContentReceiver content_receiver,
  15749. UploadProgress progress) {
  15750. return cli_->Post(path, std::move(content_provider), content_type,
  15751. std::move(content_receiver), progress);
  15752. }
  15753. inline Result Client::Post(const std::string &path, const Headers &headers,
  15754. size_t content_length,
  15755. ContentProvider content_provider,
  15756. const std::string &content_type,
  15757. UploadProgress progress) {
  15758. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15759. content_type, progress);
  15760. }
  15761. inline Result Client::Post(const std::string &path, const Headers &headers,
  15762. size_t content_length,
  15763. ContentProvider content_provider,
  15764. const std::string &content_type,
  15765. ContentReceiver content_receiver,
  15766. DownloadProgress progress) {
  15767. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15768. content_type, std::move(content_receiver), progress);
  15769. }
  15770. inline Result Client::Post(const std::string &path, const Headers &headers,
  15771. ContentProviderWithoutLength content_provider,
  15772. const std::string &content_type,
  15773. UploadProgress progress) {
  15774. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15775. progress);
  15776. }
  15777. inline Result Client::Post(const std::string &path, const Headers &headers,
  15778. ContentProviderWithoutLength content_provider,
  15779. const std::string &content_type,
  15780. ContentReceiver content_receiver,
  15781. DownloadProgress progress) {
  15782. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15783. std::move(content_receiver), progress);
  15784. }
  15785. inline Result Client::Post(const std::string &path, const Params &params) {
  15786. return cli_->Post(path, params);
  15787. }
  15788. inline Result Client::Post(const std::string &path, const Headers &headers,
  15789. const Params &params) {
  15790. return cli_->Post(path, headers, params);
  15791. }
  15792. inline Result Client::Post(const std::string &path,
  15793. const UploadFormDataItems &items,
  15794. UploadProgress progress) {
  15795. return cli_->Post(path, items, progress);
  15796. }
  15797. inline Result Client::Post(const std::string &path, const Headers &headers,
  15798. const UploadFormDataItems &items,
  15799. UploadProgress progress) {
  15800. return cli_->Post(path, headers, items, progress);
  15801. }
  15802. inline Result Client::Post(const std::string &path, const Headers &headers,
  15803. const UploadFormDataItems &items,
  15804. const std::string &boundary,
  15805. UploadProgress progress) {
  15806. return cli_->Post(path, headers, items, boundary, progress);
  15807. }
  15808. inline Result Client::Post(const std::string &path, const Headers &headers,
  15809. const UploadFormDataItems &items,
  15810. const FormDataProviderItems &provider_items,
  15811. UploadProgress progress) {
  15812. return cli_->Post(path, headers, items, provider_items, progress);
  15813. }
  15814. inline Result Client::Post(const std::string &path, const Headers &headers,
  15815. const std::string &body,
  15816. const std::string &content_type,
  15817. ContentReceiver content_receiver,
  15818. DownloadProgress progress) {
  15819. return cli_->Post(path, headers, body, content_type,
  15820. std::move(content_receiver), progress);
  15821. }
  15822. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15823. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15824. return cli_->Put(path, headers);
  15825. }
  15826. inline Result Client::Put(const std::string &path, const char *body,
  15827. size_t content_length,
  15828. const std::string &content_type,
  15829. UploadProgress progress) {
  15830. return cli_->Put(path, body, content_length, content_type, progress);
  15831. }
  15832. inline Result Client::Put(const std::string &path, const Headers &headers,
  15833. const char *body, size_t content_length,
  15834. const std::string &content_type,
  15835. UploadProgress progress) {
  15836. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15837. }
  15838. inline Result Client::Put(const std::string &path, const std::string &body,
  15839. const std::string &content_type,
  15840. UploadProgress progress) {
  15841. return cli_->Put(path, body, content_type, progress);
  15842. }
  15843. inline Result Client::Put(const std::string &path, const Headers &headers,
  15844. const std::string &body,
  15845. const std::string &content_type,
  15846. UploadProgress progress) {
  15847. return cli_->Put(path, headers, body, content_type, progress);
  15848. }
  15849. inline Result Client::Put(const std::string &path, size_t content_length,
  15850. ContentProvider content_provider,
  15851. const std::string &content_type,
  15852. UploadProgress progress) {
  15853. return cli_->Put(path, content_length, std::move(content_provider),
  15854. content_type, progress);
  15855. }
  15856. inline Result Client::Put(const std::string &path, size_t content_length,
  15857. ContentProvider content_provider,
  15858. const std::string &content_type,
  15859. ContentReceiver content_receiver,
  15860. UploadProgress progress) {
  15861. return cli_->Put(path, content_length, std::move(content_provider),
  15862. content_type, std::move(content_receiver), progress);
  15863. }
  15864. inline Result Client::Put(const std::string &path,
  15865. ContentProviderWithoutLength content_provider,
  15866. const std::string &content_type,
  15867. UploadProgress progress) {
  15868. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15869. }
  15870. inline Result Client::Put(const std::string &path,
  15871. ContentProviderWithoutLength content_provider,
  15872. const std::string &content_type,
  15873. ContentReceiver content_receiver,
  15874. UploadProgress progress) {
  15875. return cli_->Put(path, std::move(content_provider), content_type,
  15876. std::move(content_receiver), progress);
  15877. }
  15878. inline Result Client::Put(const std::string &path, const Headers &headers,
  15879. size_t content_length,
  15880. ContentProvider content_provider,
  15881. const std::string &content_type,
  15882. UploadProgress progress) {
  15883. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15884. content_type, progress);
  15885. }
  15886. inline Result Client::Put(const std::string &path, const Headers &headers,
  15887. size_t content_length,
  15888. ContentProvider content_provider,
  15889. const std::string &content_type,
  15890. ContentReceiver content_receiver,
  15891. UploadProgress progress) {
  15892. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15893. content_type, std::move(content_receiver), progress);
  15894. }
  15895. inline Result Client::Put(const std::string &path, const Headers &headers,
  15896. ContentProviderWithoutLength content_provider,
  15897. const std::string &content_type,
  15898. UploadProgress progress) {
  15899. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15900. progress);
  15901. }
  15902. inline Result Client::Put(const std::string &path, const Headers &headers,
  15903. ContentProviderWithoutLength content_provider,
  15904. const std::string &content_type,
  15905. ContentReceiver content_receiver,
  15906. UploadProgress progress) {
  15907. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15908. std::move(content_receiver), progress);
  15909. }
  15910. inline Result Client::Put(const std::string &path, const Params &params) {
  15911. return cli_->Put(path, params);
  15912. }
  15913. inline Result Client::Put(const std::string &path, const Headers &headers,
  15914. const Params &params) {
  15915. return cli_->Put(path, headers, params);
  15916. }
  15917. inline Result Client::Put(const std::string &path,
  15918. const UploadFormDataItems &items,
  15919. UploadProgress progress) {
  15920. return cli_->Put(path, items, progress);
  15921. }
  15922. inline Result Client::Put(const std::string &path, const Headers &headers,
  15923. const UploadFormDataItems &items,
  15924. UploadProgress progress) {
  15925. return cli_->Put(path, headers, items, progress);
  15926. }
  15927. inline Result Client::Put(const std::string &path, const Headers &headers,
  15928. const UploadFormDataItems &items,
  15929. const std::string &boundary,
  15930. UploadProgress progress) {
  15931. return cli_->Put(path, headers, items, boundary, progress);
  15932. }
  15933. inline Result Client::Put(const std::string &path, const Headers &headers,
  15934. const UploadFormDataItems &items,
  15935. const FormDataProviderItems &provider_items,
  15936. UploadProgress progress) {
  15937. return cli_->Put(path, headers, items, provider_items, progress);
  15938. }
  15939. inline Result Client::Put(const std::string &path, const Headers &headers,
  15940. const std::string &body,
  15941. const std::string &content_type,
  15942. ContentReceiver content_receiver,
  15943. DownloadProgress progress) {
  15944. return cli_->Put(path, headers, body, content_type, content_receiver,
  15945. progress);
  15946. }
  15947. inline Result Client::Patch(const std::string &path) {
  15948. return cli_->Patch(path);
  15949. }
  15950. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15951. return cli_->Patch(path, headers);
  15952. }
  15953. inline Result Client::Patch(const std::string &path, const char *body,
  15954. size_t content_length,
  15955. const std::string &content_type,
  15956. UploadProgress progress) {
  15957. return cli_->Patch(path, body, content_length, content_type, progress);
  15958. }
  15959. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15960. const char *body, size_t content_length,
  15961. const std::string &content_type,
  15962. UploadProgress progress) {
  15963. return cli_->Patch(path, headers, body, content_length, content_type,
  15964. progress);
  15965. }
  15966. inline Result Client::Patch(const std::string &path, const std::string &body,
  15967. const std::string &content_type,
  15968. UploadProgress progress) {
  15969. return cli_->Patch(path, body, content_type, progress);
  15970. }
  15971. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15972. const std::string &body,
  15973. const std::string &content_type,
  15974. UploadProgress progress) {
  15975. return cli_->Patch(path, headers, body, content_type, progress);
  15976. }
  15977. inline Result Client::Patch(const std::string &path, size_t content_length,
  15978. ContentProvider content_provider,
  15979. const std::string &content_type,
  15980. UploadProgress progress) {
  15981. return cli_->Patch(path, content_length, std::move(content_provider),
  15982. content_type, progress);
  15983. }
  15984. inline Result Client::Patch(const std::string &path, size_t content_length,
  15985. ContentProvider content_provider,
  15986. const std::string &content_type,
  15987. ContentReceiver content_receiver,
  15988. UploadProgress progress) {
  15989. return cli_->Patch(path, content_length, std::move(content_provider),
  15990. content_type, std::move(content_receiver), progress);
  15991. }
  15992. inline Result Client::Patch(const std::string &path,
  15993. ContentProviderWithoutLength content_provider,
  15994. const std::string &content_type,
  15995. UploadProgress progress) {
  15996. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15997. }
  15998. inline Result Client::Patch(const std::string &path,
  15999. ContentProviderWithoutLength content_provider,
  16000. const std::string &content_type,
  16001. ContentReceiver content_receiver,
  16002. UploadProgress progress) {
  16003. return cli_->Patch(path, std::move(content_provider), content_type,
  16004. std::move(content_receiver), progress);
  16005. }
  16006. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16007. size_t content_length,
  16008. ContentProvider content_provider,
  16009. const std::string &content_type,
  16010. UploadProgress progress) {
  16011. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16012. content_type, progress);
  16013. }
  16014. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16015. size_t content_length,
  16016. ContentProvider content_provider,
  16017. const std::string &content_type,
  16018. ContentReceiver content_receiver,
  16019. UploadProgress progress) {
  16020. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16021. content_type, std::move(content_receiver), progress);
  16022. }
  16023. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16024. ContentProviderWithoutLength content_provider,
  16025. const std::string &content_type,
  16026. UploadProgress progress) {
  16027. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16028. progress);
  16029. }
  16030. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16031. ContentProviderWithoutLength content_provider,
  16032. const std::string &content_type,
  16033. ContentReceiver content_receiver,
  16034. UploadProgress progress) {
  16035. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16036. std::move(content_receiver), progress);
  16037. }
  16038. inline Result Client::Patch(const std::string &path, const Params &params) {
  16039. return cli_->Patch(path, params);
  16040. }
  16041. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16042. const Params &params) {
  16043. return cli_->Patch(path, headers, params);
  16044. }
  16045. inline Result Client::Patch(const std::string &path,
  16046. const UploadFormDataItems &items,
  16047. UploadProgress progress) {
  16048. return cli_->Patch(path, items, progress);
  16049. }
  16050. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16051. const UploadFormDataItems &items,
  16052. UploadProgress progress) {
  16053. return cli_->Patch(path, headers, items, progress);
  16054. }
  16055. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16056. const UploadFormDataItems &items,
  16057. const std::string &boundary,
  16058. UploadProgress progress) {
  16059. return cli_->Patch(path, headers, items, boundary, progress);
  16060. }
  16061. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16062. const UploadFormDataItems &items,
  16063. const FormDataProviderItems &provider_items,
  16064. UploadProgress progress) {
  16065. return cli_->Patch(path, headers, items, provider_items, progress);
  16066. }
  16067. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16068. const std::string &body,
  16069. const std::string &content_type,
  16070. ContentReceiver content_receiver,
  16071. DownloadProgress progress) {
  16072. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16073. progress);
  16074. }
  16075. inline Result Client::Delete(const std::string &path,
  16076. DownloadProgress progress) {
  16077. return cli_->Delete(path, progress);
  16078. }
  16079. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16080. DownloadProgress progress) {
  16081. return cli_->Delete(path, headers, progress);
  16082. }
  16083. inline Result Client::Delete(const std::string &path, const char *body,
  16084. size_t content_length,
  16085. const std::string &content_type,
  16086. DownloadProgress progress) {
  16087. return cli_->Delete(path, body, content_length, content_type, progress);
  16088. }
  16089. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16090. const char *body, size_t content_length,
  16091. const std::string &content_type,
  16092. DownloadProgress progress) {
  16093. return cli_->Delete(path, headers, body, content_length, content_type,
  16094. progress);
  16095. }
  16096. inline Result Client::Delete(const std::string &path, const std::string &body,
  16097. const std::string &content_type,
  16098. DownloadProgress progress) {
  16099. return cli_->Delete(path, body, content_type, progress);
  16100. }
  16101. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16102. const std::string &body,
  16103. const std::string &content_type,
  16104. DownloadProgress progress) {
  16105. return cli_->Delete(path, headers, body, content_type, progress);
  16106. }
  16107. inline Result Client::Delete(const std::string &path, const Params &params,
  16108. DownloadProgress progress) {
  16109. return cli_->Delete(path, params, progress);
  16110. }
  16111. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16112. const Params &params, DownloadProgress progress) {
  16113. return cli_->Delete(path, headers, params, progress);
  16114. }
  16115. inline Result Client::Options(const std::string &path) {
  16116. return cli_->Options(path);
  16117. }
  16118. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16119. return cli_->Options(path, headers);
  16120. }
  16121. inline ClientImpl::StreamHandle
  16122. Client::open_stream(const std::string &method, const std::string &path,
  16123. const Params &params, const Headers &headers,
  16124. const std::string &body, const std::string &content_type) {
  16125. return cli_->open_stream(method, path, params, headers, body, content_type);
  16126. }
  16127. inline bool Client::send(Request &req, Response &res, Error &error) {
  16128. return cli_->send(req, res, error);
  16129. }
  16130. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16131. inline void Client::stop() { cli_->stop(); }
  16132. inline std::string Client::host() const { return cli_->host(); }
  16133. inline int Client::port() const { return cli_->port(); }
  16134. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16135. inline socket_t Client::socket() const { return cli_->socket(); }
  16136. inline void
  16137. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16138. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16139. }
  16140. inline void Client::set_direct_hostname_addr_map(
  16141. std::map<std::string, std::string> addr_map) {
  16142. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16143. }
  16144. inline void Client::set_tunnel_hostname_addr_map(
  16145. std::map<std::string, std::string> addr_map) {
  16146. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16147. }
  16148. inline void Client::set_default_headers(Headers headers) {
  16149. cli_->set_default_headers(std::move(headers));
  16150. }
  16151. inline void Client::set_header_writer(
  16152. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16153. cli_->set_header_writer(writer);
  16154. }
  16155. inline void Client::set_address_family(int family) {
  16156. cli_->set_address_family(family);
  16157. }
  16158. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16159. inline void Client::set_socket_options(SocketOptions socket_options) {
  16160. cli_->set_socket_options(std::move(socket_options));
  16161. }
  16162. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16163. cli_->set_connection_timeout(sec, usec);
  16164. }
  16165. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16166. cli_->set_read_timeout(sec, usec);
  16167. }
  16168. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16169. cli_->set_write_timeout(sec, usec);
  16170. }
  16171. inline void Client::set_basic_auth(const std::string &username,
  16172. const std::string &password) {
  16173. cli_->set_basic_auth(username, password);
  16174. }
  16175. inline void Client::set_bearer_token_auth(const std::string &token) {
  16176. cli_->set_bearer_token_auth(token);
  16177. }
  16178. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16179. inline void Client::set_follow_location(bool on) {
  16180. cli_->set_follow_location(on);
  16181. }
  16182. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16183. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16184. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16185. inline void Client::set_payload_max_length(size_t length) {
  16186. cli_->set_payload_max_length(length);
  16187. }
  16188. inline void Client::set_interface(const std::string &intf) {
  16189. cli_->set_interface(intf);
  16190. }
  16191. inline void Client::set_proxy(const std::string &host, int port) {
  16192. cli_->set_proxy(host, port);
  16193. }
  16194. inline void Client::set_proxy_basic_auth(const std::string &username,
  16195. const std::string &password) {
  16196. cli_->set_proxy_basic_auth(username, password);
  16197. }
  16198. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16199. cli_->set_proxy_bearer_token_auth(token);
  16200. }
  16201. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16202. cli_->set_no_proxy(patterns);
  16203. }
  16204. inline void Client::set_logger(Logger logger) {
  16205. cli_->set_logger(std::move(logger));
  16206. }
  16207. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16208. cli_->set_error_logger(std::move(error_logger));
  16209. }
  16210. /*
  16211. * Group 6: SSL Server and Client implementation
  16212. */
  16213. #ifdef CPPHTTPLIB_SSL_ENABLED
  16214. // SSL HTTP server implementation
  16215. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16216. const char *client_ca_cert_file_path,
  16217. const char *client_ca_cert_dir_path,
  16218. const char *private_key_password) {
  16219. using namespace tls;
  16220. ctx_ = create_server_context();
  16221. if (!ctx_) { return; }
  16222. // Load server certificate and private key
  16223. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16224. private_key_password)) {
  16225. last_ssl_error_ = static_cast<int>(get_error());
  16226. free_context(ctx_);
  16227. ctx_ = nullptr;
  16228. return;
  16229. }
  16230. // Load client CA certificates for client authentication
  16231. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16232. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16233. client_ca_cert_dir_path)) {
  16234. last_ssl_error_ = static_cast<int>(get_error());
  16235. free_context(ctx_);
  16236. ctx_ = nullptr;
  16237. return;
  16238. }
  16239. // Enable client certificate verification
  16240. set_verify_client(ctx_, true);
  16241. }
  16242. }
  16243. inline SSLServer::SSLServer(const PemMemory &pem) {
  16244. using namespace tls;
  16245. ctx_ = create_server_context();
  16246. if (ctx_) {
  16247. std::string cert_buf, key_buf;
  16248. if (!set_server_cert_pem(
  16249. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16250. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16251. pem.private_key_password)) {
  16252. last_ssl_error_ = static_cast<int>(get_error());
  16253. free_context(ctx_);
  16254. ctx_ = nullptr;
  16255. } else if (pem.client_ca_pem) {
  16256. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16257. : strlen(pem.client_ca_pem);
  16258. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16259. last_ssl_error_ = static_cast<int>(get_error());
  16260. free_context(ctx_);
  16261. ctx_ = nullptr;
  16262. } else {
  16263. set_verify_client(ctx_, true);
  16264. }
  16265. }
  16266. }
  16267. }
  16268. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16269. using namespace tls;
  16270. ctx_ = create_server_context();
  16271. if (ctx_) {
  16272. if (!setup_callback(ctx_)) {
  16273. free_context(ctx_);
  16274. ctx_ = nullptr;
  16275. }
  16276. }
  16277. }
  16278. inline SSLServer::~SSLServer() {
  16279. if (ctx_) { tls::free_context(ctx_); }
  16280. }
  16281. inline bool SSLServer::is_valid() const {
  16282. return ctx_ != nullptr && Server::is_valid();
  16283. }
  16284. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16285. using namespace tls;
  16286. session_t session = nullptr;
  16287. {
  16288. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16289. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16290. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16291. if (session) { handshakes_in_progress_++; }
  16292. }
  16293. if (!session) {
  16294. last_ssl_error_ = static_cast<int>(get_error());
  16295. detail::shutdown_socket(sock);
  16296. detail::close_socket(sock);
  16297. return false;
  16298. }
  16299. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16300. bool handshake_done = false;
  16301. bool ret = false;
  16302. bool websocket_upgraded = false;
  16303. auto cleanup = detail::scope_exit([&] {
  16304. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16305. free_session(session);
  16306. detail::shutdown_socket(sock);
  16307. detail::close_socket(sock);
  16308. });
  16309. // Perform TLS accept handshake with timeout
  16310. TlsError tls_err;
  16311. auto accepted = false;
  16312. {
  16313. auto handshake_left = detail::scope_exit([&] {
  16314. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16315. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16316. });
  16317. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16318. read_timeout_usec_, &tls_err);
  16319. }
  16320. if (!accepted) {
  16321. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16322. // Map TlsError to legacy ssl_error for backward compatibility
  16323. if (tls_err.code == ErrorCode::WantRead) {
  16324. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16325. } else if (tls_err.code == ErrorCode::WantWrite) {
  16326. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16327. } else {
  16328. last_ssl_error_ = SSL_ERROR_SSL;
  16329. }
  16330. #else
  16331. last_ssl_error_ = static_cast<int>(get_error());
  16332. #endif
  16333. return false;
  16334. }
  16335. handshake_done = true;
  16336. std::string remote_addr;
  16337. int remote_port = 0;
  16338. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16339. std::string local_addr;
  16340. int local_port = 0;
  16341. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16342. ret = serve_guarded([&]() {
  16343. return detail::process_server_socket_ssl(
  16344. svr_sock_, session, sock, keep_alive_max_count_,
  16345. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16346. write_timeout_sec_, write_timeout_usec_,
  16347. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16348. return process_request(
  16349. strm, remote_addr, remote_port, local_addr, local_port,
  16350. close_connection, connection_closed,
  16351. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16352. });
  16353. });
  16354. return ret;
  16355. }
  16356. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16357. const char *key_pem,
  16358. const char *client_ca_pem,
  16359. const char *password) {
  16360. if (!ctx_) { return false; }
  16361. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16362. updates_pending_++;
  16363. auto se = detail::scope_exit([&] {
  16364. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16365. });
  16366. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16367. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16368. return false;
  16369. }
  16370. if (client_ca_pem) {
  16371. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16372. // As in the constructors, a client CA makes client certificates required
  16373. tls::set_verify_client(ctx_, true);
  16374. }
  16375. return true;
  16376. }
  16377. // SSL HTTP client implementation
  16378. inline SSLClient::~SSLClient() {
  16379. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16380. // base function rather than the derived function once we get to the
  16381. // base class destructor, and won't free the SSL (causing a leak).
  16382. // This must happen before the context is freed below: some backends
  16383. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16384. // context, so freeing the context first leaves close_notify reading
  16385. // freed memory.
  16386. shutdown_ssl_impl(socket_, true);
  16387. if (ctx_) {
  16388. tls::free_context(ctx_);
  16389. ctx_ = nullptr;
  16390. }
  16391. }
  16392. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16393. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16394. shutdown_ssl_impl(socket, shutdown_gracefully);
  16395. }
  16396. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16397. bool shutdown_gracefully) {
  16398. if (socket.sock == INVALID_SOCKET) {
  16399. assert(socket.ssl == nullptr);
  16400. return;
  16401. }
  16402. if (socket.ssl) {
  16403. tls::shutdown(socket.ssl, shutdown_gracefully);
  16404. {
  16405. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16406. tls::free_session(socket.ssl);
  16407. }
  16408. socket.ssl = nullptr;
  16409. }
  16410. assert(socket.ssl == nullptr);
  16411. }
  16412. inline bool SSLClient::process_socket(
  16413. const Socket &socket,
  16414. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16415. std::function<bool(Stream &strm)> callback) {
  16416. assert(socket.ssl);
  16417. return detail::process_client_socket_ssl(
  16418. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16419. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16420. [&](detail::SSLSocketStream &strm) {
  16421. auto ret = callback(strm);
  16422. // A request that failed after the handshake reports Error::Read or
  16423. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16424. // from the server, for Result::ssl_error() and ssl_backend_error()
  16425. const auto &tls_error = strm.tls_error();
  16426. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16427. last_ssl_error_ = static_cast<int>(tls_error.code);
  16428. last_backend_error_ = tls_error.backend_code;
  16429. }
  16430. return ret;
  16431. });
  16432. }
  16433. inline bool SSLClient::is_ssl() const { return true; }
  16434. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16435. if (!is_valid()) {
  16436. error = Error::SSLConnection;
  16437. return false;
  16438. }
  16439. return ClientImpl::create_and_connect_socket(socket, error);
  16440. }
  16441. inline bool SSLClient::setup_proxy_connection(
  16442. Socket &socket,
  16443. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16444. Response &res, bool &success, Error &error) {
  16445. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16446. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16447. return false;
  16448. }
  16449. if (!initialize_ssl(socket, error)) {
  16450. success = false;
  16451. return false;
  16452. }
  16453. return true;
  16454. }
  16455. // Assumes that socket_mutex_ is locked and that there are no requests in
  16456. // flight
  16457. inline bool SSLClient::connect_with_proxy(
  16458. Socket &socket,
  16459. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16460. Response &res, bool &success, Error &error) {
  16461. success = true;
  16462. auto connect_target =
  16463. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  16464. auto retargeted = connect_target !=
  16465. detail::make_host_and_port_string_always_port(host_, port_);
  16466. Response proxy_res;
  16467. if (!detail::process_client_socket(
  16468. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16469. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16470. start_time, [&](Stream &strm) {
  16471. Request req2;
  16472. req2.method = "CONNECT";
  16473. req2.path = connect_target;
  16474. if (retargeted) { req2.set_header("Host", connect_target); }
  16475. if (max_timeout_msec_ > 0) {
  16476. req2.start_time_ = std::chrono::steady_clock::now();
  16477. }
  16478. return process_request(strm, req2, proxy_res, false, error);
  16479. })) {
  16480. // Thread-safe to close everything because we are assuming there are no
  16481. // requests in flight
  16482. shutdown_ssl(socket, true);
  16483. shutdown_socket(socket);
  16484. close_socket(socket);
  16485. success = false;
  16486. return false;
  16487. }
  16488. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16489. if (!proxy_digest_auth_username_.empty() &&
  16490. !proxy_digest_auth_password_.empty()) {
  16491. std::map<std::string, std::string> auth;
  16492. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16493. // Close the current socket and create a new one for the authenticated
  16494. // request
  16495. shutdown_ssl(socket, true);
  16496. shutdown_socket(socket);
  16497. close_socket(socket);
  16498. // Create a new socket for the authenticated CONNECT request
  16499. if (!ensure_socket_connection(socket, error)) {
  16500. success = false;
  16501. return false;
  16502. }
  16503. proxy_res = Response();
  16504. if (!detail::process_client_socket(
  16505. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16506. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16507. start_time, [&](Stream &strm) {
  16508. Request req3;
  16509. req3.method = "CONNECT";
  16510. req3.path = connect_target;
  16511. if (retargeted) { req3.set_header("Host", connect_target); }
  16512. req3.headers.insert(detail::make_digest_authentication_header(
  16513. req3, make_request_target(req3), auth, 1,
  16514. detail::random_string(10), proxy_digest_auth_username_,
  16515. proxy_digest_auth_password_, true));
  16516. if (max_timeout_msec_ > 0) {
  16517. req3.start_time_ = std::chrono::steady_clock::now();
  16518. }
  16519. return process_request(strm, req3, proxy_res, false, error);
  16520. })) {
  16521. // Thread-safe to close everything because we are assuming there are
  16522. // no requests in flight
  16523. shutdown_ssl(socket, true);
  16524. shutdown_socket(socket);
  16525. close_socket(socket);
  16526. success = false;
  16527. return false;
  16528. }
  16529. }
  16530. }
  16531. }
  16532. // If status code is not 200, proxy request is failed.
  16533. // Set error to ProxyConnection. A 407 is returned as the response of the
  16534. // request, so the caller sees the proxy asks for credentials; any other
  16535. // status would read as the answer of the origin, which it never reached.
  16536. if (proxy_res.status != StatusCode::OK_200) {
  16537. error = Error::ProxyConnection;
  16538. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16539. res = std::move(proxy_res);
  16540. } else {
  16541. success = false;
  16542. }
  16543. // Thread-safe to close everything because we are assuming there are
  16544. // no requests in flight
  16545. shutdown_ssl(socket, true);
  16546. shutdown_socket(socket);
  16547. close_socket(socket);
  16548. return false;
  16549. }
  16550. return true;
  16551. }
  16552. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16553. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16554. if (is_proxy_enabled_for_host(host_)) { return true; }
  16555. if (!initialize_ssl(socket, error)) {
  16556. shutdown_socket(socket);
  16557. close_socket(socket);
  16558. return false;
  16559. }
  16560. return true;
  16561. }
  16562. // SSL HTTP client implementation
  16563. inline SSLClient::SSLClient(const std::string &host)
  16564. : SSLClient(host, 443, std::string(), std::string()) {}
  16565. inline SSLClient::SSLClient(const std::string &host, int port)
  16566. : SSLClient(host, port, std::string(), std::string()) {}
  16567. inline void SSLClient::init_ctx() {
  16568. ctx_ = tls::create_client_context();
  16569. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16570. }
  16571. inline void SSLClient::reset_ctx_on_error() {
  16572. last_backend_error_ = tls::get_error();
  16573. tls::free_context(ctx_);
  16574. ctx_ = nullptr;
  16575. }
  16576. inline SSLClient::SSLClient(const std::string &host, int port,
  16577. const std::string &client_cert_path,
  16578. const std::string &client_key_path,
  16579. const std::string &private_key_password)
  16580. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16581. init_ctx();
  16582. if (!ctx_) { return; }
  16583. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16584. const char *password =
  16585. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16586. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16587. client_key_path.c_str(), password)) {
  16588. reset_ctx_on_error();
  16589. }
  16590. }
  16591. }
  16592. inline SSLClient::SSLClient(const std::string &host, int port,
  16593. const PemMemory &pem)
  16594. : ClientImpl(host, port) {
  16595. init_ctx();
  16596. if (!ctx_) { return; }
  16597. if (pem.cert_pem && pem.key_pem) {
  16598. std::string cert_buf, key_buf;
  16599. if (!tls::set_client_cert_pem(
  16600. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16601. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16602. pem.private_key_password)) {
  16603. reset_ctx_on_error();
  16604. }
  16605. }
  16606. }
  16607. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16608. if (ca_cert_store && ctx_) {
  16609. // set_ca_store takes ownership of ca_cert_store
  16610. tls::set_ca_store(ctx_, ca_cert_store);
  16611. ca_cert_store_set_ = true;
  16612. } else if (ca_cert_store) {
  16613. tls::free_ca_store(ca_cert_store);
  16614. }
  16615. custom_ca_loaded_ = true;
  16616. tls_settings_changed();
  16617. }
  16618. inline void
  16619. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16620. if (!ctx_) { return; }
  16621. server_certificate_verifier_ = verifier;
  16622. {
  16623. // Under the lock that creating a session from ctx_ takes
  16624. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16625. tls::set_verify_callback(ctx_, std::move(verifier));
  16626. }
  16627. tls_settings_changed();
  16628. }
  16629. inline void SSLClient::set_session_verifier(
  16630. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16631. session_verifier_ = std::move(verifier);
  16632. tls_settings_changed();
  16633. }
  16634. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16635. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16636. if (enable_windows_cert_verification_ == enabled) { return; }
  16637. enable_windows_cert_verification_ = enabled;
  16638. tls_settings_changed();
  16639. }
  16640. #endif
  16641. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16642. std::size_t size) {
  16643. if (ctx_ && ca_cert && size > 0) {
  16644. // Every PEM loaded, for redirect transfer
  16645. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16646. ca_cert_pem_ += '\n';
  16647. }
  16648. ca_cert_pem_.append(ca_cert, size);
  16649. tls::load_ca_pem(ctx_, ca_cert, size);
  16650. }
  16651. custom_ca_loaded_ = true;
  16652. tls_settings_changed();
  16653. }
  16654. inline bool SSLClient::load_certs() {
  16655. auto ret = true;
  16656. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16657. // one client is shared across concurrent requests here.
  16658. std::call_once(initialize_cert_, [&]() {
  16659. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16660. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16661. ca_cert_dir_path_, custom_ca_loaded_,
  16662. system_ca_mode_, last_backend_error_);
  16663. });
  16664. return ret;
  16665. }
  16666. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16667. // Load CA certificates if server verification is enabled
  16668. if (server_certificate_verification_) {
  16669. if (!load_certs()) {
  16670. error = Error::SSLLoadingCerts;
  16671. return false;
  16672. }
  16673. }
  16674. detail::ClientTlsSessionOptions options;
  16675. options.server_hostname_verification = server_hostname_verification_;
  16676. options.session_verifier = session_verifier_;
  16677. options.ctx_mutex = &ctx_mutex_;
  16678. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16679. // Skip Schannel when a custom CA cert is specified, as the Windows
  16680. // certificate store would not know about user-provided CA certificates.
  16681. // Also skip when system CA trust is explicitly disabled.
  16682. options.windows_cert_verification =
  16683. enable_windows_cert_verification_ &&
  16684. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16685. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16686. // Only a verifier set through set_server_certificate_verifier() is seen
  16687. // here, not one installed with tls::set_verify_callback() directly.
  16688. options.server_certificate_verifier_set =
  16689. static_cast<bool>(server_certificate_verifier_);
  16690. #endif
  16691. tls::session_t session = nullptr;
  16692. // Use scope_exit to ensure session is freed on error paths
  16693. bool success = false;
  16694. auto session_guard = detail::scope_exit([&] {
  16695. if (!success) { tls::free_session(session); }
  16696. });
  16697. detail::ClientTlsSessionError tls_error;
  16698. if (!detail::setup_client_tls_session(
  16699. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16700. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16701. options)) {
  16702. error = tls_error.error;
  16703. last_ssl_error_ = tls_error.ssl_error;
  16704. last_backend_error_ = tls_error.backend_error;
  16705. return false;
  16706. }
  16707. success = true;
  16708. socket.ssl = session;
  16709. return true;
  16710. }
  16711. inline void Client::set_digest_auth(const std::string &username,
  16712. const std::string &password) {
  16713. cli_->set_digest_auth(username, password);
  16714. }
  16715. inline void Client::set_proxy_digest_auth(const std::string &username,
  16716. const std::string &password) {
  16717. cli_->set_proxy_digest_auth(username, password);
  16718. }
  16719. inline void Client::enable_server_certificate_verification(bool enabled) {
  16720. cli_->enable_server_certificate_verification(enabled);
  16721. }
  16722. inline void Client::enable_server_hostname_verification(bool enabled) {
  16723. cli_->enable_server_hostname_verification(enabled);
  16724. }
  16725. inline void Client::enable_system_ca(bool enabled) {
  16726. cli_->enable_system_ca(enabled);
  16727. }
  16728. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16729. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16730. if (is_ssl_) {
  16731. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16732. enabled);
  16733. }
  16734. }
  16735. #endif
  16736. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16737. const std::string &ca_cert_dir_path) {
  16738. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16739. }
  16740. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16741. if (is_ssl_) {
  16742. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16743. } else if (ca_cert_store) {
  16744. tls::free_ca_store(ca_cert_store);
  16745. }
  16746. }
  16747. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16748. if (is_ssl_) {
  16749. // Use the PEM-based path so the CA data is retained for redirect transfer
  16750. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16751. }
  16752. }
  16753. inline void
  16754. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16755. if (is_ssl_) {
  16756. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16757. std::move(verifier));
  16758. }
  16759. }
  16760. inline void Client::set_session_verifier(
  16761. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16762. if (is_ssl_) {
  16763. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16764. }
  16765. }
  16766. inline tls::ctx_t Client::tls_context() const {
  16767. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16768. return nullptr;
  16769. }
  16770. #endif // CPPHTTPLIB_SSL_ENABLED
  16771. /*
  16772. * Group 7: TLS abstraction layer - Common API
  16773. */
  16774. #ifdef CPPHTTPLIB_SSL_ENABLED
  16775. namespace tls {
  16776. // Helper for PeerCert construction
  16777. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16778. return PeerCert(get_peer_cert(session));
  16779. }
  16780. namespace impl {
  16781. // set_verify_callback() can replace a callback while handshakes on other
  16782. // threads run it, so they share it, and take their reference under this lock.
  16783. inline std::mutex &verify_callback_mutex() {
  16784. static std::mutex mutex;
  16785. return mutex;
  16786. }
  16787. // The TLS libraries are C, so an exception from a verify callback must not
  16788. // unwind through them. It rejects the certificate instead.
  16789. inline bool run_verify_callback(const VerifyCallback &callback,
  16790. const VerifyContext &ctx) {
  16791. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16792. return callback(ctx);
  16793. #else
  16794. try {
  16795. return callback(ctx);
  16796. } catch (...) { return false; }
  16797. #endif
  16798. }
  16799. // Check if a string is an IPv4 address
  16800. inline bool is_ipv4_address(const std::string &str) {
  16801. int dots = 0;
  16802. for (char c : str) {
  16803. if (c == '.') {
  16804. dots++;
  16805. } else if (!detail::is_ascii_digit(c)) {
  16806. return false;
  16807. }
  16808. }
  16809. return dots == 3;
  16810. }
  16811. // Parse IPv4 address string to bytes
  16812. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16813. const char *p = str.c_str();
  16814. for (int i = 0; i < 4; i++) {
  16815. if (i > 0) {
  16816. if (*p != '.') { return false; }
  16817. p++;
  16818. }
  16819. int val = 0;
  16820. int digits = 0;
  16821. while (detail::is_ascii_digit(*p)) {
  16822. val = val * 10 + (*p - '0');
  16823. if (val > 255) { return false; }
  16824. p++;
  16825. digits++;
  16826. }
  16827. if (digits == 0) { return false; }
  16828. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16829. if (digits > 1 && *(p - digits) == '0') { return false; }
  16830. out[i] = static_cast<unsigned char>(val);
  16831. }
  16832. return *p == '\0';
  16833. }
  16834. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16835. // `out` must have room for at least 16 bytes. Returns the address length
  16836. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16837. // literal. Used to match a host against iPAddress SANs the same way the
  16838. // OpenSSL backend does via X509_check_ip.
  16839. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16840. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16841. struct in6_addr addr6 = {};
  16842. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16843. memcpy(out, &addr6, 16);
  16844. return 16;
  16845. }
  16846. return 0;
  16847. }
  16848. #ifdef _WIN32
  16849. // Enumerate Windows system certificates and call callback with DER data
  16850. template <typename Callback>
  16851. inline bool enumerate_windows_system_certs(Callback cb) {
  16852. bool loaded = false;
  16853. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16854. for (auto store_name : store_names) {
  16855. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16856. if (hStore) {
  16857. PCCERT_CONTEXT pContext = nullptr;
  16858. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16859. nullptr) {
  16860. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16861. loaded = true;
  16862. }
  16863. }
  16864. CertCloseStore(hStore, 0);
  16865. }
  16866. }
  16867. return loaded;
  16868. }
  16869. #endif
  16870. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16871. // The trust a certificate's Trust Settings give it for SSL server
  16872. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  16873. // Otherwise the first usage-constraints dictionary that applies decides: one
  16874. // naming a policy other than SSL, a host name or an application does not
  16875. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  16876. // Trust" as kSecTrustSettingsResultDeny.
  16877. inline SecTrustSettingsResult
  16878. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  16879. auto count = CFArrayGetCount(trust_settings);
  16880. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  16881. for (CFIndex i = 0; i < count; i++) {
  16882. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  16883. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  16884. auto constraint = static_cast<CFDictionaryRef>(value);
  16885. auto policy_value =
  16886. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  16887. if (policy_value) {
  16888. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  16889. auto is_ssl = false;
  16890. if (auto properties = SecPolicyCopyProperties(policy)) {
  16891. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  16892. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  16893. CFRelease(properties);
  16894. }
  16895. if (!is_ssl) { continue; }
  16896. }
  16897. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  16898. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  16899. continue;
  16900. }
  16901. auto result = kSecTrustSettingsResultTrustRoot;
  16902. auto number = static_cast<CFNumberRef>(
  16903. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  16904. if (number) {
  16905. SInt32 number_value = 0;
  16906. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  16907. continue;
  16908. }
  16909. result = static_cast<SecTrustSettingsResult>(number_value);
  16910. }
  16911. if (result == kSecTrustSettingsResultTrustRoot ||
  16912. result == kSecTrustSettingsResultTrustAsRoot ||
  16913. result == kSecTrustSettingsResultDeny) {
  16914. return result;
  16915. }
  16916. }
  16917. return kSecTrustSettingsResultUnspecified;
  16918. }
  16919. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  16920. // with DER data. A certificate with Trust Settings is not trusted just by
  16921. // having them: the settings say whether it is, and a per-user setting
  16922. // overrides the admin domain's, which overrides the system domain's (whose
  16923. // roots are all trusted). So a system root the user set to "Never Trust" is
  16924. // left out, as is one trusted only for S/MIME or code signing.
  16925. template <typename Callback>
  16926. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16927. const SecTrustSettingsDomain domains[] = {
  16928. kSecTrustSettingsDomainUser,
  16929. kSecTrustSettingsDomainAdmin,
  16930. kSecTrustSettingsDomainSystem,
  16931. };
  16932. std::set<std::string> decided;
  16933. std::vector<std::string> trusted;
  16934. for (auto domain : domains) {
  16935. CFArrayRef certs = nullptr;
  16936. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16937. if (status != errSecSuccess || !certs) {
  16938. if (certs) CFRelease(certs);
  16939. continue;
  16940. }
  16941. CFIndex count = CFArrayGetCount(certs);
  16942. for (CFIndex i = 0; i < count; i++) {
  16943. SecCertificateRef cert =
  16944. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16945. CFDataRef data = SecCertificateCopyData(cert);
  16946. if (!data) { continue; }
  16947. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  16948. static_cast<size_t>(CFDataGetLength(data)));
  16949. CFRelease(data);
  16950. // Decided by a domain that overrides this one
  16951. if (decided.find(der) != decided.end()) { continue; }
  16952. auto result = kSecTrustSettingsResultTrustRoot;
  16953. if (domain != kSecTrustSettingsDomainSystem) {
  16954. result = kSecTrustSettingsResultUnspecified;
  16955. CFArrayRef trust_settings = nullptr;
  16956. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  16957. errSecSuccess &&
  16958. trust_settings) {
  16959. result = macos_ssl_trust_settings_result(trust_settings);
  16960. }
  16961. if (trust_settings) CFRelease(trust_settings);
  16962. }
  16963. // Neither trusted nor distrusted here; a domain below may decide
  16964. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  16965. decided.insert(der);
  16966. if (result == kSecTrustSettingsResultTrustRoot ||
  16967. result == kSecTrustSettingsResultTrustAsRoot) {
  16968. trusted.push_back(std::move(der));
  16969. }
  16970. }
  16971. CFRelease(certs);
  16972. }
  16973. bool loaded = false;
  16974. for (const auto &der : trusted) {
  16975. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  16976. loaded = true;
  16977. }
  16978. }
  16979. return loaded;
  16980. }
  16981. #endif
  16982. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16983. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16984. // Common CA certificate file paths on Linux/Unix
  16985. inline const char **system_ca_paths() {
  16986. static const char *paths[] = {
  16987. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16988. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16989. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16990. "/etc/pki/tls/cacert.pem", // OpenELEC
  16991. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16992. nullptr};
  16993. return paths;
  16994. }
  16995. // Common CA certificate directory paths on Linux/Unix
  16996. inline const char **system_ca_dirs() {
  16997. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16998. "/etc/pki/tls/certs", // RHEL/CentOS
  16999. "/usr/share/ca-certificates", // Other
  17000. nullptr};
  17001. return dirs;
  17002. }
  17003. #endif
  17004. } // namespace impl
  17005. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  17006. const char *ca_dir) {
  17007. if (!ctx) { return false; }
  17008. bool success = true;
  17009. if (ca_file && *ca_file) {
  17010. if (!load_ca_file(ctx, ca_file)) { success = false; }
  17011. }
  17012. if (ca_dir && *ca_dir) {
  17013. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  17014. }
  17015. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17016. // Set CA list for client certificate request (CertificateRequest message)
  17017. if (ca_file && *ca_file) {
  17018. auto list = SSL_load_client_CA_file(ca_file);
  17019. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  17020. }
  17021. #endif
  17022. return success;
  17023. }
  17024. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17025. const char *password) {
  17026. return set_client_cert_pem(ctx, cert, key, password);
  17027. }
  17028. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17029. const char *key_path, const char *password) {
  17030. return set_client_cert_file(ctx, cert_path, key_path, password);
  17031. }
  17032. // PeerCert implementation
  17033. inline PeerCert::PeerCert() = default;
  17034. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17035. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17036. other.cert_ = nullptr;
  17037. }
  17038. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17039. if (this != &other) {
  17040. if (cert_) { free_cert(cert_); }
  17041. cert_ = other.cert_;
  17042. other.cert_ = nullptr;
  17043. }
  17044. return *this;
  17045. }
  17046. inline PeerCert::~PeerCert() {
  17047. if (cert_) { free_cert(cert_); }
  17048. }
  17049. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17050. inline std::string PeerCert::subject_cn() const {
  17051. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17052. }
  17053. inline std::string PeerCert::issuer_name() const {
  17054. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17055. }
  17056. inline bool PeerCert::check_hostname(const char *hostname) const {
  17057. return cert_ ? verify_hostname(cert_, hostname) : false;
  17058. }
  17059. inline std::vector<SanEntry> PeerCert::sans() const {
  17060. std::vector<SanEntry> result;
  17061. if (cert_) { get_cert_sans(cert_, result); }
  17062. return result;
  17063. }
  17064. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17065. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17066. }
  17067. inline std::string PeerCert::serial() const {
  17068. return cert_ ? get_cert_serial(cert_) : std::string();
  17069. }
  17070. // VerifyContext method implementations
  17071. inline std::string VerifyContext::subject_cn() const {
  17072. return cert ? get_cert_subject_cn(cert) : std::string();
  17073. }
  17074. inline std::string VerifyContext::issuer_name() const {
  17075. return cert ? get_cert_issuer_name(cert) : std::string();
  17076. }
  17077. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17078. return cert ? verify_hostname(cert, hostname) : false;
  17079. }
  17080. inline std::vector<SanEntry> VerifyContext::sans() const {
  17081. std::vector<SanEntry> result;
  17082. if (cert) { get_cert_sans(cert, result); }
  17083. return result;
  17084. }
  17085. inline bool VerifyContext::validity(time_t &not_before,
  17086. time_t &not_after) const {
  17087. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17088. }
  17089. inline std::string VerifyContext::serial() const {
  17090. return cert ? get_cert_serial(cert) : std::string();
  17091. }
  17092. // TlsError static method implementation
  17093. inline std::string TlsError::verify_error_to_string(long error_code) {
  17094. return verify_error_string(error_code);
  17095. }
  17096. } // namespace tls
  17097. // Request::peer_cert() implementation
  17098. inline tls::PeerCert Request::peer_cert() const {
  17099. return tls::get_peer_cert_from_session(ssl);
  17100. }
  17101. // Request::sni() implementation
  17102. inline std::string Request::sni() const {
  17103. if (!ssl) { return std::string(); }
  17104. const char *s = tls::get_sni(ssl);
  17105. return s ? std::string(s) : std::string();
  17106. }
  17107. #endif // CPPHTTPLIB_SSL_ENABLED
  17108. /*
  17109. * Group 8: TLS abstraction layer - OpenSSL backend
  17110. */
  17111. /*
  17112. * OpenSSL Backend Implementation
  17113. */
  17114. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17115. namespace tls {
  17116. namespace impl {
  17117. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17118. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17119. switch (ssl_error) {
  17120. case SSL_ERROR_NONE: return ErrorCode::Success;
  17121. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17122. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17123. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17124. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17125. case SSL_ERROR_SSL:
  17126. default: return ErrorCode::Fatal;
  17127. }
  17128. }
  17129. // Fills in a failed SSL_connect(). One that the server certificate's
  17130. // verification stopped reports the verify result, as the other backends and
  17131. // a check after the handshake do.
  17132. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17133. auto ssl_err = SSL_get_error(ssl, ret);
  17134. auto error = ERR_get_error();
  17135. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17136. err.backend_code = error;
  17137. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17138. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17139. return;
  17140. }
  17141. // A certificate only a verify callback turned down carries no verdict of
  17142. // its own, and fails as any other handshake does
  17143. auto verify_result = SSL_get_verify_result(ssl);
  17144. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17145. return;
  17146. }
  17147. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17148. ? ErrorCode::HostnameMismatch
  17149. : ErrorCode::CertVerifyFailed;
  17150. err.backend_code = static_cast<uint64_t>(verify_result);
  17151. }
  17152. // Helper: Create client CA list from PEM string
  17153. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17154. // Caller takes ownership of returned list
  17155. inline STACK_OF(X509_NAME) *
  17156. create_client_ca_list_from_pem(const char *ca_pem) {
  17157. if (!ca_pem) { return nullptr; }
  17158. auto ca_list = sk_X509_NAME_new_null();
  17159. if (!ca_list) { return nullptr; }
  17160. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17161. if (!bio) {
  17162. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17163. return nullptr;
  17164. }
  17165. X509 *cert = nullptr;
  17166. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17167. nullptr) {
  17168. const X509_NAME *name = X509_get_subject_name(cert);
  17169. if (name) {
  17170. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17171. }
  17172. X509_free(cert);
  17173. }
  17174. BIO_free(bio);
  17175. return ca_list;
  17176. }
  17177. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17178. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17179. long /*argl*/, void * /*argp*/) {
  17180. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17181. }
  17182. // The SSL_CTX owns its verify callback, so each client or server sees only
  17183. // its own, on whichever thread runs the handshake.
  17184. inline int verify_callback_index() {
  17185. static const auto index = SSL_CTX_get_ex_new_index(
  17186. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17187. return index;
  17188. }
  17189. // OpenSSL verify callback wrapper
  17190. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17191. // Get SSL object from X509_STORE_CTX
  17192. auto ssl = static_cast<SSL *>(
  17193. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17194. if (!ssl) { return preverify_ok; }
  17195. std::shared_ptr<VerifyCallback> callback;
  17196. {
  17197. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17198. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17199. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17200. if (stored) { callback = *stored; }
  17201. }
  17202. if (!callback) { return preverify_ok; }
  17203. // Get current certificate and depth
  17204. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17205. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17206. int error = X509_STORE_CTX_get_error(ctx);
  17207. // Build context
  17208. VerifyContext verify_ctx;
  17209. verify_ctx.session = static_cast<session_t>(ssl);
  17210. verify_ctx.cert = static_cast<cert_t>(cert);
  17211. verify_ctx.depth = depth;
  17212. verify_ctx.preverify_ok = (preverify_ok != 0);
  17213. verify_ctx.error_code = error;
  17214. verify_ctx.error_string =
  17215. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17216. auto accepted = run_verify_callback(*callback, verify_ctx);
  17217. // A client verifying the server during the handshake, which is what
  17218. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17219. if (!SSL_is_server(ssl) &&
  17220. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17221. accepted = accepted && preverify_ok;
  17222. }
  17223. return accepted ? 1 : 0;
  17224. }
  17225. // Sets the verify mode from whether the peer's certificate is required and
  17226. // whether a verify callback is set.
  17227. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17228. auto has_callback =
  17229. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17230. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17231. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17232. SSL_CTX_set_verify(ssl_ctx, mode,
  17233. has_callback ? openssl_verify_callback : nullptr);
  17234. }
  17235. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17236. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17237. // that must be released with release_store_objects
  17238. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17239. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17240. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17241. #endif
  17242. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17243. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17244. return X509_STORE_get1_objects(store);
  17245. #else
  17246. return X509_STORE_get0_objects(store);
  17247. #endif
  17248. }
  17249. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17250. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17251. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17252. #else
  17253. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17254. #endif
  17255. }
  17256. } // namespace impl
  17257. inline ctx_t create_client_context() {
  17258. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17259. if (ctx) {
  17260. // Disable auto-retry to properly handle non-blocking I/O
  17261. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17262. // Set minimum TLS version
  17263. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17264. }
  17265. return static_cast<ctx_t>(ctx);
  17266. }
  17267. inline void free_context(ctx_t ctx) {
  17268. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17269. }
  17270. inline bool set_min_version(ctx_t ctx, Version version) {
  17271. if (!ctx) return false;
  17272. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17273. static_cast<uint16_t>(version)) == 1;
  17274. }
  17275. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17276. if (!ctx || !pem || len == 0) return false;
  17277. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17278. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17279. if (!store) return false;
  17280. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17281. if (!bio) return false;
  17282. bool ok = true;
  17283. X509 *cert = nullptr;
  17284. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17285. nullptr) {
  17286. if (X509_STORE_add_cert(store, cert) != 1) {
  17287. // Ignore duplicate errors
  17288. auto err = ERR_peek_last_error();
  17289. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17290. ok = false;
  17291. }
  17292. }
  17293. X509_free(cert);
  17294. if (!ok) break;
  17295. }
  17296. BIO_free(bio);
  17297. // Clear any "no more certificates" errors
  17298. ERR_clear_error();
  17299. return ok;
  17300. }
  17301. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17302. if (!ctx || !file_path) return false;
  17303. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17304. nullptr) == 1;
  17305. }
  17306. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17307. if (!ctx || !dir_path) return false;
  17308. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17309. dir_path) == 1;
  17310. }
  17311. inline bool load_system_certs(ctx_t ctx) {
  17312. if (!ctx) return false;
  17313. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17314. #ifdef _WIN32
  17315. // Windows: Load from system certificate store (ROOT and CA)
  17316. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17317. if (!store) return false;
  17318. bool loaded_any = false;
  17319. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17320. for (auto store_name : store_names) {
  17321. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17322. if (!hStore) continue;
  17323. PCCERT_CONTEXT pContext = nullptr;
  17324. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17325. nullptr) {
  17326. const unsigned char *data = pContext->pbCertEncoded;
  17327. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17328. if (x509) {
  17329. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17330. X509_free(x509);
  17331. }
  17332. }
  17333. CertCloseStore(hStore, 0);
  17334. }
  17335. return loaded_any;
  17336. #elif defined(__APPLE__)
  17337. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17338. // macOS: Load from Keychain
  17339. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17340. if (!store) return false;
  17341. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17342. [&](const unsigned char *data, size_t len) {
  17343. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17344. if (!x509) { return false; }
  17345. auto added = X509_STORE_add_cert(store, x509) == 1;
  17346. X509_free(x509);
  17347. return added;
  17348. });
  17349. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17350. #else
  17351. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17352. #endif
  17353. #else
  17354. // Other Unix: use default verify paths
  17355. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17356. #endif
  17357. }
  17358. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17359. const char *password) {
  17360. if (!ctx || !cert || !key) return false;
  17361. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17362. // Load certificate
  17363. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17364. if (!cert_bio) return false;
  17365. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17366. BIO_free(cert_bio);
  17367. if (!x509) return false;
  17368. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17369. X509_free(x509);
  17370. if (!cert_ok) return false;
  17371. // Load private key
  17372. auto key_bio = BIO_new_mem_buf(key, -1);
  17373. if (!key_bio) return false;
  17374. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17375. password ? const_cast<char *>(password)
  17376. : nullptr);
  17377. BIO_free(key_bio);
  17378. if (!pkey) return false;
  17379. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17380. EVP_PKEY_free(pkey);
  17381. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17382. }
  17383. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17384. const char *key_path, const char *password) {
  17385. if (!ctx || !cert_path || !key_path) return false;
  17386. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17387. if (password && password[0] != '\0') {
  17388. SSL_CTX_set_default_passwd_cb_userdata(
  17389. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17390. }
  17391. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17392. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17393. }
  17394. inline ctx_t create_server_context() {
  17395. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17396. if (ctx) {
  17397. // No renegotiation, as on the other backends: it would run a handshake
  17398. // that SSLServer::update_certs_pem() does not wait for
  17399. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17400. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17401. SSL_OP_NO_RENEGOTIATION);
  17402. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17403. // Without one, a client resuming its session is sent a fatal alert once
  17404. // client certificates are verified.
  17405. static const unsigned char sid_ctx[] = "cpp-httplib";
  17406. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17407. }
  17408. return static_cast<ctx_t>(ctx);
  17409. }
  17410. inline void set_verify_client(ctx_t ctx, bool require) {
  17411. if (!ctx) return;
  17412. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17413. }
  17414. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17415. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17416. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17417. SSL *ssl = SSL_new(ssl_ctx);
  17418. if (!ssl) return nullptr;
  17419. // Disable auto-retry for proper non-blocking I/O handling
  17420. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17421. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17422. if (!bio) {
  17423. SSL_free(ssl);
  17424. return nullptr;
  17425. }
  17426. SSL_set_bio(ssl, bio, bio);
  17427. return static_cast<session_t>(ssl);
  17428. }
  17429. inline void free_session(session_t session) {
  17430. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17431. }
  17432. inline bool set_sni(session_t session, const char *hostname,
  17433. bool verify_hostname) {
  17434. if (!session || !hostname) return false;
  17435. auto ssl = static_cast<SSL *>(session);
  17436. // The handshake's chain verification then checks the name as well
  17437. if (verify_hostname) {
  17438. auto param = SSL_get0_param(ssl);
  17439. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  17440. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  17441. return false;
  17442. }
  17443. }
  17444. #if defined(OPENSSL_IS_BORINGSSL)
  17445. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17446. #else
  17447. // Direct call instead of macro to suppress -Wold-style-cast warning
  17448. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17449. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17450. #endif
  17451. }
  17452. inline TlsError connect(session_t session) {
  17453. if (!session) { return TlsError(); }
  17454. auto ssl = static_cast<SSL *>(session);
  17455. auto ret = SSL_connect(ssl);
  17456. TlsError err;
  17457. if (ret == 1) {
  17458. err.code = ErrorCode::Success;
  17459. } else {
  17460. impl::fill_connect_error(ssl, ret, err);
  17461. }
  17462. return err;
  17463. }
  17464. inline TlsError accept(session_t session) {
  17465. if (!session) { return TlsError(); }
  17466. auto ssl = static_cast<SSL *>(session);
  17467. auto ret = SSL_accept(ssl);
  17468. TlsError err;
  17469. if (ret == 1) {
  17470. err.code = ErrorCode::Success;
  17471. } else {
  17472. auto ssl_err = SSL_get_error(ssl, ret);
  17473. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17474. err.backend_code = ERR_get_error();
  17475. }
  17476. return err;
  17477. }
  17478. inline bool connect_nonblocking(session_t session, socket_t sock,
  17479. time_t timeout_sec, time_t timeout_usec,
  17480. TlsError *err) {
  17481. if (!session) {
  17482. if (err) { err->code = ErrorCode::Fatal; }
  17483. return false;
  17484. }
  17485. auto ssl = static_cast<SSL *>(session);
  17486. auto bio = SSL_get_rbio(ssl);
  17487. // Set non-blocking mode for handshake
  17488. detail::set_nonblocking(sock, true);
  17489. if (bio) { BIO_set_nbio(bio, 1); }
  17490. auto cleanup = detail::scope_exit([&]() {
  17491. // Restore blocking mode after handshake
  17492. if (bio) { BIO_set_nbio(bio, 0); }
  17493. detail::set_nonblocking(sock, false);
  17494. });
  17495. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17496. auto res = 0;
  17497. while ((res = SSL_connect(ssl)) != 1) {
  17498. auto ssl_err = SSL_get_error(ssl, res);
  17499. switch (ssl_err) {
  17500. case SSL_ERROR_WANT_READ:
  17501. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17502. break;
  17503. case SSL_ERROR_WANT_WRITE:
  17504. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17505. break;
  17506. default: break;
  17507. }
  17508. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17509. return false;
  17510. }
  17511. if (err) { err->code = ErrorCode::Success; }
  17512. return true;
  17513. }
  17514. inline bool accept_nonblocking(session_t session, socket_t sock,
  17515. time_t timeout_sec, time_t timeout_usec,
  17516. TlsError *err) {
  17517. if (!session) {
  17518. if (err) { err->code = ErrorCode::Fatal; }
  17519. return false;
  17520. }
  17521. auto ssl = static_cast<SSL *>(session);
  17522. auto bio = SSL_get_rbio(ssl);
  17523. // Set non-blocking mode for handshake
  17524. detail::set_nonblocking(sock, true);
  17525. if (bio) { BIO_set_nbio(bio, 1); }
  17526. auto cleanup = detail::scope_exit([&]() {
  17527. // Restore blocking mode after handshake
  17528. if (bio) { BIO_set_nbio(bio, 0); }
  17529. detail::set_nonblocking(sock, false);
  17530. });
  17531. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17532. auto res = 0;
  17533. while ((res = SSL_accept(ssl)) != 1) {
  17534. auto ssl_err = SSL_get_error(ssl, res);
  17535. switch (ssl_err) {
  17536. case SSL_ERROR_WANT_READ:
  17537. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17538. break;
  17539. case SSL_ERROR_WANT_WRITE:
  17540. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17541. break;
  17542. default: break;
  17543. }
  17544. if (err) {
  17545. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17546. err->backend_code = ERR_get_error();
  17547. }
  17548. return false;
  17549. }
  17550. if (err) { err->code = ErrorCode::Success; }
  17551. return true;
  17552. }
  17553. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17554. if (!session || !buf) {
  17555. err.code = ErrorCode::Fatal;
  17556. return -1;
  17557. }
  17558. auto ssl = static_cast<SSL *>(session);
  17559. constexpr auto max_len =
  17560. static_cast<size_t>((std::numeric_limits<int>::max)());
  17561. if (len > max_len) { len = max_len; }
  17562. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17563. if (ret > 0) {
  17564. err.code = ErrorCode::Success;
  17565. return ret;
  17566. }
  17567. auto ssl_err = SSL_get_error(ssl, ret);
  17568. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17569. if (err.code == ErrorCode::PeerClosed) {
  17570. return 0;
  17571. } // Gracefully handle the peer closed state.
  17572. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17573. return -1;
  17574. }
  17575. inline ssize_t write(session_t session, const void *buf, size_t len,
  17576. TlsError &err) {
  17577. if (!session || !buf) {
  17578. err.code = ErrorCode::Fatal;
  17579. return -1;
  17580. }
  17581. auto ssl = static_cast<SSL *>(session);
  17582. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17583. if (ret > 0) {
  17584. err.code = ErrorCode::Success;
  17585. return ret;
  17586. }
  17587. auto ssl_err = SSL_get_error(ssl, ret);
  17588. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17589. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17590. return -1;
  17591. }
  17592. inline int pending(const_session_t session) {
  17593. if (!session) return 0;
  17594. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17595. }
  17596. inline void shutdown(session_t session, bool graceful) {
  17597. if (!session) return;
  17598. auto ssl = static_cast<SSL *>(session);
  17599. if (graceful) {
  17600. // Send close_notify without waiting for the peer's. The connection is
  17601. // closed right after this, so a unidirectional shutdown is enough, and an
  17602. // idle peer that never answers would otherwise hold this thread until the
  17603. // read timeout. The other backends do not wait either.
  17604. SSL_shutdown(ssl);
  17605. }
  17606. }
  17607. inline bool is_peer_closed(session_t session, socket_t sock) {
  17608. if (!session) return true;
  17609. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17610. detail::set_nonblocking(sock, true);
  17611. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17612. auto ssl = static_cast<SSL *>(session);
  17613. char buf;
  17614. auto ret = SSL_peek(ssl, &buf, 1);
  17615. if (ret > 0) return false;
  17616. auto err = SSL_get_error(ssl, ret);
  17617. return err == SSL_ERROR_ZERO_RETURN;
  17618. }
  17619. inline cert_t get_peer_cert(const_session_t session) {
  17620. if (!session) return nullptr;
  17621. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17622. static_cast<SSL *>(const_cast<void *>(session))));
  17623. }
  17624. inline size_t get_peer_certs(const_session_t session,
  17625. std::vector<cert_t> &certs) {
  17626. certs.clear();
  17627. if (!session) { return 0; }
  17628. auto ssl = static_cast<const SSL *>(session);
  17629. // On the server side, the chain leaves out the peer's own certificate
  17630. if (SSL_is_server(ssl)) {
  17631. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17632. }
  17633. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17634. auto count = sk_X509_num(sk);
  17635. for (decltype(count) i = 0; i < count; i++) {
  17636. auto x509 = sk_X509_value(sk, i);
  17637. X509_up_ref(x509);
  17638. certs.push_back(static_cast<cert_t>(x509));
  17639. }
  17640. }
  17641. return certs.size();
  17642. }
  17643. inline void free_cert(cert_t cert) {
  17644. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17645. }
  17646. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17647. if (!cert || !hostname) return false;
  17648. auto x509 = static_cast<X509 *>(cert);
  17649. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17650. if (detail::is_ip_address(hostname)) {
  17651. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17652. }
  17653. return X509_check_host(x509, hostname, strlen(hostname),
  17654. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  17655. }
  17656. inline uint64_t hostname_mismatch_code() {
  17657. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17658. }
  17659. inline long get_verify_result(const_session_t session) {
  17660. if (!session) return X509_V_ERR_UNSPECIFIED;
  17661. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17662. }
  17663. inline std::string get_cert_subject_cn(cert_t cert) {
  17664. if (!cert) return "";
  17665. auto x509 = static_cast<X509 *>(cert);
  17666. auto subject_name = X509_get_subject_name(x509);
  17667. if (!subject_name) return "";
  17668. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17669. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17670. if (idx < 0) return "";
  17671. auto entry = X509_NAME_get_entry(subject_name, idx);
  17672. if (!entry) return "";
  17673. auto data = X509_NAME_ENTRY_get_data(entry);
  17674. if (!data) return "";
  17675. return std::string(
  17676. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17677. static_cast<size_t>(ASN1_STRING_length(data)));
  17678. }
  17679. inline std::string get_cert_issuer_name(cert_t cert) {
  17680. if (!cert) return "";
  17681. auto x509 = static_cast<X509 *>(cert);
  17682. auto issuer_name = X509_get_issuer_name(x509);
  17683. if (!issuer_name) return "";
  17684. char buf[256];
  17685. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17686. return std::string(buf);
  17687. }
  17688. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17689. sans.clear();
  17690. if (!cert) return false;
  17691. auto x509 = static_cast<X509 *>(cert);
  17692. auto names = static_cast<GENERAL_NAMES *>(
  17693. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17694. if (!names) return true; // No SANs is valid
  17695. auto count = sk_GENERAL_NAME_num(names);
  17696. for (decltype(count) i = 0; i < count; i++) {
  17697. auto gen = sk_GENERAL_NAME_value(names, i);
  17698. if (!gen) continue;
  17699. SanEntry entry;
  17700. switch (gen->type) {
  17701. case GEN_DNS:
  17702. entry.type = SanType::DNS;
  17703. if (gen->d.dNSName) {
  17704. entry.value = std::string(
  17705. reinterpret_cast<const char *>(
  17706. ASN1_STRING_get0_data(gen->d.dNSName)),
  17707. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17708. }
  17709. break;
  17710. case GEN_IPADD:
  17711. entry.type = SanType::IP;
  17712. if (gen->d.iPAddress) {
  17713. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17714. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17715. if (len == 4) {
  17716. // IPv4
  17717. char buf[INET_ADDRSTRLEN];
  17718. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17719. entry.value = buf;
  17720. } else if (len == 16) {
  17721. // IPv6
  17722. char buf[INET6_ADDRSTRLEN];
  17723. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17724. entry.value = buf;
  17725. }
  17726. }
  17727. break;
  17728. case GEN_EMAIL:
  17729. entry.type = SanType::EMAIL;
  17730. if (gen->d.rfc822Name) {
  17731. entry.value = std::string(
  17732. reinterpret_cast<const char *>(
  17733. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17734. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17735. }
  17736. break;
  17737. case GEN_URI:
  17738. entry.type = SanType::URI;
  17739. if (gen->d.uniformResourceIdentifier) {
  17740. entry.value = std::string(
  17741. reinterpret_cast<const char *>(
  17742. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17743. static_cast<size_t>(
  17744. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17745. }
  17746. break;
  17747. default: entry.type = SanType::OTHER; break;
  17748. }
  17749. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17750. }
  17751. GENERAL_NAMES_free(names);
  17752. return true;
  17753. }
  17754. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17755. time_t &not_after) {
  17756. if (!cert) return false;
  17757. auto x509 = static_cast<X509 *>(cert);
  17758. auto nb = X509_get0_notBefore(x509);
  17759. auto na = X509_get0_notAfter(x509);
  17760. if (!nb || !na) return false;
  17761. ASN1_TIME *epoch = ASN1_TIME_new();
  17762. if (!epoch) return false;
  17763. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17764. if (!ASN1_TIME_set(epoch, 0)) return false;
  17765. int pday, psec;
  17766. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17767. not_before = 86400 * (time_t)pday + psec;
  17768. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17769. not_after = 86400 * (time_t)pday + psec;
  17770. return true;
  17771. }
  17772. inline std::string get_cert_serial(cert_t cert) {
  17773. if (!cert) return "";
  17774. auto x509 = static_cast<X509 *>(cert);
  17775. auto serial = X509_get_serialNumber(x509);
  17776. if (!serial) return "";
  17777. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17778. if (!bn) return "";
  17779. auto hex = BN_bn2hex(bn);
  17780. BN_free(bn);
  17781. if (!hex) return "";
  17782. std::string result(hex);
  17783. OPENSSL_free(hex);
  17784. return result;
  17785. }
  17786. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17787. if (!cert) return false;
  17788. auto x509 = static_cast<X509 *>(cert);
  17789. auto len = i2d_X509(x509, nullptr);
  17790. if (len < 0) return false;
  17791. der.resize(static_cast<size_t>(len));
  17792. auto p = der.data();
  17793. i2d_X509(x509, &p);
  17794. return true;
  17795. }
  17796. inline const char *get_sni(const_session_t session) {
  17797. if (!session) return nullptr;
  17798. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17799. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17800. }
  17801. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17802. inline uint64_t get_error() { return ERR_get_error(); }
  17803. inline std::string error_string(uint64_t code) {
  17804. char buf[256];
  17805. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17806. sizeof(buf));
  17807. return std::string(buf);
  17808. }
  17809. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17810. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17811. if (!mem) { return nullptr; }
  17812. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17813. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17814. if (!inf) { return nullptr; }
  17815. auto store = X509_STORE_new();
  17816. if (store) {
  17817. auto count = sk_X509_INFO_num(inf);
  17818. for (decltype(count) i = 0; i < count; i++) {
  17819. auto itmp = sk_X509_INFO_value(inf, i);
  17820. if (!itmp) { continue; }
  17821. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17822. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17823. }
  17824. }
  17825. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17826. return static_cast<ca_store_t>(store);
  17827. }
  17828. inline void free_ca_store(ca_store_t store) {
  17829. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17830. }
  17831. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17832. if (!ctx || !store) { return false; }
  17833. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17834. auto x509_store = static_cast<X509_STORE *>(store);
  17835. // Check if same store is already set
  17836. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17837. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17838. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17839. return true;
  17840. }
  17841. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17842. certs.clear();
  17843. if (!ctx) { return 0; }
  17844. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17845. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17846. if (!store) { return 0; }
  17847. auto objs = impl::get_store_objects(store);
  17848. if (!objs) { return 0; }
  17849. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17850. auto count = sk_X509_OBJECT_num(objs);
  17851. for (decltype(count) i = 0; i < count; i++) {
  17852. auto obj = sk_X509_OBJECT_value(objs, i);
  17853. if (!obj) { continue; }
  17854. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17855. auto x509 = X509_OBJECT_get0_X509(obj);
  17856. if (x509) {
  17857. // Increment reference count so caller can free it
  17858. X509_up_ref(x509);
  17859. certs.push_back(static_cast<cert_t>(x509));
  17860. }
  17861. }
  17862. }
  17863. return certs.size();
  17864. }
  17865. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17866. std::vector<std::string> names;
  17867. if (!ctx) { return names; }
  17868. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17869. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17870. if (!store) { return names; }
  17871. auto objs = impl::get_store_objects(store);
  17872. if (!objs) { return names; }
  17873. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17874. auto count = sk_X509_OBJECT_num(objs);
  17875. for (decltype(count) i = 0; i < count; i++) {
  17876. auto obj = sk_X509_OBJECT_value(objs, i);
  17877. if (!obj) { continue; }
  17878. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17879. auto x509 = X509_OBJECT_get0_X509(obj);
  17880. if (x509) {
  17881. auto subject = X509_get_subject_name(x509);
  17882. if (subject) {
  17883. char buf[512];
  17884. X509_NAME_oneline(subject, buf, sizeof(buf));
  17885. names.push_back(buf);
  17886. }
  17887. }
  17888. }
  17889. }
  17890. return names;
  17891. }
  17892. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17893. const char *key_pem, const char *password) {
  17894. if (!ctx || !cert_pem || !key_pem) { return false; }
  17895. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17896. // Load certificate from PEM
  17897. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17898. if (!cert_bio) { return false; }
  17899. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17900. BIO_free(cert_bio);
  17901. if (!cert) { return false; }
  17902. // Load private key from PEM
  17903. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17904. if (!key_bio) {
  17905. X509_free(cert);
  17906. return false;
  17907. }
  17908. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17909. password ? const_cast<char *>(password)
  17910. : nullptr);
  17911. BIO_free(key_bio);
  17912. if (!key) {
  17913. X509_free(cert);
  17914. return false;
  17915. }
  17916. // Update certificate and key
  17917. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17918. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17919. X509_free(cert);
  17920. EVP_PKEY_free(key);
  17921. return ret;
  17922. }
  17923. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17924. if (!ctx || !ca_pem) { return false; }
  17925. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17926. // Create new X509_STORE from PEM
  17927. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17928. if (!store) { return false; }
  17929. // A resumed session is not verified again, so the ticket keys from before
  17930. // go, or a client verified under the old CAs could go on resuming.
  17931. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17932. unsigned char ticket_keys[48];
  17933. #else
  17934. unsigned char ticket_keys[80];
  17935. #endif
  17936. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17937. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17938. sizeof(ticket_keys)) != 1) {
  17939. free_ca_store(store);
  17940. return false;
  17941. }
  17942. // SSL_CTX_set_cert_store takes ownership
  17943. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17944. // Set client CA list for client certificate request
  17945. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17946. if (ca_list) {
  17947. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17948. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17949. }
  17950. // The cached sessions go for the same reason.
  17951. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17952. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17953. #else
  17954. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17955. #endif
  17956. return true;
  17957. }
  17958. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17959. if (!ctx) { return false; }
  17960. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17961. auto index = impl::verify_callback_index();
  17962. if (index < 0) { return false; }
  17963. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17964. if (callback) {
  17965. stored = new std::shared_ptr<VerifyCallback>(
  17966. std::make_shared<VerifyCallback>(std::move(callback)));
  17967. }
  17968. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17969. {
  17970. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17971. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17972. SSL_CTX_get_ex_data(ssl_ctx, index));
  17973. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17974. delete stored;
  17975. return false;
  17976. }
  17977. }
  17978. // A handshake running the previous callback keeps it until it returns.
  17979. delete previous;
  17980. // A resumed handshake shows no certificate to run the callback on.
  17981. if (stored) {
  17982. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17983. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17984. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17985. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17986. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17987. #endif
  17988. }
  17989. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17990. auto require =
  17991. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17992. impl::apply_verify_mode(ssl_ctx, require);
  17993. return true;
  17994. }
  17995. inline long get_verify_error(const_session_t session) {
  17996. if (!session) { return -1; }
  17997. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17998. return SSL_get_verify_result(ssl);
  17999. }
  18000. inline std::string verify_error_string(long error_code) {
  18001. if (error_code == X509_V_OK) { return ""; }
  18002. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  18003. return str ? str : "unknown error";
  18004. }
  18005. } // namespace tls
  18006. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  18007. /*
  18008. * Group 9: TLS abstraction layer - Mbed TLS backend
  18009. */
  18010. /*
  18011. * Mbed TLS Backend Implementation
  18012. */
  18013. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  18014. namespace tls {
  18015. namespace impl {
  18016. // Mbed TLS session wrapper
  18017. struct MbedTlsSession {
  18018. mbedtls_ssl_context ssl;
  18019. socket_t sock = INVALID_SOCKET;
  18020. std::string hostname; // For client: set via set_sni
  18021. std::string sni_hostname; // For server: received from client via SNI callback
  18022. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  18023. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  18024. // (e.g. a response that arrived while this side was still in its post-write
  18025. // check), the byte is pushed back here and served by the next read().
  18026. unsigned char peeked_byte = 0;
  18027. bool has_peeked_byte = false;
  18028. // Set by set_sni() when the caller disabled hostname verification, so the
  18029. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18030. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18031. // OpenSSL and wolfSSL keep them independent).
  18032. bool suppress_hostname_mismatch = false;
  18033. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18034. // ever runs the callback of its own context.
  18035. VerifyCallback verify_callback;
  18036. bool is_server = false;
  18037. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18038. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18039. MbedTlsSession(const MbedTlsSession &) = delete;
  18040. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18041. };
  18042. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18043. // queue)
  18044. inline int &mbedtls_last_error() {
  18045. static thread_local int err = 0;
  18046. return err;
  18047. }
  18048. // Helper to map Mbed TLS error to ErrorCode
  18049. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18050. uint32_t verify_flags) {
  18051. if (ret == 0) { return ErrorCode::Success; }
  18052. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18053. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18054. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18055. return ErrorCode::PeerClosed;
  18056. }
  18057. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18058. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18059. out_errno = errno;
  18060. return ErrorCode::SyscallError;
  18061. }
  18062. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18063. // EOF without close_notify
  18064. out_errno = 0;
  18065. return ErrorCode::SyscallError;
  18066. }
  18067. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18068. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18069. // the handshake's chain verification (see set_sni()); a mismatch there
  18070. // is reported the same way as any other verify_flags bit. Report it as
  18071. // HostnameMismatch, matching the other backends and the post-handshake
  18072. // identity check below, but only when naming is the sole problem -
  18073. // if the chain itself is also untrusted/expired/etc., that takes
  18074. // priority over the naming detail.
  18075. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18076. return ErrorCode::HostnameMismatch;
  18077. }
  18078. return ErrorCode::CertVerifyFailed;
  18079. }
  18080. return ErrorCode::Fatal;
  18081. }
  18082. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18083. // return value, including the verify-flags-dependent HostnameMismatch
  18084. // mapping; shared by connect() and connect_nonblocking() so the
  18085. // backend_code policy for that mapping only lives in one place.
  18086. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18087. int ret) {
  18088. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18089. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18090. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18091. ? static_cast<uint64_t>(verify_flags)
  18092. : static_cast<uint64_t>(-ret);
  18093. }
  18094. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18095. // non-fatal notification delivered between records, not an error and not
  18096. // application data, so I/O calls that see it should just be retried. Kept in
  18097. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18098. // splitting the closing brace across an #if.
  18099. inline bool mbedtls_is_session_ticket(int ret) {
  18100. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18101. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18102. #else
  18103. (void)ret;
  18104. return false;
  18105. #endif
  18106. }
  18107. // BIO-like send callback for Mbed TLS
  18108. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18109. size_t len) {
  18110. auto sock = *static_cast<socket_t *>(ctx);
  18111. #ifdef _WIN32
  18112. auto ret =
  18113. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18114. if (ret == SOCKET_ERROR) {
  18115. int err = WSAGetLastError();
  18116. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18117. return MBEDTLS_ERR_NET_SEND_FAILED;
  18118. }
  18119. #else
  18120. auto ret = send(sock, buf, len, 0);
  18121. if (ret < 0) {
  18122. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18123. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18124. }
  18125. return MBEDTLS_ERR_NET_SEND_FAILED;
  18126. }
  18127. #endif
  18128. return static_cast<int>(ret);
  18129. }
  18130. // BIO-like recv callback for Mbed TLS
  18131. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18132. auto sock = *static_cast<socket_t *>(ctx);
  18133. #ifdef _WIN32
  18134. auto ret =
  18135. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18136. if (ret == SOCKET_ERROR) {
  18137. int err = WSAGetLastError();
  18138. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18139. return MBEDTLS_ERR_NET_RECV_FAILED;
  18140. }
  18141. #else
  18142. auto ret = recv(sock, buf, len, 0);
  18143. if (ret < 0) {
  18144. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18145. return MBEDTLS_ERR_SSL_WANT_READ;
  18146. }
  18147. return MBEDTLS_ERR_NET_RECV_FAILED;
  18148. }
  18149. #endif
  18150. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18151. return static_cast<int>(ret);
  18152. }
  18153. // MbedTlsContext constructor/destructor implementations
  18154. inline MbedTlsContext::MbedTlsContext() {
  18155. mbedtls_ssl_config_init(&conf);
  18156. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18157. mbedtls_entropy_init(&entropy);
  18158. mbedtls_ctr_drbg_init(&ctr_drbg);
  18159. #endif
  18160. mbedtls_x509_crt_init(&ca_chain);
  18161. mbedtls_x509_crt_init(&own_cert);
  18162. mbedtls_pk_init(&own_key);
  18163. }
  18164. inline MbedTlsContext::~MbedTlsContext() {
  18165. mbedtls_pk_free(&own_key);
  18166. mbedtls_x509_crt_free(&own_cert);
  18167. mbedtls_x509_crt_free(&ca_chain);
  18168. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18169. mbedtls_ctr_drbg_free(&ctr_drbg);
  18170. mbedtls_entropy_free(&entropy);
  18171. #endif
  18172. mbedtls_ssl_config_free(&conf);
  18173. }
  18174. // Thread-local storage for SNI captured during handshake
  18175. // This is needed because the SNI callback doesn't have a way to pass
  18176. // session-specific data before the session is fully set up
  18177. inline std::string &mbedpending_sni() {
  18178. static thread_local std::string sni;
  18179. return sni;
  18180. }
  18181. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18182. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18183. const unsigned char *name, size_t name_len) {
  18184. (void)p_ctx;
  18185. (void)ssl;
  18186. // Store SNI name in thread-local storage
  18187. // It will be retrieved and stored in the session after handshake
  18188. if (name && name_len > 0) {
  18189. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18190. } else {
  18191. mbedpending_sni().clear();
  18192. }
  18193. return 0; // Accept any SNI
  18194. }
  18195. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18196. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18197. }
  18198. // MbedTLS verify callback wrapper
  18199. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18200. int cert_depth, uint32_t *flags) {
  18201. // data points to the MbedTlsSession
  18202. auto *session = static_cast<MbedTlsSession *>(data);
  18203. // set_sni() disabled hostname verification for this session: ignore the
  18204. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18205. // pass/fail decision still comes from the remaining flags (and, below, from
  18206. // the user's own verify callback).
  18207. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18208. const auto &callback = session->verify_callback;
  18209. if (!callback) { return 0; } // Continue with default verification
  18210. // Build context
  18211. VerifyContext verify_ctx;
  18212. verify_ctx.session = static_cast<session_t>(session);
  18213. verify_ctx.cert = static_cast<cert_t>(crt);
  18214. verify_ctx.depth = cert_depth;
  18215. verify_ctx.preverify_ok = (*flags == 0);
  18216. verify_ctx.error_code = static_cast<long>(*flags);
  18217. // Convert Mbed TLS flags to error string
  18218. static thread_local char error_buf[256];
  18219. if (*flags != 0) {
  18220. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18221. verify_ctx.error_string = error_buf;
  18222. } else {
  18223. verify_ctx.error_string = nullptr;
  18224. }
  18225. bool accepted = run_verify_callback(callback, verify_ctx);
  18226. if (accepted) {
  18227. // Overrides the built-in verification only on a server, as on OpenSSL and
  18228. // wolfSSL, whose clients check the verify result after the handshake
  18229. if (session->is_server) { *flags = 0; }
  18230. return 0;
  18231. }
  18232. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18233. }
  18234. // Sets the authentication mode from whether the peer's certificate is required
  18235. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18236. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18237. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18238. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18239. if (mctx.verify_client) {
  18240. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18241. } else if (mctx.verify_callback) {
  18242. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18243. }
  18244. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18245. }
  18246. } // namespace impl
  18247. inline ctx_t create_client_context() {
  18248. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18249. if (!ctx) { return nullptr; }
  18250. ctx->is_server = false;
  18251. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18252. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18253. if (!detail::ensure_mbedtls_psa_crypto()) {
  18254. delete ctx;
  18255. return nullptr;
  18256. }
  18257. int ret;
  18258. #else
  18259. // Seed the random number generator
  18260. const char *pers = "httplib_client";
  18261. int ret = mbedtls_ctr_drbg_seed(
  18262. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18263. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18264. if (ret != 0) {
  18265. impl::mbedtls_last_error() = ret;
  18266. delete ctx;
  18267. return nullptr;
  18268. }
  18269. #endif
  18270. // Set up SSL config for client
  18271. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18272. MBEDTLS_SSL_TRANSPORT_STREAM,
  18273. MBEDTLS_SSL_PRESET_DEFAULT);
  18274. if (ret != 0) {
  18275. impl::mbedtls_last_error() = ret;
  18276. delete ctx;
  18277. return nullptr;
  18278. }
  18279. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18280. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18281. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18282. #endif
  18283. // Default: verify peer certificate
  18284. ctx->verify_client = true;
  18285. impl::apply_verify_mode(*ctx);
  18286. // Set minimum TLS version to 1.2
  18287. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18288. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18289. #else
  18290. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18291. MBEDTLS_SSL_MINOR_VERSION_3);
  18292. #endif
  18293. return static_cast<ctx_t>(ctx);
  18294. }
  18295. inline ctx_t create_server_context() {
  18296. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18297. if (!ctx) { return nullptr; }
  18298. ctx->is_server = true;
  18299. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18300. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18301. if (!detail::ensure_mbedtls_psa_crypto()) {
  18302. delete ctx;
  18303. return nullptr;
  18304. }
  18305. int ret;
  18306. #else
  18307. // Seed the random number generator
  18308. const char *pers = "httplib_server";
  18309. int ret = mbedtls_ctr_drbg_seed(
  18310. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18311. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18312. if (ret != 0) {
  18313. impl::mbedtls_last_error() = ret;
  18314. delete ctx;
  18315. return nullptr;
  18316. }
  18317. #endif
  18318. // Set up SSL config for server
  18319. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18320. MBEDTLS_SSL_TRANSPORT_STREAM,
  18321. MBEDTLS_SSL_PRESET_DEFAULT);
  18322. if (ret != 0) {
  18323. impl::mbedtls_last_error() = ret;
  18324. delete ctx;
  18325. return nullptr;
  18326. }
  18327. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18328. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18329. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18330. #endif
  18331. // Default: don't verify client
  18332. impl::apply_verify_mode(*ctx);
  18333. // Set minimum TLS version to 1.2
  18334. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18335. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18336. #else
  18337. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18338. MBEDTLS_SSL_MINOR_VERSION_3);
  18339. #endif
  18340. // Set SNI callback to capture client's SNI hostname
  18341. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18342. return static_cast<ctx_t>(ctx);
  18343. }
  18344. inline void free_context(ctx_t ctx) {
  18345. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18346. }
  18347. inline bool set_min_version(ctx_t ctx, Version version) {
  18348. if (!ctx) { return false; }
  18349. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18350. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18351. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18352. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18353. if (version >= Version::TLS1_3) {
  18354. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18355. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18356. #endif
  18357. }
  18358. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18359. #else
  18360. // Mbed TLS 2.x uses major/minor version numbers
  18361. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18362. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18363. if (version >= Version::TLS1_3) {
  18364. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18365. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18366. #else
  18367. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18368. #endif
  18369. }
  18370. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18371. #endif
  18372. return true;
  18373. }
  18374. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18375. if (!ctx || !pem) { return false; }
  18376. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18377. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18378. // Add null terminator if not present
  18379. std::string pem_str(pem, len);
  18380. int ret = mbedtls_x509_crt_parse(
  18381. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18382. pem_str.size() + 1);
  18383. if (ret != 0) {
  18384. impl::mbedtls_last_error() = ret;
  18385. return false;
  18386. }
  18387. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18388. return true;
  18389. }
  18390. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18391. if (!ctx || !file_path) { return false; }
  18392. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18393. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18394. if (ret != 0) {
  18395. impl::mbedtls_last_error() = ret;
  18396. return false;
  18397. }
  18398. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18399. return true;
  18400. }
  18401. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18402. if (!ctx || !dir_path) { return false; }
  18403. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18404. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18405. if (ret < 0) { // Returns number of certs on success, negative on error
  18406. impl::mbedtls_last_error() = ret;
  18407. return false;
  18408. }
  18409. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18410. return true;
  18411. }
  18412. inline bool load_system_certs(ctx_t ctx) {
  18413. if (!ctx) { return false; }
  18414. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18415. bool loaded = false;
  18416. #ifdef _WIN32
  18417. loaded = impl::enumerate_windows_system_certs(
  18418. [&](const unsigned char *data, size_t len) {
  18419. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18420. });
  18421. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18422. loaded = impl::enumerate_macos_keychain_certs(
  18423. [&](const unsigned char *data, size_t len) {
  18424. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18425. });
  18426. #else
  18427. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18428. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18429. loaded = true;
  18430. break;
  18431. }
  18432. }
  18433. if (!loaded) {
  18434. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18435. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18436. loaded = true;
  18437. break;
  18438. }
  18439. }
  18440. }
  18441. #endif
  18442. if (loaded) {
  18443. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18444. }
  18445. return loaded;
  18446. }
  18447. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18448. const char *password) {
  18449. if (!ctx || !cert || !key) { return false; }
  18450. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18451. // Parse certificate
  18452. std::string cert_str(cert);
  18453. int ret = mbedtls_x509_crt_parse(
  18454. &mctx->own_cert,
  18455. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18456. cert_str.size() + 1);
  18457. if (ret != 0) {
  18458. impl::mbedtls_last_error() = ret;
  18459. return false;
  18460. }
  18461. // Parse private key
  18462. std::string key_str(key);
  18463. const unsigned char *pwd =
  18464. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18465. size_t pwd_len = password ? strlen(password) : 0;
  18466. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18467. ret = mbedtls_pk_parse_key(
  18468. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18469. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18470. &mctx->ctr_drbg);
  18471. #else
  18472. ret = mbedtls_pk_parse_key(
  18473. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18474. key_str.size() + 1, pwd, pwd_len);
  18475. #endif
  18476. if (ret != 0) {
  18477. impl::mbedtls_last_error() = ret;
  18478. return false;
  18479. }
  18480. // Verify that the certificate and private key match.
  18481. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18482. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18483. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18484. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18485. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18486. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18487. #else
  18488. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18489. #endif
  18490. if (ret != 0) {
  18491. impl::mbedtls_last_error() = ret;
  18492. return false;
  18493. }
  18494. #endif
  18495. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18496. if (ret != 0) {
  18497. impl::mbedtls_last_error() = ret;
  18498. return false;
  18499. }
  18500. return true;
  18501. }
  18502. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18503. const char *key_path, const char *password) {
  18504. if (!ctx || !cert_path || !key_path) { return false; }
  18505. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18506. // Parse certificate file
  18507. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18508. if (ret != 0) {
  18509. impl::mbedtls_last_error() = ret;
  18510. return false;
  18511. }
  18512. // Parse private key file
  18513. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18514. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18515. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18516. #else
  18517. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18518. #endif
  18519. if (ret != 0) {
  18520. impl::mbedtls_last_error() = ret;
  18521. return false;
  18522. }
  18523. // Verify that the certificate and private key match.
  18524. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18525. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18526. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18527. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18528. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18529. #else
  18530. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18531. #endif
  18532. if (ret != 0) {
  18533. impl::mbedtls_last_error() = ret;
  18534. return false;
  18535. }
  18536. #endif
  18537. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18538. if (ret != 0) {
  18539. impl::mbedtls_last_error() = ret;
  18540. return false;
  18541. }
  18542. return true;
  18543. }
  18544. inline void set_verify_client(ctx_t ctx, bool require) {
  18545. if (!ctx) { return; }
  18546. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18547. mctx->verify_client = require;
  18548. impl::apply_verify_mode(*mctx);
  18549. }
  18550. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18551. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18552. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18553. auto session = new (std::nothrow) impl::MbedTlsSession();
  18554. if (!session) { return nullptr; }
  18555. session->sock = sock;
  18556. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18557. if (ret != 0) {
  18558. impl::mbedtls_last_error() = ret;
  18559. delete session;
  18560. return nullptr;
  18561. }
  18562. // Explicitly opt out of in-handshake hostname verification by default;
  18563. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18564. // fails outright when no hostname was set. set_sni() installs the real
  18565. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18566. // caller verifies the certificate identity post-handshake via
  18567. // verify_hostname().
  18568. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18569. // Set BIO callbacks
  18570. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18571. impl::mbedtls_net_recv_cb, nullptr);
  18572. // Installed always, as it also masks the hostname mismatch that set_sni()
  18573. // may ask for. The session runs its own copy of the user's callback, which
  18574. // set_verify_callback() cannot replace under a handshake.
  18575. session->verify_callback = mctx->verify_callback;
  18576. session->is_server = mctx->is_server;
  18577. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18578. return static_cast<session_t>(session);
  18579. }
  18580. inline void free_session(session_t session) {
  18581. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18582. }
  18583. inline bool set_sni(session_t session, const char *hostname,
  18584. bool verify_hostname) {
  18585. if (!session || !hostname) { return false; }
  18586. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18587. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18588. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18589. // independently, so a disabled hostname check is handled below by masking
  18590. // the resulting mismatch flag instead of skipping this call.
  18591. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18592. if (ret != 0) {
  18593. impl::mbedtls_last_error() = ret;
  18594. return false;
  18595. }
  18596. msession->hostname = hostname;
  18597. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18598. return true;
  18599. }
  18600. inline TlsError connect(session_t session) {
  18601. TlsError err;
  18602. if (!session) {
  18603. err.code = ErrorCode::Fatal;
  18604. return err;
  18605. }
  18606. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18607. int ret;
  18608. do {
  18609. ret = mbedtls_ssl_handshake(&msession->ssl);
  18610. } while (impl::mbedtls_is_session_ticket(ret));
  18611. if (ret == 0) {
  18612. err.code = ErrorCode::Success;
  18613. } else {
  18614. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18615. impl::mbedtls_last_error() = ret;
  18616. }
  18617. return err;
  18618. }
  18619. inline TlsError accept(session_t session) {
  18620. // A failed handshake leaves its SNI behind, so start without it
  18621. impl::mbedpending_sni().clear();
  18622. // Same as connect for Mbed TLS - handshake works for both client and server
  18623. auto result = connect(session);
  18624. // After successful handshake, capture SNI from thread-local storage
  18625. if (result.code == ErrorCode::Success && session) {
  18626. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18627. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18628. }
  18629. return result;
  18630. }
  18631. inline bool connect_nonblocking(session_t session, socket_t sock,
  18632. time_t timeout_sec, time_t timeout_usec,
  18633. TlsError *err) {
  18634. if (!session) {
  18635. if (err) { err->code = ErrorCode::Fatal; }
  18636. return false;
  18637. }
  18638. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18639. // Set socket to non-blocking mode
  18640. detail::set_nonblocking(sock, true);
  18641. auto cleanup =
  18642. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18643. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18644. int ret;
  18645. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18646. // Non-fatal TLS 1.3 ticket; retry immediately.
  18647. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18648. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18649. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18650. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18651. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18652. }
  18653. // TlsError or timeout
  18654. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18655. impl::mbedtls_last_error() = ret;
  18656. return false;
  18657. }
  18658. if (err) { err->code = ErrorCode::Success; }
  18659. return true;
  18660. }
  18661. inline bool accept_nonblocking(session_t session, socket_t sock,
  18662. time_t timeout_sec, time_t timeout_usec,
  18663. TlsError *err) {
  18664. // A failed handshake leaves its SNI behind, so start without it
  18665. impl::mbedpending_sni().clear();
  18666. // Same implementation as connect for Mbed TLS
  18667. bool result =
  18668. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18669. // After successful handshake, capture SNI from thread-local storage
  18670. if (result && session) {
  18671. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18672. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18673. }
  18674. return result;
  18675. }
  18676. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18677. if (!session || !buf) {
  18678. err.code = ErrorCode::Fatal;
  18679. return -1;
  18680. }
  18681. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18682. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18683. if (msession->has_peeked_byte) {
  18684. if (len == 0) { return 0; }
  18685. auto p = static_cast<unsigned char *>(buf);
  18686. p[0] = msession->peeked_byte;
  18687. msession->has_peeked_byte = false;
  18688. size_t n = 1;
  18689. // Top up with any already-decrypted bytes without risking a block.
  18690. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18691. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18692. if (extra > 0) { n += static_cast<size_t>(extra); }
  18693. }
  18694. err.code = ErrorCode::Success;
  18695. return static_cast<ssize_t>(n);
  18696. }
  18697. int ret;
  18698. do {
  18699. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18700. len);
  18701. } while (impl::mbedtls_is_session_ticket(ret));
  18702. if (ret > 0) {
  18703. err.code = ErrorCode::Success;
  18704. return static_cast<ssize_t>(ret);
  18705. }
  18706. // 0 means EOF without close_notify, which is an error as on OpenSSL
  18707. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  18708. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18709. err.backend_code = static_cast<uint64_t>(-ret);
  18710. impl::mbedtls_last_error() = ret;
  18711. // mbedTLS signals a clean close_notify via a negative error code rather
  18712. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18713. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18714. return -1;
  18715. }
  18716. inline ssize_t write(session_t session, const void *buf, size_t len,
  18717. TlsError &err) {
  18718. if (!session || !buf) {
  18719. err.code = ErrorCode::Fatal;
  18720. return -1;
  18721. }
  18722. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18723. int ret;
  18724. do {
  18725. ret = mbedtls_ssl_write(&msession->ssl,
  18726. static_cast<const unsigned char *>(buf), len);
  18727. } while (impl::mbedtls_is_session_ticket(ret));
  18728. if (ret > 0) {
  18729. err.code = ErrorCode::Success;
  18730. return static_cast<ssize_t>(ret);
  18731. }
  18732. if (ret == 0) {
  18733. err.code = ErrorCode::PeerClosed;
  18734. return 0;
  18735. }
  18736. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18737. err.backend_code = static_cast<uint64_t>(-ret);
  18738. impl::mbedtls_last_error() = ret;
  18739. return -1;
  18740. }
  18741. inline int pending(const_session_t session) {
  18742. if (!session) { return 0; }
  18743. auto msession =
  18744. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18745. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18746. (msession->has_peeked_byte ? 1 : 0);
  18747. }
  18748. inline void shutdown(session_t session, bool graceful) {
  18749. if (!session) { return; }
  18750. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18751. if (graceful) {
  18752. // Try to send close_notify, but don't block forever
  18753. int ret;
  18754. int attempts = 0;
  18755. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18756. attempts < 3) {
  18757. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18758. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18759. break;
  18760. }
  18761. attempts++;
  18762. }
  18763. }
  18764. }
  18765. inline bool is_peer_closed(session_t session, socket_t sock) {
  18766. if (!session || sock == INVALID_SOCKET) { return true; }
  18767. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18768. // Check if there's already decrypted or pushed-back data available.
  18769. // If so, the connection is definitely alive.
  18770. if (msession->has_peeked_byte ||
  18771. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18772. return false;
  18773. }
  18774. // Set socket to non-blocking to avoid blocking on read
  18775. detail::set_nonblocking(sock, true);
  18776. auto cleanup =
  18777. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18778. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18779. // on application data — e.g. a response that already arrived — push the
  18780. // byte back so the next read() delivers it instead of losing it.
  18781. unsigned char buf;
  18782. int ret;
  18783. do {
  18784. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18785. } while (impl::mbedtls_is_session_ticket(ret));
  18786. // If we got data or WANT_READ (would block), connection is alive
  18787. if (ret > 0) {
  18788. msession->peeked_byte = buf;
  18789. msession->has_peeked_byte = true;
  18790. return false;
  18791. }
  18792. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18793. // If we get a peer close notify or a connection reset, the peer is closed
  18794. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18795. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18796. }
  18797. inline cert_t get_peer_cert(const_session_t session) {
  18798. if (!session) { return nullptr; }
  18799. auto msession =
  18800. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18801. // Mbed TLS returns a pointer to the internal peer cert chain.
  18802. // WARNING: This pointer is only valid while the session is active.
  18803. // Do not use the certificate after calling free_session().
  18804. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18805. return const_cast<mbedtls_x509_crt *>(cert);
  18806. }
  18807. inline size_t get_peer_certs(const_session_t session,
  18808. std::vector<cert_t> &certs) {
  18809. certs.clear();
  18810. // Mbed TLS parses the whole received chain into a list headed by the peer
  18811. // certificate, owned by the session like get_peer_cert()'s result
  18812. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18813. crt && crt->raw.len > 0; crt = crt->next) {
  18814. certs.push_back(static_cast<cert_t>(crt));
  18815. }
  18816. return certs.size();
  18817. }
  18818. inline void free_cert(cert_t cert) {
  18819. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18820. // chain, so there is nothing to free. Callers still call this for the other
  18821. // backends.
  18822. (void)cert;
  18823. }
  18824. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18825. if (!cert || !hostname) { return false; }
  18826. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18827. std::string host_str(hostname);
  18828. // Check if hostname is an IP address (IPv4 or IPv6)
  18829. unsigned char ip_bytes[16];
  18830. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18831. auto is_ip = ip_len > 0;
  18832. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18833. // in buf.tag and the raw value in buf.p / buf.len.
  18834. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18835. if (!san->buf.p || san->buf.len == 0) { continue; }
  18836. const unsigned char *p = san->buf.p;
  18837. size_t len = san->buf.len;
  18838. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18839. if (is_ip) {
  18840. // For an IP host, only a matching iPAddress SAN of the same family
  18841. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18842. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18843. memcmp(p, ip_bytes, ip_len) == 0) {
  18844. return true;
  18845. }
  18846. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18847. std::string san_name(reinterpret_cast<const char *>(p), len);
  18848. if (detail::match_hostname(san_name, host_str)) { return true; }
  18849. }
  18850. }
  18851. return false;
  18852. }
  18853. inline uint64_t hostname_mismatch_code() {
  18854. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18855. }
  18856. inline long get_verify_result(const_session_t session) {
  18857. if (!session) { return -1; }
  18858. auto msession =
  18859. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18860. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18861. // Return 0 (X509_V_OK equivalent) if verification passed
  18862. return flags == 0 ? 0 : static_cast<long>(flags);
  18863. }
  18864. inline std::string get_cert_subject_cn(cert_t cert) {
  18865. if (!cert) return "";
  18866. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18867. // Find the CN in the subject
  18868. const mbedtls_x509_name *name = &x509->subject;
  18869. while (name != nullptr) {
  18870. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18871. return std::string(reinterpret_cast<const char *>(name->val.p),
  18872. name->val.len);
  18873. }
  18874. name = name->next;
  18875. }
  18876. return "";
  18877. }
  18878. inline std::string get_cert_issuer_name(cert_t cert) {
  18879. if (!cert) return "";
  18880. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18881. // Build a human-readable issuer name string
  18882. char buf[512];
  18883. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18884. if (ret < 0) return "";
  18885. return std::string(buf);
  18886. }
  18887. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18888. sans.clear();
  18889. if (!cert) return false;
  18890. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18891. // Parse the Subject Alternative Name extension
  18892. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18893. while (cur != nullptr) {
  18894. if (cur->buf.len > 0) {
  18895. const unsigned char *p = cur->buf.p;
  18896. size_t value_len = cur->buf.len;
  18897. SanEntry entry;
  18898. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18899. case MBEDTLS_X509_SAN_DNS_NAME:
  18900. entry.type = SanType::DNS;
  18901. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18902. break;
  18903. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18904. entry.type = SanType::IP;
  18905. if (value_len == 4) {
  18906. // IPv4
  18907. char buf[16];
  18908. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18909. entry.value = buf;
  18910. } else if (value_len == 16) {
  18911. // IPv6
  18912. char buf[64];
  18913. snprintf(buf, sizeof(buf),
  18914. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18915. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18916. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18917. p[10], p[11], p[12], p[13], p[14], p[15]);
  18918. entry.value = buf;
  18919. }
  18920. break;
  18921. case MBEDTLS_X509_SAN_RFC822_NAME:
  18922. entry.type = SanType::EMAIL;
  18923. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18924. break;
  18925. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18926. entry.type = SanType::URI;
  18927. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18928. break;
  18929. default: entry.type = SanType::OTHER; break;
  18930. }
  18931. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18932. }
  18933. cur = cur->next;
  18934. }
  18935. return true;
  18936. }
  18937. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18938. time_t &not_after) {
  18939. if (!cert) return false;
  18940. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18941. // Convert mbedtls_x509_time to time_t
  18942. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18943. struct tm tm_time = {};
  18944. tm_time.tm_year = t.year - 1900;
  18945. tm_time.tm_mon = t.mon - 1;
  18946. tm_time.tm_mday = t.day;
  18947. tm_time.tm_hour = t.hour;
  18948. tm_time.tm_min = t.min;
  18949. tm_time.tm_sec = t.sec;
  18950. #ifdef _WIN32
  18951. return _mkgmtime(&tm_time);
  18952. #else
  18953. return timegm(&tm_time);
  18954. #endif
  18955. };
  18956. not_before = to_time_t(x509->valid_from);
  18957. not_after = to_time_t(x509->valid_to);
  18958. return true;
  18959. }
  18960. inline std::string get_cert_serial(cert_t cert) {
  18961. if (!cert) return "";
  18962. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18963. // Convert serial number to hex string
  18964. std::string result;
  18965. result.reserve(x509->serial.len * 2);
  18966. for (size_t i = 0; i < x509->serial.len; i++) {
  18967. char hex[3];
  18968. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18969. result += hex;
  18970. }
  18971. return result;
  18972. }
  18973. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18974. if (!cert) return false;
  18975. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18976. if (!crt->raw.p || crt->raw.len == 0) return false;
  18977. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18978. return true;
  18979. }
  18980. inline const char *get_sni(const_session_t session) {
  18981. if (!session) return nullptr;
  18982. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18983. // For server: return SNI received from client during handshake
  18984. if (!msession->sni_hostname.empty()) {
  18985. return msession->sni_hostname.c_str();
  18986. }
  18987. // For client: return the hostname set via set_sni
  18988. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18989. return nullptr;
  18990. }
  18991. inline uint64_t peek_error() {
  18992. // Mbed TLS doesn't have an error queue, return the last error
  18993. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18994. }
  18995. inline uint64_t get_error() {
  18996. // Mbed TLS doesn't have an error queue, return and clear the last error
  18997. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18998. impl::mbedtls_last_error() = 0;
  18999. return err;
  19000. }
  19001. inline std::string error_string(uint64_t code) {
  19002. char buf[256];
  19003. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  19004. return std::string(buf);
  19005. }
  19006. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19007. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19008. // Parsing certificates needs PSA Crypto, and no context may exist yet
  19009. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  19010. #endif
  19011. if (!pem) { return nullptr; }
  19012. // mbedtls_x509_crt_parse expects null-terminated PEM
  19013. std::string pem_str(pem, len);
  19014. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  19015. if (!ca_chain) { return nullptr; }
  19016. mbedtls_x509_crt_init(ca_chain);
  19017. auto ret = mbedtls_x509_crt_parse(
  19018. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19019. pem_str.size() + 1);
  19020. if (ret != 0) {
  19021. mbedtls_x509_crt_free(ca_chain);
  19022. delete ca_chain;
  19023. return nullptr;
  19024. }
  19025. return static_cast<ca_store_t>(ca_chain);
  19026. }
  19027. inline void free_ca_store(ca_store_t store) {
  19028. if (store) {
  19029. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19030. mbedtls_x509_crt_free(ca_chain);
  19031. delete ca_chain;
  19032. }
  19033. }
  19034. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19035. if (!ctx || !store) { return false; }
  19036. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19037. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19038. // Free existing CA chain
  19039. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19040. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19041. // Copy the CA chain (deep copy)
  19042. // Parse from the raw data of the source cert
  19043. mbedtls_x509_crt *src = ca_chain;
  19044. while (src != nullptr) {
  19045. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19046. src->raw.len);
  19047. if (ret != 0) {
  19048. free_ca_store(store);
  19049. return false;
  19050. }
  19051. src = src->next;
  19052. }
  19053. // This function takes ownership of the store; the chain was deep-copied
  19054. // above, so release the source
  19055. free_ca_store(store);
  19056. // Update the SSL config to use the new CA chain
  19057. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19058. return true;
  19059. }
  19060. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19061. certs.clear();
  19062. if (!ctx) { return 0; }
  19063. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19064. // Owned by the context; see free_cert()
  19065. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19066. cert = cert->next) {
  19067. certs.push_back(static_cast<cert_t>(cert));
  19068. }
  19069. return certs.size();
  19070. }
  19071. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19072. std::vector<std::string> names;
  19073. if (!ctx) { return names; }
  19074. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19075. // Iterate through the CA chain
  19076. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19077. while (cert != nullptr && cert->raw.len > 0) {
  19078. char buf[512];
  19079. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19080. if (ret > 0) { names.push_back(buf); }
  19081. cert = cert->next;
  19082. }
  19083. return names;
  19084. }
  19085. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19086. const char *key_pem, const char *password) {
  19087. if (!ctx || !cert_pem || !key_pem) { return false; }
  19088. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19089. // Parse into new objects first, so that a bad pair leaves the old one in
  19090. // place, and swap them in after; the old ones are freed on the way out.
  19091. mbedtls_x509_crt cert;
  19092. mbedtls_pk_context key;
  19093. mbedtls_x509_crt_init(&cert);
  19094. mbedtls_pk_init(&key);
  19095. auto se = detail::scope_exit([&] {
  19096. mbedtls_x509_crt_free(&cert);
  19097. mbedtls_pk_free(&key);
  19098. });
  19099. // Parse certificate PEM
  19100. int ret = mbedtls_x509_crt_parse(
  19101. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19102. strlen(cert_pem) + 1);
  19103. if (ret != 0) {
  19104. impl::mbedtls_last_error() = ret;
  19105. return false;
  19106. }
  19107. // Parse private key PEM
  19108. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19109. ret = mbedtls_pk_parse_key(
  19110. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19111. strlen(key_pem) + 1,
  19112. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19113. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19114. &mbed_ctx->ctr_drbg);
  19115. #else
  19116. ret = mbedtls_pk_parse_key(
  19117. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19118. strlen(key_pem) + 1,
  19119. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19120. password ? strlen(password) : 0);
  19121. #endif
  19122. if (ret != 0) {
  19123. impl::mbedtls_last_error() = ret;
  19124. return false;
  19125. }
  19126. std::swap(mbed_ctx->own_cert, cert);
  19127. std::swap(mbed_ctx->own_key, key);
  19128. // Configure SSL to use the new certificate and key
  19129. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19130. &mbed_ctx->own_key);
  19131. if (ret != 0) {
  19132. impl::mbedtls_last_error() = ret;
  19133. return false;
  19134. }
  19135. return true;
  19136. }
  19137. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19138. if (!ctx || !ca_pem) { return false; }
  19139. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19140. // Parse into a new chain first, so that a bad one leaves the old in place
  19141. mbedtls_x509_crt chain;
  19142. mbedtls_x509_crt_init(&chain);
  19143. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19144. // Parse CA PEM
  19145. int ret = mbedtls_x509_crt_parse(
  19146. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19147. strlen(ca_pem) + 1);
  19148. if (ret != 0) {
  19149. impl::mbedtls_last_error() = ret;
  19150. return false;
  19151. }
  19152. std::swap(mbed_ctx->ca_chain, chain);
  19153. // Update SSL config to use new CA chain
  19154. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19155. return true;
  19156. }
  19157. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19158. if (!ctx) { return false; }
  19159. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19160. // create_session() hands each session its own copy to run.
  19161. mbed_ctx->verify_callback = std::move(callback);
  19162. impl::apply_verify_mode(*mbed_ctx);
  19163. return true;
  19164. }
  19165. inline long get_verify_error(const_session_t session) {
  19166. if (!session) { return -1; }
  19167. auto *msession =
  19168. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19169. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19170. }
  19171. inline std::string verify_error_string(long error_code) {
  19172. if (error_code == 0) { return ""; }
  19173. char buf[256];
  19174. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19175. static_cast<uint32_t>(error_code));
  19176. // Remove trailing newline if present
  19177. std::string result(buf);
  19178. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19179. result.pop_back();
  19180. }
  19181. return result;
  19182. }
  19183. } // namespace tls
  19184. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19185. /*
  19186. * Group 10: TLS abstraction layer - wolfSSL backend
  19187. */
  19188. /*
  19189. * wolfSSL Backend Implementation
  19190. */
  19191. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19192. namespace tls {
  19193. namespace impl {
  19194. // wolfSSL session wrapper
  19195. struct WolfSSLSession {
  19196. WOLFSSL *ssl = nullptr;
  19197. socket_t sock = INVALID_SOCKET;
  19198. std::string hostname; // For client: set via set_sni
  19199. std::string sni_hostname; // For server: received from client via SNI callback
  19200. WolfSSLSession() = default;
  19201. ~WolfSSLSession() {
  19202. if (ssl) { wolfSSL_free(ssl); }
  19203. }
  19204. WolfSSLSession(const WolfSSLSession &) = delete;
  19205. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19206. };
  19207. // Thread-local error code accessor for wolfSSL
  19208. inline uint64_t &wolfssl_last_error() {
  19209. static thread_local uint64_t err = 0;
  19210. return err;
  19211. }
  19212. // Helper to map wolfSSL error to ErrorCode.
  19213. // ssl_error is the value from wolfSSL_get_error().
  19214. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19215. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19216. int &out_errno) {
  19217. switch (ssl_error) {
  19218. case SSL_ERROR_NONE: return ErrorCode::Success;
  19219. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19220. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19221. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19222. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19223. // EOF without close_notify
  19224. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19225. default:
  19226. if (ssl) {
  19227. // wolfSSL stores the low-level error code as a negative value.
  19228. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19229. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19230. if (low_err == DOMAIN_NAME_MISMATCH) {
  19231. return ErrorCode::HostnameMismatch;
  19232. }
  19233. // Check verify result to distinguish cert verification from generic SSL
  19234. // errors.
  19235. long vr = wolfSSL_get_verify_result(ssl);
  19236. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19237. }
  19238. return ErrorCode::Fatal;
  19239. }
  19240. }
  19241. // WolfSSLContext constructor/destructor implementations
  19242. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19243. inline WolfSSLContext::~WolfSSLContext() {
  19244. if (ctx) { wolfSSL_CTX_free(ctx); }
  19245. }
  19246. // Thread-local storage for SNI captured during handshake
  19247. inline std::string &wolfssl_pending_sni() {
  19248. static thread_local std::string sni;
  19249. return sni;
  19250. }
  19251. // SNI callback for wolfSSL server to capture client's SNI hostname
  19252. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19253. (void)ret;
  19254. (void)exArg;
  19255. void *name_data = nullptr;
  19256. unsigned short name_len =
  19257. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19258. if (name_data && name_len > 0) {
  19259. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19260. name_len);
  19261. } else {
  19262. wolfssl_pending_sni().clear();
  19263. }
  19264. return 0; // Continue regardless
  19265. }
  19266. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19267. // runs the verify callback of its own context.
  19268. inline int context_ex_data_index() {
  19269. static const auto index =
  19270. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19271. return index;
  19272. }
  19273. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19274. // other tls:: function takes.
  19275. inline int session_ex_data_index() {
  19276. static const auto index =
  19277. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19278. return index;
  19279. }
  19280. // A resumed session skips the client's certificate, so a server that checks
  19281. // one would let in a certificate checked against another server's CA, as
  19282. // wolfSSL shares its session cache between contexts, or against a CA since
  19283. // replaced by update_server_client_ca().
  19284. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19285. if (!wctx->is_server) { return; }
  19286. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19287. #ifdef HAVE_SESSION_TICKET
  19288. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19289. #endif
  19290. }
  19291. // wolfSSL verify callback wrapper
  19292. inline int wolfssl_verify_callback(int preverify_ok,
  19293. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19294. // Get the WOLFSSL object from the X509_STORE_CTX
  19295. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19296. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19297. if (!ssl) { return preverify_ok; }
  19298. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19299. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19300. if (!wctx) { return preverify_ok; }
  19301. std::shared_ptr<VerifyCallback> callback;
  19302. {
  19303. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19304. callback = wctx->verify_callback;
  19305. }
  19306. if (!callback) { return preverify_ok; }
  19307. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19308. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19309. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19310. VerifyContext verify_ctx;
  19311. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19312. verify_ctx.cert = static_cast<cert_t>(cert);
  19313. verify_ctx.depth = depth;
  19314. verify_ctx.preverify_ok = (preverify_ok != 0);
  19315. verify_ctx.error_code = static_cast<long>(err);
  19316. if (err != 0) {
  19317. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19318. } else {
  19319. verify_ctx.error_string = nullptr;
  19320. }
  19321. auto accepted = run_verify_callback(*callback, verify_ctx);
  19322. // A client verifying the server during the handshake, which is what
  19323. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19324. if (!wolfSSL_is_server(ssl) &&
  19325. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19326. accepted = accepted && preverify_ok;
  19327. }
  19328. return accepted ? 1 : 0;
  19329. }
  19330. // Sets the verify mode from whether the peer's certificate is required and
  19331. // whether a verify callback is set.
  19332. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19333. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19334. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19335. auto mode = wctx.verify_client
  19336. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19337. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19338. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19339. has_callback ? wolfssl_verify_callback : nullptr);
  19340. }
  19341. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19342. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19343. wolfSSL_CTX_set_default_passwd_cb(
  19344. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19345. auto *pwd = static_cast<const char *>(userdata);
  19346. if (!pwd) return 0;
  19347. auto len = static_cast<int>(strlen(pwd));
  19348. if (len > size) len = size;
  19349. memcpy(buf, pwd, static_cast<size_t>(len));
  19350. return len;
  19351. });
  19352. }
  19353. } // namespace impl
  19354. inline ctx_t create_client_context() {
  19355. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19356. if (!ctx) { return nullptr; }
  19357. ctx->is_server = false;
  19358. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19359. if (!method) {
  19360. delete ctx;
  19361. return nullptr;
  19362. }
  19363. ctx->ctx = wolfSSL_CTX_new(method);
  19364. if (!ctx->ctx ||
  19365. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19366. WOLFSSL_SUCCESS) {
  19367. delete ctx;
  19368. return nullptr;
  19369. }
  19370. // Default: verify peer certificate
  19371. ctx->verify_client = true;
  19372. impl::apply_verify_mode(*ctx);
  19373. return static_cast<ctx_t>(ctx);
  19374. }
  19375. inline ctx_t create_server_context() {
  19376. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19377. if (!ctx) { return nullptr; }
  19378. ctx->is_server = true;
  19379. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19380. if (!method) {
  19381. delete ctx;
  19382. return nullptr;
  19383. }
  19384. ctx->ctx = wolfSSL_CTX_new(method);
  19385. if (!ctx->ctx ||
  19386. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19387. WOLFSSL_SUCCESS) {
  19388. delete ctx;
  19389. return nullptr;
  19390. }
  19391. // Default: don't verify client
  19392. impl::apply_verify_mode(*ctx);
  19393. // Enable SNI on server
  19394. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19395. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19396. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19397. return static_cast<ctx_t>(ctx);
  19398. }
  19399. inline void free_context(ctx_t ctx) {
  19400. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19401. }
  19402. inline bool set_min_version(ctx_t ctx, Version version) {
  19403. if (!ctx) { return false; }
  19404. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19405. int min_ver = WOLFSSL_TLSV1_2;
  19406. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19407. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19408. }
  19409. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19410. if (!ctx || !pem) { return false; }
  19411. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19412. int ret = wolfSSL_CTX_load_verify_buffer(
  19413. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19414. static_cast<long>(len), SSL_FILETYPE_PEM);
  19415. if (ret != SSL_SUCCESS) {
  19416. impl::wolfssl_last_error() =
  19417. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19418. return false;
  19419. }
  19420. wctx->ca_pem_data_.append(pem, len);
  19421. return true;
  19422. }
  19423. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19424. if (!ctx || !file_path) { return false; }
  19425. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19426. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19427. if (ret != SSL_SUCCESS) {
  19428. impl::wolfssl_last_error() =
  19429. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19430. return false;
  19431. }
  19432. return true;
  19433. }
  19434. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19435. if (!ctx || !dir_path) { return false; }
  19436. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19437. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19438. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19439. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19440. // immediately. Return true even on failure since the CA file may have
  19441. // already been loaded, matching OpenSSL's lenient behavior.
  19442. (void)ret;
  19443. return true;
  19444. }
  19445. inline bool load_system_certs(ctx_t ctx) {
  19446. if (!ctx) { return false; }
  19447. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19448. bool loaded = false;
  19449. #ifdef _WIN32
  19450. loaded = impl::enumerate_windows_system_certs(
  19451. [&](const unsigned char *data, size_t len) {
  19452. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19453. static_cast<long>(len),
  19454. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19455. });
  19456. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19457. loaded = impl::enumerate_macos_keychain_certs(
  19458. [&](const unsigned char *data, size_t len) {
  19459. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19460. static_cast<long>(len),
  19461. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19462. });
  19463. #else
  19464. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19465. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19466. SSL_SUCCESS) {
  19467. loaded = true;
  19468. break;
  19469. }
  19470. }
  19471. if (!loaded) {
  19472. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19473. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19474. SSL_SUCCESS) {
  19475. loaded = true;
  19476. break;
  19477. }
  19478. }
  19479. }
  19480. #endif
  19481. return loaded;
  19482. }
  19483. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19484. const char *password) {
  19485. if (!ctx || !cert || !key) { return false; }
  19486. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19487. // Load certificate
  19488. int ret = wolfSSL_CTX_use_certificate_buffer(
  19489. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19490. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19491. if (ret != SSL_SUCCESS) {
  19492. impl::wolfssl_last_error() =
  19493. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19494. return false;
  19495. }
  19496. // Set password callback if password is provided
  19497. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19498. // Load private key
  19499. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19500. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19501. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19502. if (ret != SSL_SUCCESS) {
  19503. impl::wolfssl_last_error() =
  19504. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19505. return false;
  19506. }
  19507. // Verify that the certificate and private key match
  19508. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19509. }
  19510. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19511. const char *key_path, const char *password) {
  19512. if (!ctx || !cert_path || !key_path) { return false; }
  19513. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19514. // Load certificate file
  19515. int ret =
  19516. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19517. if (ret != SSL_SUCCESS) {
  19518. impl::wolfssl_last_error() =
  19519. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19520. return false;
  19521. }
  19522. // Set password callback if password is provided
  19523. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19524. // Load private key file
  19525. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19526. if (ret != SSL_SUCCESS) {
  19527. impl::wolfssl_last_error() =
  19528. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19529. return false;
  19530. }
  19531. // Verify that the certificate and private key match
  19532. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19533. }
  19534. inline void set_verify_client(ctx_t ctx, bool require) {
  19535. if (!ctx) { return; }
  19536. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19537. wctx->verify_client = require;
  19538. impl::apply_verify_mode(*wctx);
  19539. }
  19540. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19541. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19542. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19543. auto session = new (std::nothrow) impl::WolfSSLSession();
  19544. if (!session) { return nullptr; }
  19545. session->sock = sock;
  19546. session->ssl = wolfSSL_new(wctx->ctx);
  19547. if (!session->ssl) {
  19548. impl::wolfssl_last_error() =
  19549. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19550. delete session;
  19551. return nullptr;
  19552. }
  19553. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19554. session) != WOLFSSL_SUCCESS) {
  19555. delete session;
  19556. return nullptr;
  19557. }
  19558. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19559. return static_cast<session_t>(session);
  19560. }
  19561. inline void free_session(session_t session) {
  19562. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19563. }
  19564. inline bool set_sni(session_t session, const char *hostname,
  19565. bool verify_hostname) {
  19566. if (!session || !hostname) { return false; }
  19567. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19568. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19569. static_cast<word16>(strlen(hostname)));
  19570. if (ret != WOLFSSL_SUCCESS) {
  19571. impl::wolfssl_last_error() =
  19572. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19573. return false;
  19574. }
  19575. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19576. // separately from the SNI extension sent above; skip it when hostname
  19577. // verification is disabled so only the chain is checked, matching OpenSSL.
  19578. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19579. wsession->hostname = hostname;
  19580. return true;
  19581. }
  19582. inline TlsError connect(session_t session) {
  19583. TlsError err;
  19584. if (!session) {
  19585. err.code = ErrorCode::Fatal;
  19586. return err;
  19587. }
  19588. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19589. int ret = wolfSSL_connect(wsession->ssl);
  19590. if (ret == SSL_SUCCESS) {
  19591. err.code = ErrorCode::Success;
  19592. } else {
  19593. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19594. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19595. err.backend_code = static_cast<uint64_t>(ssl_error);
  19596. impl::wolfssl_last_error() = err.backend_code;
  19597. }
  19598. return err;
  19599. }
  19600. inline TlsError accept(session_t session) {
  19601. TlsError err;
  19602. if (!session) {
  19603. err.code = ErrorCode::Fatal;
  19604. return err;
  19605. }
  19606. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19607. int ret = wolfSSL_accept(wsession->ssl);
  19608. if (ret == SSL_SUCCESS) {
  19609. err.code = ErrorCode::Success;
  19610. // Capture SNI from thread-local storage after successful handshake
  19611. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19612. impl::wolfssl_pending_sni().clear();
  19613. } else {
  19614. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19615. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19616. err.backend_code = static_cast<uint64_t>(ssl_error);
  19617. impl::wolfssl_last_error() = err.backend_code;
  19618. }
  19619. return err;
  19620. }
  19621. inline bool connect_nonblocking(session_t session, socket_t sock,
  19622. time_t timeout_sec, time_t timeout_usec,
  19623. TlsError *err) {
  19624. if (!session) {
  19625. if (err) { err->code = ErrorCode::Fatal; }
  19626. return false;
  19627. }
  19628. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19629. // Set socket to non-blocking mode
  19630. detail::set_nonblocking(sock, true);
  19631. auto cleanup =
  19632. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19633. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19634. int ret;
  19635. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19636. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19637. if (ssl_error == SSL_ERROR_WANT_READ) {
  19638. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19639. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19640. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19641. }
  19642. // Error or timeout
  19643. if (err) {
  19644. err->code =
  19645. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19646. err->backend_code = static_cast<uint64_t>(ssl_error);
  19647. }
  19648. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19649. return false;
  19650. }
  19651. if (err) { err->code = ErrorCode::Success; }
  19652. return true;
  19653. }
  19654. inline bool accept_nonblocking(session_t session, socket_t sock,
  19655. time_t timeout_sec, time_t timeout_usec,
  19656. TlsError *err) {
  19657. if (!session) {
  19658. if (err) { err->code = ErrorCode::Fatal; }
  19659. return false;
  19660. }
  19661. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19662. // Set socket to non-blocking mode
  19663. detail::set_nonblocking(sock, true);
  19664. auto cleanup =
  19665. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19666. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19667. int ret;
  19668. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19669. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19670. if (ssl_error == SSL_ERROR_WANT_READ) {
  19671. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19672. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19673. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19674. }
  19675. // Error or timeout
  19676. if (err) {
  19677. err->code =
  19678. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19679. err->backend_code = static_cast<uint64_t>(ssl_error);
  19680. }
  19681. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19682. return false;
  19683. }
  19684. if (err) { err->code = ErrorCode::Success; }
  19685. // Capture SNI from thread-local storage after successful handshake
  19686. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19687. impl::wolfssl_pending_sni().clear();
  19688. return true;
  19689. }
  19690. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19691. if (!session || !buf) {
  19692. err.code = ErrorCode::Fatal;
  19693. return -1;
  19694. }
  19695. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19696. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19697. if (ret > 0) {
  19698. err.code = ErrorCode::Success;
  19699. return static_cast<ssize_t>(ret);
  19700. }
  19701. // 0 is also returned for EOF without close_notify; get_error tells them apart
  19702. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19703. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19704. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19705. err.backend_code = static_cast<uint64_t>(ssl_error);
  19706. impl::wolfssl_last_error() = err.backend_code;
  19707. return -1;
  19708. }
  19709. inline ssize_t write(session_t session, const void *buf, size_t len,
  19710. TlsError &err) {
  19711. if (!session || !buf) {
  19712. err.code = ErrorCode::Fatal;
  19713. return -1;
  19714. }
  19715. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19716. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19717. if (ret > 0) {
  19718. err.code = ErrorCode::Success;
  19719. return static_cast<ssize_t>(ret);
  19720. }
  19721. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19722. // Treat this as an error (return -1) so callers don't spin in a
  19723. // write loop adding zero to the offset.
  19724. if (ret == 0) {
  19725. err.code = ErrorCode::PeerClosed;
  19726. return -1;
  19727. }
  19728. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19729. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19730. err.backend_code = static_cast<uint64_t>(ssl_error);
  19731. impl::wolfssl_last_error() = err.backend_code;
  19732. return -1;
  19733. }
  19734. inline int pending(const_session_t session) {
  19735. if (!session) { return 0; }
  19736. auto wsession =
  19737. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19738. return wolfSSL_pending(wsession->ssl);
  19739. }
  19740. inline void shutdown(session_t session, bool graceful) {
  19741. if (!session) { return; }
  19742. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19743. if (graceful) {
  19744. int ret;
  19745. int attempts = 0;
  19746. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19747. attempts < 3) {
  19748. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19749. if (ssl_error != SSL_ERROR_WANT_READ &&
  19750. ssl_error != SSL_ERROR_WANT_WRITE) {
  19751. break;
  19752. }
  19753. attempts++;
  19754. }
  19755. } else {
  19756. wolfSSL_shutdown(wsession->ssl);
  19757. }
  19758. }
  19759. inline bool is_peer_closed(session_t session, socket_t sock) {
  19760. if (!session || sock == INVALID_SOCKET) { return true; }
  19761. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19762. // Check if there's already decrypted data available
  19763. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19764. // Set socket to non-blocking to avoid blocking on read
  19765. detail::set_nonblocking(sock, true);
  19766. auto cleanup =
  19767. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19768. // Peek 1 byte to check connection status without consuming data
  19769. unsigned char buf;
  19770. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19771. // If we got data or WANT_READ (would block), connection is alive
  19772. if (ret > 0) { return false; }
  19773. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19774. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19775. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19776. ret == 0;
  19777. }
  19778. inline cert_t get_peer_cert(const_session_t session) {
  19779. if (!session) { return nullptr; }
  19780. auto wsession =
  19781. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19782. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19783. return static_cast<cert_t>(cert);
  19784. }
  19785. inline size_t get_peer_certs(const_session_t session,
  19786. std::vector<cert_t> &certs) {
  19787. certs.clear();
  19788. if (!session) { return 0; }
  19789. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19790. #ifdef SESSION_CERTS
  19791. auto wsession =
  19792. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19793. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19794. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19795. for (int i = 0; i < count; i++) {
  19796. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19797. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19798. }
  19799. #endif
  19800. return certs.size();
  19801. }
  19802. inline void free_cert(cert_t cert) {
  19803. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19804. }
  19805. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19806. if (!cert || !hostname) { return false; }
  19807. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19808. std::string host_str(hostname);
  19809. // Check if hostname is an IP address (IPv4 or IPv6)
  19810. unsigned char ip_bytes[16];
  19811. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19812. auto is_ip = ip_len > 0;
  19813. // Check Subject Alternative Names
  19814. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19815. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19816. if (san_names) {
  19817. int san_count = wolfSSL_sk_num(san_names);
  19818. for (int i = 0; i < san_count; i++) {
  19819. auto *names =
  19820. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19821. if (!names) continue;
  19822. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19823. // DNS name
  19824. unsigned char *dns_name = nullptr;
  19825. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19826. if (dns_name && dns_len > 0) {
  19827. std::string san_name(reinterpret_cast<char *>(dns_name),
  19828. static_cast<size_t>(dns_len));
  19829. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19830. if (detail::match_hostname(san_name, host_str)) {
  19831. wolfSSL_sk_free(san_names);
  19832. return true;
  19833. }
  19834. }
  19835. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19836. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19837. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19838. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19839. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19840. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19841. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19842. wolfSSL_sk_free(san_names);
  19843. return true;
  19844. }
  19845. }
  19846. }
  19847. wolfSSL_sk_free(san_names);
  19848. }
  19849. return false;
  19850. }
  19851. inline uint64_t hostname_mismatch_code() {
  19852. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19853. }
  19854. inline long get_verify_result(const_session_t session) {
  19855. if (!session) { return -1; }
  19856. auto wsession =
  19857. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19858. long result = wolfSSL_get_verify_result(wsession->ssl);
  19859. return result;
  19860. }
  19861. inline std::string get_cert_subject_cn(cert_t cert) {
  19862. if (!cert) return "";
  19863. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19864. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19865. if (!subject) return "";
  19866. char cn[256] = {};
  19867. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19868. sizeof(cn));
  19869. if (cn_len <= 0) return "";
  19870. return std::string(cn, static_cast<size_t>(cn_len));
  19871. }
  19872. inline std::string get_cert_issuer_name(cert_t cert) {
  19873. if (!cert) return "";
  19874. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19875. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19876. if (!issuer) return "";
  19877. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19878. if (!name_str) return "";
  19879. std::string result(name_str);
  19880. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19881. return result;
  19882. }
  19883. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19884. sans.clear();
  19885. if (!cert) return false;
  19886. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19887. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19888. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19889. if (!san_names) return true; // No SANs is not an error
  19890. int count = wolfSSL_sk_num(san_names);
  19891. for (int i = 0; i < count; i++) {
  19892. auto *name =
  19893. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19894. if (!name) continue;
  19895. SanEntry entry;
  19896. switch (name->type) {
  19897. case WOLFSSL_GEN_DNS: {
  19898. entry.type = SanType::DNS;
  19899. unsigned char *dns_name = nullptr;
  19900. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19901. if (dns_name && dns_len > 0) {
  19902. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19903. static_cast<size_t>(dns_len));
  19904. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19905. }
  19906. break;
  19907. }
  19908. case WOLFSSL_GEN_IPADD: {
  19909. entry.type = SanType::IP;
  19910. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19911. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19912. if (ip_data && ip_len == 4) {
  19913. char buf[16];
  19914. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19915. ip_data[2], ip_data[3]);
  19916. entry.value = buf;
  19917. } else if (ip_data && ip_len == 16) {
  19918. char buf[64];
  19919. snprintf(buf, sizeof(buf),
  19920. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19921. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19922. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19923. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19924. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19925. ip_data[14], ip_data[15]);
  19926. entry.value = buf;
  19927. }
  19928. break;
  19929. }
  19930. case WOLFSSL_GEN_EMAIL:
  19931. entry.type = SanType::EMAIL;
  19932. {
  19933. unsigned char *email = nullptr;
  19934. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19935. if (email && email_len > 0) {
  19936. entry.value = std::string(reinterpret_cast<char *>(email),
  19937. static_cast<size_t>(email_len));
  19938. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19939. }
  19940. }
  19941. break;
  19942. case WOLFSSL_GEN_URI:
  19943. entry.type = SanType::URI;
  19944. {
  19945. unsigned char *uri = nullptr;
  19946. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19947. &uri, name->d.uniformResourceIdentifier);
  19948. if (uri && uri_len > 0) {
  19949. entry.value = std::string(reinterpret_cast<char *>(uri),
  19950. static_cast<size_t>(uri_len));
  19951. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19952. }
  19953. }
  19954. break;
  19955. default: entry.type = SanType::OTHER; break;
  19956. }
  19957. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19958. }
  19959. wolfSSL_sk_free(san_names);
  19960. return true;
  19961. }
  19962. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19963. time_t &not_after) {
  19964. if (!cert) return false;
  19965. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19966. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19967. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19968. if (!nb || !na) return false;
  19969. // wolfSSL_ASN1_TIME_to_tm is available
  19970. struct tm tm_nb = {}, tm_na = {};
  19971. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19972. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19973. #ifdef _WIN32
  19974. not_before = _mkgmtime(&tm_nb);
  19975. not_after = _mkgmtime(&tm_na);
  19976. #else
  19977. not_before = timegm(&tm_nb);
  19978. not_after = timegm(&tm_na);
  19979. #endif
  19980. return true;
  19981. }
  19982. inline std::string get_cert_serial(cert_t cert) {
  19983. if (!cert) return "";
  19984. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19985. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19986. if (!serial_asn1) return "";
  19987. // Get the serial number data
  19988. int len = serial_asn1->length;
  19989. unsigned char *data = serial_asn1->data;
  19990. if (!data || len <= 0) return "";
  19991. std::string result;
  19992. result.reserve(static_cast<size_t>(len) * 2);
  19993. for (int i = 0; i < len; i++) {
  19994. char hex[3];
  19995. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19996. result += hex;
  19997. }
  19998. return result;
  19999. }
  20000. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20001. if (!cert) return false;
  20002. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20003. int der_len = 0;
  20004. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  20005. if (!der_data || der_len <= 0) return false;
  20006. der.assign(der_data, der_data + der_len);
  20007. return true;
  20008. }
  20009. inline const char *get_sni(const_session_t session) {
  20010. if (!session) return nullptr;
  20011. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  20012. // For server: return SNI received from client during handshake
  20013. if (!wsession->sni_hostname.empty()) {
  20014. return wsession->sni_hostname.c_str();
  20015. }
  20016. // For client: return the hostname set via set_sni
  20017. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  20018. return nullptr;
  20019. }
  20020. inline uint64_t peek_error() {
  20021. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20022. }
  20023. inline uint64_t get_error() {
  20024. uint64_t err = impl::wolfssl_last_error();
  20025. impl::wolfssl_last_error() = 0;
  20026. return err;
  20027. }
  20028. inline std::string error_string(uint64_t code) {
  20029. char buf[256];
  20030. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20031. return std::string(buf);
  20032. }
  20033. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20034. if (!pem || len == 0) { return nullptr; }
  20035. // Validate by attempting to load into a temporary ctx
  20036. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20037. if (!tmp_ctx) { return nullptr; }
  20038. int ret = wolfSSL_CTX_load_verify_buffer(
  20039. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20040. static_cast<long>(len), SSL_FILETYPE_PEM);
  20041. wolfSSL_CTX_free(tmp_ctx);
  20042. if (ret != SSL_SUCCESS) { return nullptr; }
  20043. return static_cast<ca_store_t>(
  20044. new impl::WolfSSLCAStore{std::string(pem, len)});
  20045. }
  20046. inline void free_ca_store(ca_store_t store) {
  20047. delete static_cast<impl::WolfSSLCAStore *>(store);
  20048. }
  20049. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20050. if (!ctx || !store) { return false; }
  20051. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20052. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20053. int ret = wolfSSL_CTX_load_verify_buffer(
  20054. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20055. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20056. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20057. // This function takes ownership of the store; the PEM data was copied into
  20058. // the context, so release the source
  20059. free_ca_store(store);
  20060. return ret == SSL_SUCCESS;
  20061. }
  20062. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20063. certs.clear();
  20064. if (!ctx) { return 0; }
  20065. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20066. if (wctx->ca_pem_data_.empty()) { return 0; }
  20067. const std::string &pem = wctx->ca_pem_data_;
  20068. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20069. const std::string end_marker = "-----END CERTIFICATE-----";
  20070. size_t pos = 0;
  20071. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20072. size_t end_pos = pem.find(end_marker, pos);
  20073. if (end_pos == std::string::npos) { break; }
  20074. end_pos += end_marker.size();
  20075. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20076. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20077. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20078. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20079. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20080. pos = end_pos;
  20081. }
  20082. return certs.size();
  20083. }
  20084. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20085. std::vector<std::string> names;
  20086. if (!ctx) { return names; }
  20087. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20088. if (wctx->ca_pem_data_.empty()) { return names; }
  20089. const std::string &pem = wctx->ca_pem_data_;
  20090. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20091. const std::string end_marker = "-----END CERTIFICATE-----";
  20092. size_t pos = 0;
  20093. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20094. size_t end_pos = pem.find(end_marker, pos);
  20095. if (end_pos == std::string::npos) { break; }
  20096. end_pos += end_marker.size();
  20097. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20098. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20099. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20100. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20101. if (x509) {
  20102. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20103. if (subject) {
  20104. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20105. if (name_str) {
  20106. names.push_back(name_str);
  20107. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20108. }
  20109. }
  20110. wolfSSL_X509_free(x509);
  20111. }
  20112. pos = end_pos;
  20113. }
  20114. return names;
  20115. }
  20116. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20117. const char *key_pem, const char *password) {
  20118. if (!ctx || !cert_pem || !key_pem) { return false; }
  20119. // Try the pair on a scratch context first, so that a bad one leaves the
  20120. // server's certificate and key as they were
  20121. auto tmp = create_server_context();
  20122. if (!tmp) { return false; }
  20123. auto se = detail::scope_exit([&] { free_context(tmp); });
  20124. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20125. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20126. }
  20127. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20128. if (!ctx || !ca_pem) { return false; }
  20129. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20130. // Replace the CAs rather than add to them, as the other backends do, once
  20131. // the new ones are known to load
  20132. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20133. if (!store) { return false; }
  20134. free_ca_store(store);
  20135. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20136. wctx->ca_pem_data_.clear();
  20137. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20138. }
  20139. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20140. if (!ctx) { return false; }
  20141. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20142. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20143. : nullptr;
  20144. {
  20145. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20146. // A handshake running the previous callback keeps it until it returns.
  20147. wctx->verify_callback.swap(stored);
  20148. }
  20149. impl::apply_verify_mode(*wctx);
  20150. return true;
  20151. }
  20152. inline long get_verify_error(const_session_t session) {
  20153. if (!session) { return -1; }
  20154. auto *wsession =
  20155. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20156. return wolfSSL_get_verify_result(wsession->ssl);
  20157. }
  20158. inline std::string verify_error_string(long error_code) {
  20159. if (error_code == 0) { return ""; }
  20160. const char *str =
  20161. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20162. return str ? std::string(str) : std::string();
  20163. }
  20164. } // namespace tls
  20165. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20166. // WebSocket implementation
  20167. namespace ws {
  20168. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20169. bool fin) {
  20170. std::lock_guard<std::mutex> lock(write_mutex_);
  20171. if (closed_) { return false; }
  20172. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20173. }
  20174. inline ReadResult WebSocket::read(std::string &msg) {
  20175. // Answers a control frame; any other opcode here is a protocol error.
  20176. // Returns false when the connection is done.
  20177. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20178. switch (op) {
  20179. case Opcode::Ping: {
  20180. std::lock_guard<std::mutex> lock(write_mutex_);
  20181. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20182. payload.size(), true, !is_server_);
  20183. return true;
  20184. }
  20185. case Opcode::Pong: {
  20186. std::lock_guard<std::mutex> lock(ping_mutex_);
  20187. unacked_pings_ = 0;
  20188. return true;
  20189. }
  20190. case Opcode::Close: {
  20191. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20192. // malformed, which is answered with a protocol error instead.
  20193. if (closed_.exchange(true)) { return false; }
  20194. auto reply = payload;
  20195. if (!impl::is_valid_close_payload(payload)) {
  20196. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20197. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20198. }
  20199. std::lock_guard<std::mutex> lock(write_mutex_);
  20200. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20201. reply.size(), true, !is_server_);
  20202. return false;
  20203. }
  20204. default: closed_ = true; return false;
  20205. }
  20206. };
  20207. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20208. while (!closed_) {
  20209. Opcode opcode;
  20210. std::string payload;
  20211. bool fin;
  20212. impl::FrameRead r =
  20213. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  20214. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  20215. // A timeout landed on a frame boundary of an open connection: it is
  20216. // untouched and still usable, so hand control back without closing it.
  20217. // That is only useful to a caller who asked for the timeout; the
  20218. // compile-time default is a backstop against a peer gone quiet, and
  20219. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  20220. // ends. A wait that a pong timeout cut short finds the connection closed.
  20221. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20222. return Timeout;
  20223. }
  20224. if (r != impl::FrameRead::Ok) {
  20225. closed_ = true;
  20226. return Fail;
  20227. }
  20228. switch (opcode) {
  20229. case Opcode::Text:
  20230. case Opcode::Binary: {
  20231. auto result = opcode == Opcode::Text ? Text : Binary;
  20232. msg = std::move(payload);
  20233. // Handle fragmentation
  20234. if (!fin) {
  20235. while (true) {
  20236. Opcode cont_opcode;
  20237. std::string cont_payload;
  20238. bool cont_fin;
  20239. // Only what is left of the limit, but room for a control frame,
  20240. // which may come between the fragments.
  20241. auto max_len =
  20242. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  20243. ? size_t(0)
  20244. : (std::max)(size_t(125),
  20245. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20246. msg.size());
  20247. // A timeout is not reportable here: half of a fragmented message is
  20248. // already in `msg` and read() has no way to resume it, so it is a
  20249. // failure like any other. Timeouts are only ever seen on a message
  20250. // boundary.
  20251. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  20252. cont_fin, is_server_,
  20253. max_len) != impl::FrameRead::Ok) {
  20254. closed_ = true;
  20255. return Fail;
  20256. }
  20257. // RFC 6455 5.4: the fragments are continuation frames, with only
  20258. // control frames between them.
  20259. if (cont_opcode != Opcode::Continuation) {
  20260. if (handle_control(cont_opcode, cont_payload)) { continue; }
  20261. return Fail;
  20262. }
  20263. msg += cont_payload;
  20264. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20265. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20266. closed_ = true;
  20267. return Fail;
  20268. }
  20269. if (cont_fin) { break; }
  20270. }
  20271. }
  20272. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20273. if (result == Text && !impl::is_valid_utf8(msg)) {
  20274. // close() takes the read lock to wait for the peer's Close reply, so
  20275. // it must not run while this thread still holds it.
  20276. read_lock.unlock();
  20277. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20278. return Fail;
  20279. }
  20280. return result;
  20281. }
  20282. default:
  20283. if (handle_control(opcode, payload)) { continue; }
  20284. return Fail;
  20285. }
  20286. }
  20287. return Fail;
  20288. }
  20289. inline bool WebSocket::send(const std::string &data) {
  20290. return send_frame(Opcode::Text, data.data(), data.size());
  20291. }
  20292. inline bool WebSocket::send(const char *data, size_t len) {
  20293. return send_frame(Opcode::Binary, data, len);
  20294. }
  20295. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20296. if (closed_.exchange(true)) { return; }
  20297. ping_cv_.notify_all();
  20298. std::string payload;
  20299. auto code = static_cast<uint16_t>(status);
  20300. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20301. payload.push_back(static_cast<char>(code & 0xFF));
  20302. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20303. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20304. // cut back to a whole UTF-8 character
  20305. auto short_reason = reason.substr(0, 123);
  20306. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20307. short_reason.pop_back();
  20308. }
  20309. payload += short_reason;
  20310. // A code that may not be sent, such as NoStatus, goes without a payload
  20311. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20312. {
  20313. std::lock_guard<std::mutex> lock(write_mutex_);
  20314. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20315. payload.size(), true, !is_server_);
  20316. }
  20317. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20318. // Close response before closing the TCP connection.
  20319. //
  20320. // Wait only when no other thread is parsing frames. When one is, it is the
  20321. // thread positioned to see the peer's reply, and reading here would take
  20322. // bytes out of the message it is assembling. Bailing out also leaves the
  20323. // stream, including its read timeout, entirely to that thread.
  20324. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20325. if (!read_lock.owns_lock()) { return; }
  20326. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20327. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20328. Opcode op;
  20329. std::string resp;
  20330. bool fin;
  20331. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20332. impl::FrameRead::Ok) {
  20333. if (op == Opcode::Close) { break; }
  20334. }
  20335. }
  20336. inline WebSocket::~WebSocket() {
  20337. {
  20338. std::lock_guard<std::mutex> lock(ping_mutex_);
  20339. closed_ = true;
  20340. }
  20341. ping_cv_.notify_all();
  20342. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20343. // A server's stream outlives this object
  20344. strm_.set_read_interrupt(nullptr);
  20345. }
  20346. inline void WebSocket::start_heartbeat() {
  20347. if (ping_interval_sec_ <= 0) { return; }
  20348. // A pong timeout ends a read() blocked on the silent peer
  20349. if (max_missed_pongs_ > 0) {
  20350. strm_.set_read_interrupt([this] { return pong_timed_out_.load(); });
  20351. }
  20352. ping_thread_ = std::thread([this]() {
  20353. std::unique_lock<std::mutex> lock(ping_mutex_);
  20354. // The predicate keeps a spurious wakeup from sending a ping early
  20355. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20356. [this]() { return closed_.load(); })) {
  20357. // If the peer has failed to respond to the previous pings, give up.
  20358. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20359. // opt-in liveness check controlled by max_missed_pongs_.
  20360. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20361. lock.unlock();
  20362. close(CloseStatus::GoingAway, "pong timeout");
  20363. pong_timed_out_ = true;
  20364. return;
  20365. }
  20366. lock.unlock();
  20367. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20368. lock.lock();
  20369. closed_ = true;
  20370. break;
  20371. }
  20372. lock.lock();
  20373. unacked_pings_++;
  20374. }
  20375. });
  20376. }
  20377. inline const Request &WebSocket::request() const { return req_; }
  20378. inline bool WebSocket::is_open() const { return !closed_; }
  20379. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20380. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20381. // poll(), where 0 would instead mean "return immediately", so hand it the
  20382. // negative poll uses for an unbounded wait.
  20383. if (sec == 0 && usec == 0) { sec = -1; }
  20384. strm_.set_read_timeout(sec, usec);
  20385. read_timeout_set_ = true;
  20386. }
  20387. // WebSocketClient implementation
  20388. inline WebSocketClient::WebSocketClient(
  20389. const std::string &scheme_host_port_path, const Headers &headers)
  20390. : headers_(headers) {
  20391. detail::UrlComponents uc;
  20392. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20393. !uc.host.empty() && !uc.path.empty()) {
  20394. auto &scheme = uc.scheme;
  20395. #ifdef CPPHTTPLIB_SSL_ENABLED
  20396. if (scheme != "ws" && scheme != "wss") {
  20397. #else
  20398. if (scheme != "ws") {
  20399. #endif
  20400. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20401. std::string msg = "'" + scheme + "' scheme is not supported.";
  20402. throw std::invalid_argument(msg);
  20403. #endif
  20404. return;
  20405. }
  20406. auto is_ssl = scheme == "wss";
  20407. host_ = std::move(uc.host);
  20408. port_ = is_ssl ? 443 : 80;
  20409. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20410. path_ = std::move(uc.path);
  20411. if (!uc.query.empty()) { path_ += uc.query; }
  20412. #ifdef CPPHTTPLIB_SSL_ENABLED
  20413. is_ssl_ = is_ssl;
  20414. if (is_ssl_) {
  20415. // The context lives as long as the client so that CA configuration
  20416. // survives reconnects; sessions are created per connection.
  20417. tls_ctx_ = tls::create_client_context();
  20418. if (!tls_ctx_) { return; }
  20419. }
  20420. #else
  20421. if (is_ssl) { return; }
  20422. #endif
  20423. is_valid_ = true;
  20424. }
  20425. }
  20426. #ifdef CPPHTTPLIB_SSL_ENABLED
  20427. inline WebSocketClient::WebSocketClient(
  20428. const std::string &scheme_host_port_path, const PemMemory &pem,
  20429. const Headers &headers)
  20430. : WebSocketClient(scheme_host_port_path, headers) {
  20431. // For ws:// URLs the client certificate is silently ignored, consistent
  20432. // with the TLS-only setters such as set_ca_cert_path().
  20433. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20434. std::string cert_buf, key_buf;
  20435. if (!tls::set_client_cert_pem(
  20436. tls_ctx_,
  20437. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20438. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20439. pem.private_key_password)) {
  20440. tls::free_context(tls_ctx_);
  20441. tls_ctx_ = nullptr;
  20442. is_valid_ = false;
  20443. }
  20444. }
  20445. }
  20446. #endif
  20447. inline WebSocketClient::~WebSocketClient() {
  20448. shutdown_and_close();
  20449. #ifdef CPPHTTPLIB_SSL_ENABLED
  20450. if (tls_ctx_) {
  20451. tls::free_context(tls_ctx_);
  20452. tls_ctx_ = nullptr;
  20453. }
  20454. #endif
  20455. }
  20456. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20457. inline void WebSocketClient::shutdown_and_close() {
  20458. // Send the close frame while the TLS session is still alive: ws_ holds an
  20459. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20460. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20461. if (ws_ && ws_->is_open()) { ws_->close(); }
  20462. ws_.reset();
  20463. #ifdef CPPHTTPLIB_SSL_ENABLED
  20464. if (is_ssl_) {
  20465. if (tls_session_) {
  20466. tls::shutdown(tls_session_, true);
  20467. tls::free_session(tls_session_);
  20468. tls_session_ = nullptr;
  20469. }
  20470. }
  20471. #endif
  20472. if (sock_ != INVALID_SOCKET) {
  20473. detail::shutdown_socket(sock_);
  20474. detail::close_socket(sock_);
  20475. sock_ = INVALID_SOCKET;
  20476. }
  20477. }
  20478. // The handshakes belong to establishing the connection, so an unset read
  20479. // timeout leaves them bounded by the connection timeout instead of forever.
  20480. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20481. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20482. return {connection_timeout_sec_, connection_timeout_usec_};
  20483. }
  20484. return {read_timeout_sec_, read_timeout_usec_};
  20485. }
  20486. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20487. Error &error, int &ssl_error,
  20488. uint64_t &ssl_backend_error) {
  20489. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20490. // The streams wait with poll(), where 0 instead means "return immediately",
  20491. // so they are given the negative poll uses for an unbounded wait.
  20492. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20493. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20494. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20495. #ifdef CPPHTTPLIB_SSL_ENABLED
  20496. if (is_ssl_) {
  20497. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20498. // is not safe to call concurrently on one client to begin with, since
  20499. // nothing else here is guarded either.
  20500. if (server_certificate_verification_ && !certs_loaded_) {
  20501. uint64_t backend_error = 0;
  20502. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20503. ca_cert_dir_path_, custom_ca_loaded_,
  20504. system_ca_mode_, backend_error);
  20505. certs_loaded_ = true;
  20506. }
  20507. detail::ClientTlsSessionOptions options;
  20508. options.server_hostname_verification = server_hostname_verification_;
  20509. options.session_verifier = session_verifier_;
  20510. auto timeout = handshake_timeout();
  20511. detail::ClientTlsSessionError tls_error;
  20512. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20513. server_certificate_verification_,
  20514. timeout.first, timeout.second,
  20515. &tls_error, options)) {
  20516. error = tls_error.error;
  20517. ssl_error = tls_error.ssl_error;
  20518. ssl_backend_error = tls_error.backend_error;
  20519. return false;
  20520. }
  20521. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20522. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20523. write_timeout_usec_));
  20524. return true;
  20525. }
  20526. #else
  20527. (void)error;
  20528. (void)ssl_error;
  20529. (void)ssl_backend_error;
  20530. #endif
  20531. strm = std::unique_ptr<Stream>(
  20532. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20533. write_timeout_sec_, write_timeout_usec_));
  20534. return true;
  20535. }
  20536. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20537. #ifdef CPPHTTPLIB_SSL_ENABLED
  20538. auto is_ssl = is_ssl_;
  20539. #else
  20540. auto is_ssl = false;
  20541. #endif
  20542. if (!req.has_header("Host")) {
  20543. req.headers.emplace("Host", detail::make_default_host_header_value(
  20544. host_, port_, is_ssl, address_family_));
  20545. }
  20546. detail::add_default_user_agent_header(req);
  20547. detail::add_authorization_header(req, basic_auth_username_,
  20548. basic_auth_password_,
  20549. bearer_token_auth_token_, false);
  20550. }
  20551. inline Result WebSocketClient::connect() {
  20552. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20553. shutdown_and_close();
  20554. auto error = Error::Success;
  20555. if (!create_and_connect_socket(error)) {
  20556. return Result{error, -1, Headers{}};
  20557. }
  20558. if (is_proxy_enabled()) {
  20559. Response proxy_res;
  20560. if (!connect_with_proxy(proxy_res, error)) {
  20561. shutdown_and_close();
  20562. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20563. }
  20564. }
  20565. std::unique_ptr<Stream> strm;
  20566. auto stream_error = Error::SSLConnection;
  20567. int ssl_error = 0;
  20568. uint64_t ssl_backend_error = 0;
  20569. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20570. shutdown_and_close();
  20571. #ifdef CPPHTTPLIB_SSL_ENABLED
  20572. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20573. #else
  20574. return Result{stream_error, -1, Headers{}};
  20575. #endif
  20576. }
  20577. Request req;
  20578. req.method = "GET";
  20579. req.path = path_;
  20580. req.headers = headers_;
  20581. prepare_default_headers(req);
  20582. detail::WebSocketUpgradeResponse upgrade;
  20583. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20584. shutdown_and_close();
  20585. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20586. }
  20587. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20588. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20589. websocket_ping_interval_sec_,
  20590. websocket_max_missed_pongs_));
  20591. // The stream was created with the timeout already; tell the WebSocket
  20592. // whether it came from the caller, so read() knows to report it as Timeout.
  20593. ws_->read_timeout_set_ = read_timeout_set_;
  20594. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20595. }
  20596. inline ReadResult WebSocketClient::read(std::string &msg) {
  20597. if (!ws_) { return Fail; }
  20598. return ws_->read(msg);
  20599. }
  20600. inline bool WebSocketClient::send(const std::string &data) {
  20601. if (!ws_) { return false; }
  20602. return ws_->send(data);
  20603. }
  20604. inline bool WebSocketClient::send(const char *data, size_t len) {
  20605. if (!ws_) { return false; }
  20606. return ws_->send(data, len);
  20607. }
  20608. inline void WebSocketClient::close(CloseStatus status,
  20609. const std::string &reason) {
  20610. if (ws_) { ws_->close(status, reason); }
  20611. }
  20612. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20613. inline const std::string &WebSocketClient::subprotocol() const {
  20614. return subprotocol_;
  20615. }
  20616. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20617. read_timeout_sec_ = sec;
  20618. read_timeout_usec_ = usec;
  20619. read_timeout_set_ = true;
  20620. // The members above only seed the next connect(); read() consults the
  20621. // stream, so an already-open connection has to be told directly.
  20622. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20623. }
  20624. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20625. write_timeout_sec_ = sec;
  20626. write_timeout_usec_ = usec;
  20627. }
  20628. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20629. websocket_ping_interval_sec_ = sec;
  20630. }
  20631. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20632. websocket_max_missed_pongs_ = count;
  20633. }
  20634. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20635. inline void WebSocketClient::set_address_family(int family) {
  20636. address_family_ = family;
  20637. }
  20638. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20639. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20640. socket_options_ = std::move(socket_options);
  20641. }
  20642. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20643. connection_timeout_sec_ = sec;
  20644. connection_timeout_usec_ = usec;
  20645. }
  20646. inline void WebSocketClient::set_interface(const std::string &intf) {
  20647. interface_ = intf;
  20648. }
  20649. inline void WebSocketClient::set_hostname_addr_map(
  20650. std::map<std::string, std::string> addr_map) {
  20651. set_direct_hostname_addr_map(std::move(addr_map));
  20652. }
  20653. inline void WebSocketClient::set_direct_hostname_addr_map(
  20654. std::map<std::string, std::string> addr_map) {
  20655. addr_map_ = std::move(addr_map);
  20656. }
  20657. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  20658. std::map<std::string, std::string> addr_map) {
  20659. tunnel_addr_map_ = std::move(addr_map);
  20660. }
  20661. inline bool WebSocketClient::is_proxy_enabled() const {
  20662. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20663. if (no_proxy_entries_.empty()) { return true; }
  20664. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20665. no_proxy_entries_);
  20666. }
  20667. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20668. std::string connect_host;
  20669. std::string ip;
  20670. auto port = port_;
  20671. if (is_proxy_enabled()) {
  20672. connect_host = proxy_host_;
  20673. port = proxy_port_;
  20674. } else {
  20675. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20676. }
  20677. sock_ = detail::create_client_socket(
  20678. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20679. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20680. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20681. write_timeout_usec_, interface_, error);
  20682. if (sock_ != INVALID_SOCKET) { return true; }
  20683. if (error == Error::Success) { error = Error::Connection; }
  20684. return false;
  20685. }
  20686. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20687. Response &proxy_res,
  20688. Error &error) {
  20689. auto timeout = handshake_timeout();
  20690. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20691. write_timeout_sec_, write_timeout_usec_);
  20692. if (!detail::write_request_head(strm, req, error)) { return false; }
  20693. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20694. error = Error::Read;
  20695. return false;
  20696. }
  20697. return true;
  20698. }
  20699. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20700. // forward an Upgrade request.
  20701. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20702. Error &error) {
  20703. Request req;
  20704. req.method = "CONNECT";
  20705. req.path =
  20706. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  20707. req.headers.emplace("Host", req.path);
  20708. detail::add_default_user_agent_header(req);
  20709. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20710. proxy_basic_auth_password_,
  20711. proxy_bearer_token_auth_token_, true);
  20712. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20713. #ifdef CPPHTTPLIB_SSL_ENABLED
  20714. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20715. std::map<std::string, std::string> auth;
  20716. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20717. !proxy_digest_auth_username_.empty() &&
  20718. !proxy_digest_auth_password_.empty() &&
  20719. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20720. proxy_res = Response();
  20721. shutdown_and_close();
  20722. if (!create_and_connect_socket(error)) { return false; }
  20723. req.headers.erase("Proxy-Authorization");
  20724. req.headers.insert(detail::make_digest_authentication_header(
  20725. req, req.path, auth, 1, detail::random_string(10),
  20726. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20727. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20728. }
  20729. #endif
  20730. if (proxy_res.status != StatusCode::OK_200) {
  20731. error = Error::ProxyConnection;
  20732. return false;
  20733. }
  20734. return true;
  20735. }
  20736. inline void WebSocketClient::set_basic_auth(const std::string &username,
  20737. const std::string &password) {
  20738. basic_auth_username_ = username;
  20739. basic_auth_password_ = password;
  20740. }
  20741. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  20742. bearer_token_auth_token_ = token;
  20743. }
  20744. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20745. proxy_host_ = host;
  20746. proxy_port_ = port;
  20747. }
  20748. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20749. const std::string &password) {
  20750. proxy_basic_auth_username_ = username;
  20751. proxy_basic_auth_password_ = password;
  20752. }
  20753. inline void
  20754. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20755. proxy_bearer_token_auth_token_ = token;
  20756. }
  20757. inline void
  20758. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20759. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20760. }
  20761. #ifdef CPPHTTPLIB_SSL_ENABLED
  20762. inline void
  20763. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20764. const std::string &ca_cert_dir_path) {
  20765. ca_cert_file_path_ = ca_cert_file_path;
  20766. ca_cert_dir_path_ = ca_cert_dir_path;
  20767. }
  20768. inline void
  20769. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20770. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20771. }
  20772. inline void WebSocketClient::set_session_verifier(
  20773. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20774. session_verifier_ = std::move(verifier);
  20775. }
  20776. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20777. if (store && tls_ctx_) {
  20778. // set_ca_store takes ownership of store
  20779. tls::set_ca_store(tls_ctx_, store);
  20780. } else if (store) {
  20781. tls::free_ca_store(store);
  20782. }
  20783. custom_ca_loaded_ = true;
  20784. }
  20785. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20786. std::size_t size) {
  20787. if (tls_ctx_ && ca_cert && size > 0) {
  20788. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20789. }
  20790. custom_ca_loaded_ = true;
  20791. }
  20792. inline void
  20793. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20794. server_certificate_verification_ = enabled;
  20795. }
  20796. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20797. server_hostname_verification_ = enabled;
  20798. }
  20799. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20800. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20801. }
  20802. inline void
  20803. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20804. const std::string &password) {
  20805. proxy_digest_auth_username_ = username;
  20806. proxy_digest_auth_password_ = password;
  20807. }
  20808. #endif // CPPHTTPLIB_SSL_ENABLED
  20809. } // namespace ws
  20810. // ----------------------------------------------------------------------------
  20811. } // namespace httplib
  20812. #endif // CPPHTTPLIB_HTTPLIB_H